starlingx/docs
Code Issues Proposed changes

Merge "Update distcloud doc"

Browse Source
This commit is contained in:
Zuul
2020-05-18 03:39:41 +00:00
committed by Gerrit Code Review
parent 5f12efc83b 97df7b262f
commit f2ea4047c5
2 changed files with 28 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
doc/source/deploy_install_guides/r3_release/distributed_cloud/index.rst
View File

@@ -103,8 +103,9 @@ routing. The settings required to connect a subcloud to the SystemController
are specified when a subcloud is defined. A gateway router is required to are specified when a subcloud is defined. A gateway router is required to
complete the L3 connections, which will provide IP routing between the complete the L3 connections, which will provide IP routing between the
subcloud Management and OAM IP subnet and the SystemController Management and subcloud Management and OAM IP subnet and the SystemController Management and
OAM IP subnet, respectively. For more information, see the OAM IP subnet, respectively. The SystemController bootstraps the subclouds via
`Install a Subcloud`_ section later in this guide. the OAM network, and manages them via the management network. For more
information, see the `Install a Subcloud`_ section later in this guide.
--------------------------------------- ---------------------------------------
@@ -162,7 +163,8 @@ At the subcloud location:
5. Establish an L3 connection to the SystemController by enabling the OAM 5. 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. ``config_management`` script. This step is for subcloud ansible bootstrap
preparation.
.. note:: This step should **not** use an interface that uses the MGMT .. note:: This step should **not** use an interface that uses the MGMT
IP/subnet because the MGMT IP subnet will get moved to the loopback IP/subnet because the MGMT IP subnet will get moved to the loopback
@@ -183,6 +185,9 @@ At the subcloud location:
.. note:: To exit without completing the script, use ``CTRL+C``. Allow a few minutes for .. note:: To exit without completing the script, use ``CTRL+C``. Allow a few minutes for
the script to finish. the script to finish.
.. note:: The `config_management` in the code snippet configures the OAM
interface/address/gateway.
.. code:: sh .. code:: sh
$ sudo config_management $ sudo config_management
@@ -230,6 +235,11 @@ At the System Controller:
.. important:: The `management_*` entries in the override file are required .. important:: The `management_*` entries in the override file are required
for all installation types, including AIO-Simplex. for all installation types, including AIO-Simplex.
.. important:: The `management_subnet` must not overlap with any other subclouds.
.. note:: The `systemcontroller_gateway_address` is the address of central
cloud management network gateway.
2. Add the subcloud using the CLI command below: 2. Add the subcloud using the CLI command below:
.. code:: sh .. code:: sh
@@ -239,7 +249,7 @@ At the System Controller:
Where: Where:
- *<ip_address>* is the bootstrap_ip set earlier on the subcloud. - *<ip_address>* is the OAM interface address set earlier on the subcloud.
- *<config_file>* is the Ansible override configuration file, ``bootstrap-values.yml``, - *<config_file>* is the Ansible override configuration file, ``bootstrap-values.yml``,
created earlier in step 1. created earlier in step 1.

18
doc/source/deploy_install_guides/r4_release/distributed_cloud/index.rst
View File

@@ -103,8 +103,9 @@ routing. The settings required to connect a subcloud to the SystemController
are specified when a subcloud is defined. A gateway router is required to are specified when a subcloud is defined. A gateway router is required to
complete the L3 connections, which will provide IP routing between the complete the L3 connections, which will provide IP routing between the
subcloud Management and OAM IP subnet and the SystemController Management and subcloud Management and OAM IP subnet and the SystemController Management and
OAM IP subnet, respectively. For more information, see the OAM IP subnet, respectively. The SystemController bootstraps the subclouds via
`Install a Subcloud`_ section later in this guide. the OAM network, and manages them via the management network. For more
information, see the `Install a Subcloud`_ section later in this guide.
--------------------------------------- ---------------------------------------
@@ -162,7 +163,8 @@ At the subcloud location:
5. Establish an L3 connection to the SystemController by enabling the OAM 5. 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. ``config_management`` script. This step is for subcloud ansible bootstrap
preparation.
.. note:: This step should **not** use an interface that uses the MGMT .. note:: This step should **not** use an interface that uses the MGMT
IP/subnet because the MGMT IP subnet will get moved to the loopback IP/subnet because the MGMT IP subnet will get moved to the loopback
@@ -183,6 +185,9 @@ At the subcloud location:
.. note:: To exit without completing the script, use ``CTRL+C``. Allow a few minutes for .. note:: To exit without completing the script, use ``CTRL+C``. Allow a few minutes for
the script to finish. the script to finish.
.. note:: The `config_management` in the code snippet configures the OAM
interface/address/gateway.
.. code:: sh .. code:: sh
$ sudo config_management $ sudo config_management
@@ -230,6 +235,11 @@ At the System Controller:
.. important:: The `management_*` entries in the override file are required .. important:: The `management_*` entries in the override file are required
for all installation types, including AIO-Simplex. for all installation types, including AIO-Simplex.
.. important:: The `management_subnet` must not overlap with any other subclouds.
.. note:: The `systemcontroller_gateway_address` is the address of central
cloud management network gateway.
2. Add the subcloud using the CLI command below: 2. Add the subcloud using the CLI command below:
.. code:: sh .. code:: sh
@@ -239,7 +249,7 @@ At the System Controller:
Where: Where:
- *<ip_address>* is the bootstrap_ip set earlier on the subcloud. - *<ip_address>* is the OAM interface address set earlier on the subcloud.
- *<config_file>* is the Ansible override configuration file, ``bootstrap-values.yml``, - *<config_file>* is the Ansible override configuration file, ``bootstrap-values.yml``,
created earlier in step 1. created earlier in step 1.