From 4b05fa8a5faec3584e40f30b687cf3ea28abf158 Mon Sep 17 00:00:00 2001
From: yuval <yuval@lightbitslabs.com>
Date: Tue, 20 Aug 2024 15:05:14 +0300
Subject: add lightbits driver support

Change-Id: I50c5a1443c5d2012388debed20b96274bc69e7e7
---
 .../reference/storage/cinder-guide-lightbits.rst   | 33 ++++++++++++++++++++++
 doc/source/reference/storage/cinder-guide.rst      |  3 ++
 doc/source/reference/storage/index.rst             |  1 +
 3 files changed, 37 insertions(+)
 create mode 100644 doc/source/reference/storage/cinder-guide-lightbits.rst

(limited to 'doc')

diff --git a/doc/source/reference/storage/cinder-guide-lightbits.rst b/doc/source/reference/storage/cinder-guide-lightbits.rst
new file mode 100644
index 000000000..b09d0e4a1
--- /dev/null
+++ b/doc/source/reference/storage/cinder-guide-lightbits.rst
@@ -0,0 +1,33 @@
+.. cinder-guide-Lightbits:
+
+=====================================
+Lightbits labs storage for OpenStack
+=====================================
+
+Lightbits labs Cinder Driver
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To use the ``Lightbits labs`` Cinder backend, enable and
+configure the ``Lightbits labs`` Cinder driver in
+``/etc/kolla/globals.yml``.
+
+.. code-block:: yaml
+
+  enable_cinder_backend_lightbits: "yes"
+
+.. end
+
+Also set the values for the following parameters in ``/etc/kolla/globals.yml``:
+
+- ``lightos_api_address``
+- ``lightos_api_port``
+- ``lightos_default_num_replicas``
+- ``lightos_skip_ssl_verify``
+- ``lightos_jwt``
+
+
+For details on how to use these parameters, refer to the
+`Lightbits labs Cinder Reference Guide <https://docs.openstack.org/cinder/latest/configuration/block-storage/drivers/lightbits-lightos-driver.html>`_.
+
+There are numerous other parameters that can be set for this driver and
+these are detailed in the above link.
diff --git a/doc/source/reference/storage/cinder-guide.rst b/doc/source/reference/storage/cinder-guide.rst
index 7c45a8d28..cd674d8cc 100644
--- a/doc/source/reference/storage/cinder-guide.rst
+++ b/doc/source/reference/storage/cinder-guide.rst
@@ -296,6 +296,9 @@ that appears in cinder.conf:
    * - Pure Storage FlashArray for OpenStack
      - cinder_backend_pure_nvme_tcp_name
      - Pure-FlashArray-nvme-tcp
+   * - Lightbits Labs storage backend
+     - cinder_backend_lightbits_name
+     - Lightbits-NVMe-TCP
 
 These are the names you use when
 `configuring <https://docs.openstack.org/cinder/latest/admin/multi-backend.html#volume-type>`_
diff --git a/doc/source/reference/storage/index.rst b/doc/source/reference/storage/index.rst
index ad18929a6..05c2d7bf6 100644
--- a/doc/source/reference/storage/index.rst
+++ b/doc/source/reference/storage/index.rst
@@ -12,6 +12,7 @@ supported by kolla.
    cinder-guide
    cinder-guide-quobyte
    cinder-guide-pure
+   cinder-guide-lightbits
    manila-guide
    manila-hnas-guide
    swift-guide
-- 
cgit v1.2.3