starlingx/docs
Code Issues Proposed changes

Update docs to mention that Openstack DOES NOT support ceph-rook (r10,ds R10)

Browse Source 
Remove mentions of rook-ceph from the Openstack Install Guide.
Add warning about rook-ceph not being supported in openstack.
Fix merge conflict.

Change-Id: I4c120927e1b8e387d38878a5b682e052c9d2b9f3
Signed-off-by: Elisamara Aoki Gonçalves <elisamaraaoki.goncalves@windriver.com>
This commit is contained in:
Elisamara Aoki Gonçalves 2025-03-25 20:48:05 +00:00
parent 77518ebbf6
commit 3bd59f9595
3 changed files with 419 additions and 381 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
doc/source/deploy_install_guides/release/bare_metal/aio_duplex_install_kubernetes.rst
View File

@ -934,19 +934,21 @@ A persistent storage backend is required if your application requires |PVCs|.
The StarlingX OpenStack application **requires** |PVCs|.
.. note::
.. only:: starlingx or platform
Each deployment model enforces a different structure for the Rook Ceph
cluster and its integration with the platform.
There are two options for persistent storage backend: the host-based Ceph
solution and the Rook container-based Ceph solution.
There are two options for persistent storage backend: the host-based Ceph
solution and the Rook container-based Ceph solution.
.. note::
.. note::
Host-based Ceph will be deprecated and removed in an upcoming release.
Adoption of Rook-Ceph is recommended for new deployments.
.. warning::
Currently |prod-os| does not support rook-ceph. If you plan on using
|prod-os|, choose host-based Ceph.
For host-based Ceph:
#. Initialize with add ceph backend:
@ -969,9 +971,16 @@ For host-based Ceph:
# List OSD storage devices
~(keystone_admin)$ system host-stor-list controller-0
For Rook-Ceph:
.. only:: starlingx or platform
#. Add Storage-Backend with Deployment Model.
For Rook-Ceph:
.. note::
Each deployment model enforces a different structure for the Rook Ceph
cluster and its integration with the platform.
#. Add Storage-Backend with Deployment Model.
.. code-block:: none
@ -984,13 +993,13 @@ For Rook-Ceph:
| | | | | | | min_replication: 1 |
+--------------------------------------+-----------------+-----------+----------------------+----------+------------------+------------------------------------------------------+
#. Set up a ``contorllerfs ceph-float`` filesystem.
#. Set up a ``contorllerfs ceph-float`` filesystem.
.. code-block:: none
~(keystone_admin)$ system controllerfs-add ceph-float=20
#. Set up a ``host-fs ceph`` filesystem on controller-0.
#. Set up a ``host-fs ceph`` filesystem on controller-0.
.. code-block:: none
@ -1459,9 +1468,11 @@ For host-based Ceph:
# List OSD storage devices
~(keystone_admin)$ system host-stor-list controller-1
For Rook-Ceph:
.. only:: starlingx or platform
#. Set up a ``host-fs ceph`` filesystem on controller-1.
For Rook-Ceph:
#. Set up a ``host-fs ceph`` filesystem on controller-1.
.. code-block:: none
@ -1481,11 +1492,13 @@ Controller-1 will reboot in order to apply configuration changes and come into
service. This can take 5-10 minutes, depending on the performance of the host
machine.
-------------------------------------------------------------------
If configuring Rook Ceph Storage Backend, configure the environment
-------------------------------------------------------------------
.. only:: starlingx or platform
#. Check if the rook-ceph app is uploaded.
-------------------------------------------------------------------
If configuring Rook Ceph Storage Backend, configure the environment
-------------------------------------------------------------------
#. Check if the rook-ceph app is uploaded.
.. code-block:: none
@ -1503,7 +1516,7 @@ If configuring Rook Ceph Storage Backend, configure the environment
| rook-ceph | 24.09-12 | rook-ceph-fluxcd-manifests | fluxcd-manifests | uploaded | completed |
+--------------------------+-----------+-------------------------------------------+------------------+----------+-----------+
#. List all the disks.
#. List all the disks.
.. code-block:: none
@ -1525,7 +1538,7 @@ If configuring Rook Ceph Storage Backend, configure the environment
| dc0ec403-67f8-40bf-ada0-6fcae3ed76da | /dev/sdc | 2080 | HDD | 9.765 | 9.761 | Undetermined | VB16244caf-ab36d36c | /dev/disk/by-path/pci-0000:00:0d.0-ata-3.0 |
+--------------------------------------+-------------+------------+-------------+----------+---------------+--------------+---------------------+--------------------------------------------+
#. Choose empty disks and provide hostname and uuid to finish |OSD|
#. Choose empty disks and provide hostname and uuid to finish |OSD|
configuration:
.. code-block:: none
@ -1533,7 +1546,7 @@ If configuring Rook Ceph Storage Backend, configure the environment
~(keystone_admin)$ system host-stor-add controller-0 osd bfb83b6f-61e2-4f9f-a87d-ecae938b7e78
~(keystone_admin)$ system host-stor-add controller-1 osd 93020ce0-249e-4db3-b8c3-6c7e8f32713b
#. Wait for |OSDs| pod to be ready.
#. Wait for |OSDs| pod to be ready.
.. code-block:: none
@ -1565,7 +1578,7 @@ If configuring Rook Ceph Storage Backend, configure the environment
rook-ceph-tools-7dc9678ccb-nmwwc 1/1 Running 0 12m
stx-ceph-manager-664f8585d8-5lt8c 1/1 Running 0 10m
#. Check ceph cluster health.
#. Check ceph cluster health.
.. code-block:: none
@ -1591,7 +1604,7 @@ If configuring Rook Ceph Storage Backend, configure the environment
client: 1.2 KiB/s rd, 2 op/s rd, 0 op/s wr
.. include:: /_includes/bootstrapping-and-deploying-starlingx.rest
.. include:: /_includes/bootstrapping-and-deploying-starlingx.rest
.. _extend-dx-with-workers:

49
doc/source/deploy_install_guides/release/bare_metal/aio_simplex_install_kubernetes.rst
View File

@ -842,9 +842,9 @@ Optionally Configure PCI-SRIOV Interfaces
:end-before: end-config-controller-0-OS-k8s-sriov-sx
************************************************************
Optional - Initialize a Ceph-rook Persistent Storage Backend
************************************************************
*******************************************************
Optional - Initialize a Ceph Persistent Storage Backend
*******************************************************
A persistent storage backend is required if your application requires
|PVCs|.
@ -855,19 +855,21 @@ A persistent storage backend is required if your application requires
The StarlingX OpenStack application **requires** |PVCs|.
.. note::
.. only:: starlingx or platform
Each deployment model enforces a different structure for the Rook Ceph
cluster and its integration with the platform.
There are two options for persistent storage backend: the host-based Ceph
solution and the Rook container-based Ceph solution.
There are two options for persistent storage backend: the host-based Ceph
solution and the Rook container-based Ceph solution.
.. note::
.. note::
Host-based Ceph will be deprecated and removed in an upcoming release.
Adoption of Rook-Ceph is recommended for new deployments.
.. warning::
Currently |prod-os| does not support rook-ceph. If you plan on using
|prod-os|, choose host-based Ceph.
For host-based Ceph:
#. Add host-based Ceph backend:
@ -890,9 +892,16 @@ For host-based Ceph:
# List OSD storage devices
~(keystone_admin)$ system host-stor-list controller-0
For Rook-Ceph:
.. only:: starlingx or platform
#. Check if the rook-ceph app is uploaded.
For Rook-Ceph:
.. note::
Each deployment model enforces a different structure for the Rook Ceph
cluster and its integration with the platform.
#. Check if the rook-ceph app is uploaded.
.. code-block:: none
@ -910,7 +919,7 @@ For Rook-Ceph:
| rook-ceph | 24.09-12 | rook-ceph-fluxcd-manifests | fluxcd-manifests | uploaded | completed |
+--------------------------+-----------+-------------------------------------------+------------------+----------+-----------+
#. Add Storage-Backend with Deployment Model.
#. Add Storage-Backend with Deployment Model.
There are three deployment models: Controller, Dedicated, and Open.
@ -956,7 +965,7 @@ For Rook-Ceph:
| | | | | | filesystem | 1 min_replication: 1 |
+--------------------------------------+-----------------+-----------+----------------------+----------+------------+-------------------------------------------+
#. Set up a ``host-fs ceph`` filesystem.
#. Set up a ``host-fs ceph`` filesystem.
.. code-block:: none
@ -980,9 +989,11 @@ Controller-0 will reboot in order to apply configuration changes and come into
service. This can take 5-10 minutes, depending on the performance of the host
machine.
For Rook-Ceph:
.. only:: starlingx or platform
#. List all the disks.
For Rook-Ceph:
#. List all the disks.
.. code-block:: none
@ -995,14 +1006,14 @@ For Rook-Ceph:
| 0c6435af-805a-4a62-ad8e-403bf916f5cf | /dev/sdc | 2080 | HDD | 9.765 | 9.761 | Undetermined | VBeefed5ad-b4815f0d | /dev/disk/by-path/pci-0000:00:0d.0-ata-3.0 |
+--------------------------------------+-------------+------------+-------------+----------+---------------+--------------+---------------------+--------------------------------------------+
#. Choose empty disks and provide hostname and uuid to finish |OSD|
#. Choose empty disks and provide hostname and uuid to finish |OSD|
configuration:
.. code-block:: none
$ system host-stor-add controller-0 osd cee99187-dac4-4a7b-8e58-f2d5bd48dcaf
#. Wait for |OSDs| pod to be ready.
#. Wait for |OSDs| pod to be ready.
.. code-block:: none
@ -1026,7 +1037,7 @@ For Rook-Ceph:
rook-ceph-tools-7dc9678ccb-v2gps 1/1 Running 0 6m2s
stx-ceph-manager-664f8585d8-wzr4v 1/1 Running 0 4m31s
#. Check ceph cluster health.
#. Check ceph cluster health.
.. code-block:: none

40
doc/source/deploy_install_guides/release/bare_metal/controller_storage_install_kubernetes.rst
View File

@ -758,6 +758,11 @@ host machine.
If configuring host based Ceph Storage Backend, Add Ceph OSDs to controllers
----------------------------------------------------------------------------
.. warning::
Currently |prod-os| does not support rook-ceph. If you plan on using
|prod-os|, choose host-based Ceph.
.. only:: starlingx
.. tabs::
@ -829,17 +834,23 @@ Complete system configuration by reviewing procedures in:
- |index-sysconf-kub-78f0e1e9ca5a|
- |index-admintasks-kub-ebc55fefc368|
.. only:: starlingx or platform
*******************************************************************
If configuring Rook Ceph Storage Backend, configure the environment
*******************************************************************
*******************************************************************
If configuring Rook Ceph Storage Backend, configure the environment
*******************************************************************
.. note::
.. warning::
Currently |prod-os| does not support rook-ceph. If you plan on using
|prod-os|, choose host-based Ceph.
.. note::
Each deployment model enforces a different structure for the Rook Ceph
cluster and its integration with the platform.
#. Check if the rook-ceph app is uploaded.
#. Check if the rook-ceph app is uploaded.
.. code-block:: none
@ -857,19 +868,22 @@ If configuring Rook Ceph Storage Backend, configure the environment
| rook-ceph | 24.09-12 | rook-ceph-fluxcd-manifests | fluxcd-manifests | uploaded | completed |
+--------------------------+-----------+-------------------------------------------+------------------+----------+-----------+
#. Add Storage-Backend with Deployment Model.
#. Add Storage-Backend with Deployment Model.
There are three deployment models: Controller, Dedicated, and Open.
For the simplex and duplex environments you can use the Controller and Open
configuration.
This model aligns with the existing Bare-metal Ceph assignment of OSDs
to controllers.
Controller (default)
|OSDs| must only be added to host with controller personality set.
Replication factor is limited to a maximum of 2.
This model aligns with the existing Bare-metal Ceph assignment of OSDs
This model aligns with the existing Bare-metal Ceph assignement of OSDs
to controllers.
Dedicated
@ -903,7 +917,7 @@ If configuring Rook Ceph Storage Backend, configure the environment
| | | | | | | min_replication: 1 |
+--------------------------------------+-----------------+-----------+----------------------+----------+------------------+---------------------------------------------+
#. Set up a ``host-fs ceph`` filesystem.
#. Set up a ``host-fs ceph`` filesystem.
.. code-block:: none
@ -911,7 +925,7 @@ If configuring Rook Ceph Storage Backend, configure the environment
$ system host-fs-add controller-1 ceph=20
$ system host-fs-add compute-0 ceph=20
#. List all the disks.
#. List all the disks.
.. code-block:: none
@ -940,7 +954,7 @@ If configuring Rook Ceph Storage Backend, configure the environment
| c9b4ed65-da32-4770-b901-60b56fd68c35 | /dev/sdc | 2080 | HDD | 9.765 | 9.761 | Undetermined | VBf88762a8-9aa3315c | /dev/disk/by-path/pci-0000:00:0d.0-ata-3.0 |
+--------------------------------------+-------------+------------+-------------+----------+---------------+--------------+---------------------+--------------------------------------------+
#. Choose empty disks and provide hostname and uuid to finish |OSD|
#. Choose empty disks and provide hostname and uuid to finish |OSD|
configuration:
.. code-block:: none
@ -948,13 +962,13 @@ If configuring Rook Ceph Storage Backend, configure the environment
$ system host-stor-add controller-0 osd fdaf3f71-a2df-4b40-9e70-335900f953a3
$ system host-stor-add controller-1 osd 03cbb10e-fdc1-4d84-a0d8-6e02c22e3251
$ system host-stor-add compute-0 osd c9b4ed65-da32-4770-b901-60b56fd68c35
#. Apply the rook-ceph application.
#. Apply the rook-ceph application.
.. code-block:: none
$ system application-apply rook-ceph
#. Wait for |OSDs| pod to be ready.
#. Wait for |OSDs| pod to be ready.
.. code-block:: none
@ -994,7 +1008,7 @@ If configuring Rook Ceph Storage Backend, configure the environment
rook-ceph-tools-7dc9678ccb-srnd8 1/1 Running 1 (4h7m ago) 18h
stx-ceph-manager-664f8585d8-csl7p 1/1 Running 1 (4h7m ago) 18h
#. Check ceph cluster health.
#. Check ceph cluster health.
.. code-block:: none