Stable release

The Cinder Library is an interfacing library that doesn’t have any storage driver and expects Cinder drivers to be properly installed in the system to run properly.


For Red Hat distributions the recommendation is to use RPMs to install the Cinder drivers instead of using pip. If we don’t have access to the Red Hat OpenStack Platform packages we can use the RDO community packages.

On CentOS, the Extras repository provides the RPM that enables the OpenStack repository. Extras is enabled by default on CentOS 7, so you can simply install the RPM to set up the OpenStack repository:

# yum install -y centos-release-openstack-queens
# yum-config-manager --enable openstack-queens
# yum update -y
# yum install -y openstack-cinder

On RHEL and Fedora, you’ll need to download and install the RDO repository RPM to set up the OpenStack repository:

# yum install -y
# yum-config-manager --enable openstack-queens
# sudo yum update -y
# yum install -y openstack-cinder


To install Cinder Library we’ll use PyPI, so we’ll make sure to have the pip command available:

# yum install -y python-pip
# pip install cinderlib

This is the preferred method to install Cinder Library, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.


There is a docker image, in case you prefer trying the library without any installation.

The image is called akrog/cinderlib:stable, and we can run Python dirrectly with:

$ docker run --name=cinderlib --privileged --net=host -v /etc/iscsi:/etc/iscsi -v /dev:/dev -it akrog/cinderlib:stable python

Latest code


A Docker image is automatically built on every commit to the master branch. Running a Python shell with the latest cinderlib code is as simple as:

$ docker run --name=cinderlib --privileged --net=host -v /etc/iscsi:/etc/iscsi -v /dev:/dev -it akrog/cinderlib python


If we don’t have a packaged version or if we want to use a virtual environment we can install the drivers from source:

$ virtualenv cinder
$ source cinder/bin/activate
$ pip install git+


The sources for Cinder Library can be downloaded from the Github repo to use the latest version of the library.

You can either clone the public repository:

$ git clone git://

Or download the tarball:

$ curl  -OL

Once you have a copy of the source, you can install it with:

# python install