DEPRECATED, Direct usage of Cinder Block Storage drivers without the services
Go to file
Brian Rosmaita 82b8c25c97 Continue yoga development
As a cycle-with-intermediary release with trailing deliverable type,
cinderlib's master remains the yoga development branch until early in
the zed cycle when the cinderlib yoga release is made.  So update
tox.ini to test against cinder and os-brick stable/yoga instead of
their master branches, and restrict cinder and os-brick in
requirements.txt to yoga versions.

Change-Id: I8da1ddc38607eca378a503a961bf55a03566c5bc
2022-03-30 11:32:37 -04:00
cinderlib Fix datetime serialization 2021-06-29 17:48:07 +02:00
devstack OpenDev Migration Patch 2019-04-26 16:28:35 +00:00
doc Update contributor docs 2021-06-30 09:45:28 -04:00
playbooks Fix cinderlib-lvm-functional 2020-08-07 14:46:23 +02:00
releasenotes Update master for stable/xena 2021-12-13 16:11:12 +00:00
roles/run-cinderlib-tests Fix: add a default value for cinderlib_pool_name 2019-12-17 19:57:19 +01:00
tools Add privsep support 2021-06-18 15:12:24 +02:00
.gitignore Add zuul jobs 2019-02-26 16:21:34 +01:00
.gitreview OpenDev Migration Patch 2019-04-26 16:28:35 +00:00
.stestr.conf Add zuul jobs 2019-02-26 16:21:34 +01:00
.zuul.yaml Migrate jobs from CentOS 8 to CentOS 8 Stream 2022-01-12 09:50:28 +09:00
CONTRIBUTING.rst Ussuri contrib docs community goal 2020-03-05 10:00:21 -05:00
DESCRIPTION.rst Fix cinderlib Python package 2019-03-15 13:19:12 +01:00
HACKING.rst Format as a Cinder-related OpenStack project 2019-02-19 16:28:03 +01:00
LICENSE Format as a Cinder-related OpenStack project 2019-02-19 16:28:03 +01:00
README.rst Fix cinderlib Python package 2019-03-15 13:19:12 +01:00
babel.cfg Format as a Cinder-related OpenStack project 2019-02-19 16:28:03 +01:00
bindep.txt Use Python 3 by default and drop Python 2 2020-01-10 15:03:23 +01:00
requirements.txt Continue yoga development 2022-03-30 11:32:37 -04:00
setup.cfg setup.cfg: Replace dashes by underscores 2022-02-06 01:40:06 +09:00
setup.py Cleanup py27 support 2020-04-04 17:29:41 +02:00
test-requirements.txt Move cinderlib to new hacking 4.0.0 2021-02-23 16:25:51 +00:00
tox.ini Continue yoga development 2022-03-30 11:32:37 -04:00

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