From a27b9910060bdfff7ce2d5fd968684bfb0b1862b Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Mon, 17 Jan 2022 07:36:18 -0500 Subject: [PATCH] Prepare files to copy deployment config Add include placeholders for new DS content. Add conditionalized DS content to topics. Patchset 1 review updates. Signed-off-by: Ron Stone Change-Id: Ib12d85ae37e6fe0b8f8fb73784ba5698b61e4060 --- ...g-redfish-platform-management-service.rest | 5 +- ...t-redfish-platform-management-service.rest | 3 + ...ng-redfish-platform-management-service.rst | 75 ++++++------------- ...ut-redfish-platform-management-service.rst | 27 ++----- 4 files changed, 37 insertions(+), 73 deletions(-) diff --git a/doc/source/_includes/installing-a-subcloud-using-redfish-platform-management-service.rest b/doc/source/_includes/installing-a-subcloud-using-redfish-platform-management-service.rest index a80ba1bc8..cac3df103 100644 --- a/doc/source/_includes/installing-a-subcloud-using-redfish-platform-management-service.rest +++ b/doc/source/_includes/installing-a-subcloud-using-redfish-platform-management-service.rest @@ -8,4 +8,7 @@ .. end-subcloud-1 .. begin-ref-1 -.. end-ref-1 \ No newline at end of file +.. end-ref-1 + +.. begin-prepare-files-to-copy-deployment-config +.. end-prepare-files-to-copy-deployment-config diff --git a/doc/source/_includes/installing-a-subcloud-without-redfish-platform-management-service.rest b/doc/source/_includes/installing-a-subcloud-without-redfish-platform-management-service.rest index 797955fe9..685d9919b 100644 --- a/doc/source/_includes/installing-a-subcloud-without-redfish-platform-management-service.rest +++ b/doc/source/_includes/installing-a-subcloud-without-redfish-platform-management-service.rest @@ -3,3 +3,6 @@ .. begin-ref-1 .. end-ref-1 + +.. begin-prepare-files-to-copy-deployment-config +.. end-prepare-files-to-copy-deployment-config \ No newline at end of file diff --git a/doc/source/dist_cloud/kubernetes/installing-a-subcloud-using-redfish-platform-management-service.rst b/doc/source/dist_cloud/kubernetes/installing-a-subcloud-using-redfish-platform-management-service.rst index 5c87775d0..e5f8bd548 100644 --- a/doc/source/dist_cloud/kubernetes/installing-a-subcloud-using-redfish-platform-management-service.rst +++ b/doc/source/dist_cloud/kubernetes/installing-a-subcloud-using-redfish-platform-management-service.rst @@ -100,12 +100,13 @@ subcloud, the subcloud installation has these phases: .. note:: If your controller is on a ZTSystems Triton server that requires a - longer timeout value, you can now use the rd.net.timeout.ipv6dad dracut - parameter to specify an increased timeout value for dracut to wait for - the interface to have carrier, and complete IPv6 duplicate address - detection |DAD|. For the ZTSystems server, this can take more than - four minutes. It is recommended to set this value to 300 seconds, by - specifying the following in the subcloud install-values.yaml file: + longer timeout value, you can now use the ``rd.net.timeout.ipv6dad`` + dracut parameter to specify an increased timeout value for dracut to + wait for the interface to have carrier, and complete IPv6 duplicate + address detection |DAD|. For the ZTSystems server, this can take more + than four minutes. It is recommended to set this value to 300 seconds, + by specifying the following in the ``subcloud install-values.yaml`` + file: .. code-block:: none @@ -163,7 +164,7 @@ subcloud, the subcloud installation has these phases: #. At the System Controller, create a - /home/sysadmin/subcloud1-bootstrap-values.yaml overrides file for the + ``/home/sysadmin/subcloud1-bootstrap-values.yaml`` overrides file for the subcloud. For example: @@ -228,62 +229,26 @@ subcloud, the subcloud installation has these phases: ~(keystone_admin)]$ system certificate-install -m docker_registry path_to_cert - If you prefer to install container images from the default WRS |AWS| ECR - external registries, make the following substitutions for the - **docker_registries** sections of the file. + If you prefer to install container images from the default external + registries, make the following substitutions for the **docker_registries** + sections of the file. .. code-block:: none docker_registries: defaults: - username: - password: + username: + password: .. include:: /_includes/installing-a-subcloud-using-redfish-platform-management-service.rest :start-after: begin-subcloud-1 :end-before: end-subcloud-1 -#. Add the subcloud using :command:`dcmanager`. + .. only:: partner - When calling the :command:`subcloud add` command, specify the install - values, the bootstrap values and the subcloud's **sysadmin** password. - - .. code-block:: none - - ~(keystone_admin)]$ dcmanager subcloud add \ - --bootstrap-address \ - --bootstrap-values /home/sysadmin/subcloud1-bootstrap-values.yaml \ - --sysadmin-password \ - --install-values /home/sysadmin/install-values.yaml \ - --bmc-password - - If the ``--sysadmin-password`` is not specified, you are prompted to - enter it once the full command is invoked. The password is masked - when it is entered. - - .. code-block:: none - - Enter the sysadmin password for the subcloud: - - \(Optional\) The ``--bmc-password`` is used for subcloud - installation, and only required if the ``--install-values`` parameter is - specified. - - If the ``--bmc-password`` is omitted and the - ``--install-values`` option is specified the system administrator will be - prompted to enter it, following the :command:`dcmanager subcloud add` - command. This option is ignored if the ``--install-values`` option is not - specified. The password is masked when it is entered. - - .. code-block:: none - - Enter the bmc password for the subcloud: - - You will be prompted for the |BMC| password of the subcloud. This command - will take five to ten minutes to complete. - - The :command:`dcmanager subcloud add` command can take up to ten minutes to - complete. + .. include:: /_includes/installing-a-subcloud-using-redfish-platform-management-service.rest + :start-after: begin-prepare-files-to-copy-deployment-config + :end-before: end-prepare-files-to-copy-deployment-config #. At the Central Cloud / System Controller, monitor the progress of the subcloud install, bootstrapping, and deployment by using the deploy status @@ -385,4 +350,8 @@ subcloud, the subcloud installation has these phases: :ref:`Updating Docker Registry Credentials on a Subcloud ` for more information. -- For more information on bootstrapping and deploying |inst-doc|. +- For more information on bootstrapping and deploying, see the procedure + `Install a subcloud + `__, + step 4. + diff --git a/doc/source/dist_cloud/kubernetes/installing-a-subcloud-without-redfish-platform-management-service.rst b/doc/source/dist_cloud/kubernetes/installing-a-subcloud-without-redfish-platform-management-service.rst index ae7280f95..d17838176 100644 --- a/doc/source/dist_cloud/kubernetes/installing-a-subcloud-without-redfish-platform-management-service.rst +++ b/doc/source/dist_cloud/kubernetes/installing-a-subcloud-without-redfish-platform-management-service.rst @@ -47,11 +47,11 @@ subcloud, the subcloud installation process has two phases: :start-after: prereq-begin :end-before: prereq-end -- You must have downloaded update-iso.sh from |dnload-loc|. +- You must have downloaded ``update-iso.sh`` from |dnload-loc|. - In order to be able to deploy subclouds from either controller, all local files that are referenced in the **bootstrap.yml** file must exist on both - controllers \(for example, /home/sysadmin/docker-registry-ca-cert.pem\). + controllers \(for example, ``/home/sysadmin/docker-registry-ca-cert.pem``\). .. rubric:: |proc| @@ -234,22 +234,11 @@ subcloud, the subcloud installation process has two phases: ~(keystone_admin)]$ system certificate-install -m docker_registry path_to_cert -#. Add the subcloud using :command:`dcmanager`. + .. only:: partner - When calling the :command:`subcloud add` command, specify the bootstrap - values and the subcloud's **sysadmin** password. - - For example: - - .. code-block:: none - - ~(keystone_admin)]$ dcmanager subcloud add --bootstrap-address \ - --bootstrap-values /home/sysadmin/subcloud1-bootstrap-values.yaml \ - --sysadmin-password - - - You will be prompted for the Linux password of the subcloud. This command - will take five to ten minutes to complete. + .. include:: /_includes/installing-a-subcloud-without-redfish-platform-management-service.rest + :start-after: begin-prepare-files-to-copy-deployment-config + :end-before: end-prepare-files-to-copy-deployment-config #. At the Central Cloud / System Controller, monitor the progress of the subcloud bootstrapping and deployment by using the deploy status field of @@ -329,8 +318,8 @@ subcloud, the subcloud installation process has two phases: Subcloud ` for more information. -- For more information on bootstrapping and deploying see the following - StarlingX procedure `Install a subcloud +- For more information on bootstrapping and deploying, see the procedure + `Install a subcloud `__, step 4.