openstack/cinderlib
Code Issues Proposed changes
DEPRECATED, Direct usage of Cinder Block Storage drivers without the services
340 Commits 8 Branches 39 Tags 2.9 MiB
94bd3fffc0
Go to file
Takashi Kajinami 94bd3fffc0 Remove six 
This library no longer supports Python 2, thus usage of six can be
removed. This also removes workarounds for Python 2.

Change-Id: Ia3f56a2a984cc1d82b717041583a727d9cb5642c
2022-12-14 05:40:11 +00:00
cinderlib Remove six 2022-12-14 05:40:11 +00:00
devstack OpenDev Migration Patch 2019-04-26 16:28:35 +00:00
doc Merge "[docs] add zuul.yaml maintenance tasks" 2022-07-22 13:05:15 +00:00
playbooks Don't use yum to install ceph 2022-07-18 11:31:48 -04:00
releasenotes Update master for stable/yoga 2022-06-27 08:52:36 +00:00
roles/run-cinderlib-tests Fix privsep issues inside virtual env 2022-06-24 15:26:48 +02:00
tools Add local upper constraints support 2022-06-25 06:25:13 +00:00
.gitignore Add local upper constraints support 2022-06-25 06:25:13 +00: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 Open cinderlib for zed development 2022-12-14 04:26:23 +00: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
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
requirements.txt Don't limit use of importlib-metadata to Python < 3.8 2022-12-14 04:44:10 +00:00
setup.cfg Open cinderlib for zed development 2022-12-14 04:26:23 +00: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 Open cinderlib for zed development 2022-12-14 04:26:23 +00: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