Merge "Update DCN docs for export data with ephemeral heat"

This commit is contained in:
Zuul 2021-10-29 16:48:47 +00:00 committed by Gerrit Code Review
commit c0c993caa9
1 changed files with 59 additions and 37 deletions

View File

@ -323,25 +323,39 @@ Once the overcloud control plane has been deployed, data needs to be retrieved
from the overcloud Heat stack and plan to pass as input values into the
separate DCN deployment.
Extract the needed data from the control plane stack:
Beginning in Wallaby with :ref:`ephemeral_heat`, the export file is created
automatically under the default working directory which defaults to
``$HOME/overcloud-deploy/<stack>``. The working directory can also be set with
the ``--working-dir`` cli argument to the ``openstack overcloud deploy``
command.
.. code-block:: bash
The export file will be automatically created as
``$HOME/overcloud-deploy/<stack>/<stack>-export.yaml``.
# Pass --help to see a full list of options
openstack overcloud export \
--stack control-plane \
--output-file control-plane-export.yaml
.. admonition:: Victoria and prior releases
In Victoria and prior releases, the export file must be created by running
the export command.
Extract the needed data from the control plane stack:
.. code-block:: bash
# Pass --help to see a full list of options
openstack overcloud export \
--stack control-plane \
--output-file control-plane-export.yaml
.. note::
The ``control-plane-export.yaml`` generated in the previous command contains
sensitive security data such as passwords and TLS certificates that are used
in the overcloud deployment. Some passwords in the file may be removed if
they are not needed by DCN. For example, the passwords for RabbitMQ, MySQL,
Keystone, Nova and Neutron should be sufficient to launch an instance. When
the export common is run, the Ceph passwords are excluded so that DCN
deployments which include Ceph do not reuse the same Ceph password and
instead new ones are generated per DCN deployment.
The generated ``control-plane-export.yaml`` contains sensitive security data
such as passwords and TLS certificates that are used in the overcloud
deployment. Some passwords in the file may be removed if they are not needed
by DCN. For example, the passwords for RabbitMQ, MySQL, Keystone, Nova and
Neutron should be sufficient to launch an instance. When the export common
is run, the Ceph passwords are excluded so that DCN deployments which include
Ceph do not reuse the same Ceph password and instead new ones are generated
per DCN deployment.
Care should be taken to keep the file as secured as possible.
@ -729,14 +743,19 @@ When the deployment completes, a single stack is deployed::
.. _example_export_dcn:
Export configuration from the ``control-plane`` stack
_____________________________________________________
As documented in export_dcn_, the following command is run to save needed
configuration data from the ``control-plane`` stack::
Exported configuration from the ``control-plane`` stack
_______________________________________________________
As documented in export_dcn_, the export file is created automatically by the
``openstack overcloud deploy`` command.
openstack overcloud export \
--stack control-plane \
--output-file control-plane-export.yaml
.. admonition:: Victoria and prior releases
For Victoria and prior releases, the following command must be run to export
the configuration data from the ``control-plane`` stack::
openstack overcloud export \
--stack control-plane \
--output-file control-plane-export.yaml
Deploy the central stack
________________________
@ -769,7 +788,7 @@ The ``central`` stack is deployed with the following command::
-e deployed-server-port-map.yaml \
-e ceph-environment.yaml \
-e az.yaml \
-e /home/centos/control-plane-export.yaml
-e /home/centos/overcloud-deploy/control-plane/control-plane-export.yaml
``--stack central`` sets the stack name to ``central``.
@ -799,8 +818,9 @@ stack::
CinderStorageAvailabilityZone: 'central'
NovaComputeAvailabilityZone: 'central'
The ``control-plane-export.yaml`` file was generated from the command from
example_export_dcn_.
The ``control-plane-export.yaml`` file was generated by the ``openstack
overcloud deploy`` command when deploying the ``control-plane`` stack or from
the command from example_export_dcn_ (Victoria or prior releases).
When the deployment completes, 2 stacks are deployed::
@ -915,7 +935,7 @@ The ``edge-0`` stack is deployed with the following command::
-e deployed-server-port-map.yaml \
-e ceph-environment.yaml \
-e az.yaml \
-e /home/centos/control-plane-export.yaml
-e /home/centos/overcloud-deploy/control-plane/control-plane-export.yaml
``--stack edge-0`` sets the stack name to ``edge-0``.
@ -945,9 +965,9 @@ same as was used in the ``central`` stack.
The ``CinderStorageAvailabilityZone`` and ``NovaDefaultAvailabilityZone``
parameters are set to ``edge-0`` to match the stack name.
The ``control-plane-export.yaml`` file was generated from the command from
example_export_dcn_, and is the same file that was used with the ``central``
stack.
The ``control-plane-export.yaml`` file was generated by the ``openstack
overcloud deploy`` command when deploying the ``control-plane`` stack or from
the command from example_export_dcn_ (Victoria or prior releases).
``network_data_v2.yaml``, ``vip_data.yaml``, and ``baremetal_deployment.yaml``
are the same files used with the ``control-plane`` stack. However, the files
@ -1059,17 +1079,19 @@ each stack in the deployment.
The control-plane or central stack should be updated first by completing all
the steps from the minor update procedure.
Once the central stack is updated, re-run the export command from
:ref:`export_dcn` to recreate the required input file for each separate
DCN stack.
.. admonition:: Victoria and prior releases
.. note::
Once the central stack is updated, re-run the export command from
:ref:`export_dcn` to recreate the required input file for each separate
DCN stack.
When re-running the export command, save the generated file in a new
directory so that the previous version is not overwritten. In the event
that a separate DCN stack needs a stack update operation performed prior to
the minor update procedure, the previous version of the exported file
should be used.
.. note::
When re-running the export command, save the generated file in a new
directory so that the previous version is not overwritten. In the event
that a separate DCN stack needs a stack update operation performed prior to
the minor update procedure, the previous version of the exported file
should be used.
Each separate DCN stack can then be updated individually as required. There is
no requirement as to the order of which DCN stack is updated first.