openstack
/
cinderlib
Code Issues Proposed changes

docs: Update docks referring to Pike release 

Now that we support other Cinder releases besides Pike we need to update
the documentation a little bit to reflect this.
This commit is contained in:
Gorka Eguileor 2018-08-24 17:03:54 +02:00
parent a0b98c9892
commit 836182bb01
7 changed files with 23 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.rst
View File

@ -101,13 +101,21 @@ You can either use a container:
.. code-block:: shell
$ docker run --name=cinderlib --privileged --net=host -v /etc/iscsi:/etc/iscsi -v /dev:/dev -it akrog/cinderlib python
$ docker run --name=cinderlib --privileged --net=host \
-v /etc/iscsi:/etc/iscsi \
-v /dev:/dev \
-v /etc/lvm:/etc/lvm \
-v /var/lock/lvm:/var/lock/lvm \
-v /lib/modules:/lib/modules \
-v /run/udev:/run/udev \
-v /etc/localtime:/etc/localtime \
-it akrog/cinderlib python
Or install things on baremetal/VM:
.. code-block:: shell
$ sudo yum install -y centos-release-openstack-pike
$ sudo yum install -y centos-release-openstack-queens
$ test -f /etc/yum/vars/contentdir || echo centos >/etc/yum/vars/contentdir
$ sudo yum install -y openstack-cinder targetcli python-pip
$ sudo pip install cinderlib

10
docs/installation.rst
View File

@ -27,8 +27,8 @@ the RPM to set up the OpenStack repository:
.. code-block:: console
# yum install -y centos-release-openstack-pike
# yum-config-manager --enable openstack-pike
# yum install -y centos-release-openstack-queens
# yum-config-manager --enable openstack-queens
# yum update -y
# yum install -y openstack-cinder
@ -37,8 +37,8 @@ to set up the OpenStack repository:
.. code-block:: console
# yum install -y https://repos.fedorapeople.org/repos/openstack/openstack-pike/rdo-release-pike-1.noarch.rpm
# yum-config-manager --enable openstack-pike
# yum install -y https://repos.fedorapeople.org/repos/openstack/openstack-queens/rdo-release-queens-1.noarch.rpm
# yum-config-manager --enable openstack-queens
# sudo yum update -y
# yum install -y openstack-cinder
@ -99,7 +99,7 @@ we can install the drivers from source:
$ virtualenv cinder
$ source cinder/bin/activate
$ pip install git+https://github.com/openstack/cinder.git@stable/pike
$ pip install git+https://github.com/openstack/cinder.git
Library
_______

2
docs/introduction.rst
View File

@ -89,8 +89,6 @@ more noticeable limitations one should be aware of are:
- Only a subset of Cinder available operations are supported by the library.
- The only Cinder release that has been tested with the library has been Pike.
- Access to a small number of storage arrays has limited the number of drivers
that have been verified to work with cinderlib.

2
docs/topics/backends.rst
View File

@ -152,7 +152,7 @@ Some of the keys provided in the stats dictionary include:
- `vendor_name volume_backend_name`
Additional information can be found in the `Volume Stats section
<https://docs.openstack.org/cinder/pike/contributor/drivers.html#volume-stats>`_
<https://docs.openstack.org/cinder/queens/contributor/drivers.html#volume-stats>`_
within the Developer's Documentation.
Gathering stats is a costly operation for many storage backends, so by default

2
docs/topics/volumes.rst
View File

@ -87,7 +87,7 @@ information.
Available fields with their types can be found in `Cinder's Volume OVO
definition
<https://github.com/openstack/cinder/blob/stable/pike/cinder/objects/volume.py#L69-L126>`_,
<https://github.com/openstack/cinder/blob/stable/queens/cinder/objects/volume.py#L71-L131>`_,
but most of them are only relevant within the full *Cinder* service.
We can access these fields as if they were part of the *cinderlib* *Volume*

8
docs/validated_backends.rst
View File

@ -27,7 +27,7 @@ LVM
---
- *Cinderlib version*: v0.1.0, v0.2.0
- *Cinder release*: *Pike*
- *Cinder release*: *Pike*, *Queens*, *Rocky*
- *Storage*: LVM with LIO
- *Connection type*: iSCSI
- *Requirements*: None
@ -91,7 +91,7 @@ XtremIO
-------
- *Cinderlib version*: v0.1.0, v0.2.0
- *Cinder release*: *Pike*
- *Cinder release*: *Pike*, *Queens*, *Rocky*
- *Storage*: Dell EMC XtremIO
- *Versions*: v4.0.15-20_hotfix_3
- *Connection type*: iSCSI, FC
@ -133,7 +133,7 @@ Kaminario
---------
- *Cinderlib version*: v0.1.0, v0.2.0
- *Cinder release*: *Pike*
- *Cinder release*: *Pike*, *Queens*, *Rocky*
- *Storage*: Kaminario K2
- *Versions*: VisionOS v6.0.72.10
- *Connection type*: iSCSI
@ -190,7 +190,7 @@ VMAX
----
- *Cinderlib version*: v0.1.0
- *Cinder release*: Pike, Queens, Rocky
- *Cinder release*: *Pike*, *Queens*, *Rocky*
- *Storage*: Dell EMC VMAX
- *Versions*: Unknown
- *Connection type*: iSCSI

4
docs/validating_backends.rst
View File

@ -45,7 +45,7 @@ be comprised of three steps:
To see the Python dependencies for each backend we can check the
`driver-requirements.txt
<https://raw.githubusercontent.com/openstack/cinder/stable/pike/driver-requirements.txt>`_
<https://raw.githubusercontent.com/openstack/cinder/stable/queens/driver-requirements.txt>`_
file from the Cinder project, or in *cinderlib*'s `setup.py` file listed in
the `extras` dictionary.
@ -218,7 +218,7 @@ was tested please include the following information in your report:
configuration files...
- Contents of the YAML file with usernames, passwords, and IPs appropriately
masked.
- *Cinder* release: If a release other than *Pike* has been used.
- *Cinder* releases: What cinder releases have been tested.
- Additional notes: Limitations or anything worth mentioning.
To report the results of the tests please create an `issue on the project`_