DEPRECATED, Direct usage of Cinder Block Storage drivers without the services
Go to file
Brian Rosmaita dcdc437f11 Update deprecated zuul syntax
Replace declaring shared queues at the project-pipeline level
with declaring them at the project level so that cinderlib CI
won't break at opendev's next Zuul major update.

Details:
https://lists.zuul-ci.org/pipermail/zuul-discuss/2022-May/001801.html

Change-Id: Ie0b14c0c64d1b233a37aeae61618efdc2d6e262e
(cherry picked from commit 9c09e93937)
(cherry picked from commit 4f8a6a5e62)
(cherry picked from commit 9f83b47cdc)
(cherry picked from commit 03441bf1ba)
(cherry picked from commit dcf2a4b5e5)
(cherry picked from commit 20ad4931f6)
2022-07-22 16:20:16 +00:00
cinderlib Fix configuration options 2019-12-19 14:29:58 +01:00
devstack OpenDev Migration Patch 2019-04-26 16:28:35 +00:00
doc Fix configuration options 2019-12-19 14:29:58 +01:00
playbooks Merge "Fake unused packages" 2019-10-24 13:46:07 +00:00
releasenotes Merge "Add missing release notes" 2019-12-10 17:42:43 +00:00
roles/run-cinderlib-tests zuul: change the cinderlib test runner into a role 2019-07-31 16:51:37 +02:00
tools Add DevStack plugin 2019-03-20 18:34:16 +01:00
.gitignore Add zuul jobs 2019-02-26 16:21:34 +01:00
.gitreview Update .gitreview for stable/train 2019-12-12 10:08:07 +00:00
.stestr.conf Add zuul jobs 2019-02-26 16:21:34 +01:00
.zuul.yaml Update deprecated zuul syntax 2022-07-22 16:20:16 +00:00
CONTRIBUTING.rst OpenDev Migration Patch 2019-04-26 16:28:35 +00: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 Add pdf build support 2019-09-04 13:34:47 +00:00
lower-constraints.txt Bump openstackdocstheme to 1.20.0 2019-07-16 16:57:55 +08:00
requirements.txt Format as a Cinder-related OpenStack project 2019-02-19 16:28:03 +01:00
setup.cfg Add Python 3 Train unit tests 2019-07-08 12:09:19 -04:00
setup.py Format as a Cinder-related OpenStack project 2019-02-19 16:28:03 +01:00
test-requirements.txt Fix cinderlib Python package 2019-03-15 13:19:12 +01:00
tox.ini [train-only] Update train CI 2022-07-22 12:08:16 -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