Skip to content

Commit f1a1043

Browse files
committed
Make clear RMQ migration/upgrade is prerequisites
1 parent 7f778d1 commit f1a1043

File tree

1 file changed

+60
-52
lines changed

1 file changed

+60
-52
lines changed

doc/source/operations/upgrading-openstack.rst

Lines changed: 60 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -35,58 +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 4.1
39-
------------
40-
41-
StackHPC Kayobe Config sets RabbitMQ 4.1 as the default for the Epoxy release.
42-
Existing transient queues must be migrated to durable queues with Queue Manager before upgrading to RabbitMQ 4.1.
43-
44-
Queue Migration
45-
~~~~~~~~~~~~~~~
46-
47-
.. warning::
48-
49-
This migration will stop all services using RabbitMQ and cause an extended
50-
API outage while queues are migrated. It should only be performed in a
51-
pre-agreed maintenance window.
52-
53-
If you are using Azimuth or the ClusterAPI driver for Magnum, you should
54-
make sure to pause reconciliation of all clusters before the API outage
55-
window. See the `Azimuth docs
56-
<https://azimuth-config.readthedocs.io/en/stable/operations/01-maintenance/>`__
57-
for instructions.
58-
59-
Set the following variables in your kolla globals file (i.e.
60-
$KAYOBE_CONFIG_PATH/kolla/globals.yml or $KAYOBE_CONFIG_PATH/environments/$KAYOBE_ENVIRONMENT/kolla/globals.yml):
61-
62-
.. code-block:: yaml
63-
64-
om_enable_queue_manager: true
65-
om_enable_rabbitmq_quorum_queues: true
66-
om_enable_rabbitmq_transient_quorum_queue: true
67-
om_enable_rabbitmq_stream_fanout: true
68-
69-
Then execute the migration script:
70-
71-
.. code-block:: bash
72-
73-
$KAYOBE_CONFIG_PATH/../../tools/rabbitmq-queue-migration.sh
74-
75-
RabbitMQ Upgrade
76-
~~~~~~~~~~~~~~~~
77-
78-
After queue migration is finished, upgrade RabbitMQ to 4.1 by running the following command
79-
80-
.. code-block:: bash
81-
82-
kayobe kolla ansible run "rabbitmq-upgrade 4.1"
83-
84-
.. note::
85-
86-
Until Kolla-Ansible bug `LP#2118452 <https://bugs.launchpad.net/kolla-ansible/+bug/2118452>`__
87-
is fixed, add ``--kolla-skip-tags rabbitmq-version-check`` to avoid Kolla-Ansible incorrectly
88-
stopping RabbitMQ upgrade from 3.13 to 4.1.
89-
9038
stackhpc.linux collection
9139
-------------------------
9240

@@ -341,6 +289,66 @@ must be migrated to Ubuntu 24.04 before upgrading OpenStack services. The
341289
upgrade process is currently a work in progress.
342290
.. TODO: Add link to another page describing how to migrate
343291
292+
RabbitMQ 4.1
293+
------------
294+
295+
.. warning::
296+
297+
RabbitMQ queue migration and upgrade must be done in Caracal environment.
298+
299+
StackHPC Kayobe Config sets RabbitMQ 4.1 as the default for the Epoxy release.
300+
Existing transient queues must be migrated to durable queues with Queue Manager before upgrading to RabbitMQ 4.1.
301+
302+
Queue Migration
303+
~~~~~~~~~~~~~~~
304+
305+
.. warning::
306+
307+
This migration will stop all services using RabbitMQ and cause an extended
308+
API outage while queues are migrated. It should only be performed in a
309+
pre-agreed maintenance window.
310+
311+
If you are using Azimuth or the ClusterAPI driver for Magnum, you should
312+
make sure to pause reconciliation of all clusters before the API outage
313+
window. See the `Azimuth docs
314+
<https://azimuth-config.readthedocs.io/en/stable/operations/01-maintenance/>`__
315+
for instructions.
316+
317+
Set the following variables in your kolla globals file (i.e.
318+
$KAYOBE_CONFIG_PATH/kolla/globals.yml or $KAYOBE_CONFIG_PATH/environments/$KAYOBE_ENVIRONMENT/kolla/globals.yml):
319+
320+
.. code-block:: yaml
321+
322+
om_enable_queue_manager: true
323+
om_enable_rabbitmq_quorum_queues: true
324+
om_enable_rabbitmq_transient_quorum_queue: true
325+
om_enable_rabbitmq_stream_fanout: true
326+
327+
Then execute the migration script:
328+
329+
.. code-block:: bash
330+
331+
$KAYOBE_CONFIG_PATH/../../tools/rabbitmq-queue-migration.sh
332+
333+
RabbitMQ Upgrade
334+
~~~~~~~~~~~~~~~~
335+
336+
After queue migration is finished, upgrade RabbitMQ to 4.1.
337+
338+
1. Sync and publish latest Kolla container images to ensure local pulp has RabbitMQ 4.1 image.
339+
(This can be skipped if local pulp is not used.)
340+
341+
.. code-block:: bash
342+
343+
kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-container-sync.yml
344+
kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/pulp-container-publish.yml
345+
346+
2. Upgrade RabbitMQ to 4.1 with Kolla-Ansible
347+
348+
.. code-block:: bash
349+
350+
kayobe kolla ansible run "rabbitmq-upgrade 4.1"
351+
344352
Preparation
345353
===========
346354

0 commit comments

Comments
 (0)