starlingx/docs
Code Issues Proposed changes

Prepare files to copy deployment config

Browse Source 
Add include placeholders for new DS content.
Add conditionalized DS content to topics.
Patchset 1 review updates.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ib12d85ae37e6fe0b8f8fb73784ba5698b61e4060
This commit is contained in:
Ron Stone 2022-01-17 07:36:18 -05:00
parent 0b803bfad1
commit a27b991006
4 changed files with 37 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/_includes/installing-a-subcloud-using-redfish-platform-management-service.rest
View File

@ -9,3 +9,6 @@
.. begin-ref-1 .. begin-ref-1
.. end-ref-1 .. end-ref-1
.. begin-prepare-files-to-copy-deployment-config
.. end-prepare-files-to-copy-deployment-config

3
doc/source/_includes/installing-a-subcloud-without-redfish-platform-management-service.rest
View File

@ -3,3 +3,6 @@
.. begin-ref-1 .. begin-ref-1
.. end-ref-1 .. end-ref-1
.. begin-prepare-files-to-copy-deployment-config
.. end-prepare-files-to-copy-deployment-config

75
doc/source/dist_cloud/kubernetes/installing-a-subcloud-using-redfish-platform-management-service.rst
View File

@ -100,12 +100,13 @@ subcloud, the subcloud installation has these phases:
.. note:: .. note::
If your controller is on a ZTSystems Triton server that requires a 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 longer timeout value, you can now use the ``rd.net.timeout.ipv6dad``
parameter to specify an increased timeout value for dracut to wait for dracut parameter to specify an increased timeout value for dracut to
the interface to have carrier, and complete IPv6 duplicate address wait for the interface to have carrier, and complete IPv6 duplicate
detection |DAD|. For the ZTSystems server, this can take more than address detection |DAD|. For the ZTSystems server, this can take more
four minutes. It is recommended to set this value to 300 seconds, by than four minutes. It is recommended to set this value to 300 seconds,
specifying the following in the subcloud install-values.yaml file: by specifying the following in the ``subcloud install-values.yaml``
file:
.. code-block:: none .. code-block:: none
@ -163,7 +164,7 @@ subcloud, the subcloud installation has these phases:
#. At the System Controller, create a #. 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. subcloud.
For example: For example:
@ -228,62 +229,26 @@ subcloud, the subcloud installation has these phases:
~(keystone_admin)]$ system certificate-install -m docker_registry path_to_cert ~(keystone_admin)]$ system certificate-install -m docker_registry path_to_cert
If you prefer to install container images from the default WRS |AWS| ECR If you prefer to install container images from the default external
external registries, make the following substitutions for the registries, make the following substitutions for the **docker_registries**
**docker_registries** sections of the file. sections of the file.
.. code-block:: none .. code-block:: none
docker_registries: docker_registries:
defaults: defaults:
username: <your_wrs-aws.io_username> username: <your_default_registry_username>
password: <your_wrs-aws.io_password> password: <your_default_registry_password>
.. include:: /_includes/installing-a-subcloud-using-redfish-platform-management-service.rest .. include:: /_includes/installing-a-subcloud-using-redfish-platform-management-service.rest
:start-after: begin-subcloud-1 :start-after: begin-subcloud-1
:end-before: end-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 .. include:: /_includes/installing-a-subcloud-using-redfish-platform-management-service.rest
values, the bootstrap values and the subcloud's **sysadmin** password. :start-after: begin-prepare-files-to-copy-deployment-config
:end-before: end-prepare-files-to-copy-deployment-config
.. code-block:: none
~(keystone_admin)]$ dcmanager subcloud add \
--bootstrap-address <oam_ip_address_of_subclouds_controller-0 >\
--bootstrap-values /home/sysadmin/subcloud1-bootstrap-values.yaml \
--sysadmin-password <sysadmin_password> \
--install-values /home/sysadmin/install-values.yaml \
--bmc-password <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`` <password> is used for subcloud
installation, and only required if the ``--install-values`` parameter is
specified.
If the ``--bmc-password`` <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.
#. At the Central Cloud / System Controller, monitor the progress of the #. At the Central Cloud / System Controller, monitor the progress of the
subcloud install, bootstrapping, and deployment by using the deploy status 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 :ref:`Updating Docker Registry Credentials on a Subcloud
<updating-docker-registry-credentials-on-a-subcloud>` for more information. <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
<https://docs.starlingx.io/deploy_install_guides/r5_release/distributed_cloud/index.html#install-a-subcloud>`__,
step 4.

27
doc/source/dist_cloud/kubernetes/installing-a-subcloud-without-redfish-platform-management-service.rst
View File

@ -47,11 +47,11 @@ subcloud, the subcloud installation process has two phases:
:start-after: prereq-begin :start-after: prereq-begin
:end-before: prereq-end :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 - 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 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| .. 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 ~(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 .. include:: /_includes/installing-a-subcloud-without-redfish-platform-management-service.rest
values and the subcloud's **sysadmin** password. :start-after: begin-prepare-files-to-copy-deployment-config
:end-before: end-prepare-files-to-copy-deployment-config
For example:
.. code-block:: none
~(keystone_admin)]$ dcmanager subcloud add --bootstrap-address <oam ip address of subcloud's controller-0> \
--bootstrap-values /home/sysadmin/subcloud1-bootstrap-values.yaml \
--sysadmin-password <sysadmin_password>
You will be prompted for the Linux password of the subcloud. This command
will take five to ten minutes to complete.
#. At the Central Cloud / System Controller, monitor the progress of the #. At the Central Cloud / System Controller, monitor the progress of the
subcloud bootstrapping and deployment by using the deploy status field of subcloud bootstrapping and deployment by using the deploy status field of
@ -329,8 +318,8 @@ subcloud, the subcloud installation process has two phases:
Subcloud <updating-docker-registry-credentials-on-a-subcloud>` for more Subcloud <updating-docker-registry-credentials-on-a-subcloud>` for more
information. information.
- For more information on bootstrapping and deploying see the following - For more information on bootstrapping and deploying, see the procedure
StarlingX procedure `Install a subcloud `Install a subcloud
<https://docs.starlingx.io/deploy_install_guides/r5_release/distributed_cloud/index.html#install-a-subcloud>`__, <https://docs.starlingx.io/deploy_install_guides/r5_release/distributed_cloud/index.html#install-a-subcloud>`__,
step 4. step 4.