openstack/openstack-manuals
Code Issues Proposed changes

Merge "[config-ref] RST markup improvements for block-storage drivers"

Browse Source
This commit is contained in:
Jenkins 2015-12-14 06:42:35 +00:00 committed by Gerrit Code Review
commit 985e71a1fa
10 changed files with 123 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/config-ref-rst/source/block-storage/drivers/nfs-volume-driver.rst
View File

@ -25,7 +25,7 @@ Enable the NFS driver and related options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To use Cinder with the NFS driver, first set the ``volume_driver``
in ``cinder.conf``:
in the ``cinder.conf`` configuration file:
.. code-block:: ini
@ -66,7 +66,7 @@ How to use the NFS driver
#. Add your list of NFS servers to the file you specified with the
``nfs_shares_config`` option. For example, if the value of this option
was set to ``/etc/cinder/shares.txt``, then:
was set to ``/etc/cinder/shares.txt`` file, then:
.. code-block:: console
@ -78,13 +78,13 @@ How to use the NFS driver
Comments are allowed in this file. They begin with a ``#``.
#. Configure the ``nfs_mount_point_base`` option. This is a directory
where ``cinder-volume`` mounts all NFS shares stored in ``shares.txt``.
For this example, ``/var/lib/cinder/nfs`` is used. You can, of course,
use the default value of ``$state_path/mnt``.
where ``cinder-volume`` mounts all NFS shares stored in the ``shares.txt``
file. For this example, ``/var/lib/cinder/nfs`` is used. You can,
of course, use the default value of ``$state_path/mnt``.
#. Start the ``cinder-volume`` service. ``/var/lib/cinder/nfs`` should
now contain a directory for each NFS share specified in ``shares.txt``.
The name of each directory is a hashed name:
now contain a directory for each NFS share specified in the ``shares.txt``
file. The name of each directory is a hashed name:
.. code-block:: console

18
doc/config-ref-rst/source/block-storage/drivers/nimble-volume-driver.rst
View File

@ -12,13 +12,21 @@ Supported operations
~~~~~~~~~~~~~~~~~~~~
* Create, delete, clone, attach, and detach volumes
* Create and delete volume snapshots
* Create a volume from a snapshot
* Copy an image to a volume
* Copy a volume to an image
* Extend a volume
* Get volume statistics
* Manage and unmanage a volume
* Enable encryption and default performance policy for a volume-type
extra-specs
@ -43,7 +51,7 @@ within the ``[default]`` section as follows.
san_password = NIMBLE_PASSWORD
volume_driver = cinder.volume.drivers.nimble.NimbleISCSIDriver
In case of multi back-end configuration, for example, configuration
In case of multiple back-end configuration, for example, configuration
which supports multiple Nimble Storage arrays or a single Nimble Storage
array with arrays from other vendors, use the following parameters.
@ -59,7 +67,7 @@ array with arrays from other vendors, use the following parameters.
volume_driver = cinder.volume.drivers.nimble.NimbleISCSIDriver
volume_backend_name = NIMBLE_BACKEND_NAME
In case of multi back-end configuration, Nimble Storage volume type
In case of multiple back-end configuration, Nimble Storage volume type
is created and associated with a back-end name as follows.
.. note::
@ -77,14 +85,14 @@ NIMBLE_MGMT_IP
Management IP address of Nimble Storage array/group.
NIMBLE_USER
Nimble Storage account login with minimum "power user" (admin) privilege
Nimble Storage account login with minimum ``power user`` (admin) privilege
if RBAC is used.
NIMBLE_PASSWORD
Password of the admin account for nimble array.
NIMBLE_BACKEND_NAME
A volume back-end name which is specified in ``cinder.conf``.
A volume back-end name which is specified in the ``cinder.conf`` file.
This is also used while assigning a back-end name to the Nimble volume type.
NIMBLE_VOLUME_TYPE
@ -94,7 +102,7 @@ NIMBLE_VOLUME_TYPE
.. note::
Restart the ``cinder-api``, ``cinder-scheduler``, and ``cinder-volume``
services after updating the ``cinder.conf``.
services after updating the ``cinder.conf`` file.
Nimble driver extra spec options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

13
doc/config-ref-rst/source/block-storage/drivers/prophetstor-dpl-driver.rst
View File

@ -16,11 +16,17 @@ Supported operations
~~~~~~~~~~~~~~~~~~~~
* Create, delete, attach, and detach volumes.
* Create, list, and delete volume snapshots.
* Create a volume from a snapshot.
* Copy an image to a volume.
* Copy a volume to an image.
* Clone a volume.
* Extend a volume.
Enable the Fibre Channel or iSCSI drivers
@ -29,7 +35,8 @@ Enable the Fibre Channel or iSCSI drivers
The ``DPLFCDriver`` and ``DPLISCSIDriver`` are installed with the OpenStack
software.
#. Query storage pool id for configure ``dpl_pool`` of the ``cinder.conf``.
#. Query storage pool id to configure ``dpl_pool`` of the ``cinder.conf``
file.
a. Log on to the storage system with administrator access.
@ -44,8 +51,8 @@ software.
$ flvcli show pool list
- d5bd40b58ea84e9da09dcf25a01fdc07 : default_pool_dc07
c. Use ``d5bd40b58ea84e9da09dcf25a01fdc07`` to config the ``dpl_pool`` of
``/etc/cinder/cinder.conf``.
c. Use ``d5bd40b58ea84e9da09dcf25a01fdc07`` to configure the ``dpl_pool`` of
``/etc/cinder/cinder.conf`` file.
.. note::

4
doc/config-ref-rst/source/block-storage/drivers/quobyte-driver.rst
View File

@ -7,11 +7,11 @@ Storage service volumes on a Quobyte storage back end. Block Storage service
back ends are mapped to Quobyte volumes and individual Block Storage service
volumes are stored as files on a Quobyte volume. Selection of the appropriate
Quobyte volume is done by the aforementioned back end configuration that
specifies the Quobyte volume explicitely.
specifies the Quobyte volume explicitly.
.. note::
Note the dual use of the term 'volume' in the context of Block Storage
Note the dual use of the term ``volume`` in the context of Block Storage
service volumes and in the context of Quobyte volumes.
For more information see `the Quobyte support webpage

2
doc/config-ref-rst/source/block-storage/drivers/sheepdog-driver.rst
View File

@ -36,7 +36,7 @@ Sheepdog driver supports these operations:
Configuration
~~~~~~~~~~~~~
Set the following option in ``cinder.conf``:
Set the following option in the ``cinder.conf`` file:
.. code-block:: ini

2
doc/config-ref-rst/source/block-storage/drivers/smbfs-volume-driver.rst
View File

@ -3,7 +3,7 @@ SambaFS driver
==============
There is a volume back-end for Samba filesystems. Set the following in
your ``cinder.conf``, and use the following options to configure it.
your ``cinder.conf`` file, and use the following options to configure it.
.. note::

8
doc/config-ref-rst/source/block-storage/drivers/solidfire-volume-driver.rst
View File

@ -26,10 +26,10 @@ To configure the use of a SolidFire cluster with Block Storage, modify your
account prefixed with ``$cinder-volume-service-hostname-$tenant-id`` on the
SolidFire cluster for each tenant. Unfortunately, this account formation
resulted in issues for High Availability (HA) installations and
installations where the cinder-volume service can move to a new node. The
current default implementation does not experience this issue as no prefix
is used. For installations created on a prior release, the OLD default
behavior can be configured by using the keyword "hostname" in
installations where the ``cinder-volume`` service can move to a new node.
The current default implementation does not experience this issue as no
prefix is used. For installations created on a prior release, the OLD
default behavior can be configured by using the keyword ``hostname`` in
sf_account_prefix.
.. include:: ../../tables/cinder-solidfire.rst

24
doc/config-ref-rst/source/block-storage/drivers/violin-v6000-driver.rst
View File

@ -2,7 +2,7 @@
Violin Memory 6000 series AFA volume driver
===========================================
The OpenStack V6000 driver package from Violin Memory adds block storage
The OpenStack V6000 driver package from Violin Memory adds Block Storage
service support for Violin 6000 Series All Flash Arrays.
The driver package release can be used with any OpenStack Liberty
@ -35,7 +35,7 @@ To use the Violin driver, the following are required:
- The vmemclient library: This is the Violin Array Communications library to
the Flash Storage Platform through a REST-like interface. The client can be
installed using the python 'pip' installer tool. Further information on
installed using the python **pip** installer tool. Further information on
vmemclient can be found here: `PyPI
<https://pypi.python.org/pypi/vmemclient/>`__.
@ -68,9 +68,9 @@ Supported operations
Array configuration
~~~~~~~~~~~~~~~~~~~
After installing and configuring your V6000 array per the installation guide
provided with your array, please follow these additional steps to prepare your
array for use with OpenStack.
After installing and configuring your V6000 array as per the installation
guide provided with your array, please follow these additional steps to
prepare your array for use with OpenStack.
#. Ensure your client initiator interfaces are all zoned or VLAN'd so that they
can communicate with ALL of the target ports on the array. See your array
@ -92,7 +92,7 @@ array for use with OpenStack.
Driver configuration
~~~~~~~~~~~~~~~~~~~~
Once the array is configured, it is simply a matter of editing the cinder
Once the array is configured, it is simply a matter of editing the ``cinder``
configuration file to add or modify the parameters. Contents will differ
depending on whether you are setting up a fibre channel or iSCSI environment.
@ -140,7 +140,7 @@ Description of configuration value placeholders:
VMEM_MGMT_IP
Cluster master IP address or hostname of the Violin 6000 Array. Can be an
IP address or hostname.
IP address or host name.
VMEM_USER_NAME
Log-in user name for the Violin 6000 Memory Gateways. This user must have
@ -150,14 +150,14 @@ VMEM_PASSWORD
Log-in user's password.
CINDER_INITIATOR_IP
The IP address assigned to the primary iSCSI interface on the cinder-volume
client. This IP address must be able to communicate with all target ports
that are active on the array.
The IP address assigned to the primary iSCSI interface on the
``cinder-volume`` client. This IP address must be able to communicate
with all target ports that are active on the array.
VMEM_MGA_IP
The IP or hostname of the gateway node marked ``A``, commonly referred to
The IP or host name of the gateway node marked ``A``, commonly referred to
as ``MG-A``.
VMEM_MGB_IP
The IP or hostname of the gateway node marked ``B``, commonly referred to
The IP or host name of the gateway node marked ``B``, commonly referred to
as ``MG-B``.