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.
 
 
 
OpenStack Release Bot 40106f9c17 Update .gitreview for stable/ussuri 2 months ago
cinderlib RBD: Fix error on disconnect 2 months ago
devstack OpenDev Migration Patch 1 year ago
doc Support references in driver configuration 2 months ago
playbooks Fix rbd attach on python3 5 months ago
releasenotes RBD: Fix error on disconnect 2 months ago
roles/run-cinderlib-tests Fix: add a default value for cinderlib_pool_name 9 months ago
tools Add DevStack plugin 1 year ago
.gitignore Add zuul jobs 1 year ago
.gitreview Update .gitreview for stable/ussuri 2 months ago
.stestr.conf Add zuul jobs 1 year ago
.zuul.yaml Fix and improve cross-project functional testing 2 months ago
CONTRIBUTING.rst Ussuri contrib docs community goal 6 months ago
DESCRIPTION.rst Fix cinderlib Python package 1 year ago
HACKING.rst Format as a Cinder-related OpenStack project 1 year ago
LICENSE Format as a Cinder-related OpenStack project 1 year ago
README.rst Fix cinderlib Python package 1 year ago
babel.cfg Format as a Cinder-related OpenStack project 1 year ago
bindep.txt Use Python 3 by default and drop Python 2 8 months ago
lower-constraints.txt Switch to newer openstackdocstheme and reno versions 4 months ago
requirements.txt Pin cinder version 5 months ago
setup.cfg Cleanup py27 support 5 months ago
setup.py Cleanup py27 support 5 months ago
test-requirements.txt Fix hacking min version to 3.0.1 4 months ago
tox.ini Fix and improve cross-project functional testing 2 months ago

README.rst

Cinder Library

image

image

image

Introduction

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.

Features

  • 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.

Demo