starlingx/docs
Code Issues Proposed changes

Updated r6 intallation guides

Browse Source 
Converted all stx-openstack to use |prefix|
Fixed |vswitch-label|

Fixed comment lining
Replaced AVS by correct acronym

Solved conflict.

Minor fix.

Signed-off-by: egoncalv <elisamaraaoki.goncalves@windriver.com>
Change-Id: Ifd2b0b9ba9193ca3d02b7354679b933fc93d7eeb
This commit is contained in:
egoncalv 2021-09-09 21:54:15 -03:00
parent 98d01b5049
commit 2f51d33fd7
7 changed files with 57 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -101,9 +101,9 @@ Configure worker nodes
.. parsed-literal::
for NODE in worker-0 worker-1; do
system host-label-assign $NODE openstack-compute-node=enabled
system host-label-assign $NODE |vswitch-label|
system host-label-assign $NODE sriov=enabled
system host-label-assign $NODE openstack-compute-node=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.

55
doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex_install_kubernetes.rst
View File

@ -263,7 +263,7 @@ Configure controller-0
.. only:: starlingx
.. parsed-literal::
.. parsed-literal::
system host-label-assign controller-0 openstack-control-plane=enabled
system host-label-assign controller-0 openstack-compute-node=enabled
@ -598,24 +598,31 @@ Unlock controller-0
# check existing size of docker fs
system host-fs-list controller-0
# check available space (Avail Size (GiB)) in cgts-vg LVG where docker fs is located
system host-lvg-list controller-0
# if existing docker fs size + cgts-vg available space is less than
# 60G, you will need to add a new disk partition to cgts-vg.
# Assuming you have unused space on ROOT DISK, add partition to ROOT DISK.
# ( if not use another unused disk )
# Get device path of ROOT DISK
system host-show controller-0 | fgrep rootfs
# Get UUID of ROOT DISK by listing disks
system host-disk-list controller-0
# Create new PARTITION on ROOT DISK, and take note of new partition’s ‘uuid’ in response
# Use a partition size such that you’ll be able to increase docker fs size from 30G to 60G
PARTITION_SIZE=30
system host-disk-partition-add -t lvm_phys_vol controller-0 <root-disk-uuid> ${PARTITION_SIZE}
# Add new partition to ‘cgts-vg’ local volume group
system host-pv-add controller-0 cgts-vg <NEW_PARTITION_UUID>
sleep 2 # wait for partition to be added
# check available space (Avail Size (GiB)) in cgts-vg LVG where docker fs is located
system host-lvg-list controller-0
# if existing docker fs size + cgts-vg available space is less than
# 60G, you will need to add a new disk partition to cgts-vg.
# Assuming you have unused space on ROOT DISK, add partition to ROOT DISK.
# ( if not use another unused disk )
# Get device path of ROOT DISK
system host-show controller-0 | grep rootfs
# Get UUID of ROOT DISK by listing disks
system host-disk-list controller-0
# Create new PARTITION on ROOT DISK, and take note of new partition’s ‘uuid’ in response
# Use a partition size such that you’ll be able to increase docker fs size from 30G to 60G
PARTITION_SIZE=30
system host-disk-partition-add -t lvm_phys_vol controller-0 <root-disk-uuid> ${PARTITION_SIZE}
# Add new partition to ‘cgts-vg’ local volume group
system host-pv-add controller-0 cgts-vg <NEW_PARTITION_UUID>
sleep 2 # wait for partition to be added
# Increase docker filesystem to 60G
system host-fs-modify controller-0 docker=60
@ -711,7 +718,7 @@ Configure controller-1
.. only:: starlingx
::
.. parsed-literal::
system host-label-assign controller-1 openstack-control-plane=enabled
system host-label-assign controller-1 openstack-compute-node=enabled
@ -950,10 +957,10 @@ For host-based Ceph:
.. only:: starlingx
For Rook container-based Ceph:
For Rook container-based Ceph:
#. Assign Rook host labels to controller-1 in support of installing the
rook-ceph-apps manifest/helm-charts later:
#. Assign Rook host labels to controller-1 in support of installing the
rook-ceph-apps manifest/helm-charts later:
.. code-block:: bash
@ -989,8 +996,8 @@ machine.
# check available space (Avail Size (GiB)) in cgts-vg LVG where docker fs is located
system host-lvg-list controller-1
# if existing docker fs size + cgts-vg available space is less than
# 60G, you will need to add a new disk partition to cgts-vg.
# if existing docker fs size + cgts-vg available space is less than 60G,
# you will need to add a new disk partition to cgts-vg.
# Assuming you have unused space on ROOT DISK, add partition to ROOT DISK.
# ( if not use another unused disk )

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

@ -350,7 +350,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

2
doc/source/deploy_install_guides/r6_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 (|prefix|-openstack) applied.
.. toctree::
:maxdepth: 1

14
doc/source/deploy_install_guides/r6_release/virtual/aio_duplex_install_kubernetes.rst
View File

@ -191,8 +191,8 @@ Optionally, initialize a Ceph-based Persistent Storage Backend
A persistent storage backend is required if your application requires
Persistent Volume Claims (PVCs). The StarlingX OpenStack application
(stx-openstack) requires PVCs, therefore if you plan on using the
stx-openstack application, then you must configure a persistent storage
(|prefix|-openstack) requires PVCs, therefore if you plan on using the
|prefix|-openstack application, then you must configure a persistent storage
backend.
There are two options for persistent storage backend:
@ -243,7 +243,7 @@ For Rook container-based Ceph:
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
(|prefix|-openstack) will be installed.**
1G Huge Pages are not supported in the virtual environment and there is no
virtual NIC supporting SRIOV. For that reason, data interfaces are not
@ -388,7 +388,7 @@ On virtual controller-0:
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
(|prefix|-openstack) will be installed.**
1G Huge Pages are not supported in the virtual environment and there is no
virtual NIC supporting SRIOV. For that reason, data interfaces are not
@ -455,10 +455,10 @@ OpenStack-specific host configuration
.. important::
**This step is 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-1 in
support of installing the stx-openstack manifest/helm-charts later:
support of installing the |prefix|-openstack manifest/helm-charts later:
::
@ -468,7 +468,7 @@ OpenStack-specific host configuration
system host-label-assign controller-1 sriov=enabled
#. **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:
::

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

@ -182,8 +182,8 @@ Optionally, initialize a Ceph-based Persistent Storage Backend
A persistent storage backend is required if your application requires
Persistent Volume Claims (PVCs). The StarlingX OpenStack application
(stx-openstack) requires PVCs, therefore if you plan on using the
stx-openstack application, then you must configure a persistent storage
(|prefix|-openstack) requires PVCs, therefore if you plan on using the
|prefix|-openstack application, then you must configure a persistent storage
backend.
There are two options for persistent storage backend:
@ -234,7 +234,7 @@ For Rook container-based Ceph:
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
(|prefix|-openstack) will be installed.**
1G Huge Pages are not supported in the virtual environment and there is no
virtual NIC supporting SRIOV. For that reason, data interfaces are not
@ -291,10 +291,10 @@ OpenStack-specific host configuration
.. important::
**This step is 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/helm-charts later.
support of installing the |prefix|-openstack manifest/helm-charts later.
.. parsed-literal::
@ -306,13 +306,13 @@ OpenStack-specific host configuration
#. **For OpenStack only:** A vSwitch is required.
The default vSwitch is containerized |OVS| that is packaged with the
stx-openstack manifest/helm-charts. StarlingX provides the option to use
|prefix|-openstack manifest/helm-charts. StarlingX provides the option to use
|OVS-DPDK| on the host, however, in the virtual environment |OVS-DPDK| is
NOT supported, only |OVS| is supported. Therefore, simply use the default
|OVS| vSwitch here.
#. **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.
::

14
doc/source/shared/_includes/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.**
(|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.
::
.. 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 |prefix|-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 |prefix|-openstack
manifest.
To deploy |OVS-DPDK|, run the following command:
@ -91,7 +91,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 |prefix|-openstack nova ephemeral disks.
::