From 7bc0274aa37fd27c41c33ef029ce83eb7ccbba3c Mon Sep 17 00:00:00 2001 From: Mark Goddard Date: Wed, 20 Sep 2017 17:11:37 +0100 Subject: [PATCH] Add documentation on generating and saving overcloud service configuration --- doc/source/administration.rst | 31 +++++++++++++++++++++++++++++++ doc/source/upgrading.rst | 31 +++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+) diff --git a/doc/source/administration.rst b/doc/source/administration.rst index 7c5211876..52ce834dc 100644 --- a/doc/source/administration.rst +++ b/doc/source/administration.rst @@ -80,6 +80,37 @@ To deprovision the seed VM:: (kayobe-venv) $ kayobe seed vm deprovision +Saving Overcloud Service Configuration +====================================== + +It is often useful to be able to save the configuration of the control +plane services for inspection or comparison with another configuration set +prior to a reconfiguration or upgrade. This command will gather and save the +control plane configuration for all hosts to the ansible control host:: + + (kayobe-venv) $ kayobe overcloud service configuration save + +The default location for the saved configuration is ``$PWD/overcloud-config``, +but this can be changed via the ``output-dir`` argument. To gather +configuration from a directory other than the default ``/etc/kolla``, use the +``node-config-dir`` argument. + +Generating Overcloud Service Configuration +========================================== + +Prior to deploying, reconfiguring, or upgrading a control plane, it may be +useful to generate the configuration that will be applied, without actually +applying it to the running containers. The configuration should typically be +generated in a directory other than the default configuration directory of +``/etc/kolla``, to avoid overwriting the active configuration:: + + (kayobe-venv) $ kayobe overcloud service configuration generate --node-config-dir /path/to/generated/config + +The configuration will be generated remotely on the overcloud hosts in the +specified directory, with one subdirectory per container. This command may be +followed by ``kayobe ovecloud service configuration save`` to gather the +generated configuration to the ansible control host. + Running Kayobe Playbooks on Demand ================================== diff --git a/doc/source/upgrading.rst b/doc/source/upgrading.rst index b1400894b..ed76642d1 100644 --- a/doc/source/upgrading.rst +++ b/doc/source/upgrading.rst @@ -165,6 +165,37 @@ pull images from the configured image registry:: (kayobe-venv) $ kayobe overcloud container image pull +Saving Overcloud Service Configuration +-------------------------------------- + +It is often useful to be able to save the configuration of the control +plane services for inspection or comparison with another configuration set +prior to a reconfiguration or upgrade. This command will gather and save the +control plane configuration for all hosts to the ansible control host:: + + (kayobe-venv) $ kayobe overcloud service configuration save + +The default location for the saved configuration is ``$PWD/overcloud-config``, +but this can be changed via the ``output-dir`` argument. To gather +configuration from a directory other than the default ``/etc/kolla``, use the +``node-config-dir`` argument. + +Generating Overcloud Service Configuration +------------------------------------------ + +Prior to deploying, reconfiguring, or upgrading a control plane, it may be +useful to generate the configuration that will be applied, without actually +applying it to the running containers. The configuration should typically be +generated in a directory other than the default configuration directory of +``/etc/kolla``, to avoid overwriting the active configuration:: + + (kayobe-venv) $ kayobe overcloud service configuration generate --node-config-dir /path/to/generated/config + +The configuration will be generated remotely on the overcloud hosts in the +specified directory, with one subdirectory per container. This command may be +followed by ``kayobe ovecloud service configuration save`` to gather the +generated configuration to the ansible control host. + Upgrading Containerised Services --------------------------------