starlingx/docs
Code Issues Proposed changes

String cleanup

Browse Source 
Replaced some downstream terms with substitutions
Removed double dash (--) in file name and adjusted index
Fixed broken label
Incorporated comment from patchset 1

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I199481424a9630ad828c4570ac2ff0cbbb4f7c60
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
Ron Stone 2021-04-22 17:00:22 -04:00
parent 4461fa3ab8
commit af747f6e15
13 changed files with 51 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/source/dist_cloud/certificate-management-for-admin-rest--api-endpoints.rst → doc/source/dist_cloud/certificate-management-for-admin-rest-api-endpoints.rst
View File

@ -1,6 +1,6 @@
.. ygm1607361314876 .. ygm1607361314876
.. certificate-management-for-admin-rest--api-endpoints: .. _certificate-management-for-admin-rest-api-endpoints:
=================================================== ===================================================
Certificate Management for Admin REST API Endpoints Certificate Management for Admin REST API Endpoints
@ -10,7 +10,7 @@ All messaging between SystemControllers and Subclouds in the |prod-dc|
system uses the admin REST API service endpoints, which are all configured for system uses the admin REST API service endpoints, which are all configured for
secure HTTPS. secure HTTPS.
Cloud Platform supports automated HTTPS certificate renewal for |prod-dc| admin |prod| supports automated HTTPS certificate renewal for |prod-dc| admin
endpoints. endpoints.
.. contents:: |minitoc| .. contents:: |minitoc|
@ -24,7 +24,7 @@ Certificates on the SystemController
------------------------------------ ------------------------------------
In a |prod-dc| system, the HTTPS certificates for admin endpoints are In a |prod-dc| system, the HTTPS certificates for admin endpoints are
managed by Cloud Platform internally. managed by |prod| internally.
.. note:: .. note::
All renewal operations are automatic, and no user operation is required. All renewal operations are automatic, and no user operation is required.
@ -36,16 +36,17 @@ manages the following certificates:
.. certificate-management-for-admin-rest--api-endpoints-ul-zdc-pmk-xnb: .. certificate-management-for-admin-rest--api-endpoints-ul-zdc-pmk-xnb:
- **DC-AdminEp-Root-CA certificate**: This certificate expires in 1825 days - **DC-AdminEp-Root-CA certificate**: This certificate expires in 1825 days
\(approximately 5 years\). Renewal of this certificate starts 30 days prior to \(approximately 5 years\). Renewal of this certificate starts 30 days prior
expiry. to expiry.
The Root |CA| certificate is renewed on the SystemController. When the The Root |CA| certificate is renewed on the SystemController. When the
certificate is renewed, Cloud Platform renews the intermediate |CA| certificate is renewed, |prod| renews the intermediate |CA|
certificates for all subclouds. certificates for all subclouds.
- **DC-AdminEp-Intermediate-CA certificate for 'each' subcloud**: This - **DC-AdminEp-Intermediate-CA certificate for 'each' subcloud**: This
certificate expires in 365 days. Renewal of this certificate starts 30 days certificate expires in 365 days. Renewal of this certificate starts 30 days
prior to expiry. This certificate is used for all subclouds that are unmanaged. prior to expiry. This certificate is used for all subclouds that are
unmanaged.
- **DC-AdminEp-endpoint**: This certificate expires in 180 days. Renewal of - **DC-AdminEp-endpoint**: This certificate expires in 180 days. Renewal of
this certificate starts 30 days prior to expiry. this certificate starts 30 days prior to expiry.
@ -58,7 +59,8 @@ manages the following certificates:
Certificates on the Subcloud Certificates on the Subcloud
---------------------------- ----------------------------
For admin endpoints, the subcloud controllers manage the following certificates: For admin endpoints, the subcloud controllers manage the following
certificates:
.. certificate-management-for-admin-rest--api-endpoints-ul-x51-3qk-xnb: .. certificate-management-for-admin-rest--api-endpoints-ul-x51-3qk-xnb:

2
doc/source/dist_cloud/index.rst
View File

@ -59,4 +59,4 @@ Appendix
:caption: Contents: :caption: Contents:
distributed-cloud-ports-reference distributed-cloud-ports-reference
certificate-management-for-admin-rest--api-endpoints certificate-management-for-admin-rest-api-endpoints

4
doc/source/fault-mgmt/kubernetes/index.rs1
View File

@ -46,7 +46,7 @@
- :ref:`Setting SNMP Identifying Information <setting-snmp-identifying-information>` - :ref:`Setting SNMP Identifying Information <setting-snmp-identifying-information>`
- :ref:`Troubleshooting Log Collection <troubleshooting-log-collection>` - :ref:`Troubleshooting Log Collection <troubleshooting-log-collection>`
- Cloud Platform Alarm Messages - |prod| Alarm Messages
- :ref:`Alarm Messages Overview <alarm-messages-overview>` - :ref:`Alarm Messages Overview <alarm-messages-overview>`
- :ref:`100 Series Alarm Messages <100-series-alarm-messages>` - :ref:`100 Series Alarm Messages <100-series-alarm-messages>`
@ -58,7 +58,7 @@
- :ref:`800 Series Alarm Messages <800-series-alarm-messages>` - :ref:`800 Series Alarm Messages <800-series-alarm-messages>`
- :ref:`900 Series Alarm Messages <900-series-alarm-messages>` - :ref:`900 Series Alarm Messages <900-series-alarm-messages>`
- Cloud Platform Customer Log Messages - |prod| Customer Log Messages
- :ref:`200 Series Maintenance Customer Log Messages <200-series-maintenance-customer-log-messages>` - :ref:`200 Series Maintenance Customer Log Messages <200-series-maintenance-customer-log-messages>`
- :ref:`400 Series Customer Log Messages <400-series-customer-log-messages>` - :ref:`400 Series Customer Log Messages <400-series-customer-log-messages>`

2
doc/source/introduction/terms.rst
View File

@ -106,7 +106,7 @@ Node Interfaces
Only controller type nodes are required to be connected to the OAM network. Only controller type nodes are required to be connected to the OAM network.
Open Source Cloud Platform Open Source StarlingX
A set of services that can be used to build cloud infrastructure. The source A set of services that can be used to build cloud infrastructure. The source
code of the services is available under an open source license that allows code of the services is available under an open source license that allows
access and re-distribution of the codebase. The software components are access and re-distribution of the codebase. The software components are

12
doc/source/node_management/openstack/pci-device-access-for-vms.rst
View File

@ -30,7 +30,7 @@ cards and other |PCI| devices.
- large: Requests the largest available huge page size, 1GiB or 2MiB. - large: Requests the largest available huge page size, 1GiB or 2MiB.
- any: Requests any available size, including small pages. Cloud platform - any: Requests any available size, including small pages. |prod|
uses the largest available size, 1GiB, then 2MiB, and then 4KiB. uses the largest available size, 1GiB, then 2MiB, and then 4KiB.
@ -38,11 +38,11 @@ For a network interface card, you can provide |VM| access by configuring the
network interface. For more information, see :ref:`Configuring PCI Passthrough network interface. For more information, see :ref:`Configuring PCI Passthrough
Ethernet Interfaces <configure-pci-passthrough-ethernet-interfaces>`. Ethernet Interfaces <configure-pci-passthrough-ethernet-interfaces>`.
For other types of device, you can provide |VM| access by assigning a |PCI| alias For other types of device, you can provide |VM| access by assigning a |PCI|
to the device, and then referencing the |PCI| alias in a flavor extra alias to the device, and then referencing the |PCI| alias in a flavor extra
specification. For more information, see :ref:`Expose a Generic PCI Device specification. For more information, see :ref:`Expose a Generic PCI Device for
for Use by VMs <expose-a-generic-pci-device-for-use-by-vms>` and Use by VMs <expose-a-generic-pci-device-for-use-by-vms>` and :ref:`Configuring
:ref:`Configuring a Flavor to Use a Generic PCI Device a Flavor to Use a Generic PCI Device
<configuring-a-flavor-to-use-a-generic-pci-device>`. <configuring-a-flavor-to-use-a-generic-pci-device>`.
- :ref:`PCI Passthrough Ethernet Interface Devices <pci-passthrough-ethernet-interface-devices>` - :ref:`PCI Passthrough Ethernet Interface Devices <pci-passthrough-ethernet-interface-devices>`

2
doc/source/planning/openstack/installation-and-resource-planning-verified-commercial-hardware.rst
View File

@ -57,7 +57,7 @@ here.
| | - Kontron Symkloud MS2920 | | | - Kontron Symkloud MS2920 |
| | | | | |
| | .. note:: | | | .. note:: |
| | The Kontron platform does not support power ON/OFF or reset through the BMC interface on Cloud Platform. As a result, it is not possible for the system to properly fence a node in the event of a management network isolation event. In order to mitigate this, hosted application auto recovery needs to be disabled. | | | The Kontron platform does not support power ON/OFF or reset through the BMC interface on the platform. As a result, it is not possible for the system to properly fence a node in the event of a management network isolation event. In order to mitigate this, hosted application auto recovery needs to be disabled. |
+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Supported Reference Platforms | - Intel Iron Pass | | Supported Reference Platforms | - Intel Iron Pass |
| | | | | |

2
doc/source/planning/openstack/storage-configuration-storage-on-hosts.rst
View File

@ -69,7 +69,7 @@ information about this type of storage, see :ref:`Storage on Compute Hosts
You can add a physical volume using the system :command:`host-pv-add` command. You can add a physical volume using the system :command:`host-pv-add` command.
.. xbooklink For more information, see Cloud Platform Storage Configuration: :ref:`Adding a Physical Volume <adding-a-physical-volume>`. .. xbooklink For more information, see |stor-doc|: :ref:`Adding a Physical Volume <adding-a-physical-volume>`.
.. _storage-on-storage-hosts: .. _storage-on-storage-hosts:

2
doc/source/storage/openstack/nova-ephemeral-storage.rst
View File

@ -24,7 +24,7 @@ The nova-local group can be backed locally by one or more disks or partitions
on the compute host, or remotely by resources on the internal Ceph cluster \(on on the compute host, or remotely by resources on the internal Ceph cluster \(on
controller or storage hosts\). If it is backed locally on the compute host, controller or storage hosts\). If it is backed locally on the compute host,
then it uses CoW-image storage backing. For more information about then it uses CoW-image storage backing. For more information about
**nova-local** backing options, see Cloud Platform Storage Configuration: **nova-local** backing options, see |stor-doc|:
:ref:`Block Storage for Virtual Machines <block-storage-for-virtual-machines>`. :ref:`Block Storage for Virtual Machines <block-storage-for-virtual-machines>`.
Compute hosts are grouped into host aggregates based on whether they offer CoW Compute hosts are grouped into host aggregates based on whether they offer CoW

4
doc/source/storage/openstack/replacing-a-nova-local-disk.rst
View File

@ -11,8 +11,8 @@ You can replace failed nova-local disks on compute nodes.
.. rubric:: |context| .. rubric:: |context|
To replace a nova-local storage disk on a compute node, follow the instructions To replace a nova-local storage disk on a compute node, follow the instructions
in Cloud Platform Node Management: :ref:`Changing Hardware Components for a in |node-doc|: :ref:`Changing Hardware Components for a Worker Host
Worker Host <changing-hardware-components-for-a-worker-host>`. <changing-hardware-components-for-a-worker-host>`.
To avoid reconfiguration, ensure that the replacement disk is assigned to the To avoid reconfiguration, ensure that the replacement disk is assigned to the
same location on the host, and is the same size as the original. The new disk same location on the host, and is the same size as the original. The new disk

6
doc/source/storage/openstack/replacing-the-nova-local-storage-disk-on-a-cloud-platform-simplex-system.rst
View File

@ -2,9 +2,9 @@
.. syu1590591059068 .. syu1590591059068
.. _replacing-the-nova-local-storage-disk-on-a-cloud-platform-simplex-system: .. _replacing-the-nova-local-storage-disk-on-a-cloud-platform-simplex-system:
======================================================================== ===================================================
Replace Nova-local Storage Disk on a Cloud Platform Simplex System Replace Nova-local Storage Disk on a Simplex System
======================================================================== ===================================================
On a |prod-long| Simplex system, a special procedure is On a |prod-long| Simplex system, a special procedure is
recommended for replacing or upgrading the nova-local storage device, to allow recommended for replacing or upgrading the nova-local storage device, to allow

11
doc/source/storage/openstack/specifying-the-storage-type-for-vm-ephemeral-disks.rst
View File

@ -33,9 +33,9 @@ Local storage is allocated from the Local Volume Group on the host, and does
not persist when the instance is terminated. Remote storage is allocated from a not persist when the instance is terminated. Remote storage is allocated from a
Ceph storage pool configured on the storage host resources, and persists until Ceph storage pool configured on the storage host resources, and persists until
the pool resources are reallocated for other purposes. The choice of storage the pool resources are reallocated for other purposes. The choice of storage
type affects migration behavior; for more information, see Cloud Platform type affects migration behavior; for more information, see |stor-doc|: :ref:`VM
Storage Configuration: :ref:`VM Storage Settings for Migration, Resize, or Storage Settings for Migration, Resize, or Evacuation
Evacuation <vm-storage-settings-for-migration-resize-or-evacuation>`. <vm-storage-settings-for-migration-resize-or-evacuation>`.
If the instance is configured to boot from volume, the root disk is implemented If the instance is configured to boot from volume, the root disk is implemented
using persistent Cinder-based storage allocated from the controller \(for a using persistent Cinder-based storage allocated from the controller \(for a
@ -43,9 +43,8 @@ system using LVM\) or from storage hosts \(for a system using Ceph\) by
default. On a system that offers both LVM and Ceph storage backends for Cinder default. On a system that offers both LVM and Ceph storage backends for Cinder
storage, you can specify to use the LVM backend when you launch an instance. storage, you can specify to use the LVM backend when you launch an instance.
To specify the type of storage offered by a compute host, see Cloud Platform To specify the type of storage offered by a compute host, see |stor-doc|:
Storage Configuration: :ref:`Work with Local Volume Groups :ref:`Work with Local Volume Groups <work-with-local-volume-groups>`.
<work-with-local-volume-groups>`.
.. rubric:: |context| .. rubric:: |context|

2
doc/source/storage/openstack/storage-configuration-and-management-storage-on-storage-hosts.rst
View File

@ -9,7 +9,7 @@ Storage on Storage Hosts
|prod-os| creates default Ceph storage pools for Glance images, Cinder volumes, |prod-os| creates default Ceph storage pools for Glance images, Cinder volumes,
Cinder backups, and Nova ephemeral data object data. Cinder backups, and Nova ephemeral data object data.
For more information, see the :ref:`Cloud Platform Storage Configuration For more information, see the |stor-doc|: :ref:`Storage Resources
<storage-configuration-storage-resources>` guide for details on configuring the <storage-configuration-storage-resources>` guide for details on configuring the
internal Ceph cluster on either controller or storage hosts. internal Ceph cluster on either controller or storage hosts.

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

@ -8,7 +8,8 @@ Storage-Related CLI Commands
You can use |CLI| commands when working with storage specific to OpenStack. You can use |CLI| commands when working with storage specific to OpenStack.
For more information, see :ref:`Cloud Platform Storage Configuration <storage-configuration-storage-resources>` For more information, see |stor-doc| :ref:`Storage Resources
<storage-configuration-storage-resources>`.
.. _storage-configuring-and-management-storage-related-cli-commands-section-N10044-N1001C-N10001: .. _storage-configuring-and-management-storage-related-cli-commands-section-N10044-N1001C-N10001: