Difficulty: Beginner
Estimated Time: 10 minutes

OpenStorage SDK Python Client Tutorial

In this tutorial will be going step by step how to use a Python gRPC client leveraging the OpenStorage SDK to create a volume, take its snapshot, and backup it up to a cloud.

The complete sources for app.py client are available in examples/python repo for libopenstorage.github.io.

More information

For more information and for the SDK reference please visit libopenstorage.github.io.


As you can see from the above, working with OpenStorage SDK is quite easy, fun, and powerful. Please visit OpenStorage SDK for more information.

Python Tutorial for OpenStorage SDK

Step 1 of 4

Setting up the environment

Setting up mock-sdk-server

For simplicity this tutorial will use the mock-sdk-server provided by the OpenStorage project. It is an in-memory storage system implementation of the OpenStorage SDK and it makes it possible to develop your client by simply running a container on your laptop or system.

First, let's setup the environment by running the following command:


Once the initial setup of the environment has finished, run the following command to start the mock-sdk-server:

docker run --rm --name sdk -d \ -p 9100:9100 -p 9110:9110 \ openstorage/mock-sdk-server

Running this docker command will expose port 9100 for the gRPC server, and port 9110 for the gRPC REST Gateway connection.

Let's test the connection now before continuing by running the following to the gRPC REST Gateway:

curl -s -X GET "http://localhost:9110/v1/clusters/inspectcurrent" \ -H "accept: application/json" \ -H "Content-Type: application/json" \ -d "{}" | jq

This should return information about the cluster in JSON format, as shown below:

{ "cluster": { "status": "STATUS_OK", "id": "mock" } }

Python environment setup

Lastly you need to setup our terminal environment to use the python virtualenv that has been setup. To do this run:

source sdkenv/bin/activate

Now all python commands will use the libraries contained in the sdkenv virtualenv.

REST Swagger User Interface

If you would like to access the Swagger-UI for use with curl or other REST clients, follow the link below. Once on the Swagger-UI, you must the the Schemes value to HTTPS to make it work with Katacoda.

Launch Swagger UI