From ca19d786c62e1b5c9567fbeab0974ac091d285a8 Mon Sep 17 00:00:00 2001 From: Mark Goddard Date: Fri, 8 Nov 2019 11:06:47 +0000 Subject: [PATCH] Add cross references from deployment to config docs Hopefully this provides access to relevant information without breaking the flow. Change-Id: I40b71cdf782dda6971dafb5894670c30e446ccb0 Story: 2004337 Task: 37387 --- doc/source/configuration/hosts.rst | 2 + doc/source/configuration/kayobe.rst | 2 + doc/source/configuration/kolla-ansible.rst | 2 + doc/source/configuration/kolla.rst | 2 + doc/source/configuration/physical-network.rst | 2 + doc/source/deployment.rst | 73 +++++++++++++++++-- 6 files changed, 78 insertions(+), 5 deletions(-) diff --git a/doc/source/configuration/hosts.rst b/doc/source/configuration/hosts.rst index 2ba4adf39..9b8cf3d12 100644 --- a/doc/source/configuration/hosts.rst +++ b/doc/source/configuration/hosts.rst @@ -1,3 +1,5 @@ +.. _configuration-hosts: + ================== Host Configuration ================== diff --git a/doc/source/configuration/kayobe.rst b/doc/source/configuration/kayobe.rst index 2b0dab34b..50e4fbaeb 100644 --- a/doc/source/configuration/kayobe.rst +++ b/doc/source/configuration/kayobe.rst @@ -1,3 +1,5 @@ +.. _configuration-kayobe: + ==================== Kayobe Configuration ==================== diff --git a/doc/source/configuration/kolla-ansible.rst b/doc/source/configuration/kolla-ansible.rst index 600a35a3a..49dda645e 100644 --- a/doc/source/configuration/kolla-ansible.rst +++ b/doc/source/configuration/kolla-ansible.rst @@ -1,3 +1,5 @@ +.. _configuration-kolla-ansible: + =========================== Kolla-ansible Configuration =========================== diff --git a/doc/source/configuration/kolla.rst b/doc/source/configuration/kolla.rst index 6a5497a1d..e3b973105 100644 --- a/doc/source/configuration/kolla.rst +++ b/doc/source/configuration/kolla.rst @@ -1,3 +1,5 @@ +.. _configuration-kolla: + =================== Kolla Configuration =================== diff --git a/doc/source/configuration/physical-network.rst b/doc/source/configuration/physical-network.rst index 77af47449..f21d62dd7 100644 --- a/doc/source/configuration/physical-network.rst +++ b/doc/source/configuration/physical-network.rst @@ -1,3 +1,5 @@ +.. _configuration-physical-network: + ============================== Physical Network Configuration ============================== diff --git a/doc/source/deployment.rst b/doc/source/deployment.rst index 6f4ee6afc..00870bc6a 100644 --- a/doc/source/deployment.rst +++ b/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 `. + Ansible Control Host ==================== @@ -55,6 +60,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 `. + Seed Hypervisor =============== @@ -72,6 +82,11 @@ support:: (kayobe) $ kayobe seed hypervisor host configure +.. seealso:: + + Information on configuration of hosts is available :ref:`here + `. + Seed ==== @@ -109,6 +124,11 @@ To configure the seed host OS:: (kayobe) $ kayobe seed host configure --wipe-disks +.. seealso:: + + Information on configuration of hosts is available :ref:`here + `. + Building Container Images ------------------------- @@ -135,6 +155,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 `. + .. _workaround-cloud-init: Workaround VLAN cloud-init issue @@ -175,9 +200,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:: @@ -185,6 +211,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 + `. See :ref:`here ` for + information about configuring Bifrost. + :ref:`configuration-bifrost-overcloud-root-image` provides information on + configuring the root disk image build process. + Building Deployment Images -------------------------- @@ -198,13 +232,20 @@ tarballs `_ 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 ` for information on how to + configure the IPA image build process. + Accessing the Seed via SSH (Optional) ------------------------------------- @@ -324,6 +365,11 @@ To configure the overcloud hosts' OS:: (kayobe) $ kayobe overcloud host configure --wipe-disks +.. seealso:: + + Information on configuration of hosts is available :ref:`here + `. + Building Container Images ------------------------- @@ -351,6 +397,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 `. + Pulling Container Images ------------------------ @@ -384,13 +435,20 @@ tarballs `_ 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 ` for information on how to + configure the IPA image build process. + Building Swift Rings -------------------- @@ -413,6 +471,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 + `. + Interacting with the Control Plane ----------------------------------