DEPRECATED, Direct usage of Cinder Block Storage drivers without the services
Go to file
Brian Rosmaita d3c48523cc Don't use deprecated config opt name in unit test
With cinder change Iccfbe62406b6, the 'iscsi_secondary_ip_addresses'
opt was deprecated in favor of 'target_secondary_ip_addresses'.  This
broke a cinderlib unit test that checked to see if a mocked logger
was not called (which it now was, to log a deprecation message).  Use
the current option name in the test so that the test continues to
test what it was designed to test (i.e., cinderlib config loading,
not oslo.config option deprecation).

Change-Id: Ia243368a9d68aca3a717fb2be1da99bceb271e56
2023-03-30 06:34:56 -04:00
cinderlib Don't use deprecated config opt name in unit test 2023-03-30 06:34:56 -04:00
devstack OpenDev Migration Patch 2019-04-26 16:28:35 +00:00
doc Merge "Remove unnecessary #egg= URL fragment" 2023-01-21 01:23:16 +00:00
playbooks Don't use yum to install ceph 2022-07-18 11:31:48 -04:00
releasenotes Update master for stable/zed 2022-12-16 08:50:54 +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 Fix tox.ini 2023-01-19 17:29:55 +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
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 Open cinderlib for 2023.1 (Antelope) development 2022-12-16 10:06:08 -05:00
setup.cfg Open cinderlib for 2023.1 (Antelope) development 2022-12-16 10:06:08 -05: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 Merge "Remove unnecessary #egg= URL fragment" 2023-01-21 01:23:16 +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