starlingx/docs
Code Issues Proposed changes

Substitution fixes

Browse Source 
Corrections for substitutions that were not expanded in HTML output.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I6630fa73d956a795c264646445b3fac68b0815a4
This commit is contained in:
Ron Stone 2021-07-07 08:05:48 -04:00
parent 01df660f89
commit 11ae565a91
4 changed files with 55 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/dist_cloud/installing-a-subcloud-using-redfish-platform-management-service.rst
View File

@ -113,9 +113,9 @@ subcloud, the subcloud installation has these phases:
For example, :command:`--install-values /home/sysadmin/install-values.yaml`.
.. code-block:: none
.. parsed-literal::
# Specify the |pp| software version, for example 'nn.nn' for the |pp| nn.nn release of software.
# Specify the |prod| software version, for example 'nn.nn' for the |prod| nn.nn release of software.
software_version: <software_version>
bootstrap_interface: <bootstrap_interface_name> # e.g. eno1
bootstrap_address: <bootstrap_interface_ip_address> # e.g.128.224.151.183
@ -213,7 +213,7 @@ subcloud, the subcloud installation has these phases:
This configuration will install container images from the local registry on
your central cloud. The Central Cloud's local registry's HTTPS Certificate
must have the Central Cloud's |OAM| IP, **registry.local** and
**registry.central** in the certificate's SAN list. For example, a valid
**registry.central** in the certificate's |SAN| list. For example, a valid
certificate contains a |SAN| list:
.. code-block:: none
@ -228,7 +228,7 @@ subcloud, the subcloud installation has these phases:
~(keystone_admin)]$ system certificate-install -m docker_registry path_to_cert
If you prefer to install container images from the default WRS AWS ECR
If you prefer to install container images from the default WRS |AWS| ECR
external registries, make the following substitutions for the
**docker\_registries** sections of the file.
@ -253,8 +253,8 @@ subcloud, the subcloud installation has these phases:
--install-values /home/sysadmin/install-values.yaml \
--bmc-password <bmc_password>
if the ``--sysadmin-password`` is not specified, you are prompted to
enter it once the full commmand is invoked. The password is masked
If the ``--sysadmin-password`` is not specified, you are prompted to
enter it once the full command is invoked. The password is masked
when it is entered.
.. code-block:: none

10
doc/source/node_management/kubernetes/hardware_acceleration_devices/enabling-mount-bryce-hw-accelerator-for-hosted-vram-containerized-workloads.rst
View File

@ -12,7 +12,7 @@ it can be used as a HW accelerator by hosted vRAN containerized workloads on
.. rubric:: |context|
The following procedure shows an example of configuring an AIO-SX system such
The following procedure shows an example of configuring an |AIO-SX| system such
that it can support hosting a |DPDK| FlexRAN-reference-architecture container
image that uses the Mount Bryce HW accelerator. The procedure enables the
required |SRIOV| drivers, CPU policies and memory of controller-0, and then
@ -97,7 +97,7 @@ enables the Mount Bryce device.
| 1d3b | Communication controller | Intel Corporation |
| 1d2d | USB controller | Intel Corporation |
| 1d26 | USB controller | Intel Corporation |
| 1d02 | |SATA| controller | Intel Corporation |
| 1d02 | SATA controller | Intel Corporation |
| 1d22 | SMBus | Intel Corporation |
| 1d68 | Serial Attached SCSI controller | Intel Corporation |
| 1d70 | SMBus | Intel Corporation |
@ -113,9 +113,9 @@ enables the Mount Bryce device.
| C600/X79 series chipset MEI Controller #2 | 0 | False |
| C600/X79 series chipset USB2 Enhanced Host Controller #2 | 0 | False |
| C600/X79 series chipset USB2 Enhanced Host Controller #1 | 0 | False |
| C600/X79 series chipset 6-Port |SATA| AHCI Controller | 0 | False |
| C600/X79 series chipset 6-Port SATA AHCI Controller | 0 | False |
| C600/X79 series chipset SMBus Host Controller | 0 | False |
| C606 chipset Dual 4-Port |SATA|/|SAS| Storage Control uni| 0 | False |
| C606 chipset Dual 4-Port SATA/SAS Storage Control uni.. | 0 | False |
| C600/X79 series chipset SMBus Controller 0 | 0 | False |
| C608/C606/X79 series chipset SMBus Controller 1 | 0 | False |
| Device 1eb8 | 0 | False |
@ -124,7 +124,7 @@ enables the Mount Bryce device.
+----------------------------------------------------------+-----------+---------+
#. Modify the Mount Bryce device to enable it, specify the base driver and
vf driver, and configure it for 16 VFs.
vf driver, and configure it for 16 |VFs|.
.. code-block:: none

58
doc/source/storage/openstack/storage-configuring-and-management-storage-related-cli-commands.rst
View File

@ -27,13 +27,13 @@ To list the storage backend types installed on a system:
~(keystone_admin)$ system storage-backend-list
+--------+---------------+--------+-----------+----+--------+------------+
| uuid | name |backend |state |task|services|capabilities|
+--------+---------------+--------+-----------+----+--------+------------+
| 27e... |ceph-store |ceph |configured |None| None |min_repli.:1|
| | | | | | |replicati.:1|
| 502... |shared_services|external|configured |None| glance | |
+--------+---------------+--------+-----------+----+--------+------------+
+--------+-----------------+----------+------------+------+----------+--------------+
| uuid | name | backend | state | task | services | capabilities |
+--------+-----------------+----------+------------+------+----------+--------------+
| 27e... | ceph-store | ceph | configured | None | None | min_repli.:1 |
| | | | | | | replicati.:1 |
| 502... | shared_services | external | configured | None | glance | |
+--------+-----------------+----------+------------+------+----------+--------------+
@ -49,28 +49,28 @@ For example:
.. code-block:: none
~(keystone_admin)$ system storage-backend-show ceph-store
+--------------------+-------------------------------------+
|Property | Value |
+--------------------+-------------------------------------+
|backend | ceph |
|name | ceph-store |
|state | configured |
|task | None |
|services | None |
|capabilities | min_replication: 1 |
| | replication: 1 |
|object_gateway | False |
|ceph_total_space_gib| 198 |
|object_pool_gib | None |
|cinder_pool_gib | None |
|kube_pool_gib | None |
|glance_pool_gib | None |
|ephemeral_pool_gib | None |
|tier_name | storage |
|tier_uuid | d3838363-a527-4110-9345-00e299e6a252|
|created_at | 2019-08-12T21:08:50.166006+00:00 |
|updated_at | None |
+--------------------+-------------------------------------+
+----------------------+--------------------------------------+
| Property | Value |
+----------------------+--------------------------------------+
| backend | ceph |
| name | ceph-store |
| state | configured |
| task | None |
| services | None |
| capabilities | min_replication: 1 |
| | replication: 1 |
| object_gateway | False |
| ceph_total_space_gib | 198 |
| object_pool_gib | None |
| cinder_pool_gib | None |
| kube_pool_gib | None |
| glance_pool_gib | None |
| ephemeral_pool_gib | None |
| tier_name | storage |
| tier_uuid | d3838363-a527-4110-9345-00e299e6a252 |
| created_at | 2019-08-12T21:08:50.166006+00:00 |
| updated_at | None |
+----------------------+--------------------------------------+
.. _storage-configuring-and-management-storage-related-cli-commands-section-N10086-N1001C-N10001:

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

@ -29,19 +29,19 @@ where the following are optional arguments:
.. parsed-literal::
~(keystone_admin)$ system application-list
+--------------------------+----------+-------------------------------+---------------------------+----------+-----------+
| application | version | manifest name | manifest file | status | progress |
+--------------------------+----------+-------------------------------+---------------------------+----------+-----------+
| cert-manager | 20.06-5 | cert-manager-manifest | certmanager-manifest.yaml | applied | completed |
| nginx-ingress-controller | 20.06-0 | nginx-ingress-controller- | nginx_ingress_controller | applied | completed |
| | | -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| | 20.10-0- | armada-manifest | |prefix|-openstack.yaml |s| | applied | completed |
| | centos- | | | | |
| | stable- | | | | |
| | versioned| | | | |
+--------------------------+----------+-------------------------------+---------------------------+----------+-----------+
+--------------------------+-----------+-------------------------------+---------------------------+----------+-----------+
| application | version | manifest name | manifest file | status | progress |
+--------------------------+-----------+-------------------------------+---------------------------+----------+-----------+
| cert-manager | 20.06-5 | cert-manager-manifest | certmanager-manifest.yaml | applied | completed |
| nginx-ingress-controller | 20.06-0 | nginx-ingress-controller- | nginx_ingress_controller | applied | completed |
| | | -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| | 20.10-0- | armada-manifest | |prefix|-openstack.yaml |s| | applied | completed |
| | centos- | | | | |
| | stable- | | | | |
| | versioned | | | | |
+--------------------------+-----------+-------------------------------+---------------------------+----------+-----------+
The output indicates that the currently installed version of
|prefix|-openstack is 20.10-0.
@ -87,14 +87,14 @@ and the following is a positional argument which must come last:
For example:
.. code-block:: none
.. parsed-literal::
~(keystone_admin)$ system application-update |prefix|-openstack-20.10-1.tgz
#. Monitor the status of the application-apply operation until it has
completed successfully.
.. code-block:: none
.. parsed-literal::
~(keystone_admin)$ system application-show |prefix|-openstack
+---------------+----------------------------------+
@ -110,6 +110,3 @@ and the following is a positional argument which must come last:
| status | applied |
| updated_at | 2020-05-02T17:44:40.152201+00:00 |
+---------------+----------------------------------+