From 9b484c25e41697985ae687db2d34c2bb2b113c47 Mon Sep 17 00:00:00 2001 From: Mark Goddard Date: Wed, 12 Feb 2020 10:42:42 +0000 Subject: [PATCH] Docs: Document EXTRA_OPTS Also better organise the 'tips and tricks' section. Change-Id: If20a89ae93b64b5a1b5895bb9dc73c4e70adaba7 Related-Bug: #1862649 --- doc/source/user/operating-kolla.rst | 42 +++++++++++++++++++---------- tools/kolla-ansible | 3 +++ 2 files changed, 31 insertions(+), 14 deletions(-) diff --git a/doc/source/user/operating-kolla.rst b/doc/source/user/operating-kolla.rst index 5cb6ff0f17..8b6720aa78 100644 --- a/doc/source/user/operating-kolla.rst +++ b/doc/source/user/operating-kolla.rst @@ -144,21 +144,11 @@ new images. Tips and Tricks ~~~~~~~~~~~~~~~ -Kolla ships with several utilities intended to facilitate ease of operation. +Kolla Ansible CLI +----------------- -``tools/cleanup-containers`` is used to remove deployed containers from the -system. This can be useful when you want to do a new clean deployment. It will -preserve the registry and the locally built images in the registry, but will -remove all running Kolla containers from the local Docker daemon. It also -removes the named volumes. - -``tools/cleanup-host`` is used to remove remnants of network changes -triggered on the Docker host when the neutron-agents containers are launched. -This can be useful when you want to do a new clean deployment, particularly one -changing the network topology. - -``tools/cleanup-images --all`` is used to remove all Docker images built by -Kolla from the local Docker cache. +When running the ``kolla-ansible`` CLI, additional arguments may be passed to +``ansible-playbook`` via the ``EXTRA_OPTS`` environment variable. ``kolla-ansible -i INVENTORY deploy`` is used to deploy and start all Kolla containers. @@ -198,6 +188,11 @@ images on hosts. In order to do smoke tests, requires ``kolla_enable_sanity_checks=yes``. +Passwords +--------- + +The following commands manage the Kolla Ansible passwords file. + ``kolla-mergepwd --old OLD_PASSWDS --new NEW_PASSWDS --final FINAL_PASSWDS`` is used to merge passwords from old installation with newly generated passwords during upgrade of Kolla release. The workflow is: @@ -222,3 +217,22 @@ For example: ``kolla-mergepwd``, by default, keeps old, unused passwords intact. To alter this behavior, and remove such entries, use the ``--clean`` argument when invoking ``kolla-mergepwd``. + +Tools +----- + +Kolla ships with several utilities intended to facilitate ease of operation. + +``tools/cleanup-containers`` is used to remove deployed containers from the +system. This can be useful when you want to do a new clean deployment. It will +preserve the registry and the locally built images in the registry, but will +remove all running Kolla containers from the local Docker daemon. It also +removes the named volumes. + +``tools/cleanup-host`` is used to remove remnants of network changes +triggered on the Docker host when the neutron-agents containers are launched. +This can be useful when you want to do a new clean deployment, particularly one +changing the network topology. + +``tools/cleanup-images --all`` is used to remove all Docker images built by +Kolla from the local Docker cache. diff --git a/tools/kolla-ansible b/tools/kolla-ansible index 7f4022a79f..ce642584ed 100755 --- a/tools/kolla-ansible +++ b/tools/kolla-ansible @@ -65,6 +65,9 @@ Options: --vault-password-file Specify password file for vault decrypt --verbose, -v Increase verbosity of ansible-playbook +Environment variables: + EXTRA_OPTS Additional arguments to pass to ansible-playbook + Commands: prechecks Do pre-deployment checks for hosts check Do post-deployment smoke tests