From 836182bb0173bb8559656378ed7bcd1812adf8e8 Mon Sep 17 00:00:00 2001 From: Gorka Eguileor Date: Fri, 24 Aug 2018 17:03:54 +0200 Subject: [PATCH] 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. --- README.rst | 12 ++++++++++-- docs/installation.rst | 10 +++++----- docs/introduction.rst | 2 -- docs/topics/backends.rst | 2 +- docs/topics/volumes.rst | 2 +- docs/validated_backends.rst | 8 ++++---- docs/validating_backends.rst | 4 ++-- 7 files changed, 23 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index eef2660..1c6b4b0 100644 --- a/README.rst +++ b/README.rst @@ -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 diff --git a/docs/installation.rst b/docs/installation.rst index 4230c24..9868604 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -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 _______ diff --git a/docs/introduction.rst b/docs/introduction.rst index 1a8f227..54edd96 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -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. diff --git a/docs/topics/backends.rst b/docs/topics/backends.rst index 1849a85..cf632ab 100644 --- a/docs/topics/backends.rst +++ b/docs/topics/backends.rst @@ -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 -`_ +`_ within the Developer's Documentation. Gathering stats is a costly operation for many storage backends, so by default diff --git a/docs/topics/volumes.rst b/docs/topics/volumes.rst index dc1d985..6a9f787 100644 --- a/docs/topics/volumes.rst +++ b/docs/topics/volumes.rst @@ -87,7 +87,7 @@ information. Available fields with their types can be found in `Cinder's Volume OVO definition -`_, +`_, 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* diff --git a/docs/validated_backends.rst b/docs/validated_backends.rst index 5438d9b..b820e6e 100644 --- a/docs/validated_backends.rst +++ b/docs/validated_backends.rst @@ -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 diff --git a/docs/validating_backends.rst b/docs/validating_backends.rst index 290e637..c1f12dd 100644 --- a/docs/validating_backends.rst +++ b/docs/validating_backends.rst @@ -45,7 +45,7 @@ be comprised of three steps: To see the Python dependencies for each backend we can check the `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`_