starlingx/docs
Code Issues Proposed changes

Fix rook conditionalization

Browse Source 
Indentation was lost. Restored. Also converted all stx-openstack
to use |prefix| and fixed worker topic |OVS-DPDK| substitution.
Implemented other changes identified in testing.
Incorporated patchset 1 review comments.
Fixed |vswitch-label|
Fixed merge conflict

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Id1771885a7e0b97cb4900b12b68a5e94a452bcbf
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
Ron Stone 2021-08-03 15:33:14 -04:00
parent 22917e62f9
commit f502df6856
17 changed files with 81 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/_vendor/vendor_strings.txt
View File

@ -73,4 +73,6 @@
.. |installer-image-name| replace:: bootimage
.. |OVS-DPDK| replace:: |OVS|-|DPDK|
.. |ovs-dpdk| replace:: ovs-dpdk
.. |ovs-dpdk| replace:: ovs-dpdk
.. |vswitch-label| replace:: openvswitch=enabled

24
doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_extend.rst
View File

@ -29,7 +29,7 @@ Install software on worker nodes
| id | hostname | personality | administrative | operational | availability |
+----+--------------+-------------+----------------+-------------+--------------+
| 1 | controller-0 | controller | unlocked | enabled | available |
| 2 | controller-0 | controller | unlocked | enabled | available |
| 2 | controller-1 | controller | unlocked | enabled | available |
| 3 | None | None | locked | disabled | offline |
| 4 | None | None | locked | disabled | offline |
+----+--------------+-------------+----------------+-------------+--------------+
@ -93,25 +93,25 @@ Configure worker nodes
.. important::
**These steps are required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
(|prefix|-openstack) will be installed.**
#. **For OpenStack only:** Assign OpenStack host labels to the worker nodes in
support of installing the stx-openstack manifest and helm-charts later.
support of installing the |prefix|-openstack manifest and helm-charts later.
.. code-block:: bash
.. parsed-literal
for NODE in worker-0 worker-1; do
system host-label-assign $NODE openstack-compute-node=enabled
system host-label-assign $NODE openvswitch=enabled
system host-label-assign $NODE |vswitch-label|
system host-label-assign $NODE sriov=enabled
done
#. **For OpenStack only:** Configure the host settings for the vSwitch.
**If using OVS-DPDK vswitch, run the following commands:**
If using |OVS-DPDK| vswitch, run the following commands:
Default recommendation for worker node is to use two cores on numa-node 0
for |OVS|-|DPDK| vSwitch; physical NICs are typically on first numa-node.
for |OVS-DPDK| vSwitch; physical NICs are typically on first numa-node.
This should have been automatically configured, if not run the following
command.
@ -125,7 +125,7 @@ Configure worker nodes
done
When using |OVS|-|DPDK|, configure 1G of huge pages for vSwitch memory on
When using |OVS-DPDK|, configure 1G of huge pages for vSwitch memory on
each |NUMA| node on the host. It is recommended to configure 1x 1G huge
page (-1G 1) for vSwitch memory on each |NUMA| node on the host.
@ -149,7 +149,7 @@ Configure worker nodes
.. important::
|VMs| created in an |OVS|-|DPDK| environment must be configured to use
|VMs| created in an |OVS-DPDK| environment must be configured to use
huge pages to enable networking and must use a flavor with property:
hw:mem_page_size=large
@ -170,7 +170,7 @@ Configure worker nodes
done
#. **For OpenStack only:** Setup disk partition for nova-local volume group,
needed for stx-openstack nova ephemeral disks.
needed for |prefix|-openstack nova ephemeral disks.
.. code-block:: bash
@ -184,7 +184,7 @@ Configure worker nodes
# List host’s disks and take note of UUID of disk to be used
system host-disk-list ${NODE}
# ( if using ROOT DISK, select disk with device_path of
# ‘system host-show ${NODE} --nowrap | fgrep rootfs’ )
# ‘system host-show ${NODE} | fgrep rootfs’ )
# Create new PARTITION on selected disk, and take note of new partition’s ‘uuid’ in response
# The size of the PARTITION needs to be large enough to hold the aggregate size of
@ -195,7 +195,7 @@ Configure worker nodes
# Additional PARTITION(s) from additional disks can be added later if required.
PARTITION_SIZE=30
system hostdisk-partition-add -t lvm_phys_vol ${NODE} <disk-uuid> ${PARTITION_SIZE}
system host-disk-partition-add -t lvm_phys_vol ${NODE} <disk-uuid> ${PARTITION_SIZE}
# Add new partition to ‘nova-local’ local volume group
system host-pv-add ${NODE} nova-local <NEW_PARTITION_UUID>

36
doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_install_kubernetes.rst
View File

@ -255,18 +255,18 @@ Configure controller-0
.. important::
**These steps are required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
(|prefix|-openstack) will be installed.**
#. **For OpenStack only:** Assign OpenStack host labels to controller-0 in
support of installing the stx-openstack manifest and helm-charts later.
support of installing the |prefix|-openstack manifest and helm-charts later.
.. only:: starlingx
::
.. parsed-literal::
system host-label-assign controller-0 openstack-control-plane=enabled
system host-label-assign controller-0 openstack-compute-node=enabled
system host-label-assign controller-0 openvswitch=enabled
system host-label-assign controller-0 |vswitch-label|
system host-label-assign controller-0 sriov=enabled
.. only:: partner
@ -293,7 +293,7 @@ Configure controller-0
StarlingX has |OVS| (kernel-based) vSwitch configured as default:
* Runs in a container; defined within the helm charts of stx-openstack
* Runs in a container; defined within the helm charts of |prefix|-openstack
manifest.
* Shares the core(s) assigned to the platform.
@ -312,7 +312,7 @@ Configure controller-0
system modify --vswitch_type none
This does not run any vSwitch directly on the host, instead, it uses
the containerized |OVS| defined in the helm charts of stx-openstack
the containerized |OVS| defined in the helm charts of |prefix|-openstack
manifest.
To deploy |OVS-DPDK|, run the following command:
@ -378,7 +378,7 @@ Configure controller-0
locking and unlocking controller-0 to apply the change.
#. **For OpenStack only:** Set up disk partition for nova-local volume
group, which is needed for stx-openstack nova ephemeral disks.
group, which is needed for |prefix|-openstack nova ephemeral disks.
.. code-block:: bash
@ -558,21 +558,21 @@ For host-based Ceph:
.. only:: starlingx
For Rook container-based Ceph:
For Rook container-based Ceph:
#. Initialize with add ceph-rook backend:
#. Initialize with add ceph-rook backend:
::
::
system storage-backend-add ceph-rook --confirmed
system storage-backend-add ceph-rook --confirmed
#. Assign Rook host labels to controller-0 in support of installing the
rook-ceph-apps manifest/helm-charts later:
#. Assign Rook host labels to controller-0 in support of installing the
rook-ceph-apps manifest/helm-charts later:
::
::
system host-label-assign controller-0 ceph-mon-placement=enabled
system host-label-assign controller-0 ceph-mgr-placement=enabled
system host-label-assign controller-0 ceph-mon-placement=enabled
system host-label-assign controller-0 ceph-mgr-placement=enabled
-------------------
@ -717,7 +717,7 @@ Configure controller-1
system host-label-assign controller-1 openstack-control-plane=enabled
system host-label-assign controller-1 openstack-compute-node=enabled
system host-label-assign controller-1 openvswitch=enabled
system host-label-assign controller-1 |vswitch-label|
system host-label-assign controller-1 sriov=enabled
.. only:: partner
@ -792,7 +792,7 @@ Configure controller-1
#. **For OpenStack only:** Set up disk partition for nova-local volume group,
which is needed for stx-openstack nova ephemeral disks.
which is needed for |prefix|-openstack nova ephemeral disks.
.. code-block:: bash

14
doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex_install_kubernetes.rst
View File

@ -236,19 +236,19 @@ The newly installed controller needs to be configured.
.. important::
**These steps are required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
(|prereq|-openstack) will be installed.**
#. **For OpenStack only:** Assign OpenStack host labels to controller-0 in
support of installing the stx-openstack manifest and helm-charts later.
support of installing the |prereq|-openstack manifest and helm-charts later.
.. only:: starlingx
::
.. parsed-literal::
system host-label-assign controller-0 openstack-control-plane=enabled
system host-label-assign controller-0 openstack-compute-node=enabled
system host-label-assign controller-0 openvswitch=enabled
system host-label-assign controller-0 |vswitch-label|
system host-label-assign controller-0 sriov=enabled
.. only:: partner
@ -275,7 +275,7 @@ The newly installed controller needs to be configured.
StarlingX has |OVS| (kernel-based) vSwitch configured as default:
* Runs in a container; defined within the helm charts of stx-openstack
* Runs in a container; defined within the helm charts of |prereq|-openstack
manifest.
* Shares the core(s) assigned to the platform.
@ -356,7 +356,7 @@ The newly installed controller needs to be configured.
locking and unlocking controller-0 to apply the change.
#. **For OpenStack only:** Set up disk partition for nova-local volume
group, which is needed for stx-openstack nova ephemeral disks.
group, which is needed for |prereq|-openstack nova ephemeral disks.
.. code-block:: bash
@ -370,7 +370,7 @@ The newly installed controller needs to be configured.
# List host’s disks and take note of UUID of disk to be used
system host-disk-list ${NODE}
# ( if using ROOT DISK, select disk with device_path of
# ‘system host-show ${NODE} --nowrap | fgrep rootfs’ )
# ‘system host-show ${NODE} | fgrep rootfs’ )
# Create new PARTITION on selected disk, and take note of new partition’s ‘uuid’ in response
# The size of the PARTITION needs to be large enough to hold the aggregate size of

18
doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage_install_kubernetes.rst
View File

@ -281,7 +281,7 @@ Configure controller-0
(|prefix|-openstack) will be installed.
#. **For OpenStack only:** Assign OpenStack host labels to controller-0 in
support of installing the stx-openstack manifest and helm-charts later.
support of installing the |prereq|-openstack manifest and helm-charts later.
::
@ -293,7 +293,7 @@ Configure controller-0
StarlingX has |OVS| (kernel-based) vSwitch configured as default:
* Runs in a container; defined within the helm charts of stx-openstack
* Runs in a container; defined within the helm charts of |prereq|-openstack
manifest.
* Shares the core(s) assigned to the platform.
@ -312,7 +312,7 @@ Configure controller-0
system modify --vswitch_type none
This does not run any vSwitch directly on the host, instead, it uses
the containerized |OVS| defined in the helm charts of stx-openstack
the containerized |OVS| defined in the helm charts of |prereq|-openstack
manifest.
To deploy |OVS-DPDK|, run the following command:
@ -506,7 +506,7 @@ Configure controller-1
(|prefix|-openstack) will be installed.
**For OpenStack only:** Assign OpenStack host labels to controller-1 in
support of installing the stx-openstack manifest and helm-charts later.
support of installing the |prereq|-openstack manifest and helm-charts later.
::
@ -624,13 +624,13 @@ Configure worker nodes
(|prefix|-openstack) will be installed.
#. **For OpenStack only:** Assign OpenStack host labels to the worker nodes in
support of installing the stx-openstack manifest and helm-charts later.
support of installing the |prereq|-openstack manifest and helm-charts later.
.. code-block:: bash
.. parsed-literal::
for NODE in worker-0 worker-1; do
system host-label-assign $NODE openstack-compute-node=enabled
system host-label-assign $NODE openvswitch=enabled
system host-label-assign $NODE |vswitch-label|
system host-label-assign $NODE sriov=enabled
done
@ -698,7 +698,7 @@ Configure worker nodes
done
#. **For OpenStack only:** Setup disk partition for nova-local volume group,
needed for stx-openstack nova ephemeral disks.
needed for |prereq|-openstack nova ephemeral disks.
.. code-block:: bash
@ -712,7 +712,7 @@ Configure worker nodes
# List host’s disks and take note of UUID of disk to be used
system host-disk-list ${NODE}
# ( if using ROOT DISK, select disk with device_path of
# ‘system host-show ${NODE} --nowrap | fgrep rootfs’ )
# ‘system host-show ${NODE} | fgrep rootfs’ )
# Create new PARTITION on selected disk, and take note of new partition’s ‘uuid’ in response
# The size of the PARTITION needs to be large enough to hold the aggregate size of

10
doc/source/deploy_install_guides/r5_release/bare_metal/dedicated_storage_install_kubernetes.rst
View File

@ -277,13 +277,13 @@ Configure worker nodes
(|prefix|-openstack) will be installed.
#. **For OpenStack only:** Assign OpenStack host labels to the worker nodes in
support of installing the stx-openstack manifest and helm-charts later.
support of installing the |prereq|-openstack manifest and helm-charts later.
.. code-block:: bash
.. parsed-literal
for NODE in worker-0 worker-1; do
system host-label-assign $NODE openstack-compute-node=enabled
system host-label-assign $NODE openvswitch=enabled
system host-label-assign $NODE |vswitch-label|
system host-label-assign $NODE sriov=enabled
done
@ -349,7 +349,7 @@ Configure worker nodes
done
#. **For OpenStack only:** Setup disk partition for nova-local volume group,
needed for stx-openstack nova ephemeral disks.
needed for |prereq|-openstack nova ephemeral disks.
.. code-block:: bash
@ -363,7 +363,7 @@ Configure worker nodes
# List host’s disks and take note of UUID of disk to be used
system host-disk-list ${NODE}
# ( if using ROOT DISK, select disk with device_path of
# ‘system host-show ${NODE} --nowrap | fgrep rootfs’ )
# ‘system host-show ${NODE} | fgrep rootfs’ )
# Create new PARTITION on selected disk, and take note of new partition’s ‘uuid’ in response
# The size of the PARTITION needs to be large enough to hold the aggregate size of

16
doc/source/deploy_install_guides/r5_release/bare_metal/inc-openstack-specific-host-config.rest
View File

@ -3,16 +3,16 @@
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
(|prereq|-openstack) will be installed.**
#. **For OpenStack only:** Assign OpenStack host labels to controller-0 in
support of installing the stx-openstack manifest and helm-charts later.
support of installing the |prereq|-openstack manifest and helm-charts later.
::
.. parsed-literal::
system host-label-assign controller-0 openstack-control-plane=enabled
system host-label-assign controller-0 openstack-compute-node=enabled
system host-label-assign controller-0 openvswitch=enabled
system host-label-assign controller-0 |vswitch-label|
system host-label-assign controller-0 sriov=enabled
#. **For OpenStack only:** Configure the system setting for the vSwitch.
@ -21,7 +21,7 @@
StarlingX has |OVS| (kernel-based) vSwitch configured as default:
* Runs in a container; defined within the helm charts of stx-openstack
* Runs in a container; defined within the helm charts of |prereq|-openstack
manifest.
* Shares the core(s) assigned to the platform.
@ -40,7 +40,7 @@
system modify --vswitch_type none
This does not run any vSwitch directly on the host, instead, it uses
the containerized |OVS| defined in the helm charts of stx-openstack
the containerized |OVS| defined in the helm charts of |prereq|-openstack
manifest.
To deploy |OVS-DPDK|, run the following command:
@ -94,7 +94,7 @@
controllers) to apply the change.
#. **For OpenStack only:** Set up disk partition for nova-local volume
group, which is needed for stx-openstack nova ephemeral disks.
group, which is needed for |prereq|-openstack nova ephemeral disks.
::
@ -102,7 +102,7 @@
echo ">>> Getting root disk info"
ROOT_DISK=$(system host-show ${NODE} | grep rootfs | awk '{print $4}')
ROOT_DISK_UUID=$(system host-disk-list ${NODE} --nowrap | grep ${ROOT_DISK} | awk '{print $2}')
ROOT_DISK_UUID=$(system host-disk-list ${NODE} | grep ${ROOT_DISK} | awk '{print $2}')
echo "Root disk: $ROOT_DISK, UUID: $ROOT_DISK_UUID"
echo ">>>> Configuring nova-local"

2
doc/source/deploy_install_guides/r5_release/bare_metal/ironic.rst
View File

@ -63,7 +63,7 @@ standard configuration, either:
This guide assumes that you have a standard deployment installed and configured
with 2x controllers and at least 1x compute-labeled worker node, with the
StarlingX OpenStack application (stx-openstack) applied.
StarlingX OpenStack application (|prereq|-openstack) applied.
.. toctree::
:maxdepth: 1

4
doc/source/deploy_install_guides/r5_release/virtual/aio_duplex_install_kubernetes.rst
View File

@ -460,11 +460,11 @@ OpenStack-specific host configuration
#. **For OpenStack only:** Assign OpenStack host labels to controller-1 in
support of installing the stx-openstack manifest/helm-charts later:
::
.. parsed-literal::
system host-label-assign controller-1 openstack-control-plane=enabled
system host-label-assign controller-1 openstack-compute-node=enabled
system host-label-assign controller-1 openvswitch=enabled
system host-label-assign controller-1 |vswitch-label|
system host-label-assign controller-1 sriov=enabled
#. **For OpenStack only:** Set up disk partition for nova-local volume group,

4
doc/source/deploy_install_guides/r5_release/virtual/aio_simplex_install_kubernetes.rst
View File

@ -296,11 +296,11 @@ OpenStack-specific host configuration
#. **For OpenStack only:** Assign OpenStack host labels to controller-0 in
support of installing the stx-openstack manifest/helm-charts later.
::
.. parsed-literal::
system host-label-assign controller-0 openstack-control-plane=enabled
system host-label-assign controller-0 openstack-compute-node=enabled
system host-label-assign controller-0 openvswitch=enabled
system host-label-assign controller-0 |vswitch-label|
system host-label-assign controller-0 sriov=enabled
#. **For OpenStack only:** A vSwitch is required.

4
doc/source/deploy_install_guides/r5_release/virtual/dedicated_storage_install_kubernetes.rst
View File

@ -363,11 +363,11 @@ OpenStack-specific host configuration
#. **For OpenStack only:** Assign OpenStack host labels to the worker nodes in
support of installing the stx-openstack manifest/helm-charts later:
::
.. parsed-literal::
for NODE in worker-0 worker-1; do
system host-label-assign $NODE openstack-compute-node=enabled
system host-label-assign $NODE openvswitch=enabled
system host-label-assign $NODE |vswitch-label|
system host-label-assign $NODE sriov=enabled
done

4
doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex_extend.rst
View File

@ -98,11 +98,11 @@ Configure worker nodes
#. **For OpenStack only:** Assign OpenStack host labels to the worker nodes in
support of installing the stx-openstack manifest and helm-charts later.
.. code-block:: bash
.. parsed-literal::
for NODE in worker-0 worker-1; do
system host-label-assign $NODE openstack-compute-node=enabled
system host-label-assign $NODE openvswitch=enabled
system host-label-assign $NODE |vswitch-label|
system host-label-assign $NODE sriov=enabled
done

4
doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex_install_kubernetes.rst
View File

@ -243,11 +243,11 @@ The newly installed controller needs to be configured.
.. only:: starlingx
::
.. parsed-literal::
system host-label-assign controller-0 openstack-control-plane=enabled
system host-label-assign controller-0 openstack-compute-node=enabled
system host-label-assign controller-0 openvswitch=enabled
system host-label-assign controller-0 |vswitch-label|
system host-label-assign controller-0 sriov=enabled
.. only:: partner

4
doc/source/deploy_install_guides/r6_release/bare_metal/dedicated_storage_install_kubernetes.rst
View File

@ -279,11 +279,11 @@ Configure worker nodes
#. **For OpenStack only:** Assign OpenStack host labels to the worker nodes in
support of installing the stx-openstack manifest and helm-charts later.
.. code-block:: bash
.. parsed-literal::
for NODE in worker-0 worker-1; do
system host-label-assign $NODE openstack-compute-node=enabled
system host-label-assign $NODE openvswitch=enabled
system host-label-assign $NODE |vswitch-label|
system host-label-assign $NODE sriov=enabled
done

4
doc/source/deploy_install_guides/r6_release/bare_metal/rook_storage_install_kubernetes.rst
View File

@ -591,11 +591,11 @@ OpenStack-specific host configuration
.. only:: starlingx
.. code-block:: bash
.. parsed-literal::
for NODE in worker-0 worker-1; do
system host-label-assign $NODE openstack-compute-node=enabled
system host-label-assign $NODE openvswitch=enabled
system host-label-assign $NODE |vswitch-label|
system host-label-assign $NODE sriov=enabled
done

4
doc/source/deploy_install_guides/r6_release/virtual/aio_simplex_install_kubernetes.rst
View File

@ -296,11 +296,11 @@ OpenStack-specific host configuration
#. **For OpenStack only:** Assign OpenStack host labels to controller-0 in
support of installing the stx-openstack manifest/helm-charts later.
::
.. parsed-literal::
system host-label-assign controller-0 openstack-control-plane=enabled
system host-label-assign controller-0 openstack-compute-node=enabled
system host-label-assign controller-0 openvswitch=enabled
system host-label-assign controller-0 |vswitch-label|
system host-label-assign controller-0 sriov=enabled
#. **For OpenStack only:** A vSwitch is required.

4
doc/source/deploy_install_guides/r6_release/virtual/dedicated_storage_install_kubernetes.rst
View File

@ -363,11 +363,11 @@ OpenStack-specific host configuration
#. **For OpenStack only:** Assign OpenStack host labels to the worker nodes in
support of installing the stx-openstack manifest/helm-charts later:
::
.. parsed-literal::
for NODE in worker-0 worker-1; do
system host-label-assign $NODE openstack-compute-node=enabled
system host-label-assign $NODE openvswitch=enabled
system host-label-assign $NODE |vswitch-label|
system host-label-assign $NODE sriov=enabled
done