diff --git a/doc/source/_includes/kubernetes_install_next.txt b/doc/source/_includes/kubernetes_install_next.txt index 17f621ff1..3a4670bf4 100644 --- a/doc/source/_includes/kubernetes_install_next.txt +++ b/doc/source/_includes/kubernetes_install_next.txt @@ -4,4 +4,4 @@ For instructions on how to access StarlingX Kubernetes see :ref:`kubernetes_access`. For instructions on how to install and access StarlingX OpenStack see -:doc:`/deploy_install_guides/r6_release/openstack/index`. \ No newline at end of file +:ref:`index-install-r6-os-adc44604968c`. \ No newline at end of file diff --git a/doc/source/_includes/r5_kubernetes_install_next.txt b/doc/source/_includes/r5_kubernetes_install_next.txt index 65944e54e..473878fb0 100644 --- a/doc/source/_includes/r5_kubernetes_install_next.txt +++ b/doc/source/_includes/r5_kubernetes_install_next.txt @@ -4,4 +4,4 @@ For instructions on how to access StarlingX Kubernetes see :ref:`kubernetes_access`. For instructions on how to install and access StarlingX OpenStack see -:doc:`/deploy_install_guides/r5_release/openstack/index`. \ No newline at end of file +:ref:`index-install-r5-os-bf0f49699241`. \ No newline at end of file diff --git a/doc/source/contributor/doc_contribute_guide.rst b/doc/source/contributor/doc_contribute_guide.rst index 908ae0960..0f5f24ab4 100644 --- a/doc/source/contributor/doc_contribute_guide.rst +++ b/doc/source/contributor/doc_contribute_guide.rst @@ -81,7 +81,7 @@ Documentation for StarlingX is organized into the following sections: :doc:`/introduction/index-intro-27197f27ad41` Overview of the StarlingX project. -:doc:`/deploy_install_guides/index` +:doc:`/deploy_install_guides/index-install-e083ca818006` Release-specific installation and deployment guides. :doc:`/archive/configuration/index` diff --git a/doc/source/deploy_install_guides/index.rst b/doc/source/deploy_install_guides/index-install-e083ca818006.rst old mode 100755 new mode 100644 similarity index 95% rename from doc/source/deploy_install_guides/index.rst rename to doc/source/deploy_install_guides/index-install-e083ca818006.rst index aa51158eb..a749c24e0 --- a/doc/source/deploy_install_guides/index.rst +++ b/doc/source/deploy_install_guides/index-install-e083ca818006.rst @@ -1,79 +1,82 @@ -=================== -Installation Guides -=================== - -Installation and deployment guides for StarlingX are release-specific. -Each guide provides instruction on a specific StarlingX configuration -(e.g. All-in-one Simplex). - -------------------------- -Upcoming release (latest) -------------------------- - -StarlingX R6.0 is under development. - -.. toctree:: - :maxdepth: 1 - - r6_release/index - - ------------------ -Supported release ------------------ - -StarlingX R5.0.1 is the most recent supported release of StarlingX. - -Use the R5.0 Installation Guides to install R5.0.1. - -.. toctree:: - :maxdepth: 1 - - r5_release/index - - ------------------ -Archived releases ------------------ - -To view the archived installation guides, see `Installation guides for R5.0 and -older releases `_. - - - - -.. Add common files to toctree - -.. toctree:: - :maxdepth: 1 - :hidden: - - bootable_usb - nvme_config - -.. Docs note: Starting with R5 (May 2021), team agreed that the latest/working - branch will include the current & supported install guides only. The archived - releases will only be available in a release-specific branch. The - instructions below are modified to reflect this change. - -.. Making a new release -.. 1. Copy the previous 'upcoming' release to the 'supported' release section. - Copy the old 'supported' folder to the release-specific branch. - Copy the toctree link into the Supported section of install landing page. - Update intro text for the Supported release section to use the - latest version. -.. 2. Add new 'upcoming' release, aka 'Latest' on the version button. - If new upcoming release docs aren't ready, remove toctree from Upcoming - section and just leave intro text. Update text for the upcoming - release version. Once the new upcoming docs are ready, add them in the - toctree here. - -.. Adding new release docs -.. 1. Make sure the most recent release versioned docs are complete for that - release. -.. 2. Make a copy of the most recent release folder e.g. 'r6_release.' Rename - the folder for the new release e.g. 'r7_release'. -.. 3. Search and replace all references to previous release number with the new - release number. For example replace all 'R6.0' with 'R7.0.' Also search - and replace any links that may have a specific release number in the path. -.. 4. Link new version on this page (the index page). +.. _index-install-e083ca818006: + +=================== +Installation Guides +=================== + +Installation and deployment guides for StarlingX are release-specific. +Each guide provides instruction on a specific StarlingX configuration +(e.g. All-in-one Simplex). + +------------------------- +Upcoming release (latest) +------------------------- + +StarlingX R6.0 is under development. + +.. toctree:: + :maxdepth: 1 + + r6_release/index-install-r6-8966076f0e81 + + +----------------- +Supported release +----------------- + +StarlingX R5.0.1 is the most recent supported release of StarlingX. + +Use the R5.0 Installation Guides to install R5.0.1. + +.. toctree:: + :maxdepth: 1 + + r5_release/index-install-r5-ca4053cb3ab9 + + +----------------- +Archived releases +----------------- + +To view the archived installation guides, see `Installation guides for R5.0 and +older releases `_. + + + + +.. Add common files to toctree + +.. toctree:: + :maxdepth: 1 + :hidden: + + bootable_usb + nvme_config + +.. Docs note: Starting with R5 (May 2021), team agreed that the latest/working + branch will include the current & supported install guides only. The archived + releases will only be available in a release-specific branch. The + instructions below are modified to reflect this change. + +.. Making a new release +.. 1. Copy the previous 'upcoming' release to the 'supported' release section. + Copy the old 'supported' folder to the release-specific branch. + Copy the toctree link into the Supported section of install landing page. + Update intro text for the Supported release section to use the + latest version. +.. 2. Add new 'upcoming' release, aka 'Latest' on the version button. + If new upcoming release docs aren't ready, remove toctree from Upcoming + section and just leave intro text. Update text for the upcoming + release version. Once the new upcoming docs are ready, add them in the + toctree here. + +.. Adding new release docs +.. 1. Make sure the most recent release versioned docs are complete for that + release. +.. 2. Make a copy of the most recent release folder e.g. 'r6_release.' Rename + the folder for the new release e.g. 'r7_release'. +.. 3. Search and replace all references to previous release number with the new + release number. For example replace all 'R6.0' with 'R7.0.' Also search + and replace any links that may have a specific release number in the path. +.. 4. Link new version on this page (the index page). + diff --git a/doc/source/deploy_install_guides/r5_release/distributed_cloud/index.rst b/doc/source/deploy_install_guides/r5_release/distributed_cloud/index-install-r5-distcloud-8164d5952ac5.rst similarity index 91% rename from doc/source/deploy_install_guides/r5_release/distributed_cloud/index.rst rename to doc/source/deploy_install_guides/r5_release/distributed_cloud/index-install-r5-distcloud-8164d5952ac5.rst index 8368d7fc5..0ec732260 100644 --- a/doc/source/deploy_install_guides/r5_release/distributed_cloud/index.rst +++ b/doc/source/deploy_install_guides/r5_release/distributed_cloud/index-install-r5-distcloud-8164d5952ac5.rst @@ -1,3 +1,5 @@ +.. _index-install-r5-distcloud-8164d5952ac5: + =================================== Distributed Cloud Installation R5.0 =================================== @@ -156,17 +158,20 @@ Install a subcloud At the subcloud location: -1. Physically install and cable all subcloud servers. -2. Physically install the top of rack switch and configure it for the +#. Physically install and cable all subcloud servers. + +#. Physically install the top of rack switch and configure it for the required networks. -3. Physically install the gateway routers which will provide IP routing - between the subcloud OAM and Management subnets and the SystemController - OAM and management subnets. -4. On the server designated for controller-0, install the StarlingX + +#. Physically install the gateway routers which will provide IP routing + between the subcloud |OAM| and Management subnets and the SystemController + |OAM| and management subnets. + +#. On the server designated for controller-0, install the StarlingX Kubernetes software from USB or a PXE Boot server. -5. Establish an L3 connection to the SystemController by enabling the OAM - interface (with OAM IP/subnet) on the subcloud controller using the +#. Establish an L3 connection to the SystemController by enabling the |OAM| + interface (with |OAM| IP/subnet) on the subcloud controller using the ``config_management`` script. This step is for subcloud ansible bootstrap preparation. @@ -176,15 +181,15 @@ At the subcloud location: Be prepared to provide the following information: - - Subcloud OAM interface name (for example, enp0s3). - - Subcloud OAM interface address, in CIDR format (for example, 10.10.10.12/24). + - Subcloud |OAM| interface name (for example, enp0s3). + - Subcloud |OAM| interface address, in CIDR format (for example, 10.10.10.12/24). .. note:: This must match the *external_oam_floating_address* supplied in the subcloud's ansible bootstrap override file. - - Subcloud gateway address on the OAM network + - Subcloud gateway address on the |OAM| network (for example, 10.10.10.1). A default value is shown. - - System Controller OAM subnet (for example, 10,10.10.0/24). + - System Controller |OAM| subnet (for example, 10,10.10.0/24). .. note:: To exit without completing the script, use ``CTRL+C``. Allow a few minutes for the script to finish. @@ -215,7 +220,7 @@ At the subcloud location: At the System Controller: -1. Create a ``bootstrap-values.yml`` override file for the subcloud. For +#. Create a ``bootstrap-values.yml`` override file for the subcloud. For example: .. code:: yaml @@ -244,7 +249,7 @@ At the System Controller: .. note:: The `systemcontroller_gateway_address` is the address of central cloud management network gateway. -2. Add the subcloud using the CLI command below: +#. Add the subcloud using the CLI command below: .. code:: sh @@ -265,7 +270,7 @@ At the System Controller: tail –f /var/log/dcmanager/_bootstrap_