Merge "Add cross references from deployment to config docs"

doc/source/configuration/hosts.rst

@@ -1,3 +1,5 @@
+.. _configuration-hosts:
+
 ==================
 Host Configuration
 ==================

doc/source/configuration/kayobe.rst

@@ -1,3 +1,5 @@
+.. _configuration-kayobe:
+
 ====================
 Kayobe Configuration
 ====================

doc/source/configuration/kolla-ansible.rst

@@ -1,3 +1,5 @@
+.. _configuration-kolla-ansible:
+
 ===========================
 Kolla-ansible Configuration
 ===========================

doc/source/configuration/kolla.rst

@@ -1,3 +1,5 @@
+.. _configuration-kolla:
+
 ===================
 Kolla Configuration
 ===================

doc/source/configuration/physical-network.rst

@@ -1,3 +1,5 @@
+.. _configuration-physical-network:
+
 ==============================
 Physical Network Configuration
 ==============================

doc/source/deployment.rst

@@ -9,6 +9,11 @@ hypervisor has access to the bare metal nodes that will form the OpenStack
 control plane.  Finally, we assume that the control plane nodes have access to
 the bare metal nodes that will form the workload node pool.
 
+.. seealso::
+
+   Information on the configuration of a Kayobe environment is available
+   :ref:`here <configuration-kayobe>`.
+
 Ansible Control Host
 ====================
 
@@ -56,6 +61,11 @@ the configuration interfaces in use by active nodes.
 The ``--display`` argument will display the candidate switch configuration,
 without actually applying it.
 
+.. seealso::
+
+   Information on configuration of physical network devices is available
+   :ref:`here <configuration-physical-network>`.
+
 Seed Hypervisor
 ===============
 
@@ -73,6 +83,11 @@ support::
 
     (kayobe) $ kayobe seed hypervisor host configure
 
+.. seealso::
+
+   Information on configuration of hosts is available :ref:`here
+   <configuration-hosts>`.
+
 Seed
 ====
 
@@ -110,6 +125,11 @@ To configure the seed host OS::
 
        (kayobe) $ kayobe seed host configure --wipe-disks
 
+.. seealso::
+
+   Information on configuration of hosts is available :ref:`here
+   <configuration-hosts>`.
+
 Building Container Images
 -------------------------
 
@@ -136,6 +156,11 @@ image name regular expressions::
 In order to push images to a registry after they are built, add the ``--push``
 argument.
 
+.. seealso::
+
+   Information on configuration of Kolla for building container images is
+   available :ref:`here <configuration-kolla>`.
+
 .. _workaround-cloud-init:
 
 Workaround VLAN cloud-init issue
@@ -176,9 +201,10 @@ Deploying Containerised Services
 --------------------------------
 
 At this point the seed services need to be deployed on the seed VM.  These
-services are deployed in the ``bifrost_deploy`` container.  This command will
-also build the Operating System image that will be used to deploy the overcloud
-nodes using Disk Image Builder (DIB).
+services are deployed in the ``bifrost_deploy`` container.
+
+This command will also build the Operating System image that will be used to
+deploy the overcloud nodes using Disk Image Builder (DIB).
 
 To deploy the seed services in containers::
 
@@ -186,6 +212,14 @@ To deploy the seed services in containers::
 
 After this command has completed the seed services will be active.
 
+.. seealso::
+
+   Information on configuration of Kolla Ansible is available :ref:`here
+   <configuration-kolla-ansible>`. See :ref:`here <configuration-bifrost>` for
+   information about configuring Bifrost.
+   :ref:`configuration-bifrost-overcloud-root-image` provides information on
+   configuring the root disk image build process.
+
 Building Deployment Images
 --------------------------
 
@@ -199,13 +233,20 @@ tarballs <https://tarballs.openstack.org/ironic-python-agent>`_ or another
 source.  In some cases it may be necessary to build images locally either to
 apply local image customisation or to use a downstream version of Ironic Python
 Agent (IPA).  In order to build IPA images, the ``ipa_build_images`` variable
-should be set to ``True``.  To build images locally::
+should be set to ``True``.
+
+To build images locally::
 
     (kayobe) $ kayobe seed deployment image build
 
 If images have been built previously, they will not be rebuilt.  To force
 rebuilding images, use the ``--force-rebuild`` argument.
 
+.. seealso::
+
+   See :ref:`here <configuration-ipa-build>` for information on how to
+   configure the IPA image build process.
+
 Accessing the Seed via SSH (Optional)
 -------------------------------------
 
@@ -360,6 +401,11 @@ To configure the overcloud hosts' OS::
 
        (kayobe) $ kayobe overcloud host configure --wipe-disks
 
+.. seealso::
+
+   Information on configuration of hosts is available :ref:`here
+   <configuration-hosts>`.
+
 Building Container Images
 -------------------------
 
@@ -387,6 +433,11 @@ image name regular expressions::
 In order to push images to a registry after they are built, add the ``--push``
 argument.
 
+.. seealso::
+
+   Information on configuration of Kolla for building container images is
+   available :ref:`here <configuration-kolla>`.
+
 Pulling Container Images
 ------------------------
 
@@ -420,13 +471,20 @@ tarballs <https://tarballs.openstack.org/ironic-python-agent>`_ or another
 source.  In some cases it may be necessary to build images locally either to
 apply local image customisation or to use a downstream version of Ironic Python
 Agent (IPA).  In order to build IPA images, the ``ipa_build_images`` variable
-should be set to ``True``.  To build images locally::
+should be set to ``True``.
+
+To build images locally::
 
     (kayobe) $ kayobe overcloud deployment image build
 
 If images have been built previously, they will not be rebuilt.  To force
 rebuilding images, use the ``--force-rebuild`` argument.
 
+.. seealso::
+
+   See :ref:`here <configuration-ipa-build>` for information on how to
+   configure the IPA image build process.
+
 Building Swift Rings
 --------------------
 
@@ -449,6 +507,11 @@ To deploy the overcloud services in containers::
 Once this command has completed the overcloud nodes should have OpenStack
 services running in Docker containers.
 
+.. seealso::
+
+   Information on configuration of Kolla Ansible is available :ref:`here
+   <configuration-kolla-ansible>`.
+
 Interacting with the Control Plane
 ----------------------------------