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.
OpenDev Sysadmins ad2f19eef1 OpenDev Migration Patch 1 month ago
cinderlib Merge "Fix get_connector_properties" 1 month ago
devstack Add DevStack plugin 2 months ago
doc Merge "Fix get_connector_properties" 1 month ago
playbooks Add zuul jobs 2 months ago
releasenotes Format as a Cinder-related OpenStack project 3 months ago
tools Add DevStack plugin 2 months ago
.gitignore Add zuul jobs 2 months ago
.gitreview OpenDev Migration Patch 1 month ago
.stestr.conf Add zuul jobs 2 months ago
.zuul.yaml Fix cinderlib Python package 2 months ago
CONTRIBUTING.rst Format as a Cinder-related OpenStack project 3 months ago
DESCRIPTION.rst Fix cinderlib Python package 2 months ago
HACKING.rst Format as a Cinder-related OpenStack project 3 months ago
LICENSE Format as a Cinder-related OpenStack project 3 months ago
README.rst Fix cinderlib Python package 2 months ago
babel.cfg Format as a Cinder-related OpenStack project 3 months ago
lower-constraints.txt Format as a Cinder-related OpenStack project 3 months ago
requirements.txt Format as a Cinder-related OpenStack project 3 months ago
setup.cfg Add DevStack plugin 2 months ago
setup.py Format as a Cinder-related OpenStack project 3 months ago
test-requirements.txt Fix cinderlib Python package 2 months ago
tox.ini Replace openstack.org git:// URLs with https:// 1 month 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