Merge "Unique index names (install)"

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`.
+:ref:`index-install-r6-os-adc44604968c`.

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`.
+:ref:`index-install-r5-os-bf0f49699241`.

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`

doc/source/deploy_install_guides/index-install-e083ca818006.rst

@@ -1,3 +1,5 @@
+.. _index-install-e083ca818006:
+
 ===================
 Installation Guides
 ===================
@@ -15,7 +17,7 @@ StarlingX R6.0 is under development.
 .. toctree::
    :maxdepth: 1
 
-   r6_release/index
+   r6_release/index-install-r6-8966076f0e81
 
 
 -----------------
@@ -29,7 +31,7 @@ Use the R5.0 Installation Guides to install R5.0.1.
 .. toctree::
    :maxdepth: 1
 
-   r5_release/index
+   r5_release/index-install-r5-ca4053cb3ab9
 
 
 -----------------
@@ -77,3 +79,4 @@ older releases <https://docs.starlingx.io/r/stx.5.0/deploy_install_guides/index.
       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).
+

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.
+#. Physically install and cable all subcloud servers.
-2. Physically install the top of rack switch and configure it for the
+
+#. 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
+#. Physically install the gateway routers which will provide IP routing
-   OAM and management subnets.
+   between the subcloud |OAM| and Management subnets and the SystemController
-4. On the server designated for controller-0, install the StarlingX
+   |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
+#. Establish an L3 connection to the SystemController by enabling the |OAM|
-   interface (with OAM IP/subnet) on the subcloud controller using the
+   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 name (for example, enp0s3).
-   - Subcloud OAM interface address, in CIDR format (for example, 10.10.10.12/24).
+   - 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/<subcloud name>_bootstrap_<time stamp>.log
 
-3. Confirm that the subcloud was deployed successfully:
+#. Confirm that the subcloud was deployed successfully:
 
    .. code:: sh
 
@@ -277,7 +282,7 @@ At the System Controller:
       | 1  | subcloud1 | unmanaged  | offline      | complete      | unknown |
       +----+-----------+------------+--------------+---------------+---------+
 
-4. Continue provisioning the subcloud system as required using the StarlingX
+#. Continue provisioning the subcloud system as required using the StarlingX
    R5.0 Installation procedures and starting from the 'Configure controller-0'
    step.
 

doc/source/deploy_install_guides/r5_release/index-install-r5-ca4053cb3ab9.rst

@@ -1,3 +1,5 @@
+.. _index-install-r5-ca4053cb3ab9:
+
 ===========================
 StarlingX R5.0 Installation
 ===========================
@@ -114,7 +116,7 @@ Install StarlingX Distributed Cloud on bare metal
 .. toctree::
    :maxdepth: 1
 
-   distributed_cloud/index
+   distributed_cloud/index-install-r5-distcloud-8164d5952ac5
 
 -----------------
 Access Kubernetes
@@ -132,5 +134,5 @@ Access StarlingX OpenStack
 .. toctree::
    :maxdepth: 1
 
-   openstack/index
+   openstack/index-install-r5-os-bf0f49699241
 

doc/source/deploy_install_guides/r5_release/openstack/index-install-r5-os-bf0f49699241.rst

@@ -1,3 +1,5 @@
+.. _index-install-r5-os-bf0f49699241:
+
 ===================
 StarlingX OpenStack
 ===================

doc/source/deploy_install_guides/r5_release/virtual/install_virtualbox.rst

@@ -278,8 +278,8 @@ Console usage:
 For details on how to specify installation parameters such as rootfs device
 and console port, see :ref:`config_install_parms_r5`.
 
-Follow the :doc:`StarlingX Installation and Deployment Guides </deploy_install_guides/index>`
+Follow the :ref:`StarlingX Installation and Deployment Guides
-to continue.
+<index-install-e083ca818006>` to continue.
 
 * Ensure that boot priority on all VMs is changed using the commands in the "Set
   the boot priority" step above.

doc/source/deploy_install_guides/r6_release/distributed_cloud/index-install-r6-distcloud-46f4880ec78b.rst

@@ -1,3 +1,5 @@
+.. _index-install-r6-distcloud-46f4880ec78b:
+
 ===================================
 Distributed Cloud Installation R6.0
 ===================================
@@ -158,16 +160,19 @@ Install a subcloud
 
 At the subcloud location:
 
-1. Physically install and cable all subcloud servers.
+#. Physically install and cable all subcloud servers.
-2. Physically install the top of rack switch and configure it for the
+
+#. 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
+
+#. Physically install the gateway routers which will provide IP routing
    between the subcloud OAM and Management subnets and the System Controller
    OAM and management subnets.
-4. On the server designated for controller-0, install the StarlingX
+
+#. 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 System Controller by enabling the OAM
+#. Establish an L3 connection to the System Controller 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.
@@ -217,7 +222,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
@@ -246,7 +251,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
 
@@ -279,7 +284,7 @@ At the System Controller:
       | 1  | subcloud1 | unmanaged  | offline      | complete      | unknown |
       +----+-----------+------------+--------------+---------------+---------+
 
-4. Continue provisioning the subcloud system as required using the StarlingX
+#. Continue provisioning the subcloud system as required using the StarlingX
    R6.0 Installation procedures and starting from the 'Configure controller-0'
    step.
 

doc/source/deploy_install_guides/r6_release/index-install-r6-8966076f0e81.rst

@@ -1,10 +1,12 @@
+.. _index-install-r6-8966076f0e81:
+
 ===========================
 StarlingX R6.0 Installation
 ===========================
 
-StarlingX provides a pre-defined set of standard
+StarlingX provides a pre-defined set of standard :doc:`deployment
-:doc:`deployment configurations </introduction/deploy_options>`. Most deployment options may
+configurations </introduction/deploy_options>`. Most deployment options may be
-be installed in a virtual environment or on bare metal.
+installed in a virtual environment or on bare metal.
 
 -----------------------------------------------------
 Install StarlingX Kubernetes in a virtual environment
@@ -113,7 +115,7 @@ Install StarlingX Distributed Cloud on bare metal
 .. toctree::
    :maxdepth: 1
 
-   distributed_cloud/index
+   distributed_cloud/index-install-r6-distcloud-46f4880ec78b
 
 -----------------
 Access Kubernetes
@@ -131,5 +133,5 @@ Access StarlingX OpenStack
 .. toctree::
    :maxdepth: 1
 
-   openstack/index
+   openstack/index-install-r6-os-adc44604968c
 

doc/source/deploy_install_guides/r6_release/openstack/index-install-r6-os-adc44604968c.rst

@@ -1,3 +1,5 @@
+.. _index-install-r6-os-adc44604968c:
+
 ===================
 StarlingX OpenStack
 ===================
@@ -5,8 +7,8 @@ StarlingX OpenStack
 This section describes the steps to install and access StarlingX OpenStack.
 Other than the OpenStack-specific configurations required in the underlying
 StarlingX Kubernetes infrastructure (described in the installation steps for
-StarlingX Kubernetes), the installation of containerized OpenStack for StarlingX
+StarlingX Kubernetes), the installation of containerized OpenStack for
-is independent of deployment configuration.
+StarlingX is independent of deployment configuration.
 
 .. toctree::
    :maxdepth: 2

doc/source/deploy_install_guides/r6_release/virtual/install_virtualbox.rst

@@ -278,7 +278,7 @@ Console usage:
 For details on how to specify installation parameters such as rootfs device
 and console port, see :ref:`config_install_parms_r6`.
 
-Follow the :doc:`StarlingX Installation and Deployment Guides </deploy_install_guides/index>`
+Follow the :ref:`StarlingX Installation and Deployment Guides <index-install-e083ca818006>`
 to continue.
 
 * Ensure that boot priority on all VMs is changed using the commands in the "Set

doc/source/index.rst

@@ -64,7 +64,7 @@ Installation guides
 .. toctree::
    :maxdepth: 2
 
-   deploy_install_guides/index
+   deploy_install_guides/index-install-e083ca818006
 
 --------
 Security

doc/source/operations/tsn.rst

@@ -111,7 +111,7 @@ Edge cloud platform
 *******************
 
 #. Install STX environment: follow the instructions from the
-   :doc:`Installation Guides </deploy_install_guides/index>` to install one
+   :ref:`Installation Guides <index-install-e083ca818006>` to install one
    STX environment (for example STX AIO).
 
 #. Prepare a :abbr:`VM (Virtual Machine)` image. Create image ``tsn_ubuntu_19_04.img``

doc/source/releasenotes/r5_0_1_release.rst

@@ -28,7 +28,7 @@ Deployment
 A system install is required to deploy StarlingX release 5.0.1. There is no
 upgrade path from previous StarlingX releases.
 
-Use the :doc:`R5.0 Installation Guides </deploy_install_guides/r5_release/index>`
+Use the :ref:`R5.0 Installation Guides <index-install-r5-ca4053cb3ab9>`
 to install R5.0.1.
 
 -----------------------------

doc/source/releasenotes/r5_release.rst

@@ -27,7 +27,7 @@ Deployment
 
 A system install is required to deploy StarlingX release 5.0. There is no
 upgrade path from previous StarlingX releases. For detailed instructions, see
-the :doc:`R5.0 Installation Guides </deploy_install_guides/r5_release/index>`.
+the :ref:`R5.0 Installation Guides <index-install-r5-ca4053cb3ab9>`.
 
 -----------------------------
 New features and enhancements

doc/source/releasenotes/r6-0-release-notes-bc72d0b961e7.rst

@@ -29,7 +29,7 @@ Deployment
 
 A system install is required to deploy StarlingX release 6.0. There is no
 upgrade path from previous StarlingX releases. For detailed instructions, see
-the :doc:`R6.0 Installation Guides </deploy_install_guides/r6_release/index>`.
+the :ref:`R6.0 Installation Guides <index-install-r6-8966076f0e81>`.
 
 -----------------------------
 New features and enhancements