Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating Lightbits Cinder driver documentations, replaced LightOS with Lightbits as per need basis. #23

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updating Lightbits Cinder driver documentations, replaced LightOS with Lightbits as per need basis. #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions doc/source/configuration/block-storage/drivers/lightbits-lightos-driver.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
===============================
Lightbits LightOS Cinder Driver
Lightbits Cinder Driver
===============================

The Lightbits(TM) LightOS(R) OpenStack driver enables OpenStack
clusters to use LightOS clustered storage servers. This documentation
explains how to configure Cinder for use with the Lightbits LightOS
storage backend system.
The Lightbits(TM) OpenStack driver enables OpenStack
clusters to use Lightbits clustered storage servers. This documentation
explains how to configure Cinder for use with the Lightbits storage
backend system.

Supported operations
~~~~~~~~~~~~~~~~~~~~
Expand All @@ -27,24 +27,24 @@ Supported operations
- Create volume from volume (clone)
- Active active deployment support

LightOS OpenStack Driver Components
Lightbits OpenStack Driver Components
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The LightOS OpenStack driver has three components:
The Lightbits OpenStack driver has three components:
- Cinder driver
- Nova libvirt volume driver
- os_brick initiator connector

In addition, it requires the LightOS ``discovery-client``, provided
with LightOS. The os_brick connector uses the LightOS
``discovery-client`` to communicate with LightOS NVMe/TCP discovery
In addition, it requires the Lightbits ``discovery-client``, provided
with product. The os_brick connector uses the Lightbits
``discovery-client`` to communicate with Lightbits NVMe/TCP discovery
services.

The Cinder Driver
~~~~~~~~~~~~~~~~~

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

.. code-block:: ini
Expand All @@ -65,13 +65,13 @@ and
lightos_default_compression_enabled = False
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:
``lightos_api_address =
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 installation controller. You can find the jwt at
Lightbits cluster installation controller. You can find the jwt at
``~/lightos-default-admin-jwt``.
- The default number of replicas for volumes is 3, and valid values
for ``lightos_default_num_replicas`` are 1, 2, or 3.
Expand Down Expand Up @@ -113,14 +113,14 @@ Then create a new volume with one of these volume types:
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
NVMe/TCP stack in Linux but it is fully supported in Ubuntu
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
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.

Note
Expand All @@ -136,10 +136,10 @@ Driver options
~~~~~~~~~~~~~~

The following table contains the configuration options supported by the
Lightbits LightOS Cinder driver.
Lightbits Cinder driver.

.. config-table::
:config-target: Lightbits LightOS
:config-target: Lightbits cluster

cinder.volume.drivers.lightos

Expand Down
2 changes: 1 addition & 1 deletion doc/source/reference/support-matrix.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ title=Kioxia Kumoscale Driver (NVMeOF)
title=Lenovo Storage Driver (FC, iSCSI)

[driver.lightbits_lightos]
title=Lightbits LightOS Storage Driver (NVMeTCP)
title=Lightbits Storage Driver (NVMeTCP)

[driver.linbit_linstor]
title=LINBIT DRBD/LINSTOR Driver (DRBD)
Expand Down