openstack/cinder
Code Issues Proposed changes

Merge "Updating the Lightbits Cinder driver documentation regarding renaming."

Browse Source
This commit is contained in:
Zuul 2025-02-24 20:54:37 +00:00 committed by Gerrit Code Review
commit 2900fe21ec
2 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
doc/source/configuration/block-storage/drivers/lightbits-lightos-driver.rst
View File

@ -1,11 +1,11 @@
=============================== =======================
Lightbits LightOS Cinder Driver Lightbits Cinder Driver
=============================== =======================
The Lightbits(TM) LightOS(R) OpenStack driver enables OpenStack The Lightbits(TM) OpenStack driver enables OpenStack
clusters to use LightOS clustered storage servers. This documentation clusters to use Lightbits clustered storage servers. This documentation
explains how to configure Cinder for use with the Lightbits LightOS explains how to configure Cinder for use with the Lightbits storage
storage backend system. backend system.
Supported operations Supported operations
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
@ -28,24 +28,25 @@ Supported operations
- Active active deployment support - Active active deployment support
- Volume retype (host assisted) - Volume retype (host assisted)
LightOS OpenStack Driver Components Lightbits OpenStack Driver Components
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Lightbits OpenStack driver has three components:
The LightOS OpenStack driver has three components:
- Cinder driver - Cinder driver
- Nova libvirt volume driver - Nova libvirt volume driver
- os_brick initiator connector - os_brick initiator connector
In addition, it requires the LightOS ``discovery-client``, provided In addition, it requires the Lightbits ``discovery-client``, provided
with LightOS. The os_brick connector uses the LightOS with product. The os_brick connector uses the Lightbits
``discovery-client`` to communicate with LightOS NVMe/TCP discovery ``discovery-client`` to communicate with Lightbits NVMe/TCP discovery
services. services.
The Cinder Driver The Cinder Driver
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
The Cinder driver integrates with Cinder and performs REST operations The Cinder driver integrates with Cinder and performs REST operations
against the LightOS cluster. To enable the driver, add the following against the Lightbits storage cluster. To enable the driver, add the following
to Cinder's configuration file to Cinder's configuration file
.. code-block:: ini .. code-block:: ini
@ -66,13 +67,13 @@ and
lightos_default_compression_enabled = False lightos_default_compression_enabled = False
lightos_api_service_timeout=30 lightos_api_service_timeout=30
- ``TARGET_ACCESS_IPS`` are the LightOS cluster nodes access - ``TARGET_ACCESS_IPS`` are the Lightbits cluster nodes access
IPs. Multiple nodes should be separated by commas. For example: IPs. Multiple nodes should be separated by commas. For example:
``lightos_api_address = ``lightos_api_address =
192.168.67.78,192.168.34.56,192.168.12.17``. These IPs are where the 192.168.67.78,192.168.34.56,192.168.12.17``. These IPs are where the
driver looks for the LightOS clusters REST API servers. driver looks for the Lightbits clusters REST API servers.
- ``LIGHTOS_JWT`` is the JWT (JSON Web Token) that is located at the - ``LIGHTOS_JWT`` is the JWT (JSON Web Token) that is located at the
LightOS installation controller. You can find the jwt at Lightbits installation controller. You can find the jwt at
``~/lightos-default-admin-jwt``. ``~/lightos-default-admin-jwt``.
- The default number of replicas for volumes is 3, and valid values - The default number of replicas for volumes is 3, and valid values
for ``lightos_default_num_replicas`` are 1, 2, or 3. for ``lightos_default_num_replicas`` are 1, 2, or 3.
@ -114,14 +115,14 @@ Then create a new volume with one of these volume types:
NVNe/TCP and Asymmetric Namespace Access (ANA) NVNe/TCP and Asymmetric Namespace Access (ANA)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The LightOS clusters expose their volumes using NVMe/TCP Asynchronous The Lightbits clusters expose their volumes using NVMe/TCP Asynchronous
Namespace Access (ANA). ANA is a relatively new feature in the Namespace Access (ANA). ANA is a relatively new feature in the
NVMe/TCP stack in Linux but it is fully supported in Ubuntu NVMe/TCP stack in Linux but it is fully supported in Ubuntu
20.04. Each compute host in the OpenStack cluster needs to be 20.04. Each compute host in the OpenStack cluster needs to be
ANA-capable to provide OpenStack VMs with LightOS volumes over ANA-capable to provide OpenStack VMs with Lightbits volumes over
NVMe/TCP. For more information on how to set up the compute nodes to NVMe/TCP. For more information on how to set up the compute nodes to
use ANA, see the CentOS Linux Cluster Client Software Installation use ANA, see the CentOS Linux Cluster Client Software Installation
section of the Lightbits(TM) LightOS(R) Cluster Installation and section of the Lightbits(TM) Cluster Installation and
Initial Configuration Guide. Initial Configuration Guide.
Note Note
@ -137,10 +138,10 @@ Driver options
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
The following table contains the configuration options supported by the The following table contains the configuration options supported by the
Lightbits LightOS Cinder driver. Lightbits Cinder driver.
.. config-table:: .. config-table::
:config-target: Lightbits LightOS :config-target: Lightbits cluster
cinder.volume.drivers.lightos cinder.volume.drivers.lightos

2
doc/source/reference/support-matrix.ini
View File

@ -139,7 +139,7 @@ title=Kioxia Kumoscale Driver (NVMeOF)
title=Lenovo Storage Driver (FC, iSCSI) title=Lenovo Storage Driver (FC, iSCSI)
[driver.lightbits_lightos] [driver.lightbits_lightos]
title=Lightbits LightOS Storage Driver (NVMeTCP) title=Lightbits Storage Driver (NVMeTCP)
[driver.linbit_linstor] [driver.linbit_linstor]
title=LINBIT DRBD/LINSTOR Driver (DRBD) title=LINBIT DRBD/LINSTOR Driver (DRBD)