diff --git a/doc/source/install/containers_deployment/standalone.rst b/doc/source/install/containers_deployment/standalone.rst index 6a450ee7..12284efa 100644 --- a/doc/source/install/containers_deployment/standalone.rst +++ b/doc/source/install/containers_deployment/standalone.rst @@ -234,6 +234,20 @@ Deploying a Standalone Keystone node export OS_CLOUD=standalone openstack endpoint list +Manual deployments with ansible +------------------------------- + +With the ``--output-only`` option enabled, the installation stops before Ansible +playbooks would be normally executed. Instead, it only creates a Heat stack, +then downloads the ansible deployment data and playbooks to ``--output-dir`` for +the manual execution. + +.. note:: + When updating the existing standalone installation, keep in mind the + special cases described in :ref:`notes-for-stack-updates`. There is an + additional case for the ``--force-stack-update`` flag that might need to be + used, when in the ``--output-only`` mode. That is when you cannot know the + results of the actual deployment before ansible has started. Example: 1 NIC, Using Compute with Tenant and Provider Networks --------------------------------------------------------------- diff --git a/doc/source/install/installation/updating.rst b/doc/source/install/installation/updating.rst index dc82f3b0..b65ffcc1 100644 --- a/doc/source/install/installation/updating.rst +++ b/doc/source/install/installation/updating.rst @@ -7,6 +7,10 @@ Updating Undercloud Components :doc:`../containers_deployment/undercloud` for backward compatibility related information. +.. note:: + When updating the existing containerized undercloud installation, + keep in mind the special cases described in :ref:`notes-for-stack-updates`. + #. Before upgrading the undercloud, it is highly suggested to perform a :doc:`backup <../controlplane_backup_restore/01_undercloud_backup>` of the undercloud and validate that a restore works fine. diff --git a/doc/source/install/post_deployment/post_deployment.rst b/doc/source/install/post_deployment/post_deployment.rst index 1e4e6c2c..4cc0cd74 100644 --- a/doc/source/install/post_deployment/post_deployment.rst +++ b/doc/source/install/post_deployment/post_deployment.rst @@ -14,6 +14,7 @@ In this chapter you will find advanced management of various |project| areas. vm_snapshot package_update upgrade + updating-stacks-notes build_single_image upload_single_image update_undercloud_ssh_keys diff --git a/doc/source/install/post_deployment/updating-stacks-notes.rst b/doc/source/install/post_deployment/updating-stacks-notes.rst new file mode 100644 index 00000000..cfa01aea --- /dev/null +++ b/doc/source/install/post_deployment/updating-stacks-notes.rst @@ -0,0 +1,41 @@ +.. _notes-for-stack-updates: + +Understanding undercloud/standalone stack updates +================================================= + +To update a service password or a secret when upgrading from a +non-containerized undercloud, you should edit ``undercloud.conf``. +Then you should use the ``openstack undercloud upgrade`` command. + +.. note:: ``undercloud.conf`` takes priority over + ``tripleo-undercloud-passwords.yaml`` only when running the undercloud + upgrade command. For the undercloud install command, you should edit + ``tripleo-undercloud-passwords.yaml`` instead. + +In order to apply changes for an existing containerized undercloud or +standalone installation, there is an important thing to remember. + +Undercloud and standalone heat installers create one-time ephemeral stacks. +Unlike the normal overcloud stacks, they cannot be updated via the regular +stack update procedure. Instead, the created heat stacks may be updated +virtually. For the most of the cases, the installer will take care of it +automatically via the `StackAction` heat parameter overrides. + +You can enforce the virtual update/create of the heat stack via +the ``--force-stack-update`` and ``--force-stack-create`` options. + +And the recommended command to apply changes for an existing containerized +undercloud installation is: + +.. code-block:: bash + + openstack undercloud install --force-stack-update + +Otherwise, start a new installation with ``--force-stack-create``. New +passwords will be generated in ``tripleo-undercloud-passwords.yaml``. + +It is better to be always explicit. + +.. note:: The console log for these operations will always have heat reporting + the STACK_CREATED status. Check the deployment logs for the actual virtual + create or update actions taken.