DEPRECATED, Direct usage of Cinder Block Storage drivers without the services
Go to file
Gorka Eguileor 959b8e5105
Merge pull request #8 from bennyz/fix-typo
Fix typo
2018-08-29 12:11:09 +02:00
cinderlib Bump version: 0.2.2.dev0 → 0.2.2 2018-08-24 17:34:12 +02:00
docs Fix typo 2018-08-29 12:57:31 +03:00
hooks Fix docker automated build 2018-08-27 12:59:17 +02:00
tests Change Cinder requirements 2018-08-24 11:24:20 +02:00
.dockerignore Add Docker images 2018-07-02 19:09:58 +02:00
.gitignore Add functional testing documentation 2018-06-12 18:45:29 +02:00
AUTHORS.rst Initial commit 2017-11-03 16:45:13 +01:00
CONTRIBUTING.rst Fix example in CONTRIBUTING 2018-07-12 16:16:26 +03:00
Dockerfile Fix docker automated build 2018-08-27 12:59:17 +02:00
Dockerfile-latest Fix docker automated build 2018-08-27 12:59:17 +02:00
Dockerfile-release Hook based image build process 2018-08-24 16:48:13 +02:00
HISTORY.rst Bump version: 0.2.2.dev0 → 0.2.2 2018-08-24 17:34:12 +02:00
LICENSE Initial commit 2017-11-03 16:45:13 +01:00
MANIFEST.in Initial commit 2017-11-03 16:45:13 +01:00
Makefile Fix github README file 2018-06-14 20:47:24 +02:00
README docs: Markdown README with RST 2018-07-04 12:51:22 +02:00
README.rst docs: Update docks referring to Pike release 2018-08-24 17:03:54 +02:00
TODO.rst Change Cinder requirements 2018-08-24 11:24:20 +02:00
requirements_dev.txt Change Cinder requirements 2018-08-24 11:24:20 +02:00
requirements_docs.txt docs: Fix automatic doc build requirements 2018-07-04 12:51:22 +02:00
setup.cfg Bump version: 0.2.2.dev0 → 0.2.2 2018-08-24 17:34:12 +02:00
setup.py Bump version: 0.2.2.dev0 → 0.2.2 2018-08-24 17:34:12 +02:00
tox.ini Change Cinder requirements 2018-08-24 11:24:20 +02:00

README

# Cinder library

Cinder Library is a Python library that allows using storage drivers outside of
Cinder.

* Free software: Apache Software License 2.0
* Full Documentation: [https://cinderlib.readthedocs.io](https://cinderlib.readthedocs.io).

This library is currently in Alpha stage and is primarily intended as a proof
of concept at this stage.  While some drivers have been manually validated most
drivers have not, so there's a good chance that they could experience issues.

When using this library one should be aware that this is in no way close to the
robustness or feature richness that the Cinder project provides, for detailed
information on the current limitations please refer to the documentation.

Due to the limited access to Cinder backends and time constraints the list of
drivers that have been manually tested are (I'll try to test more):

- LVM with LIO
- Dell EMC XtremIO
- Dell EMC VMAX
- Kaminario K2
- Ceph/RBD
- NetApp SolidFire

If you try the library with another storage array I would appreciate a note on
the library version, Cinder release, and results of your testing.

## Features

* Use a Cinder driver without running a DBMS, Message broker, or Cinder
  service.
* Using multiple simultaneous drivers on the same program.
* 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