From db506174378afe9160d98bfafac2876b46c46cb2 Mon Sep 17 00:00:00 2001 From: Alex-Welsh Date: Wed, 4 Sep 2024 15:19:39 +0100 Subject: [PATCH] Fix Caracal upgrade docs again --- doc/source/operations/upgrading-openstack.rst | 109 ++++++++---------- 1 file changed, 49 insertions(+), 60 deletions(-) diff --git a/doc/source/operations/upgrading-openstack.rst b/doc/source/operations/upgrading-openstack.rst index ad5d4da11..7b653fa78 100644 --- a/doc/source/operations/upgrading-openstack.rst +++ b/doc/source/operations/upgrading-openstack.rst @@ -35,64 +35,6 @@ Notable changes in the |current_release| Release There are many changes in the OpenStack |current_release| release described in the release notes for each project. Here are some notable ones. -RabbitMQ SLURP upgrade ----------------------- - -Because this is a SLURP upgrade, RabbitMQ must be upgraded manually from 3.11, -to 3.12, then to 3.13 on Antelope before the Caracal upgrade. This upgrade -should not cause an API outage (though it should still be considered "at -risk"). - -There are two prerequisites: - -1. Kolla-Ansible should be upgraded to the latest version: - - .. code-block:: bash - - cd $KOLLA_SOURCE_PATH - git fetch && git pull - $KOLLA_VENV_PATH/bin/pip install . - -2. The RabbitMQ container image tag must be equal to or newer than - ``20240823T101942``. Check the timestamps in - ``etc/kayobe/kolla-image-tags.yml``. - -Once complete, upgrade RabbitMQ: - -.. code-block:: bash - - kayobe overcloud service configuration generate --node-config-dir /tmp/ignore -kt none - kayobe kolla ansibe run "rabbitmq-upgrade 3.12" - kayobe kolla ansibe run "rabbitmq-upgrade 3.13" - -RabbitMQ quorum queues ----------------------- - -In Caracal, quorum queues are enabled by default for RabbitMQ. This is -different to Antelope which used HA queues. Before upgrading to Caracal, it is -strongly recommended that you migrate from HA to quorum queues. The migration -is automated using a script. - -.. warning:: - This migration will stop all services using RabbitMQ and cause an - extended API outage while queues are migrated. It should only be - performed in a pre-agreed maintenance window. - -Set the following variables in your kolla globals file (i.e. -``$KAYOBE_CONFIG_PATH/kolla/globals.yml`` or -``$KAYOBE_CONFIG_PATH/environments/$KAYOBE_ENVIRONMENT/kolla/globals.yml``): - -.. code-block:: yaml - - om_enable_rabbitmq_high_availability: false - om_enable_rabbitmq_quorum_queues: true - -Then execute the migration script: - -.. code-block:: bash - - $KAYOBE_CONFIG_PATH/../../tools/rabbitmq-quorum-migration.sh - Heat disabled by default ------------------------ @@ -115,8 +57,8 @@ TODO: guide for disabling Heat Designate sink disabled by default ---------------------------------- -Designate sink is optional designate service which listens for event -Notifications, primarily from Nova and Neutron. It is disabled by default (when +Designate sink is an optional Designate service which listens for event +notifications, primarily from Nova and Neutron. It is disabled by default (when designate is enabled) in Caracal. It is not required for Designate to function. If you still wish to use it, you should set the flag manually: @@ -211,6 +153,53 @@ suggestions: * Update the deployment to use the latest |previous_release| images and configuration. +RabbitMQ SLURP upgrade +---------------------- + +.. note:: + The upgrade is reliant on recent changes. Make sure you have updated to + the latest version of kolla ansible and deployed the latest kolla containers + before proceeding. + +Because this is a SLURP upgrade, RabbitMQ must be upgraded manually from 3.11, +to 3.12, then to 3.13 on Antelope before the Caracal upgrade. This upgrade +should not cause an API outage (though it should still be considered "at +risk"). + +.. code-block:: bash + + kayobe overcloud service configuration generate --node-config-dir /tmp/ignore -kt none + kayobe kolla ansible run "rabbitmq-upgrade 3.12" + kayobe kolla ansible run "rabbitmq-upgrade 3.13" + +RabbitMQ quorum queues +---------------------- + +In Caracal, quorum queues are enabled by default for RabbitMQ. This is +different to Antelope which used HA queues. Before upgrading to Caracal, it is +strongly recommended that you migrate from HA to quorum queues. The migration +is automated using a script. + +.. warning:: + This migration will stop all services using RabbitMQ and cause an + extended API outage while queues are migrated. It should only be + performed in a pre-agreed maintenance window. + +Set the following variables in your kolla globals file (i.e. +``$KAYOBE_CONFIG_PATH/kolla/globals.yml`` or +``$KAYOBE_CONFIG_PATH/environments/$KAYOBE_ENVIRONMENT/kolla/globals.yml``): + +.. code-block:: yaml + + om_enable_rabbitmq_high_availability: false + om_enable_rabbitmq_quorum_queues: true + +Then execute the migration script: + +.. code-block:: bash + + $KAYOBE_CONFIG_PATH/../../tools/rabbitmq-quorum-migration.sh + Preparation ===========