diff --git a/doc/source/dist_cloud/certificate-management-for-admin-rest--api-endpoints.rst b/doc/source/dist_cloud/certificate-management-for-admin-rest-api-endpoints.rst similarity index 90% rename from doc/source/dist_cloud/certificate-management-for-admin-rest--api-endpoints.rst rename to doc/source/dist_cloud/certificate-management-for-admin-rest-api-endpoints.rst index 8dad5e942..e9705b42e 100644 --- a/doc/source/dist_cloud/certificate-management-for-admin-rest--api-endpoints.rst +++ b/doc/source/dist_cloud/certificate-management-for-admin-rest-api-endpoints.rst @@ -1,6 +1,6 @@ .. ygm1607361314876 -.. 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 secure HTTPS. -Cloud Platform supports automated HTTPS certificate renewal for |prod-dc| admin +|prod| supports automated HTTPS certificate renewal for |prod-dc| admin endpoints. .. contents:: |minitoc| @@ -24,7 +24,7 @@ Certificates on the SystemController ------------------------------------ In a |prod-dc| system, the HTTPS certificates for admin endpoints are -managed by Cloud Platform internally. +managed by |prod| internally. .. note:: 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: - **DC-AdminEp-Root-CA certificate**: This certificate expires in 1825 days - \(approximately 5 years\). Renewal of this certificate starts 30 days prior to - expiry. + \(approximately 5 years\). Renewal of this certificate starts 30 days prior + to expiry. 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. - **DC-AdminEp-Intermediate-CA certificate for 'each' subcloud**: This 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 this certificate starts 30 days prior to expiry. @@ -58,7 +59,8 @@ manages the following certificates: 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: diff --git a/doc/source/dist_cloud/index.rst b/doc/source/dist_cloud/index.rst index d76d57db7..6c11ed9cf 100644 --- a/doc/source/dist_cloud/index.rst +++ b/doc/source/dist_cloud/index.rst @@ -59,4 +59,4 @@ Appendix :caption: Contents: distributed-cloud-ports-reference - certificate-management-for-admin-rest--api-endpoints + certificate-management-for-admin-rest-api-endpoints diff --git a/doc/source/fault-mgmt/kubernetes/index.rs1 b/doc/source/fault-mgmt/kubernetes/index.rs1 index 67c64bb89..0566c0eae 100644 --- a/doc/source/fault-mgmt/kubernetes/index.rs1 +++ b/doc/source/fault-mgmt/kubernetes/index.rs1 @@ -46,7 +46,7 @@ - :ref:`Setting SNMP Identifying Information ` - :ref:`Troubleshooting Log Collection ` -- Cloud Platform Alarm Messages +- |prod| Alarm Messages - :ref:`Alarm Messages Overview ` - :ref:`100 Series Alarm Messages <100-series-alarm-messages>` @@ -58,7 +58,7 @@ - :ref:`800 Series Alarm Messages <800-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:`400 Series Customer Log Messages <400-series-customer-log-messages>` diff --git a/doc/source/introduction/terms.rst b/doc/source/introduction/terms.rst index 84d19e540..8af6fb636 100644 --- a/doc/source/introduction/terms.rst +++ b/doc/source/introduction/terms.rst @@ -106,7 +106,7 @@ Node Interfaces 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 code of the services is available under an open source license that allows access and re-distribution of the codebase. The software components are diff --git a/doc/source/node_management/openstack/pci-device-access-for-vms.rst b/doc/source/node_management/openstack/pci-device-access-for-vms.rst index 32f269254..57267220d 100644 --- a/doc/source/node_management/openstack/pci-device-access-for-vms.rst +++ b/doc/source/node_management/openstack/pci-device-access-for-vms.rst @@ -30,7 +30,7 @@ cards and other |PCI| devices. - 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. @@ -38,27 +38,27 @@ For a network interface card, you can provide |VM| access by configuring the network interface. For more information, see :ref:`Configuring PCI Passthrough Ethernet Interfaces `. -For other types of device, you can provide |VM| access by assigning a |PCI| 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 -for Use by VMs ` and -:ref:`Configuring a Flavor to Use a Generic PCI Device +For other types of device, you can provide |VM| access by assigning a |PCI| +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 for +Use by VMs ` and :ref:`Configuring +a Flavor to Use a Generic PCI Device `. -- :ref:`PCI Passthrough Ethernet Interface Devices ` +- :ref:`PCI Passthrough Ethernet Interface Devices ` -- :ref:`Configuring PCI Passthrough Ethernet Interfaces ` +- :ref:`Configuring PCI Passthrough Ethernet Interfaces ` -- :ref:`PCI SR-IOV Ethernet Interface Devices ` +- :ref:`PCI SR-IOV Ethernet Interface Devices ` -- :ref:`Generic PCI Passthrough ` +- :ref:`Generic PCI Passthrough ` -- :ref:`SR-IOV Encryption Acceleration ` +- :ref:`SR-IOV Encryption Acceleration ` -- :ref:`Expose a Generic PCI Device for Use by VMs ` +- :ref:`Expose a Generic PCI Device for Use by VMs ` -- :ref:`Exposing a Generic PCI Device Using the CLI ` +- :ref:`Exposing a Generic PCI Device Using the CLI ` -- :ref:`Configure a Flavor to Use a Generic PCI Device ` +- :ref:`Configure a Flavor to Use a Generic PCI Device ` diff --git a/doc/source/planning/openstack/installation-and-resource-planning-verified-commercial-hardware.rst b/doc/source/planning/openstack/installation-and-resource-planning-verified-commercial-hardware.rst index a59c92384..1308b0de4 100755 --- a/doc/source/planning/openstack/installation-and-resource-planning-verified-commercial-hardware.rst +++ b/doc/source/planning/openstack/installation-and-resource-planning-verified-commercial-hardware.rst @@ -57,7 +57,7 @@ here. | | - Kontron Symkloud MS2920 | | | | | | .. 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 | | | | diff --git a/doc/source/planning/openstack/storage-configuration-storage-on-hosts.rst b/doc/source/planning/openstack/storage-configuration-storage-on-hosts.rst index 0b347654b..8dd4a7bc7 100755 --- a/doc/source/planning/openstack/storage-configuration-storage-on-hosts.rst +++ b/doc/source/planning/openstack/storage-configuration-storage-on-hosts.rst @@ -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. -.. xbooklink For more information, see Cloud Platform Storage Configuration: :ref:`Adding a Physical Volume `. +.. xbooklink For more information, see |stor-doc|: :ref:`Adding a Physical Volume `. .. _storage-on-storage-hosts: diff --git a/doc/source/storage/openstack/nova-ephemeral-storage.rst b/doc/source/storage/openstack/nova-ephemeral-storage.rst index cdcf8ad9e..bb7f13b78 100644 --- a/doc/source/storage/openstack/nova-ephemeral-storage.rst +++ b/doc/source/storage/openstack/nova-ephemeral-storage.rst @@ -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 controller or storage hosts\). If it is backed locally on the compute host, 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 `. Compute hosts are grouped into host aggregates based on whether they offer CoW diff --git a/doc/source/storage/openstack/replacing-a-nova-local-disk.rst b/doc/source/storage/openstack/replacing-a-nova-local-disk.rst index 952901980..6975f0581 100644 --- a/doc/source/storage/openstack/replacing-a-nova-local-disk.rst +++ b/doc/source/storage/openstack/replacing-a-nova-local-disk.rst @@ -11,8 +11,8 @@ You can replace failed nova-local disks on compute nodes. .. rubric:: |context| 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 -Worker Host `. +in |node-doc|: :ref:`Changing Hardware Components for a Worker Host +`. 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 diff --git a/doc/source/storage/openstack/replacing-the-nova-local-storage-disk-on-a-cloud-platform-simplex-system.rst b/doc/source/storage/openstack/replacing-the-nova-local-storage-disk-on-a-cloud-platform-simplex-system.rst index a784cc86e..7704d1ffe 100644 --- a/doc/source/storage/openstack/replacing-the-nova-local-storage-disk-on-a-cloud-platform-simplex-system.rst +++ b/doc/source/storage/openstack/replacing-the-nova-local-storage-disk-on-a-cloud-platform-simplex-system.rst @@ -2,9 +2,9 @@ .. syu1590591059068 .. _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 recommended for replacing or upgrading the nova-local storage device, to allow diff --git a/doc/source/storage/openstack/specifying-the-storage-type-for-vm-ephemeral-disks.rst b/doc/source/storage/openstack/specifying-the-storage-type-for-vm-ephemeral-disks.rst index 4f7a16ede..e5f78e656 100644 --- a/doc/source/storage/openstack/specifying-the-storage-type-for-vm-ephemeral-disks.rst +++ b/doc/source/storage/openstack/specifying-the-storage-type-for-vm-ephemeral-disks.rst @@ -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 Ceph storage pool configured on the storage host resources, and persists until the pool resources are reallocated for other purposes. The choice of storage -type affects migration behavior; for more information, see Cloud Platform -Storage Configuration: :ref:`VM Storage Settings for Migration, Resize, or -Evacuation `. +type affects migration behavior; for more information, see |stor-doc|: :ref:`VM +Storage Settings for Migration, Resize, or Evacuation +`. 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 @@ -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 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 -Storage Configuration: :ref:`Work with Local Volume Groups -`. +To specify the type of storage offered by a compute host, see |stor-doc|: +:ref:`Work with Local Volume Groups `. .. rubric:: |context| diff --git a/doc/source/storage/openstack/storage-configuration-and-management-storage-on-storage-hosts.rst b/doc/source/storage/openstack/storage-configuration-and-management-storage-on-storage-hosts.rst index db192b7d9..835546bcd 100644 --- a/doc/source/storage/openstack/storage-configuration-and-management-storage-on-storage-hosts.rst +++ b/doc/source/storage/openstack/storage-configuration-and-management-storage-on-storage-hosts.rst @@ -9,7 +9,7 @@ Storage on Storage Hosts |prod-os| creates default Ceph storage pools for Glance images, Cinder volumes, 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 ` guide for details on configuring the internal Ceph cluster on either controller or storage hosts. diff --git a/doc/source/storage/openstack/storage-configuring-and-management-storage-related-cli-commands.rst b/doc/source/storage/openstack/storage-configuring-and-management-storage-related-cli-commands.rst index 60fe308d5..6cf0e0d0a 100644 --- a/doc/source/storage/openstack/storage-configuring-and-management-storage-related-cli-commands.rst +++ b/doc/source/storage/openstack/storage-configuring-and-management-storage-related-cli-commands.rst @@ -8,7 +8,8 @@ Storage-Related CLI Commands You can use |CLI| commands when working with storage specific to OpenStack. -For more information, see :ref:`Cloud Platform Storage Configuration ` +For more information, see |stor-doc| :ref:`Storage Resources +`. .. _storage-configuring-and-management-storage-related-cli-commands-section-N10044-N1001C-N10001: @@ -25,7 +26,7 @@ To list the storage backend types installed on a system: .. code-block:: none ~(keystone_admin)$ system storage-backend-list - + +--------+---------------+--------+-----------+----+--------+------------+ | uuid | name |backend |state |task|services|capabilities| +--------+---------------+--------+-----------+----+--------+------------+ @@ -33,15 +34,15 @@ To list the storage backend types installed on a system: | | | | | | |replicati.:1| | 502... |shared_services|external|configured |None| glance | | +--------+---------------+--------+-----------+----+--------+------------+ - - + + To show details for a storage backend: .. code-block:: none ~(keystone_admin)$ system storage-backend-show - + For example: @@ -57,7 +58,7 @@ For example: |task | None | |services | None | |capabilities | min_replication: 1 | - | | replication: 1 | + | | replication: 1 | |object_gateway | False | |ceph_total_space_gib| 198 | |object_pool_gib | None | @@ -88,7 +89,7 @@ slightly to fit the page.\) ~(keystone_admin)$ openstack image list +----+------+-------+--------+-----------+------+--------+------------+-----------+ | ID | Name | Store | Disk | Container | Size | Status | Cache Size | Raw Cache | - | | | | Format | Format | | | | | + | | | | Format | Format | | | | | +----+------+-------+--------+-----------+------+--------+------------+-----------+ | .. | img1 | rbd | raw | bare | 1432 | active | | | | .. | img2 | file | raw | bare | 1432 | active | | | @@ -123,7 +124,7 @@ You can use this command to obtain information about a Glance image. | store | rbd | | owner | 05be70a23c81420180c51e9740dc730a | +------------------+--------------------------------------+ - + The Glance **store** value can be either file or rbd. The rbd value indicates a Ceph backend.