da2ee0ad0c
From the release of 2024.2 (Dalmatian) the SDK required by the Pure Cinder driver changes from ``purestorage`` to ``py-pure-client``. This patch updates the Pure documentation to reflect this change. Change-Id: I7092f3b7ca00019822b8d8f6f425fbb13db9d8ae
83 lines
2.6 KiB
ReStructuredText
83 lines
2.6 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.
|
|
|
|
To use the ``Pure Storage FlashArray NVMe-TCP`` Cinder backend, enable and
|
|
configure the ``FlashArray NVMe-TCP`` Cinder driver in
|
|
``/etc/kolla/globals.yml``.
|
|
|
|
.. code-block:: yaml
|
|
|
|
enable_cinder_backend_pure_nvme_tcp: "yes"
|
|
|
|
.. end
|
|
|
|
.. note::
|
|
|
|
The NVMe-TCP driver is only supported from OpenStack 2023.2 (Bobcat) 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 an additional Python SDK package is
|
|
installed in the ``cinder-volume`` container.
|
|
|
|
Prior to 2024.2 (Dalmatian) the ``purestorage`` SDK is required. From
|
|
2024.2 (Dalmatian) the SDK to install is called ``py-pure-client``.
|
|
|
|
To install the appropriate SDK 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.
|