Skip to content

Commit a246b35

Browse files
authored
Merge pull request #1262 from stackhpc/fix-docs-again
Fix Caracal upgrade docs again
2 parents 8c27047 + db50617 commit a246b35

File tree

1 file changed

+49
-60
lines changed

1 file changed

+49
-60
lines changed

doc/source/operations/upgrading-openstack.rst

Lines changed: 49 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -35,64 +35,6 @@ Notable changes in the |current_release| Release
3535
There are many changes in the OpenStack |current_release| release described in
3636
the release notes for each project. Here are some notable ones.
3737

38-
RabbitMQ SLURP upgrade
39-
----------------------
40-
41-
Because this is a SLURP upgrade, RabbitMQ must be upgraded manually from 3.11,
42-
to 3.12, then to 3.13 on Antelope before the Caracal upgrade. This upgrade
43-
should not cause an API outage (though it should still be considered "at
44-
risk").
45-
46-
There are two prerequisites:
47-
48-
1. Kolla-Ansible should be upgraded to the latest version:
49-
50-
.. code-block:: bash
51-
52-
cd $KOLLA_SOURCE_PATH
53-
git fetch && git pull
54-
$KOLLA_VENV_PATH/bin/pip install .
55-
56-
2. The RabbitMQ container image tag must be equal to or newer than
57-
``20240823T101942``. Check the timestamps in
58-
``etc/kayobe/kolla-image-tags.yml``.
59-
60-
Once complete, upgrade RabbitMQ:
61-
62-
.. code-block:: bash
63-
64-
kayobe overcloud service configuration generate --node-config-dir /tmp/ignore -kt none
65-
kayobe kolla ansibe run "rabbitmq-upgrade 3.12"
66-
kayobe kolla ansibe run "rabbitmq-upgrade 3.13"
67-
68-
RabbitMQ quorum queues
69-
----------------------
70-
71-
In Caracal, quorum queues are enabled by default for RabbitMQ. This is
72-
different to Antelope which used HA queues. Before upgrading to Caracal, it is
73-
strongly recommended that you migrate from HA to quorum queues. The migration
74-
is automated using a script.
75-
76-
.. warning::
77-
This migration will stop all services using RabbitMQ and cause an
78-
extended API outage while queues are migrated. It should only be
79-
performed in a pre-agreed maintenance window.
80-
81-
Set the following variables in your kolla globals file (i.e.
82-
``$KAYOBE_CONFIG_PATH/kolla/globals.yml`` or
83-
``$KAYOBE_CONFIG_PATH/environments/$KAYOBE_ENVIRONMENT/kolla/globals.yml``):
84-
85-
.. code-block:: yaml
86-
87-
om_enable_rabbitmq_high_availability: false
88-
om_enable_rabbitmq_quorum_queues: true
89-
90-
Then execute the migration script:
91-
92-
.. code-block:: bash
93-
94-
$KAYOBE_CONFIG_PATH/../../tools/rabbitmq-quorum-migration.sh
95-
9638
Heat disabled by default
9739
------------------------
9840

@@ -115,8 +57,8 @@ TODO: guide for disabling Heat
11557
Designate sink disabled by default
11658
----------------------------------
11759

118-
Designate sink is optional designate service which listens for event
119-
Notifications, primarily from Nova and Neutron. It is disabled by default (when
60+
Designate sink is an optional Designate service which listens for event
61+
notifications, primarily from Nova and Neutron. It is disabled by default (when
12062
designate is enabled) in Caracal. It is not required for Designate to function.
12163

12264
If you still wish to use it, you should set the flag manually:
@@ -211,6 +153,53 @@ suggestions:
211153
* Update the deployment to use the latest |previous_release| images and
212154
configuration.
213155

156+
RabbitMQ SLURP upgrade
157+
----------------------
158+
159+
.. note::
160+
The upgrade is reliant on recent changes. Make sure you have updated to
161+
the latest version of kolla ansible and deployed the latest kolla containers
162+
before proceeding.
163+
164+
Because this is a SLURP upgrade, RabbitMQ must be upgraded manually from 3.11,
165+
to 3.12, then to 3.13 on Antelope before the Caracal upgrade. This upgrade
166+
should not cause an API outage (though it should still be considered "at
167+
risk").
168+
169+
.. code-block:: bash
170+
171+
kayobe overcloud service configuration generate --node-config-dir /tmp/ignore -kt none
172+
kayobe kolla ansible run "rabbitmq-upgrade 3.12"
173+
kayobe kolla ansible run "rabbitmq-upgrade 3.13"
174+
175+
RabbitMQ quorum queues
176+
----------------------
177+
178+
In Caracal, quorum queues are enabled by default for RabbitMQ. This is
179+
different to Antelope which used HA queues. Before upgrading to Caracal, it is
180+
strongly recommended that you migrate from HA to quorum queues. The migration
181+
is automated using a script.
182+
183+
.. warning::
184+
This migration will stop all services using RabbitMQ and cause an
185+
extended API outage while queues are migrated. It should only be
186+
performed in a pre-agreed maintenance window.
187+
188+
Set the following variables in your kolla globals file (i.e.
189+
``$KAYOBE_CONFIG_PATH/kolla/globals.yml`` or
190+
``$KAYOBE_CONFIG_PATH/environments/$KAYOBE_ENVIRONMENT/kolla/globals.yml``):
191+
192+
.. code-block:: yaml
193+
194+
om_enable_rabbitmq_high_availability: false
195+
om_enable_rabbitmq_quorum_queues: true
196+
197+
Then execute the migration script:
198+
199+
.. code-block:: bash
200+
201+
$KAYOBE_CONFIG_PATH/../../tools/rabbitmq-quorum-migration.sh
202+
214203
Preparation
215204
===========
216205

0 commit comments

Comments
 (0)