kolla-ansible/doc/source/reference/storage/cinder-guide-pure.rst
Simon Dodsley 716899ffba Add NVMe-RoCE Cinder driver support for Pure Storage
From OpenStack Zed the Pure Storage Cinder driver supports
NVMe-RoCE as a dataplane protocol. This patch adds support
for this new driver type.

Also amend a couple of documentation formatting typos.

Change-Id: Ic1eed7d19e9b583e22419625c92ac3507ea4614d
2022-11-07 12:23:45 -05:00

64 lines
2.1 KiB
ReStructuredText

.. cinder-guide-pure:
=====================================
Pure Storage FlashArray for OpenStack
=====================================
Pure Storage FlashArray Cinder Driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To use the ``Pure Storage FlashArray iSCSI`` Cinder backend, enable and
configure the ``FlashArray iSCSI`` Cinder driver in ``/etc/kolla/globals.yml``.
.. code-block:: yaml
enable_cinder_backend_pure_iscsi: "yes"
.. end
To use the ``Pure Storage FlashArray FC`` Cinder backend, enable and
configure the ``FlashArray FC`` Cinder driver in ``/etc/kolla/globals.yml``.
.. code-block:: yaml
enable_cinder_backend_pure_fc: "yes"
.. end
To use the ``Pure Storage FlashArray NVMe-RoCE`` Cinder backend, enable and
configure the ``FlashArray NVMe-RoCE`` Cinder driver in
``/etc/kolla/globals.yml``.
.. code-block:: yaml
enable_cinder_backend_pure_roce: "yes"
.. end
.. note::
The NVMe-RoCE driver is only supported from OpenStack Zed and later.
It is important to note that you cannot mix iSCSI and FC Pure Storage
FlashArray drivers in the same OpenStack cluster.
Also set the values for the following parameters in ``/etc/kolla/globals.yml``:
- ``pure_api_token``
- ``pure_san_ip``
For details on how to use these parameters, refer to the
`Pure Storage Cinder Reference Guide <https://docs.openstack.org/cinder/latest/configuration/block-storage/drivers/pure-storage-driver.html>`_.
There are numerous other parameters that can be set for this driver and
these are detailed in the above link.
If you wish to use any of these parameters then refer to the
`Service Configuration <https://docs.openstack.org/kolla-ansible/latest/admin/advanced-configuration.html#openstack-service-configuration-in-kolla>`_
documentation for instructions using the INI update strategy.
The use of this backend requires that the ``purestorage`` SDK package is
installed in the ``cinder-volume`` container. To do this follow the steps
outlined in the `kolla image building guide <https://docs.openstack.org/kolla/latest/admin/image-building.html>`_
particularly the ``Package Customisation`` and ``Custom Repos`` sections.