diff --git a/doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage_install_kubernetes.rst index 16fb3114c..ab64aab32 100644 --- a/doc/source/deploy_install_guides/r5_release/bare_metal/rook_storage_install_kubernetes.rst +++ b/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 ===================================================================== diff --git a/doc/source/dist_cloud/index.rst b/doc/source/dist_cloud/index.rst index ccaa40660..d7ea13cff 100644 --- a/doc/source/dist_cloud/index.rst +++ b/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 diff --git a/doc/source/dist_cloud/aborting-the-distributed-upgrade-orchestration.rst b/doc/source/dist_cloud/kubernetes/aborting-the-distributed-upgrade-orchestration.rst similarity index 100% rename from doc/source/dist_cloud/aborting-the-distributed-upgrade-orchestration.rst rename to doc/source/dist_cloud/kubernetes/aborting-the-distributed-upgrade-orchestration.rst diff --git a/doc/source/dist_cloud/alarms-management-for-distributed-cloud.rst b/doc/source/dist_cloud/kubernetes/alarms-management-for-distributed-cloud.rst similarity index 100% rename from doc/source/dist_cloud/alarms-management-for-distributed-cloud.rst rename to doc/source/dist_cloud/kubernetes/alarms-management-for-distributed-cloud.rst diff --git a/doc/source/dist_cloud/applying-the-update-strategy-for-distributed-cloud.rst b/doc/source/dist_cloud/kubernetes/applying-the-update-strategy-for-distributed-cloud.rst similarity index 100% rename from doc/source/dist_cloud/applying-the-update-strategy-for-distributed-cloud.rst rename to doc/source/dist_cloud/kubernetes/applying-the-update-strategy-for-distributed-cloud.rst diff --git a/doc/source/dist_cloud/certificate-management-for-admin-rest-api-endpoints.rst b/doc/source/dist_cloud/kubernetes/certificate-management-for-admin-rest-api-endpoints.rst similarity index 100% rename from doc/source/dist_cloud/certificate-management-for-admin-rest-api-endpoints.rst rename to doc/source/dist_cloud/kubernetes/certificate-management-for-admin-rest-api-endpoints.rst diff --git a/doc/source/dist_cloud/changing-the-admin-password-on-distributed-cloud.rst b/doc/source/dist_cloud/kubernetes/changing-the-admin-password-on-distributed-cloud.rst similarity index 100% rename from doc/source/dist_cloud/changing-the-admin-password-on-distributed-cloud.rst rename to doc/source/dist_cloud/kubernetes/changing-the-admin-password-on-distributed-cloud.rst diff --git a/doc/source/dist_cloud/cli-commands-for-dc-alarms-management.rst b/doc/source/dist_cloud/kubernetes/cli-commands-for-dc-alarms-management.rst similarity index 100% rename from doc/source/dist_cloud/cli-commands-for-dc-alarms-management.rst rename to doc/source/dist_cloud/kubernetes/cli-commands-for-dc-alarms-management.rst diff --git a/doc/source/dist_cloud/configuration-for-specific-subclouds.rst b/doc/source/dist_cloud/kubernetes/configuration-for-specific-subclouds.rst similarity index 100% rename from doc/source/dist_cloud/configuration-for-specific-subclouds.rst rename to doc/source/dist_cloud/kubernetes/configuration-for-specific-subclouds.rst diff --git a/doc/source/dist_cloud/configuring-kubernetes-update-orchestration-on-distributed-cloud.rst b/doc/source/dist_cloud/kubernetes/configuring-kubernetes-update-orchestration-on-distributed-cloud.rst similarity index 99% rename from doc/source/dist_cloud/configuring-kubernetes-update-orchestration-on-distributed-cloud.rst rename to doc/source/dist_cloud/kubernetes/configuring-kubernetes-update-orchestration-on-distributed-cloud.rst index 2370afe4e..397ab4462 100644 --- a/doc/source/dist_cloud/configuring-kubernetes-update-orchestration-on-distributed-cloud.rst +++ b/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. diff --git a/doc/source/dist_cloud/creating-an-update-strategy-for-distributed-cloud-update-orchestration.rst b/doc/source/dist_cloud/kubernetes/creating-an-update-strategy-for-distributed-cloud-update-orchestration.rst similarity index 100% rename from doc/source/dist_cloud/creating-an-update-strategy-for-distributed-cloud-update-orchestration.rst rename to doc/source/dist_cloud/kubernetes/creating-an-update-strategy-for-distributed-cloud-update-orchestration.rst diff --git a/doc/source/dist_cloud/creating-subcloud-groups.rst b/doc/source/dist_cloud/kubernetes/creating-subcloud-groups.rst similarity index 100% rename from doc/source/dist_cloud/creating-subcloud-groups.rst rename to doc/source/dist_cloud/kubernetes/creating-subcloud-groups.rst diff --git a/doc/source/dist_cloud/customizing-the-update-configuration-for-distributed-cloud-update-orchestration.rst b/doc/source/dist_cloud/kubernetes/customizing-the-update-configuration-for-distributed-cloud-update-orchestration.rst similarity index 100% rename from doc/source/dist_cloud/customizing-the-update-configuration-for-distributed-cloud-update-orchestration.rst rename to doc/source/dist_cloud/kubernetes/customizing-the-update-configuration-for-distributed-cloud-update-orchestration.rst diff --git a/doc/source/dist_cloud/device-image-update-orchestration.rst b/doc/source/dist_cloud/kubernetes/device-image-update-orchestration.rst similarity index 100% rename from doc/source/dist_cloud/device-image-update-orchestration.rst rename to doc/source/dist_cloud/kubernetes/device-image-update-orchestration.rst diff --git a/doc/source/dist_cloud/distributed-cloud-architecture.rst b/doc/source/dist_cloud/kubernetes/distributed-cloud-architecture.rst similarity index 100% rename from doc/source/dist_cloud/distributed-cloud-architecture.rst rename to doc/source/dist_cloud/kubernetes/distributed-cloud-architecture.rst diff --git a/doc/source/dist_cloud/distributed-cloud-ports-reference.rst b/doc/source/dist_cloud/kubernetes/distributed-cloud-ports-reference.rst similarity index 100% rename from doc/source/dist_cloud/distributed-cloud-ports-reference.rst rename to doc/source/dist_cloud/kubernetes/distributed-cloud-ports-reference.rst diff --git a/doc/source/dist_cloud/distributed-upgrade-orchestration-process-using-the-cli.rst b/doc/source/dist_cloud/kubernetes/distributed-upgrade-orchestration-process-using-the-cli.rst similarity index 98% rename from doc/source/dist_cloud/distributed-upgrade-orchestration-process-using-the-cli.rst rename to doc/source/dist_cloud/kubernetes/distributed-upgrade-orchestration-process-using-the-cli.rst index 1a120d90f..2a2408a93 100644 --- a/doc/source/dist_cloud/distributed-upgrade-orchestration-process-using-the-cli.rst +++ b/doc/source/dist_cloud/kubernetes/distributed-upgrade-orchestration-process-using-the-cli.rst @@ -325,12 +325,12 @@ the secret payload is, "username: admin 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 diff --git a/doc/source/dist_cloud/failure-during-the-installation-or-data-migration-of-n+1-load-on-a-subcloud.rst b/doc/source/dist_cloud/kubernetes/failure-during-the-installation-or-data-migration-of-n+1-load-on-a-subcloud.rst similarity index 96% rename from doc/source/dist_cloud/failure-during-the-installation-or-data-migration-of-n+1-load-on-a-subcloud.rst rename to doc/source/dist_cloud/kubernetes/failure-during-the-installation-or-data-migration-of-n+1-load-on-a-subcloud.rst index d60408a1a..b70f02642 100644 --- a/doc/source/dist_cloud/failure-during-the-installation-or-data-migration-of-n+1-load-on-a-subcloud.rst +++ b/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 \ No newline at end of file + .. include:: /_includes/distributed-upgrade-orchestration-process-using-the-cli.rest \ No newline at end of file diff --git a/doc/source/dist_cloud/failure-prior-to-the-installation-of-n+1-load-on-a-subcloud.rst b/doc/source/dist_cloud/kubernetes/failure-prior-to-the-installation-of-n+1-load-on-a-subcloud.rst similarity index 100% rename from doc/source/dist_cloud/failure-prior-to-the-installation-of-n+1-load-on-a-subcloud.rst rename to doc/source/dist_cloud/kubernetes/failure-prior-to-the-installation-of-n+1-load-on-a-subcloud.rst diff --git a/doc/source/dist_cloud/figures/bqu1525123082913.png b/doc/source/dist_cloud/kubernetes/figures/bqu1525123082913.png similarity index 100% rename from doc/source/dist_cloud/figures/bqu1525123082913.png rename to doc/source/dist_cloud/kubernetes/figures/bqu1525123082913.png diff --git a/doc/source/dist_cloud/figures/brk1525194697928.png b/doc/source/dist_cloud/kubernetes/figures/brk1525194697928.png similarity index 100% rename from doc/source/dist_cloud/figures/brk1525194697928.png rename to doc/source/dist_cloud/kubernetes/figures/brk1525194697928.png diff --git a/doc/source/dist_cloud/figures/cah1525101473925.png b/doc/source/dist_cloud/kubernetes/figures/cah1525101473925.png similarity index 100% rename from doc/source/dist_cloud/figures/cah1525101473925.png rename to doc/source/dist_cloud/kubernetes/figures/cah1525101473925.png diff --git a/doc/source/dist_cloud/figures/jod1525122097274.png b/doc/source/dist_cloud/kubernetes/figures/jod1525122097274.png similarity index 100% rename from doc/source/dist_cloud/figures/jod1525122097274.png rename to doc/source/dist_cloud/kubernetes/figures/jod1525122097274.png diff --git a/doc/source/dist_cloud/figures/pdn1591034100660.png b/doc/source/dist_cloud/kubernetes/figures/pdn1591034100660.png similarity index 100% rename from doc/source/dist_cloud/figures/pdn1591034100660.png rename to doc/source/dist_cloud/kubernetes/figures/pdn1591034100660.png diff --git a/doc/source/dist_cloud/figures/pvr1591032739503.png b/doc/source/dist_cloud/kubernetes/figures/pvr1591032739503.png similarity index 100% rename from doc/source/dist_cloud/figures/pvr1591032739503.png rename to doc/source/dist_cloud/kubernetes/figures/pvr1591032739503.png diff --git a/doc/source/dist_cloud/figures/qfq1525194569886.png b/doc/source/dist_cloud/kubernetes/figures/qfq1525194569886.png similarity index 100% rename from doc/source/dist_cloud/figures/qfq1525194569886.png rename to doc/source/dist_cloud/kubernetes/figures/qfq1525194569886.png diff --git a/doc/source/dist_cloud/figures/rpn1518108364837.png b/doc/source/dist_cloud/kubernetes/figures/rpn1518108364837.png similarity index 100% rename from doc/source/dist_cloud/figures/rpn1518108364837.png rename to doc/source/dist_cloud/kubernetes/figures/rpn1518108364837.png diff --git a/doc/source/dist_cloud/figures/tmj1525095688715.png b/doc/source/dist_cloud/kubernetes/figures/tmj1525095688715.png similarity index 100% rename from doc/source/dist_cloud/figures/tmj1525095688715.png rename to doc/source/dist_cloud/kubernetes/figures/tmj1525095688715.png diff --git a/doc/source/dist_cloud/figures/uhp1521894539008.png b/doc/source/dist_cloud/kubernetes/figures/uhp1521894539008.png similarity index 100% rename from doc/source/dist_cloud/figures/uhp1521894539008.png rename to doc/source/dist_cloud/kubernetes/figures/uhp1521894539008.png diff --git a/doc/source/dist_cloud/figures/uzw1525102534768.png b/doc/source/dist_cloud/kubernetes/figures/uzw1525102534768.png similarity index 100% rename from doc/source/dist_cloud/figures/uzw1525102534768.png rename to doc/source/dist_cloud/kubernetes/figures/uzw1525102534768.png diff --git a/doc/source/dist_cloud/figures/vhy1525122582274.png b/doc/source/dist_cloud/kubernetes/figures/vhy1525122582274.png similarity index 100% rename from doc/source/dist_cloud/figures/vhy1525122582274.png rename to doc/source/dist_cloud/kubernetes/figures/vhy1525122582274.png diff --git a/doc/source/dist_cloud/figures/vwa1525194889921.png b/doc/source/dist_cloud/kubernetes/figures/vwa1525194889921.png similarity index 100% rename from doc/source/dist_cloud/figures/vwa1525194889921.png rename to doc/source/dist_cloud/kubernetes/figures/vwa1525194889921.png diff --git a/doc/source/dist_cloud/figures/vzc1525194338519.png b/doc/source/dist_cloud/kubernetes/figures/vzc1525194338519.png similarity index 100% rename from doc/source/dist_cloud/figures/vzc1525194338519.png rename to doc/source/dist_cloud/kubernetes/figures/vzc1525194338519.png diff --git a/doc/source/dist_cloud/kubernetes/index.rst b/doc/source/dist_cloud/kubernetes/index.rst new file mode 100644 index 000000000..08587033b --- /dev/null +++ b/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 diff --git a/doc/source/dist_cloud/installing-a-subcloud-using-redfish-platform-management-service.rst b/doc/source/dist_cloud/kubernetes/installing-a-subcloud-using-redfish-platform-management-service.rst similarity index 99% rename from doc/source/dist_cloud/installing-a-subcloud-using-redfish-platform-management-service.rst rename to doc/source/dist_cloud/kubernetes/installing-a-subcloud-using-redfish-platform-management-service.rst index 3d346a4a2..b73a7e0bd 100644 --- a/doc/source/dist_cloud/installing-a-subcloud-using-redfish-platform-management-service.rst +++ b/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 diff --git a/doc/source/dist_cloud/installing-a-subcloud-without-redfish-platform-management-service.rst b/doc/source/dist_cloud/kubernetes/installing-a-subcloud-without-redfish-platform-management-service.rst similarity index 98% rename from doc/source/dist_cloud/installing-a-subcloud-without-redfish-platform-management-service.rst rename to doc/source/dist_cloud/kubernetes/installing-a-subcloud-without-redfish-platform-management-service.rst index e2a424ad5..ae7280f95 100644 --- a/doc/source/dist_cloud/installing-a-subcloud-without-redfish-platform-management-service.rst +++ b/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 diff --git a/doc/source/dist_cloud/installing-and-provisioning-a-subcloud.rst b/doc/source/dist_cloud/kubernetes/installing-and-provisioning-a-subcloud.rst similarity index 81% rename from doc/source/dist_cloud/installing-and-provisioning-a-subcloud.rst rename to doc/source/dist_cloud/kubernetes/installing-and-provisioning-a-subcloud.rst index dc220e074..c5903c069 100644 --- a/doc/source/dist_cloud/installing-and-provisioning-a-subcloud.rst +++ b/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 diff --git a/doc/source/dist_cloud/installing-and-provisioning-the-central-cloud.rst b/doc/source/dist_cloud/kubernetes/installing-and-provisioning-the-central-cloud.rst similarity index 92% rename from doc/source/dist_cloud/installing-and-provisioning-the-central-cloud.rst rename to doc/source/dist_cloud/kubernetes/installing-and-provisioning-the-central-cloud.rst index b6d3d8ce8..b387da5fa 100644 --- a/doc/source/dist_cloud/installing-and-provisioning-the-central-cloud.rst +++ b/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 are replaced with the correct values for your environment. diff --git a/doc/source/dist_cloud/managing-ldap-linux-user-accounts-on-the-system-controller.rst b/doc/source/dist_cloud/kubernetes/managing-ldap-linux-user-accounts-on-the-system-controller.rst similarity index 100% rename from doc/source/dist_cloud/managing-ldap-linux-user-accounts-on-the-system-controller.rst rename to doc/source/dist_cloud/kubernetes/managing-ldap-linux-user-accounts-on-the-system-controller.rst diff --git a/doc/source/dist_cloud/managing-subcloud-groups.rst b/doc/source/dist_cloud/kubernetes/managing-subcloud-groups.rst similarity index 100% rename from doc/source/dist_cloud/managing-subcloud-groups.rst rename to doc/source/dist_cloud/kubernetes/managing-subcloud-groups.rst diff --git a/doc/source/dist_cloud/managing-subclouds-using-the-cli.rst b/doc/source/dist_cloud/kubernetes/managing-subclouds-using-the-cli.rst similarity index 100% rename from doc/source/dist_cloud/managing-subclouds-using-the-cli.rst rename to doc/source/dist_cloud/kubernetes/managing-subclouds-using-the-cli.rst diff --git a/doc/source/dist_cloud/migrate-an-aiosx-subcloud-to-an-aiodx-subcloud.rst b/doc/source/dist_cloud/kubernetes/migrate-an-aiosx-subcloud-to-an-aiodx-subcloud.rst similarity index 98% rename from doc/source/dist_cloud/migrate-an-aiosx-subcloud-to-an-aiodx-subcloud.rst rename to doc/source/dist_cloud/kubernetes/migrate-an-aiosx-subcloud-to-an-aiodx-subcloud.rst index 30c92b347..d1abad68a 100644 --- a/doc/source/dist_cloud/migrate-an-aiosx-subcloud-to-an-aiodx-subcloud.rst +++ b/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: diff --git a/doc/source/dist_cloud/monitoring-subclouds-using-horizon.rst b/doc/source/dist_cloud/kubernetes/monitoring-subclouds-using-horizon.rst similarity index 100% rename from doc/source/dist_cloud/monitoring-subclouds-using-horizon.rst rename to doc/source/dist_cloud/kubernetes/monitoring-subclouds-using-horizon.rst diff --git a/doc/source/dist_cloud/ochestration-strategy-using-subcloud-groups.rst b/doc/source/dist_cloud/kubernetes/ochestration-strategy-using-subcloud-groups.rst similarity index 100% rename from doc/source/dist_cloud/ochestration-strategy-using-subcloud-groups.rst rename to doc/source/dist_cloud/kubernetes/ochestration-strategy-using-subcloud-groups.rst diff --git a/doc/source/dist_cloud/overview-of-distributed-cloud.rst b/doc/source/dist_cloud/kubernetes/overview-of-distributed-cloud.rst similarity index 100% rename from doc/source/dist_cloud/overview-of-distributed-cloud.rst rename to doc/source/dist_cloud/kubernetes/overview-of-distributed-cloud.rst diff --git a/doc/source/dist_cloud/regionone-and-systemcontroller-modes.rst b/doc/source/dist_cloud/kubernetes/regionone-and-systemcontroller-modes.rst similarity index 100% rename from doc/source/dist_cloud/regionone-and-systemcontroller-modes.rst rename to doc/source/dist_cloud/kubernetes/regionone-and-systemcontroller-modes.rst diff --git a/doc/source/dist_cloud/rehoming-a-subcloud.rst b/doc/source/dist_cloud/kubernetes/rehoming-a-subcloud.rst similarity index 100% rename from doc/source/dist_cloud/rehoming-a-subcloud.rst rename to doc/source/dist_cloud/kubernetes/rehoming-a-subcloud.rst diff --git a/doc/source/dist_cloud/reinstalling-a-subcloud-with-redfish-platform-management-service.rst b/doc/source/dist_cloud/kubernetes/reinstalling-a-subcloud-with-redfish-platform-management-service.rst similarity index 93% rename from doc/source/dist_cloud/reinstalling-a-subcloud-with-redfish-platform-management-service.rst rename to doc/source/dist_cloud/kubernetes/reinstalling-a-subcloud-with-redfish-platform-management-service.rst index b9b619310..db9d540c9 100644 --- a/doc/source/dist_cloud/reinstalling-a-subcloud-with-redfish-platform-management-service.rst +++ b/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 diff --git a/doc/source/dist_cloud/restoring-subclouds-from-backupdata-using-dcmanager.rst b/doc/source/dist_cloud/kubernetes/restoring-subclouds-from-backupdata-using-dcmanager.rst similarity index 100% rename from doc/source/dist_cloud/restoring-subclouds-from-backupdata-using-dcmanager.rst rename to doc/source/dist_cloud/kubernetes/restoring-subclouds-from-backupdata-using-dcmanager.rst diff --git a/doc/source/dist_cloud/reviewing-update-status-for-distributed-cloud-using-horizon.rst b/doc/source/dist_cloud/kubernetes/reviewing-update-status-for-distributed-cloud-using-horizon.rst similarity index 100% rename from doc/source/dist_cloud/reviewing-update-status-for-distributed-cloud-using-horizon.rst rename to doc/source/dist_cloud/kubernetes/reviewing-update-status-for-distributed-cloud-using-horizon.rst diff --git a/doc/source/dist_cloud/reviewing-update-status-for-distributed-cloud-using-the-cli.rst b/doc/source/dist_cloud/kubernetes/reviewing-update-status-for-distributed-cloud-using-the-cli.rst similarity index 100% rename from doc/source/dist_cloud/reviewing-update-status-for-distributed-cloud-using-the-cli.rst rename to doc/source/dist_cloud/kubernetes/reviewing-update-status-for-distributed-cloud-using-the-cli.rst diff --git a/doc/source/dist_cloud/robust-error-handling-during-an-orchestrated-upgrade.rst b/doc/source/dist_cloud/kubernetes/robust-error-handling-during-an-orchestrated-upgrade.rst similarity index 100% rename from doc/source/dist_cloud/robust-error-handling-during-an-orchestrated-upgrade.rst rename to doc/source/dist_cloud/kubernetes/robust-error-handling-during-an-orchestrated-upgrade.rst diff --git a/doc/source/dist_cloud/shared-configurations.rst b/doc/source/dist_cloud/kubernetes/shared-configurations.rst similarity index 100% rename from doc/source/dist_cloud/shared-configurations.rst rename to doc/source/dist_cloud/kubernetes/shared-configurations.rst diff --git a/doc/source/dist_cloud/switching-to-a-subcloud-from-the-system-controller.rst b/doc/source/dist_cloud/kubernetes/switching-to-a-subcloud-from-the-system-controller.rst similarity index 100% rename from doc/source/dist_cloud/switching-to-a-subcloud-from-the-system-controller.rst rename to doc/source/dist_cloud/kubernetes/switching-to-a-subcloud-from-the-system-controller.rst diff --git a/doc/source/dist_cloud/synchronization-monitoring-and-control.rst b/doc/source/dist_cloud/kubernetes/synchronization-monitoring-and-control.rst similarity index 100% rename from doc/source/dist_cloud/synchronization-monitoring-and-control.rst rename to doc/source/dist_cloud/kubernetes/synchronization-monitoring-and-control.rst diff --git a/doc/source/dist_cloud/the-kubernetes-distributed-cloud-update-orchestration-process.rst b/doc/source/dist_cloud/kubernetes/the-kubernetes-distributed-cloud-update-orchestration-process.rst similarity index 100% rename from doc/source/dist_cloud/the-kubernetes-distributed-cloud-update-orchestration-process.rst rename to doc/source/dist_cloud/kubernetes/the-kubernetes-distributed-cloud-update-orchestration-process.rst diff --git a/doc/source/dist_cloud/update-management-for-distributed-cloud.rst b/doc/source/dist_cloud/kubernetes/update-management-for-distributed-cloud.rst similarity index 100% rename from doc/source/dist_cloud/update-management-for-distributed-cloud.rst rename to doc/source/dist_cloud/kubernetes/update-management-for-distributed-cloud.rst diff --git a/doc/source/dist_cloud/update-orchestration-of-central-clouds-regionone-and-subclouds-using-the-cli.rst b/doc/source/dist_cloud/kubernetes/update-orchestration-of-central-clouds-regionone-and-subclouds-using-the-cli.rst similarity index 100% rename from doc/source/dist_cloud/update-orchestration-of-central-clouds-regionone-and-subclouds-using-the-cli.rst rename to doc/source/dist_cloud/kubernetes/update-orchestration-of-central-clouds-regionone-and-subclouds-using-the-cli.rst diff --git a/doc/source/dist_cloud/update-orchestration-of-central-clouds-regionone-and-subclouds.rst b/doc/source/dist_cloud/kubernetes/update-orchestration-of-central-clouds-regionone-and-subclouds.rst similarity index 100% rename from doc/source/dist_cloud/update-orchestration-of-central-clouds-regionone-and-subclouds.rst rename to doc/source/dist_cloud/kubernetes/update-orchestration-of-central-clouds-regionone-and-subclouds.rst diff --git a/doc/source/dist_cloud/updating-docker-registry-credentials-on-a-subcloud.rst b/doc/source/dist_cloud/kubernetes/updating-docker-registry-credentials-on-a-subcloud.rst similarity index 100% rename from doc/source/dist_cloud/updating-docker-registry-credentials-on-a-subcloud.rst rename to doc/source/dist_cloud/kubernetes/updating-docker-registry-credentials-on-a-subcloud.rst diff --git a/doc/source/dist_cloud/upgrade-management-overview.rst b/doc/source/dist_cloud/kubernetes/upgrade-management-overview.rst similarity index 98% rename from doc/source/dist_cloud/upgrade-management-overview.rst rename to doc/source/dist_cloud/kubernetes/upgrade-management-overview.rst index e1e1e0f14..82ddace73 100644 --- a/doc/source/dist_cloud/upgrade-management-overview.rst +++ b/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 diff --git a/doc/source/dist_cloud/upgrading-the-systemcontroller-using-the-cli.rst b/doc/source/dist_cloud/kubernetes/upgrading-the-systemcontroller-using-the-cli.rst similarity index 99% rename from doc/source/dist_cloud/upgrading-the-systemcontroller-using-the-cli.rst rename to doc/source/dist_cloud/kubernetes/upgrading-the-systemcontroller-using-the-cli.rst index ccb091fc5..2f323c9e0 100644 --- a/doc/source/dist_cloud/upgrading-the-systemcontroller-using-the-cli.rst +++ b/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 diff --git a/doc/source/dist_cloud/uploading-and-applying-updates-to-systemcontroller-using-horizon.rst b/doc/source/dist_cloud/kubernetes/uploading-and-applying-updates-to-systemcontroller-using-horizon.rst similarity index 100% rename from doc/source/dist_cloud/uploading-and-applying-updates-to-systemcontroller-using-horizon.rst rename to doc/source/dist_cloud/kubernetes/uploading-and-applying-updates-to-systemcontroller-using-horizon.rst diff --git a/doc/source/dist_cloud/uploading-and-applying-updates-to-systemcontroller-using-the-cli.rst b/doc/source/dist_cloud/kubernetes/uploading-and-applying-updates-to-systemcontroller-using-the-cli.rst similarity index 100% rename from doc/source/dist_cloud/uploading-and-applying-updates-to-systemcontroller-using-the-cli.rst rename to doc/source/dist_cloud/kubernetes/uploading-and-applying-updates-to-systemcontroller-using-the-cli.rst diff --git a/doc/source/releasenotes/r5_release.rst b/doc/source/releasenotes/r5_release.rst index 397570269..5db6bf913 100644 --- a/doc/source/releasenotes/r5_release.rst +++ b/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 ` + Guide: :ref:`Install StarlingX Kubernetes on Bare Metal Standard with Rook + Storage ` * 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 ` + Guide: :ref:`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 - ` + Guide: :ref:`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 ` + Guide: :ref:`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 ` + Guide: :ref:`SNMP Overview ` * Distributed cloud scaling The distributed cloud deployment now supports up to 200 |AIO-SX| subclouds. - Guide: :doc:`Distributed Cloud Architecture ` + Guide: :ref:`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 - ` and :doc:`Verified Commercial Hardware ` + Guides: :ref:`Configuring VF Interfaces Rate Limiting Using the CLI + ` and :ref:`Verified + Commercial Hardware ` ----------