Merge "Apply dir convention to DC"

doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage_install_kubernetes.rst

@@ -1,3 +1,5 @@
+.. _rook_storage_install_kubernetes:
+
 =====================================================================
 Install StarlingX Kubernetes on Bare Metal Standard with Rook Storage
 =====================================================================

doc/source/dist_cloud/index.rst

@@ -1,157 +1,15 @@
-.. _dist-cloud-index:
 
+.. _dist-cloud-index:
 
 =================
 Distributed Cloud
 =================
 
-------------
-Introduction
-------------
+|prod-long| |prod-dc| configuration supports an edge computing solution
+by providing central management and orchestration for a geographically
+distributed network of |prod| systems.
 
 .. toctree::
-    :maxdepth: 1
-    :caption: Contents:
+    :maxdepth: 2
 
-    overview-of-distributed-cloud
-    distributed-cloud-architecture
-    shared-configurations
-    regionone-and-systemcontroller-modes
-    alarms-management-for-distributed-cloud
-
-------------
-Installation
-------------
-
-.. toctree::
-    :maxdepth: 1
-    :caption: Contents:
-
-    installing-and-provisioning-the-central-cloud
-    installing-and-provisioning-a-subcloud
-    installing-a-subcloud-using-redfish-platform-management-service
-    installing-a-subcloud-without-redfish-platform-management-service
-    reinstalling-a-subcloud-with-redfish-platform-management-service
-
----------
-Operation
----------
-
-.. toctree::
-    :maxdepth: 1
-    :caption: Contents:
-
-    monitoring-subclouds-using-horizon
-    managing-subclouds-using-the-cli
-    switching-to-a-subcloud-from-the-system-controller
-    synchronization-monitoring-and-control
-    cli-commands-for-dc-alarms-management
-    managing-subcloud-groups
-    creating-subcloud-groups
-    ochestration-strategy-using-subcloud-groups
-    managing-ldap-linux-user-accounts-on-the-system-controller
-    changing-the-admin-password-on-distributed-cloud
-    updating-docker-registry-credentials-on-a-subcloud
-    migrate-an-aiosx-subcloud-to-an-aiodx-subcloud
-    restoring-subclouds-from-backupdata-using-dcmanager
-    rehoming-a-subcloud
-
-----------------------
-Manage Subcloud Groups
-----------------------
-
-.. toctree::
-    :maxdepth: 1
-    :caption: Contents:
-
-    managing-subcloud-groups
-    creating-subcloud-groups
-    ochestration-strategy-using-subcloud-groups
-
--------------------------
-Update (Patch) management
--------------------------
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Contents:
-
-   update-management-for-distributed-cloud
-   reviewing-update-status-for-distributed-cloud-using-horizon
-   reviewing-update-status-for-distributed-cloud-using-the-cli
-   uploading-and-applying-updates-to-systemcontroller-using-horizon
-   uploading-and-applying-updates-to-systemcontroller-using-the-cli
-
-***************************************************************
-Update orchestration of Central Cloud's RegionOne and subclouds
-***************************************************************
-
-.. toctree::
-   :maxdepth: 1
-
-   update-orchestration-of-central-clouds-regionone-and-subclouds
-   creating-an-update-strategy-for-distributed-cloud-update-orchestration
-   customizing-the-update-configuration-for-distributed-cloud-update-orchestration
-   applying-the-update-strategy-for-distributed-cloud
-
-.. toctree::
-   :maxdepth: 1
-
-   update-orchestration-of-central-clouds-regionone-and-subclouds-using-the-cli
-
------------------------------------
-FPGA device image update management
------------------------------------
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Contents:
-
-   device-image-update-orchestration
-
-----------------------------------------------------------
-Kubernetes Version Upgrade Distributed Cloud Orchestration
-----------------------------------------------------------
-
-.. toctree::
-    :maxdepth: 1
-    :caption: Contents:
-
-    the-kubernetes-distributed-cloud-update-orchestration-process
-    configuring-kubernetes-update-orchestration-on-distributed-cloud
-
-------------------
-Upgrade management
-------------------
-
-.. toctree::
-    :maxdepth: 1
-    :caption: Contents:
-
-    upgrade-management-overview
-    upgrading-the-systemcontroller-using-the-cli
-
-*******************************************************************
-Upgrade Orchestration for Distributed Cloud SubClouds using the CLI
-*******************************************************************
-
-.. toctree::
-    :maxdepth: 1
-
-    distributed-upgrade-orchestration-process-using-the-cli
-    aborting-the-distributed-upgrade-orchestration
-    configuration-for-specific-subclouds
-    robust-error-handling-during-an-orchestrated-upgrade
-    failure-prior-to-the-installation-of-n+1-load-on-a-subcloud
-    failure-during-the-installation-or-data-migration-of-n+1-load-on-a-subcloud
-
---------
-Appendix
---------
-
-.. toctree::
-    :maxdepth: 1
-    :caption: Contents:
-
-    distributed-cloud-ports-reference
-    certificate-management-for-admin-rest-api-endpoints
+    kubernetes/index

doc/source/dist_cloud/kubernetes/configuring-kubernetes-update-orchestration-on-distributed-cloud.rst

@@ -68,7 +68,7 @@ Hosts that need to be upgraded must be in the **unlocked-enabled** state.
 
 .. only:: partner
 
-    .. include:: ../_includes/configuring-kubernetes-update-orchestration-on-distributed-cloud.rest
+    .. include:: /_includes/configuring-kubernetes-update-orchestration-on-distributed-cloud.rest
 
 All  :command:`dcmanager` strategies must be deleted.
 

doc/source/dist_cloud/kubernetes/distributed-upgrade-orchestration-process-using-the-cli.rst

@@ -325,12 +325,12 @@ the secret payload is, "username: admin password:<password>", see,
 
 .. only:: partner
 
-   .. include:: ../_includes/distributed-upgrade-orchestration-process-using-the-cli.rest
+   .. include:: /_includes/distributed-upgrade-orchestration-process-using-the-cli.rest
       :start-after: syscontroller-begin
       :end-before: syscontroller-end
 
 .. only:: partner
 
-   .. include:: ../_includes/distributed-upgrade-orchestration-process-using-the-cli.rest
+   .. include:: /_includes/distributed-upgrade-orchestration-process-using-the-cli.rest
       :start-after: dcupgrade-begin
       :end-before: dcupgrade-end

doc/source/dist_cloud/kubernetes/failure-during-the-installation-or-data-migration-of-n+1-load-on-a-subcloud.rst

@@ -91,4 +91,4 @@ and finalized. If failure occurs:
 
 .. only:: partner
 
-    .. include:: ../_includes/distributed-upgrade-orchestration-process-using-the-cli.rest
+    .. include:: /_includes/distributed-upgrade-orchestration-process-using-the-cli.rest

doc/source/dist_cloud/kubernetes/index.rst

@@ -0,0 +1,157 @@
+.. _dist-cloud-kubernetes-index:
+
+
+========
+Contents
+========
+
+------------
+Introduction
+------------
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Contents:
+
+    overview-of-distributed-cloud
+    distributed-cloud-architecture
+    shared-configurations
+    regionone-and-systemcontroller-modes
+    alarms-management-for-distributed-cloud
+
+------------
+Installation
+------------
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Contents:
+
+    installing-and-provisioning-the-central-cloud
+    installing-and-provisioning-a-subcloud
+    installing-a-subcloud-using-redfish-platform-management-service
+    installing-a-subcloud-without-redfish-platform-management-service
+    reinstalling-a-subcloud-with-redfish-platform-management-service
+
+---------
+Operation
+---------
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Contents:
+
+    monitoring-subclouds-using-horizon
+    managing-subclouds-using-the-cli
+    switching-to-a-subcloud-from-the-system-controller
+    synchronization-monitoring-and-control
+    cli-commands-for-dc-alarms-management
+    managing-subcloud-groups
+    creating-subcloud-groups
+    ochestration-strategy-using-subcloud-groups
+    managing-ldap-linux-user-accounts-on-the-system-controller
+    changing-the-admin-password-on-distributed-cloud
+    updating-docker-registry-credentials-on-a-subcloud
+    migrate-an-aiosx-subcloud-to-an-aiodx-subcloud
+    restoring-subclouds-from-backupdata-using-dcmanager
+    rehoming-a-subcloud
+
+----------------------
+Manage Subcloud Groups
+----------------------
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Contents:
+
+    managing-subcloud-groups
+    creating-subcloud-groups
+    ochestration-strategy-using-subcloud-groups
+
+-------------------------
+Update (Patch) management
+-------------------------
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   update-management-for-distributed-cloud
+   reviewing-update-status-for-distributed-cloud-using-horizon
+   reviewing-update-status-for-distributed-cloud-using-the-cli
+   uploading-and-applying-updates-to-systemcontroller-using-horizon
+   uploading-and-applying-updates-to-systemcontroller-using-the-cli
+
+***************************************************************
+Update orchestration of Central Cloud's RegionOne and subclouds
+***************************************************************
+
+.. toctree::
+   :maxdepth: 1
+
+   update-orchestration-of-central-clouds-regionone-and-subclouds
+   creating-an-update-strategy-for-distributed-cloud-update-orchestration
+   customizing-the-update-configuration-for-distributed-cloud-update-orchestration
+   applying-the-update-strategy-for-distributed-cloud
+
+.. toctree::
+   :maxdepth: 1
+
+   update-orchestration-of-central-clouds-regionone-and-subclouds-using-the-cli
+
+-----------------------------------
+FPGA device image update management
+-----------------------------------
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   device-image-update-orchestration
+
+----------------------------------------------------------
+Kubernetes Version Upgrade Distributed Cloud Orchestration
+----------------------------------------------------------
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Contents:
+
+    the-kubernetes-distributed-cloud-update-orchestration-process
+    configuring-kubernetes-update-orchestration-on-distributed-cloud
+
+------------------
+Upgrade management
+------------------
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Contents:
+
+    upgrade-management-overview
+    upgrading-the-systemcontroller-using-the-cli
+
+*******************************************************************
+Upgrade Orchestration for Distributed Cloud SubClouds using the CLI
+*******************************************************************
+
+.. toctree::
+    :maxdepth: 1
+
+    distributed-upgrade-orchestration-process-using-the-cli
+    aborting-the-distributed-upgrade-orchestration
+    configuration-for-specific-subclouds
+    robust-error-handling-during-an-orchestrated-upgrade
+    failure-prior-to-the-installation-of-n+1-load-on-a-subcloud
+    failure-during-the-installation-or-data-migration-of-n+1-load-on-a-subcloud
+
+--------
+Appendix
+--------
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Contents:
+
+    distributed-cloud-ports-reference
+    certificate-management-for-admin-rest-api-endpoints

doc/source/dist_cloud/kubernetes/installing-a-subcloud-using-redfish-platform-management-service.rst

@@ -89,7 +89,7 @@ subcloud, the subcloud installation has these phases:
        management subnet, and between the subcloud |OAM| subnet and the
        System Controller subnet.
 
-    .. include:: ../_includes/installing-a-subcloud-using-redfish-platform-management-service.rest
+    .. include:: /_includes/installing-a-subcloud-using-redfish-platform-management-service.rest
        :start-after: begin-ref-1
        :end-before: end-ref-1
 

doc/source/dist_cloud/kubernetes/installing-a-subcloud-without-redfish-platform-management-service.rst

@@ -65,7 +65,7 @@ subcloud, the subcloud installation process has two phases:
         Controller management subnet, and between the subcloud OAM subnet and
         the System Controller subnet.
 
-    .. include:: ../_includes/installing-a-subcloud-without-redfish-platform-management-service.rest
+    .. include:: /_includes/installing-a-subcloud-without-redfish-platform-management-service.rest
        :start-after: begin-ref-1
        :end-before: end-ref-1
 
@@ -142,7 +142,7 @@ subcloud, the subcloud installation process has two phases:
 #.  At the subcloud location, install the |prod| software from a USB
     device or a |PXE| Boot Server on the server designated as controller-0.
 
-    .. include:: ../_includes/installing-a-subcloud-without-redfish-platform-management-service.rest
+    .. include:: /_includes/installing-a-subcloud-without-redfish-platform-management-service.rest
        :start-after: begin-ref-1
        :end-before: end-ref-1
 

doc/source/dist_cloud/kubernetes/installing-and-provisioning-a-subcloud.rst

@@ -9,7 +9,7 @@ Install and Provision a Subcloud
 You can install and provision a subcloud with or without using the Redfish
 Platform Management Service.
 
-.. include:: ../_includes/installing-and-provisioning-a-subcloud.rest
+.. include:: /_includes/installing-and-provisioning-a-subcloud.rest
    :start-after: begin-redfish-vms
    :end-before: end-redfish-vms
 
@@ -23,6 +23,6 @@ Platform Management Service.
 
 .. only:: partner
 
-    .. include:: ../_includes/installing-and-provisioning-a-subcloud.rest
+    .. include:: /_includes/installing-and-provisioning-a-subcloud.rest
        :start-after: begin-shared-nic
        :end-before: end-shared-nic

doc/source/dist_cloud/kubernetes/installing-and-provisioning-the-central-cloud.rst

@@ -28,7 +28,7 @@ A Standard System Controller with Controller Storage is not supported.
 Complete the |prod| procedure for your deployment scenario with the
 modifications noted above and below.
 
-.. include:: ../_includes/installing-and-provisioning-the-central-cloud.rest
+.. include:: /_includes/installing-and-provisioning-the-central-cloud.rest
    :start-after: deployment-scenario-begin
    :end-before: deployment-scenario-end
 
@@ -51,7 +51,7 @@ You will also need to make the following modifications:
    installs with the Redfish Platform Management Service, and subcloud installs
    using a Ceph storage backend.
 
-.. include:: ../_includes/installing-and-provisioning-the-central-cloud.rest
+.. include:: /_includes/installing-and-provisioning-the-central-cloud.rest
 
 
 where <X.Y.Z> are replaced with the correct values for your environment.

doc/source/dist_cloud/kubernetes/migrate-an-aiosx-subcloud-to-an-aiodx-subcloud.rst

@@ -136,7 +136,7 @@ using the ansible playbook.
 
 .. only:: partner
 
-    .. include:: ../_includes/migrate-an-aiosx-subcloud-to-an-aiodx-subcloud.rest
+    .. include:: /_includes/migrate-an-aiosx-subcloud-to-an-aiodx-subcloud.rest
 
 
 .. _manually-migrate-a-subcloud-from-AIO-SX-to-AIO-DX:

doc/source/dist_cloud/kubernetes/reinstalling-a-subcloud-with-redfish-platform-management-service.rst

@@ -27,7 +27,7 @@ Executing the dcmanager subcloud reinstall command in the Central Cloud:
 
 .. only:: partner
 
-    .. include:: ../_includes/reinstalling-a-subcloud-with-redfish-platform-management-service.rest
+    .. include:: /_includes/reinstalling-a-subcloud-with-redfish-platform-management-service.rest
        :start-after: begin-ref-1
        :end-before: end-ref-1
 
@@ -83,7 +83,7 @@ Executing the dcmanager subcloud reinstall command in the Central Cloud:
 
     .. only:: partner
 
-        .. include:: ../_includes/reinstalling-a-subcloud-with-redfish-platform-management-service.rest
+        .. include:: /_includes/reinstalling-a-subcloud-with-redfish-platform-management-service.rest
             :start-after: begin-ref-2
             :end-before: end-ref-2
 
@@ -97,7 +97,7 @@ Executing the dcmanager subcloud reinstall command in the Central Cloud:
 
     .. only:: partner
 
-        .. include:: ../_includes/reinstalling-a-subcloud-with-redfish-platform-management-service.rest
+        .. include:: /_includes/reinstalling-a-subcloud-with-redfish-platform-management-service.rest
             :start-after: begin-ref-3
             :end-before: end-ref-3
 
@@ -147,7 +147,7 @@ Executing the dcmanager subcloud reinstall command in the Central Cloud:
 
 .. only:: partner
 
-    .. include:: ../_includes/reinstalling-a-subcloud-with-redfish-platform-management-service.rest
+    .. include:: /_includes/reinstalling-a-subcloud-with-redfish-platform-management-service.rest
         :start-after: begin-ref-4
         :end-before: end-ref-4
 

doc/source/dist_cloud/kubernetes/upgrade-management-overview.rst

@@ -86,4 +86,4 @@ The following prerequisites apply to a |prod-dc| upgrade management service.
 
 .. only:: partner
 
-    .. include:: ../_includes/upgrade-management-overview.rest
+    .. include:: /_includes/upgrade-management-overview.rest

doc/source/dist_cloud/kubernetes/upgrading-the-systemcontroller-using-the-cli.rst

@@ -28,7 +28,7 @@ Follow the steps below to manually upgrade the System Controller:
 
     .. only:: partner
 
-        .. include:: ../_includes/upgrading-the-systemcontroller-using-the-cli.rest
+        .. include:: /_includes/upgrading-the-systemcontroller-using-the-cli.rest
            :start-after: license-begin
            :end-before: license-end
 

doc/source/releasenotes/r5_release.rst

@@ -40,16 +40,16 @@ associated user guides (if applicable).
 
   A new storage backend rook-ceph to provide storage service to StarlingX.
 
-  Guide: :doc:`Install StarlingX Kubernetes on Bare Metal Standard with Rook
-  Storage </deploy_install_guides/r5_release/bare_metal/rook_storage_install_kubernetes>`
+  Guide: :ref:`Install StarlingX Kubernetes on Bare Metal Standard with Rook
+  Storage <rook_storage_install_kubernetes>`
 
 * FPGA image update orchestration for distributed cloud
 
   Added support for orchestrating updates to the Intel N3000 FPGA Programmable
   Acceleration Card across the subclouds in a distributed cloud configuration.
 
-  Guide:  :doc:`Device Image Update
-  Orchestration </dist_cloud/device-image-update-orchestration>`
+  Guide:  :ref:`Device Image Update
+  Orchestration <device-image-update-orchestration>`
 
 * Automatic certificate renewal for DC admin endpoints
 
@@ -59,8 +59,8 @@ associated user guides (if applicable).
   certificates. This feature adds support for automatically renewing the
   certificates associated with these ``admin`` endpoints.
 
-  Guide:  :doc:`Certificate Management for Admin REST API Endpoints
-  </dist_cloud/certificate-management-for-admin-rest-api-endpoints>`
+  Guide:  :ref:`Certificate Management for Admin REST API Endpoints
+  <certificate-management-for-admin-rest-api-endpoints>`
 
 * Vault integration for secret management support
 
@@ -78,7 +78,7 @@ associated user guides (if applicable).
     provides the ability to automatically unseal Vault pods in deployments
     where an external autounseal provider is not available.
 
-  Guide:  :doc:`Vault Overview </security/kubernetes/security-vault-overview>`
+  Guide:  :ref:`Vault Overview <security-vault-overview>`
 
 * Support for container image signature validation
 
@@ -109,13 +109,13 @@ associated user guides (if applicable).
   system application. The SNMP system application now supports both SNMPv2c
   and SNMPv3.
 
-  Guide:  :doc:`SNMP Overview </fault-mgmt/kubernetes/snmp-overview>`
+  Guide:  :ref:`SNMP Overview <snmp-overview>`
 
 * Distributed cloud scaling
 
   The distributed cloud deployment now supports up to 200 |AIO-SX| subclouds.
 
-  Guide:  :doc:`Distributed Cloud Architecture </dist_cloud/distributed-cloud-architecture>`
+  Guide:  :ref:`Distributed Cloud Architecture <distributed-cloud-architecture>`
 
 * Secure Device Onboard (SDO)
 
@@ -131,8 +131,9 @@ associated user guides (if applicable).
   Added support for Intel Ice Lake CPU, Intel Mt. Bryce eASIC (Pomona Lake),
   and Intel Columbiaville NIC.
 
-  Guides:  :doc:`Configuring VF Interfaces Rate Limiting Using the CLI
-  </node_management/kubernetes/node_interfaces/configuring-vf-interfaces-rate-limiting-using-cli>` and :doc:`Verified Commercial Hardware </planning/kubernetes/verified-commercial-hardware>`
+  Guides:  :ref:`Configuring VF Interfaces Rate Limiting Using the CLI
+  <configuring-vf-interfaces-rate-limiting-using-cli>` and :ref:`Verified
+  Commercial Hardware <verified-commercial-hardware>`
 
 
 ----------