starlingx/docs
Code Issues Proposed changes

Merge "Replace stx with prefix substitution (1 of 3)"

Browse Source
This commit is contained in:
Zuul 2021-11-19 19:10:55 +00:00 committed by Gerrit Code Review
commit 787c9ade9e
10 changed files with 120 additions and 121 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
doc/source/admintasks/kubernetes/admin-application-commands-and-helm-overrides.rst
View File

@ -29,19 +29,19 @@ commands to manage containerized applications provided as part of |prod|.
For example:
.. code-block:: none
.. parsed-literal::
~(keystone_admin)]$ system application-list --nowrap
+-------------+---------+---------------+---------------+----------+-----------+
| application | version | manifest name | manifest file | status | progress |
+-------------+---------+---------------+---------------+----------+-----------+
| platform- | 1.0-7 | platform- | manifest.yaml | applied | completed |
| integ-apps | | integration- | | | |
| | | manifest | | | |
| stx- | 1.0-18 | armada- | stx-openstack | uploaded | completed |
| openstack | | manifest | .yaml | | |
+-------------+---------+---------------+---------------+----------+-----------+
+--------------+---------+---------------+----------------+----------+-----------+
| application | version | manifest name | manifest file | status | progress |
+--------------+---------+---------------+----------------+----------+-----------+
| platform- | 1.0-7 | platform- | manifest.yaml | applied | completed |
| integ-apps | | integration- | | | |
| | | manifest | | | |
| |prefix|-|s| | 1.0-18 | armada- | |prefix|- |s| | uploaded | completed |
| openstack | | manifest | openstack.yaml | | |
+--------------+---------+---------------+----------------+----------+-----------+
- Use the following command to show details for |prod|.
@ -56,9 +56,9 @@ commands to manage containerized applications provided as part of |prod|.
For example:
.. code-block:: none
.. parsed-literal::
~(keystone_admin)]$ system application-show stx-openstack
~(keystone_admin)]$ system application-show |prefix|-openstack
+---------------+----------------------------------+
| Property | Value |
@ -66,9 +66,9 @@ commands to manage containerized applications provided as part of |prod|.
| active | False |
| app_version | 1.0-18 |
| created_at | 2019-09-06T15:34:03.194150+00:00 |
| manifest_file | stx-openstack.yaml |
| manifest_file | |prefix|-openstack.yaml |s| |
| manifest_name | armada-manifest |
| name | stx-openstack |
| name | |prefix|-openstack |s| |
| progress | completed |
| status | uploaded |
| updated_at | 2019-09-06T15:34:46.995929+00:00 |
@ -97,24 +97,24 @@ commands to manage containerized applications provided as part of |prod|.
For example:
.. code-block:: none
.. parsed-literal::
~(keystone_admin)]$ system application-upload stx-openstack-1.0-18.tgz
~(keystone_admin)]$ system application-upload |prefix|-openstack-1.0-18.tgz
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | False |
| app_version | 1.0-18 |
| created_at | 2019-09-06T15:34:03.194150+00:00 |
| manifest_file | stx-openstack.yaml |
| manifest_file | |prefix|-openstack.yaml |s| |
| manifest_name | armada-manifest |
| name | stx-openstack |
| name | |prefix|-openstack |s| |
| progress | None |
| status | uploading |
| updated_at | None |
+---------------+----------------------------------+
Please use 'system application-list' or 'system application-show
stx-openstack' to view the current progress.
Please use 'system application-list' or 'system application-show |prefix|-openstack'
to view the current progress.
- To list the Helm chart overrides for the |prod|, use the following
command:
@ -139,9 +139,9 @@ commands to manage containerized applications provided as part of |prod|.
For example:
.. code-block:: none
.. parsed-literal::
~(keystone_admin)]$ system helm-override-list stx-openstack --long
~(keystone_admin)]$ system helm-override-list |prefix|-openstack --long
+---------------------+--------------------------------+---------------+
| chart name | overrides namespaces | chart enabled |
+---------------------+--------------------------------+---------------+
@ -188,7 +188,7 @@ commands to manage containerized applications provided as part of |prod|.
**<app_name>**
The name of the application.
**< chart_name>**
**<chart_name>**
The name of the chart.
**<namespace>**
@ -196,9 +196,9 @@ commands to manage containerized applications provided as part of |prod|.
For example:
.. code-block:: none
.. parsed-literal::
~(keystone_admin)]$ system helm-override-show stx-openstack glance openstack
~(keystone_admin)]$ system helm-override-show |prefix|-openstack glance openstack
- To modify service configuration parameters using user-specified overrides,
use the following command. To update a single configuration parameter, you
@ -243,9 +243,10 @@ commands to manage containerized applications provided as part of |prod|.
For example, to enable the glance debugging log, use the following
command:
.. code-block:: none
.. parsed-literal::
~(keystone_admin)]$ system helm-override-update stx-openstack glance openstack --set conf.glance.DEFAULT.DEBUG=true
~(keystone_admin)]$ system helm-override-update |prefix|-openstack
glance openstack --set conf.glance.DEFAULT.DEBUG=true
+----------------+-------------------+
| Property | Value |
+----------------+-------------------+
@ -313,10 +314,10 @@ commands to manage containerized applications provided as part of |prod|.
For example:
.. code-block:: none
.. parsed-literal::
~(keystone_admin)]$ system helm-override-delete stx-openstack glance openstack
Deleted chart overrides glance:openstack for application stx-openstack
~(keystone_admin)]$ system helm-override-delete |prefix|-openstack glance openstack
Deleted chart overrides glance:openstack for application |prefix|-openstack
- Use the following command to apply or reapply an application, making it
available for service.
@ -330,7 +331,7 @@ commands to manage containerized applications provided as part of |prod|.
**mode**
An application-specific mode controlling how the manifest is
applied. This option is used to delete and restore the
**stx-openstack** application.
|prefix|-openstack application.
and the following is a positional argument:
@ -339,24 +340,24 @@ commands to manage containerized applications provided as part of |prod|.
For example:
.. code-block:: none
.. parsed-literal::
~(keystone_admin)]$ system application-apply stx-openstack
~(keystone_admin)]$ system application-apply |prefix|-openstack
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | False |
| app_version | 1.0-18 |
| created_at | 2019-09-06T15:34:03.194150+00:00 |
| manifest_file | stx-openstack.yaml |
| manifest_file | |prefix|-openstack.yaml |s| |
| manifest_name | armada-manifest |
| name | stx-openstack |
| name | |prefix|-openstack |s| |
| progress | None |
| status | applying |
| updated_at | 2019-09-06T15:34:46.995929+00:00 |
+---------------+----------------------------------+
Please use 'system application-list' or 'system application-show
stx-openstack' to view the current progress.
Please use 'system application-list' or 'system application-show |prefix|-openstack'
to view the current progress.
- Use the following command to abort the current application.
@ -371,9 +372,9 @@ commands to manage containerized applications provided as part of |prod|.
For example:
.. code-block:: none
.. parsed-literal::
~(keystone_admin)]$ system application-abort stx-openstack
~(keystone_admin)]$ system application-abort |prefix|-openstack
Application abort request has been accepted. If the previous operation has not
completed/failed, it will be cancelled shortly.
@ -436,24 +437,24 @@ commands to manage containerized applications provided as part of |prod|.
For example:
.. code-block:: none
.. parsed-literal::
~(keystone_admin)]$ system application-remove stx-openstack
~(keystone_admin)]$ system application-remove |prefix|-openstack
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | False |
| app_version | 1.0-18 |
| created_at | 2019-09-06T15:34:03.194150+00:00 |
| manifest_file | stx-openstack.yaml |
| manifest_file | |prefix|-openstack.yaml |s| |
| manifest_name | armada-manifest |
| name | stx-openstack |
| name | |prefix|-openstack |s| |
| progress | None |
| status | removing |
| updated_at | 2019-09-06T17:39:19.813754+00:00 |
+---------------+----------------------------------+
Please use 'system application-list' or 'system application-show
stx-openstack' to view the current progress.
Please use 'system application-list' or 'system application-show |prefix|-openstack'
to view the current progress.
This command places the application in the uploaded state.
@ -473,7 +474,7 @@ commands to manage containerized applications provided as part of |prod|.
For example:
.. code-block:: none
.. parsed-literal::
~(keystone_admin)]$ system application-delete stx-openstack
Application stx-openstack deleted.
~(keystone_admin)]$ system application-delete |prefix|-openstack
Application |prefix|-openstack deleted.

4
doc/source/admintasks/kubernetes/freeing-space-in-the-local-docker-registry.rst
View File

@ -64,8 +64,8 @@ associated space from the file system. To do so, you must also run the
download the deleted image from the same source and push it back into
the local Docker registry under the same name and tag.
If you need to free space consumed by **stx-openstack** images, you can
delete older tagged versions.
If you need to free space consumed by |prefix|-openstack images, you
can delete older tagged versions.
#. Free up file system space associated with the deleted/unreferenced images.

4
doc/source/dist_cloud/kubernetes/configuration-for-specific-subclouds.rst
View File

@ -23,7 +23,7 @@ The following settings are applied by default:
- alarm restriction type: relaxed
- default instance action: migrate \(This parameter is only applicable to
hosted application |VMs| with the stx-openstack application.\)
hosted application |VMs| with the |prefix|-openstack application.\)
To update the default values, use the :command:`dcmanager strategy-config
@ -107,7 +107,7 @@ individual subclouds.
.. note::
This parameter is only applicable to hosted application |VMs| with
the stx-openstack application.
the |prefix|-openstack application.
migrate or stop-start — determines whether hosted application |VMs| are
migrated or stopped and restarted when a worker host is upgraded

4
doc/source/dist_cloud/kubernetes/customizing-the-update-configuration-for-distributed-cloud-update-orchestration.rst
View File

@ -74,7 +74,7 @@ independently.
.. note::
This parameter is only applicable to hosted application VMs with
the stx-openstack application.
the |prefix|-openstack application.
migrate or stop-start — determines whether hosted application VMs are
migrated or stopped and restarted when a worker host is upgraded
@ -89,7 +89,7 @@ independently.
For information about creating and applying a patch strategy, see :ref:`Update
Management for Distributed Cloud <update-management-for-distributed-cloud>`.
**Related information**
**Related information**
.. seealso::

26
doc/source/dist_cloud/kubernetes/update-orchestration-of-central-clouds-regionone-and-subclouds-using-the-cli.rst
View File

@ -70,7 +70,7 @@ available:
[–-stop-on-failure <level>] \
[--group group] \
[<subcloud>]
For example:
@ -114,7 +114,7 @@ available:
| created_at | 2018-02-02T14:42:13.822499 |
| updated_at | None |
+------------------------+----------------------------+
.. note::
@ -136,7 +136,7 @@ available:
| created_at | 2018-02-02T14:42:13.822499 |
| updated_at | 2018-02-02T14:42:19.376688 |
+------------------------+----------------------------+
- To show the step currently being performed on each of the subclouds, use
the :command:`strategy-step list` command.
@ -155,7 +155,7 @@ available:
| subcloud-5 | 2 | finishing | | 2018-03-13 14:16:02.473669 | None |
| subcloud-6 | 2 | applying... | apply phase is 66% complete | 2018-03-13 14:16:02.483422 | None |
+------------------+-------+-------------+-----------------------------+----------------------------+----------------------------+
- To show the step currently being performed on a subcloud, use the
:command:`strategy-step show` <subcloud> command.
@ -191,7 +191,7 @@ available:
| created_at | 2018-03-23T20:04:50.992444 |
| updated_at | 2018-03-23T20:05:14.157352 |
+------------------------+----------------------------+
.. _update-orchestration-of-central-clouds-regionone-and-subclouds-using-the-cli-section-N1022D-N10029-N10001:
@ -245,7 +245,7 @@ individual subclouds.
| all clouds default | parallel | parallel | 10 | relaxed | migrate |
| subcloud-6 | parallel | parallel | 2 | relaxed | stop-start |
+--------------------+--------------------+--------------------+-----------------------+------------------------+------------------+
- To show the configuration settings applicable to all subclouds by default,
use the :command:`patch-strategy-config show` command.
@ -264,7 +264,7 @@ individual subclouds.
| created_at | None |
| updated_at | None |
+-------------------------+--------------------+
- To update the settings, or to create a custom configuration for a subcloud,
use the :command:`patch-strategy-config update` command.
@ -296,18 +296,16 @@ individual subclouds.
**alarm restriction type**
relaxed or strict — determines whether the orchestration is aborted for
alarms that are not management-affecting. For more information, refer
to the
.. xbooklink :ref:`|updates-doc| <software-updates-and-upgrades-software-updates>` guide.
to |updates-doc|: :ref:`Configure Update Orchestration <configuring-update-orchestration>`.
**default instance action**
.. note::
This parameter is only applicable to hosted application VMs with
the stx-openstack application.
the |prefix|-openstack application.
migrate or stop-start — determines whether hosted application VMs are
migrated or stopped and restarted when a worker host is upgraded
migrated or stopped and restarted when a worker host is upgraded.
**subcloud\_name**
The name of the subcloud to use the custom strategy. If this omitted,
@ -323,7 +321,7 @@ individual subclouds.
.. code-block:: none
~(keystone_admin)]$ dcmanager patch-strategy-config show [<name>]
For example:
@ -342,7 +340,7 @@ individual subclouds.
| created_at | 2018-03-12 20:08:48.917866 |
| updated_at | None |
+-------------------------+----------------------------+
If custom configuration settings have not been created for the subcloud,
the following message is displayed:

2
doc/source/updates/kubernetes/configuring-update-orchestration.rst
View File

@ -101,7 +101,7 @@ status before creating a update strategy.
- Ignore: Worker hosts will not be updated
**Default Instance Action**
This parameter only applies for systems with the stx-openstack
This parameter only applies for systems with the |prefix|-openstack
application.
- Stop-Start \(default\): hosted applications VMs will be stopped

80
doc/source/updates/kubernetes/firmware-update-orchestration-using-the-cli.rst
View File

@ -44,7 +44,7 @@ ignored even when strict restrictions are selected:
- 900.301: Firmware update auto apply in progress
You can use 'help' for the overall commands and also for each sub-command. For
You can use ``help`` for the overall commands and also for each sub-command. For
example:
.. code-block:: none
@ -71,7 +71,7 @@ firmware update strategy with default settings. A firmware update strategy can
be created with override worker apply type concurrency with a max host
parallelism, instance action, and alarm restrictions.
**--controller-apply-type, and --storage-apply-type**
``--controller-apply-type`` and ``--storage-apply-type``
These options cannot be changed from '**ignore**' because firmware update
is only supported for worker hosts.
@ -81,53 +81,53 @@ is only supported for worker hosts.
function. Any attempt to modify the controller or storage apply type is
rejected.
**--worker-apply-type**
``--worker-apply-type``
This option specifies the host concurrency of the firmware update strategy:
- serial \(default\): worker hosts will be patched one at a time
- ``serial`` \(default\): worker hosts will be patched one at a time
- parallel: worker hosts will be updated in parallel
- ``parallel``: worker hosts will be updated in parallel
- At most, **parallel** will be updated at the same time
- At most, ``parallel`` will be updated at the same time
- At most, half of the hosts in a host aggregate will be updated at the
same time
- ignore: worker hosts will not be updated; strategy create will fail
- ``ignore``: worker hosts will not be updated; strategy create will fail
Worker hosts with no instances are updated before worker hosts with instances.
**--max-parallel-worker-hosts**
``--max-parallel-worker-hosts``
This option applies to the parallel worker apply type selection to specify
the maximum worker hosts to update in parallel \(minimum: 2, maximum: 10\).
**–instance-action**
``-–instance-action``
This option only has significance when the stx-openstack application is
This option only has significance when the |prefix|-openstack application is
loaded and there are instances running on worker hosts. It specifies how
the strategy deals with worker host instances over the strategy execution.
**stop-start \(default\)**
- ``stop-start`` (default)
Instances will be stopped before the host lock operation following the
update and then started again following the host unlock.
Instances will be stopped before the host lock operation following the
update and then started again following the host unlock.
.. warning::
Using the **stop-start** option will result in an outage for each
instance, as it is stopped while the worker host is locked/unlocked. In
order to ensure this does not impact service, instances MUST be grouped
into anti-affinity \(or anti-affinity best effort\) server groups,
which will ensure that only a single instance in each server group is
stopped at a time.
.. warning::
Using the ``stop-start`` option will result in an outage for each
instance, as it is stopped while the worker host is locked/unlocked. In
order to ensure this does not impact service, instances MUST be grouped
into anti-affinity \(or anti-affinity best effort\) server groups,
which will ensure that only a single instance in each server group is
stopped at a time.
**migrate**
- ``migrate``
Instances will be migrated off a host before it is patched \(this applies
to reboot patching only\).
Instances will be migrated off a host before it is patched \(this applies
to reboot patching only\).
**--alarm-restrictions**
``--alarm-restrictions``
This option sets how the how the firmware update orchestration behaves when
alarms are present.
@ -138,16 +138,16 @@ To display management-affecting active alarms, use the following command:
~(keystone_admin)$ fm alarm-list --mgmt_affecting
**strict \(default\)**
- ``strict`` (default)
The default strict option will result in patch orchestration failing if
there are any alarms present in the system \(except for a small list of
alarms\).
The default strict option will result in patch orchestration failing if
there are any alarms present in the system \(except for a small list of
alarms\).
**relaxed**
- ``relaxed``
This option allows orchestration to proceed if alarms are present, as long
as none of these alarms are management affecting.
This option allows orchestration to proceed if alarms are present, as long
as none of these alarms are management affecting.
.. code-block:: none
@ -184,9 +184,9 @@ as none of these alarms are management affecting.
Firmware update orchestration strategy show
-------------------------------------------
The :command:`show` strategy subcommand displays a summary of the current state
The ``show`` strategy subcommand displays a summary of the current state
of the strategy. A complete view of the strategy can be shown using the
**--details** option.
``--details`` option.
.. code-block:: none
@ -203,10 +203,10 @@ of the strategy. A complete view of the strategy can be shown using the
Firmware update orchestration strategy apply
--------------------------------------------
The :command:`apply` strategy subcommand with no options executes the firmware
The ``apply`` strategy subcommand with no options executes the firmware
update strategy from current state to the end. The apply strategy operation can
be called with the **stage-id** option to execute the next stage of the
strategy. The **stage-id** option cannot be used to execute the strategy out of
be called with the ``stage-id`` option to execute the next stage of the
strategy. The ``stage-id`` option cannot be used to execute the strategy out of
order.
.. code-block:: none
@ -224,10 +224,10 @@ order.
Firmware update orchestration strategy abort
--------------------------------------------
The **abort** strategy subcommand with no options sets the strategy to abort
The ``abort`` strategy subcommand with no options sets the strategy to abort
after the current applying stage is complete. The abort strategy operation can
be called with the **stage-id** option to specify that the strategy abort
before executing the next stage of the strategy. The **stage-id** option cannot
be called with the ``stage-id`` option to specify that the strategy abort
before executing the next stage of the strategy. The ``stage-id`` option cannot
be used to execute the strategy out of order.
.. code-block:: none
@ -245,7 +245,7 @@ be used to execute the strategy out of order.
Firmware update orchestration strategy delete
---------------------------------------------
The **delete** strategy subcommand with no options deletes a strategy.
The ``delete`` strategy subcommand with no options deletes a strategy.
.. code-block:: none

8
doc/source/updates/kubernetes/overview-of-firmware-update-orchestration.rst
View File

@ -37,10 +37,10 @@ following conditions:
creation step will fail if there are no qualified hosts detected.
- Firmware update is a reboot required operation. Therefore, in systems that
have the stx-openstack application applied with running instances, if the
migrate option is selected there must be spare openstack-compute \(worker\)
capacity to move instances off the openstack-compute \(worker\) host\(s\)
being updated.
have the |prefix|-openstack application applied with running instances, if
the migrate option is selected there must be spare openstack-compute \
(worker\) capacity to move instances off the openstack-compute \
(worker\) host\(s\) being updated.
.. note::
Administrative controller Swacts should be avoided during firmware

12
doc/source/updates/kubernetes/the-firmware-update-orchestration-process.rst
View File

@ -27,10 +27,10 @@ parameters:
**parallel** mode is selected
For hosts that have the stx-openstack application running with active instances
and since the firmware update is a reboot required operation for a host, the
strategy offers **stop/start** or **migrate** options for managing instances
over the **lock/unlock** \(reboot\) steps in the update process.
For hosts that have the |prefix|-openstack application running with active
instances and since the firmware update is a reboot required operation for a
host, the strategy offers **stop/start** or **migrate** options for managing
instances over the **lock/unlock** \(reboot\) steps in the update process.
You must use the **sw-manager** |CLI| tool to **create**, and then **apply** the
update strategy. A created strategy can be monitored with the **show** command.
@ -79,12 +79,12 @@ steps involved in a firmware update for a single or group of hosts include:
#. Unlock Host – reboots the host so the updated image is used.
Systems with stx-openstack application enabled could include additional
Systems with |prefix|-openstack application enabled could include additional
instance management steps. For more information, see :ref:`Firmware Update
Operations Requiring Manual Migration
<firmware-update-operations-requiring-manual-migration>`.
On systems with stx-openstack application, the *Firmware Update Orchestration
On systems with |prefix|-openstack application, the *Firmware Update Orchestration
Strategy* considers any configured server groups and host aggregates when
creating the stages to reduce the impact to running instances. The *Firmware
Update Orchestration Strategy* automatically manages the instances during the

4
doc/source/updates/openstack/apply-update-to-the-stx-openstack-application.rst
View File

@ -3,7 +3,7 @@
.. _apply-update-to-the-stx-openstack-application:
=========================================
Apply Update to the Openstack Application
Apply Update to the OpenStack Application
=========================================
|prod-os| is managed using the StarlingX Application Package Manager.
@ -37,7 +37,7 @@ where the following are optional arguments:
| | | -manifest | _manifest.yaml | | |
| oidc-auth-apps | 20.06-28 | oidc-auth-manifest | manifest.yaml | uploaded | completed |
| platform-integ-apps | 20.06-11 | platform-integration-manifest | manifest.yaml | applied | completed |
| |prefix|-openstack |s| | 21.07-0- | armada-manifest | |prefix|-openstack.yaml |s| | applied | completed |
| |prefix|-openstack |s| | 21.07-0- | armada-manifest | |prefix|-openstack.yaml |s| | applied | completed |
| | centos- | | | | |
| | stable- | | | | |
| | versioned | | | | |