Direct usage of Cinder Block Storage drivers without the services
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Zuul aacb772f2e Merge "Update contributor docs" 3 weeks ago
cinderlib Fix datetime serialization 4 weeks ago
devstack OpenDev Migration Patch 2 years ago
doc Update contributor docs 4 weeks ago
playbooks Fix cinderlib-lvm-functional 12 months ago
releasenotes Update master for stable/wallaby 4 weeks ago
roles/run-cinderlib-tests Fix: add a default value for cinderlib_pool_name 2 years ago
tools Add privsep support 1 month ago
.gitignore Add zuul jobs 2 years ago
.gitreview OpenDev Migration Patch 2 years ago
.stestr.conf Add zuul jobs 2 years ago
.zuul.yaml Merge "Add privsep support" 1 month ago
CONTRIBUTING.rst Ussuri contrib docs community goal 1 year ago
DESCRIPTION.rst Fix cinderlib Python package 2 years ago
HACKING.rst Format as a Cinder-related OpenStack project 2 years ago
LICENSE Format as a Cinder-related OpenStack project 2 years ago
README.rst Fix cinderlib Python package 2 years ago
babel.cfg Format as a Cinder-related OpenStack project 2 years ago
bindep.txt Use Python 3 by default and drop Python 2 2 years ago
lower-constraints.txt Continue wallaby development 3 months ago
requirements.txt Open cinderlib for xena development 4 weeks ago
setup.cfg Cleanup py27 support 1 year ago Cleanup py27 support 1 year ago
test-requirements.txt Move cinderlib to new hacking 4.0.0 5 months ago
tox.ini Merge "Update TOX setenv" 4 weeks ago


Cinder Library





The Cinder Library, also known as cinderlib, is a Python library that leverages the Cinder project to provide an object oriented abstraction around Cinder's storage drivers to allow their usage directly without running any of the Cinder services or surrounding services, such as KeyStone, MySQL or RabbitMQ.

The library is intended for developers who only need the basic CRUD functionality of the drivers and don't care for all the additional features Cinder provides such as quotas, replication, multi-tenancy, migrations, retyping, scheduling, backups, authorization, authentication, REST API, etc.

The library was originally created as an external project, so it didn't have the broad range of backend testing Cinder does, and only a limited number of drivers were validated at the time. Drivers should work out of the box, and we'll keep a list of drivers that have added the cinderlib functional tests to the driver gates confirming they work and ensuring they will keep working.


  • Use a Cinder driver without running a DBMS, Message broker, or Cinder service.
  • Using multiple simultaneous drivers on the same application.
  • Basic operations support:
    • Create volume
    • Delete volume
    • Extend volume
    • Clone volume
    • Create snapshot
    • Delete snapshot
    • Create volume from snapshot
    • Connect volume
    • Disconnect volume
    • Local attach
    • Local detach
    • Validate connector
    • Extra Specs for specific backend functionality.
    • Backend QoS
    • Multi-pool support
  • Metadata persistence plugins:
    • Stateless: Caller stores JSON serialization.
    • Database: Metadata is stored in a database: MySQL, PostgreSQL, SQLite...
    • Custom plugin: Caller provides module to store Metadata and cinderlib calls it when necessary.