starlingx/docs
Code Issues Proposed changes

Replace stx with prefix substitution (2 of 3)

Browse Source 
2nd review in a group to change instances of
stx-openstack to |prefix|-openstack
This group includes install guides.
Fixed 2 files.

Change-Id: If159baaf94252b1738042209ee7f0d1a98712641
Signed-off-by: MCamp859 <maryx.camp@intel.com>
This commit is contained in:
MCamp859 2021-11-15 14:44:31 -05:00
parent 6662c926e2
commit a9df1ae72e
20 changed files with 187 additions and 185 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/source/deploy_install_guides/r5_release/bare_metal/ironic_install.rst
View File

@ -126,14 +126,14 @@ Configure Ironic network on deployed standard StarlingX
Generate user Helm overrides
****************************
Ironic Helm Charts are included in the stx-openstack application. By default,
Ironic is disabled.
Ironic Helm Charts are included in the |prefix|-openstack application. By
default, Ironic is disabled.
To enable Ironic, update the following Ironic Helm Chart attributes:
::
.. parsed-literal::
system helm-override-update stx-openstack ironic openstack \
system helm-override-update |prefix|-openstack ironic openstack \
--set network.pxe.neutron_subnet_alloc_start=10.10.20.10 \
--set network.pxe.neutron_subnet_gateway=10.10.20.1 \
--set network.pxe.neutron_provider_network=ironic-data
@ -148,18 +148,18 @@ If the data network name for Ironic is changed, modify
--set network.pxe.neutron_provider_network=ironic-data
*******************************
Apply stx-openstack application
*******************************
***************************
Apply OpenStack application
***************************
Re-apply the stx-openstack application to apply the changes to Ironic:
Re-apply the |prefix|-openstack application to apply the changes to Ironic:
::
.. parsed-literal::
system helm-chart-attribute-modify stx-openstack ironic openstack \
system helm-chart-attribute-modify |prefix|-openstack ironic openstack \
--enabled true
system application-apply stx-openstack
system application-apply |prefix|-openstack
--------------------
Start an Ironic node

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

@ -221,11 +221,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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.
::
@ -235,7 +235,7 @@ OpenStack-specific host configuration
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.
@ -253,7 +253,7 @@ OpenStack-specific host configuration
system modify --vswitch_type none
Do not run any vSwitch directly on the host, instead, use the containerized
|OVS| defined in the helm charts of stx-openstack manifest.
|OVS| defined in the helm charts of |prefix|-openstack manifest.
To deploy |OVS|-|DPDK|, run the following command:
@ -450,11 +450,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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.
of installing the |prefix|-openstack manifest and helm-charts later.
::
@ -584,11 +584,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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.
.. only:: starlingx
@ -608,7 +608,7 @@ OpenStack-specific host configuration
:end-before: ref1-end
#. **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

5
doc/source/deploy_install_guides/r5_release/openstack/access.rst
View File

@ -49,10 +49,11 @@ you can configure the DNS Server that owns `<domain_name>` with the OpenStack
service names underneath the domain.
For example:
::
.. parsed-literal::
system service-parameter-add openstack helm endpoint_domain=my-starlingx-domain.my-company.com
system application-apply stx-openstack
system application-apply |prefix|-openstack
This command updates the helm charts of all OpenStack services and restarts them.
For example it would change `cinder‐api.openstack.svc.cluster.local` to

29
doc/source/deploy_install_guides/r5_release/openstack/install.rst
View File

@ -16,7 +16,7 @@ Install application manifest and helm-charts
--------------------------------------------
#. Modify the size of the docker_lv filesystem. By default, the size of the
docker_lv filesystem is 30G, which is not enough for stx-openstack
docker_lv filesystem is 30G, which is not enough for |prefix|-openstack
installation. Use the ``host-fs-modify`` CLI to increase the filesystem size.
The syntax is:
@ -38,8 +38,8 @@ Install application manifest and helm-charts
system host-fs-modify controller-0 docker=60
#. Get the latest StarlingX OpenStack application (stx-openstack) manifest and
helm charts. Use one of the following options:
#. Get the latest StarlingX OpenStack application (|prefix|-openstack) manifest
and helm charts. Use one of the following options:
* Private StarlingX build. See :ref:`Build-stx-openstack-app` for details.
* Public download from
@ -47,13 +47,13 @@ Install application manifest and helm-charts
After you select a release, helm charts are located in ``centos/outputs/helm-charts``.
#. Load the stx-openstack application's package into StarlingX. The tarball
package contains stx-openstack's Airship Armada manifest and stx-openstack's
set of helm charts. For example:
#. Load the |prefix|-openstack application's package into StarlingX. The tarball
package contains |prefix|-openstack's Airship Armada manifest and
|prefix|-openstack's set of helm charts. For example:
::
.. parsed-literal::
system application-upload stx-openstack-<version>-centos-stable-versioned.tgz
system application-upload |prefix|-openstack-<version>-centos-stable-versioned.tgz
This will:
@ -63,13 +63,14 @@ Install application manifest and helm-charts
the current state of the underlying StarlingX Kubernetes platform and the
recommended StarlingX configuration of OpenStack services.
#. Apply the stx-openstack application in order to bring StarlingX OpenStack into
service. If your environment is preconfigured with a proxy server, then
make sure HTTPS proxy is set before applying stx-openstack.
#. Apply the |prefix|-openstack application in order to bring StarlingX
OpenStack into service. If your environment is preconfigured with a proxy
server, then make sure HTTPS proxy is set before applying
|prefix|-openstack.
::
.. parsed-literal::
system application-apply stx-openstack
system application-apply |prefix|-openstack
.. note::
@ -79,7 +80,7 @@ Install application manifest and helm-charts
To set the HTTPS proxy after installation, refer to
`Docker Proxy Configuration <https://docs.starlingx.io/configuration/docker_proxy_config.html>`_.
#. Wait for the activation of stx-openstack to complete.
#. Wait for the activation of |prefix|-openstack to complete.
This can take 5-10 minutes depending on the performance of your host machine.

12
doc/source/deploy_install_guides/r5_release/openstack/uninstall_delete.rst
View File

@ -30,10 +30,10 @@ Bring down OpenStack services
Use the system CLI to uninstall the OpenStack application:
::
.. parsed-literal::
system application-remove stx-openstack
system application-list
system application-remove |prefix|-openstack
system application-list
---------------------------------------
Delete OpenStack application definition
@ -41,7 +41,7 @@ Delete OpenStack application definition
Use the system CLI to delete the OpenStack application definition:
::
.. parsed-literal::
system application-delete stx-openstack
system application-list
system application-delete |prefix|-openstack
system application-list

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

@ -191,9 +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
backend.
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:
1) the host-based Ceph solution and
@ -242,8 +241,8 @@ For Rook container-based Ceph:
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the |prefix|-openstack application
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
@ -387,8 +386,8 @@ On virtual controller-0:
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the |prefix|-openstack application
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
@ -454,11 +453,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the |prefix|-openstack application
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:
.. parsed-literal::
@ -468,7 +467,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:
::

18
doc/source/deploy_install_guides/r5_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:
@ -233,8 +233,8 @@ For Rook container-based Ceph:
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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
@ -290,11 +290,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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.
::

30
doc/source/deploy_install_guides/r5_release/virtual/controller_storage_install_kubernetes.rst
View File

@ -199,8 +199,8 @@ On virtual controller-0:
This step required only if your application requires
persistent storage.
**If you want to install the StarlingX Openstack application
(stx-openstack) this step is mandatory.**
If you want to install the StarlingX Openstack application
(|prefix|-openstack) this step is mandatory.
::
@ -224,11 +224,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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:
::
@ -237,7 +237,7 @@ 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.
@ -377,11 +377,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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:
of installing the |prefix|-openstack manifest/helm-charts later:
::
@ -451,8 +451,8 @@ On virtual controller-0:
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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
@ -500,11 +500,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|prefix|-openstack) will be installed.
#. **For OpenStack only:** Assign OpenStack host labels to the worker nodes in
support of installing the stx-openstack manifest/helm-charts later:
support of installing the |prefix|-openstack manifest/helm-charts later:
::
@ -515,7 +515,7 @@ OpenStack-specific host configuration
done
#. **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:
::

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

@ -305,8 +305,8 @@ On virtual controller-0:
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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
@ -357,11 +357,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|prefix|-openstack) will be installed.
#. **For OpenStack only:** Assign OpenStack host labels to the worker nodes in
support of installing the stx-openstack manifest/helm-charts later:
support of installing the |prefix|-openstack manifest/helm-charts later:
.. parsed-literal::
@ -372,7 +372,7 @@ OpenStack-specific host configuration
done
#. **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:
::

20
doc/source/deploy_install_guides/r5_release/virtual/rook_storage_install_kubernetes.rst
View File

@ -98,11 +98,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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:
::
@ -111,7 +111,7 @@ 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.
@ -373,8 +373,8 @@ On virtual controller-0:
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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
@ -425,11 +425,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|prefix|-openstack) will be installed.
#. **For OpenStack only:** Assign OpenStack host labels to the worker nodes in
support of installing the stx-openstack manifest/helm-charts later:
support of installing the |prefix|-openstack manifest/helm-charts later:
::
@ -440,7 +440,7 @@ OpenStack-specific host configuration
done
#. **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:
::

30
doc/source/deploy_install_guides/r6_release/bare_metal/ironic_install.rst
View File

@ -126,17 +126,17 @@ Configure Ironic network on deployed standard StarlingX
Generate user Helm overrides
****************************
Ironic Helm Charts are included in the stx-openstack application. By default,
Ironic is disabled.
Ironic Helm Charts are included in the |prefix|-openstack application. By
default, Ironic is disabled.
To enable Ironic, update the following Ironic Helm Chart attributes:
::
.. parsed-literal::
system helm-override-update stx-openstack ironic openstack \
--set network.pxe.neutron_subnet_alloc_start=10.10.20.10 \
--set network.pxe.neutron_subnet_gateway=10.10.20.1 \
--set network.pxe.neutron_provider_network=ironic-data
system helm-override-update |prefix|-openstack ironic openstack \
--set network.pxe.neutron_subnet_alloc_start=10.10.20.10 \
--set network.pxe.neutron_subnet_gateway=10.10.20.1 \
--set network.pxe.neutron_provider_network=ironic-data
:command:`network.pxe.neutron_subnet_alloc_start` sets the DHCP start IP to
Neutron for Ironic node provision, and reserves several IPs for the platform.
@ -148,18 +148,18 @@ If the data network name for Ironic is changed, modify
--set network.pxe.neutron_provider_network=ironic-data
*******************************
Apply stx-openstack application
*******************************
***************************
Apply OpenStack application
***************************
Re-apply the stx-openstack application to apply the changes to Ironic:
Re-apply the |prefix|-openstack application to apply the changes to Ironic:
::
.. parsed-literal::
system helm-chart-attribute-modify stx-openstack ironic openstack \
--enabled true
system helm-chart-attribute-modify |prefix|-openstack ironic openstack \
--enabled true
system application-apply stx-openstack
system application-apply |prefix|-openstack
--------------------
Start an Ironic node

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

@ -219,11 +219,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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.
::
@ -233,7 +233,7 @@ OpenStack-specific host configuration
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.
@ -252,7 +252,7 @@ OpenStack-specific host configuration
system modify --vswitch_type none
Do not run any vSwitch directly on the host, instead, use the containerized
|OVS| defined in the helm charts of stx-openstack manifest.
|OVS| defined in the helm charts of |prefix|-openstack manifest.
To deploy |OVS|-|DPDK|, run the following command:
@ -449,11 +449,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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.
of installing the |prefix|-openstack manifest and helm-charts later.
::
@ -583,11 +583,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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.
.. only:: starlingx
@ -606,7 +606,7 @@ OpenStack-specific host configuration
:end-before: ref1-end
#. **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.
::

7
doc/source/deploy_install_guides/r6_release/openstack/access.rst
View File

@ -49,10 +49,11 @@ you can configure the DNS Server that owns `<domain_name>` with the OpenStack
service names underneath the domain.
For example:
::
system service-parameter-add openstack helm endpoint_domain=my-starlingx-domain.my-company.com
system application-apply stx-openstack
.. parsed-literal::
system service-parameter-add openstack helm endpoint_domain=my-starlingx-domain.my-company.com
system application-apply |prefix|-openstack
This command updates the helm charts of all OpenStack services and restarts them.
For example it would change `cinder‐api.openstack.svc.cluster.local` to

24
doc/source/deploy_install_guides/r6_release/openstack/install.rst
View File

@ -16,7 +16,7 @@ Install application manifest and helm-charts
--------------------------------------------
#. Modify the size of the docker_lv filesystem. By default, the size of the
docker_lv filesystem is 30G, which is not enough for stx-openstack
docker_lv filesystem is 30G, which is not enough for |prefix|-openstack
installation. Use the ``host-fs-modify`` CLI to increase the filesystem size.
The syntax is:
@ -38,7 +38,7 @@ Install application manifest and helm-charts
system host-fs-modify controller-0 docker=60
#. Get the latest StarlingX OpenStack application (stx-openstack) manifest and
#. Get the latest StarlingX OpenStack application (|prefix|-openstack) manifest and
helm charts. Use one of the following options:
* Private StarlingX build. See :ref:`Build-stx-openstack-app` for details.
@ -47,13 +47,13 @@ Install application manifest and helm-charts
After you select a release, helm charts are located in ``centos/outputs/helm-charts``.
#. Load the stx-openstack application's package into StarlingX. The tarball
package contains stx-openstack's Airship Armada manifest and stx-openstack's
set of helm charts. For example:
#. Load the |prefix|-openstack application's package into StarlingX. The tarball
package contains |prefix|-openstack's Airship Armada manifest and
|prefix|-openstack's set of helm charts. For example:
::
.. parsed-literal::
system application-upload stx-openstack-<version>-centos-stable-versioned.tgz
system application-upload |prefix|-openstack-<version>-centos-stable-versioned.tgz
This will:
@ -63,13 +63,13 @@ Install application manifest and helm-charts
the current state of the underlying StarlingX Kubernetes platform and the
recommended StarlingX configuration of OpenStack services.
#. Apply the stx-openstack application in order to bring StarlingX OpenStack into
#. Apply the |prefix|-openstack application in order to bring StarlingX OpenStack into
service. If your environment is preconfigured with a proxy server, then
make sure HTTPS proxy is set before applying stx-openstack.
make sure HTTPS proxy is set before applying |prefix|-openstack.
::
.. parsed-literal::
system application-apply stx-openstack
system application-apply |prefix|-openstack
.. note::
@ -79,7 +79,7 @@ Install application manifest and helm-charts
To set the HTTPS proxy after installation, refer to
`Docker Proxy Configuration <https://docs.starlingx.io/configuration/docker_proxy_config.html>`_.
#. Wait for the activation of stx-openstack to complete.
#. Wait for the activation of |prefix|-openstack to complete.
This can take 5-10 minutes depending on the performance of your host machine.

12
doc/source/deploy_install_guides/r6_release/openstack/uninstall_delete.rst
View File

@ -30,10 +30,10 @@ Bring down OpenStack services
Use the system CLI to uninstall the OpenStack application:
::
.. parsed-literal::
system application-remove stx-openstack
system application-list
system application-remove |prefix|-openstack
system application-list
---------------------------------------
Delete OpenStack application definition
@ -41,8 +41,8 @@ Delete OpenStack application definition
Use the system CLI to delete the OpenStack application definition:
::
.. parsed-literal::
system application-delete stx-openstack
system application-list
system application-delete |prefix|-openstack
system application-list

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

@ -242,8 +242,8 @@ For Rook container-based Ceph:
.. important::
**This step is required only if the StarlingX OpenStack application
(|prefix|-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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
@ -387,8 +387,8 @@ On virtual controller-0:
.. important::
**This step is required only if the StarlingX OpenStack application
(|prefix|-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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
@ -454,8 +454,8 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(|prefix|-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|prefix|-openstack) will be installed.
#. **For OpenStack only:** Assign OpenStack host labels to controller-1 in
support of installing the |prefix|-openstack manifest/helm-charts later:

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

@ -233,8 +233,8 @@ For Rook container-based Ceph:
.. important::
**This step is required only if the StarlingX OpenStack application
(|prefix|-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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
@ -290,8 +290,8 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(|prefix|-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|prefix|-openstack) will be installed.
#. **For OpenStack only:** Assign OpenStack host labels to controller-0 in
support of installing the |prefix|-openstack manifest/helm-charts later.

30
doc/source/deploy_install_guides/r6_release/virtual/controller_storage_install_kubernetes.rst
View File

@ -199,8 +199,8 @@ On virtual controller-0:
This step required only if your application requires
persistent storage.
**If you want to install the StarlingX Openstack application
(stx-openstack) this step is mandatory.**
If you want to install the StarlingX Openstack application
(|prefix|-openstack) this step is mandatory.
::
@ -224,11 +224,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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:
::
@ -237,7 +237,7 @@ 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.
@ -377,11 +377,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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:
of installing the |prefix|-openstack manifest/helm-charts later:
::
@ -451,8 +451,8 @@ On virtual controller-0:
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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
@ -500,11 +500,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|prefix|-openstack) will be installed.
#. **For OpenStack only:** Assign OpenStack host labels to the worker nodes in
support of installing the stx-openstack manifest/helm-charts later:
support of installing the |prefix|-openstack manifest/helm-charts later:
::
@ -515,7 +515,7 @@ OpenStack-specific host configuration
done
#. **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:
::

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

@ -305,8 +305,8 @@ On virtual controller-0:
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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
@ -357,11 +357,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|prefix|-openstack) will be installed.
#. **For OpenStack only:** Assign OpenStack host labels to the worker nodes in
support of installing the stx-openstack manifest/helm-charts later:
support of installing the |prefix|-openstack manifest/helm-charts later:
.. parsed-literal::
@ -372,7 +372,7 @@ OpenStack-specific host configuration
done
#. **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:
::

20
doc/source/deploy_install_guides/r6_release/virtual/rook_storage_install_kubernetes.rst
View File

@ -98,11 +98,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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:
::
@ -111,7 +111,7 @@ 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.
@ -373,8 +373,8 @@ On virtual controller-0:
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|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
@ -425,11 +425,11 @@ OpenStack-specific host configuration
.. important::
**This step is required only if the StarlingX OpenStack application
(stx-openstack) will be installed.**
This step is required only if the StarlingX OpenStack application
(|prefix|-openstack) will be installed.
#. **For OpenStack only:** Assign OpenStack host labels to the worker nodes in
support of installing the stx-openstack manifest/helm-charts later:
support of installing the |prefix|-openstack manifest/helm-charts later:
::
@ -440,7 +440,7 @@ OpenStack-specific host configuration
done
#. **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:
::