openstack/python-brick-cinderclient-ext
Code Issues Proposed changes

Initial documenation

Browse Source
This commit is contained in:
Ivan Kolodyazhny 2015-12-16 21:31:27 +02:00
parent 12e52693c4
commit 447c0bc0b3
2 changed files with 34 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.rst
View File

@ -1,19 +1,31 @@
===============================
brick-python-cinderclient-ext
===============================
=============================
python-brick-cinderclient-ext
=============================
OpenStack Boilerplate contains all the boilerplate you need to create an OpenStack package.
Please feel here a long description which must be at least 3 lines wrapped on
80 cols, so that distribution package maintainers can use it in their packages.
Note that this is a hard requirement.
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/brick-python-cinderclient-ext
* Source: http://git.openstack.org/cgit/openstack/brick-python-cinderclient-ext
* Bugs: http://bugs.launchpad.net/cinder
OpenStack Cinder Brick client for local volume attachement
Features
--------
* TODO
* Get volume connector information
Dependencies
------------
Depends on Cinder driver's protocol, python-brickclient could require following
packages::
* open-iscsi - for volume attachment via iSCSI
* ceph-common - for volume attachment via iSCSI (Ceph)
* nfs-common - for volume attachment using NFS protocol
For any other imformation, refer to the parent projects, Cinder and
python-cinderclient:::
* https://github.com/openstack/cinder
* https://github.com/openstack/python-cinderclient
* License: Apache License, Version 2.0
* Documentation: http://docs.openstack.org/developer/python-brick-cinderclient-ext
* Source: http://git.openstack.org/cgit/openstack/python-brick-cinderclient-ext
* Bugs: http://bugs.launchpad.net/python-cinderclient

12
doc/source/usage.rst
View File

@ -1,7 +1,11 @@
========
=====
Usage
========
=====
To use brick-python-cinderclient-ext in a project::
To use python-brick-cinderclient-ext in a project::
import brick-python-cinderclient-ext
import brick_cinderclient_ext
from cinderclient import client
c = client.Client(2, extensions=[brick_cinderclient_ext])
print(c.brick_client_ext.get_connector())