From b3f0a89cde704c82d22c018df17e295a68b71307 Mon Sep 17 00:00:00 2001 From: Emilien Macchi Date: Mon, 16 Jul 2018 09:19:34 -0400 Subject: [PATCH] The undercloud is containerized by default, doc changes - Update the undercloud install/upgrade manuals to reflect what we have done in tripleoclient, the undercloud is now containerized by default. - Document that we can disable this feature with --use-heat=False. - Remove useless redirect commands for upgrades, the logfile is created by tripleoclient anyway. - Document how to cleanup an undercloud after the upgrade. Change-Id: Ib597bd75e6c922f37a003588a172b817d990ac4f --- .../install/installation/installing.rst | 36 +++++++++---------- doc/source/install/installation/updating.rst | 30 +++++++--------- 2 files changed, 29 insertions(+), 37 deletions(-) diff --git a/doc/source/install/installation/installing.rst b/doc/source/install/installation/installing.rst index 71c15b91..4c11ebfd 100644 --- a/doc/source/install/installation/installing.rst +++ b/doc/source/install/installation/installing.rst @@ -166,30 +166,28 @@ Installing the Undercloud ``enable_validations = false`` in ``undercloud.conf`` to prevent that. - To deploy a containerized undercloud:: + To deploy an undercloud:: - openstack undercloud install --use-heat - - .. admonition:: Stable Branch - :class: stable - - To install a deprecated instack undercloud:: - - openstack undercloud install + openstack undercloud install .. note:: - When installing a containerized undercloud, it's possible to enable verbose - logging with --verbose option. + The undercloud is containerized by default as of Rocky. .. note:: - The ``openstack undercloud install --use-heat`` command - will run all the OpenStack services in a moby container runtime - unless the default settings are overwritten. - This command requires 2 services to be running at all times. The first one is a - basic keystone service, which is currently executed by `tripleoclient` itself, the - second one is `heat-all` which executes the templates and installs the services. - The latter can be run on baremetal or in a container (tripleoclient will run it - in a container by default). + It's possible to enable verbose logging with --verbose option. + +.. note:: + To install a deprecated instack undercloud, you'll need to deploy + with --use-heat=False option. + + +In Rocky, we will run all the OpenStack services in a moby container runtime +unless the default settings are overwritten. +This command requires 2 services to be running at all times. The first one is a +basic keystone service, which is currently executed by `tripleoclient` itself, the +second one is `heat-all` which executes the templates and installs the services. +The latter can be run on baremetal or in a container (tripleoclient will run it +in a container by default). Once the install has completed, you should take note of the files ``stackrc`` and ``undercloud-passwords.conf``. You can source ``stackrc`` to interact with the diff --git a/doc/source/install/installation/updating.rst b/doc/source/install/installation/updating.rst index 52865f0d..dc82f3b0 100644 --- a/doc/source/install/installation/updating.rst +++ b/doc/source/install/installation/updating.rst @@ -103,28 +103,22 @@ Updating Undercloud Components openstack undercloud upgrade - To upgrade to a containerized undercloud, just add --use-heat option:: - - openstack undercloud upgrade --use-heat + .. note:: + The undercloud is containerized by default as of Rocky. Therefore, + an undercloud deployed on Queens (non-containerized) will be upgraded + to a containerized undercloud on Rocky, by default. + To upgrade with instack undercloud, you'll need to upgrade + with --use-heat=False option. Note this isn't tested and not supported. .. note:: - When upgrading a containerized undercloud, it's possible to enable verbose - logging with --verbose option. - - .. admonition:: Queens to Rocky and later - :class: otop - - The containerized undercloud deployment isn't supported before Rocky release. - Therefore, the upgrade is supported in Rocky, from a non containerized undercloud - in Queens to a containerized undercloud in Rocky. + It's possible to enable verbose logging with --verbose option. + To cleanup an undercloud after its upgrade, you'll need to set + upgrade_cleanup to True in undercloud.conf. It'll remove the rpms + that were deployed by instack-undercloud, after the upgrade to a + containerized undercloud. .. note:: - - You may wish to use time and capture the output to a file for any debug - - .. code-block:: bash - - time openstack undercloud upgrade 2>&1 | tee undercloud_upgrade.log + It's possible to enable verbose logging with --verbose option. .. note::