openstack/kolla-ansible
Code Issues Proposed changes

Upgrade RabbitMQ docs for the Epoxy release

Browse Source 
Updates the HA section to account for the change to quorum queues and
streams by default.

Also adds a note to the SLURP section as it's not needed for Epoxy.

Change-Id: Id4a3b4f3934622572c8493678f109fa67ccfdec6
This commit is contained in:
Matt Crees 2025-02-04 11:28:15 +00:00 committed by Michal Arbet
parent 50bbcb09d0
commit 8fa110bb86
1 changed files with 15 additions and 15 deletions

30
doc/source/reference/message-queues/rabbitmq.rst

@ -113,23 +113,18 @@ https://www.rabbitmq.com/runtime.html#busy-waiting.
High Availability
~~~~~~~~~~~~~~~~~
RabbitMQ offers two options to configure HA:
* Quorum queues (enabled by default and controlled by
``om_enable_rabbitmq_quorum_queues`` variable)
* Classic queue mirroring and durable queues (deprecated in RabbitMQ and to
be dropped in 4.0, controlled by ``om_enable_rabbitmq_high_availability``)
There are some queue types which are intentionally not mirrored
using the exclusionary pattern ``^(?!(amq\\.)|(.*_fanout_)|(reply_)).*``.
After enabling one of these values on a running system, there are some
additional steps needed to migrate from transient to durable queues.
With the release of RabbitMQ 4.0, all queues are highly available as they are
configured to be quorum queues by default. RabbitMQ also offer queues called
streams, which can be used to replace "fanout" queues with a more performant
alternative. This is enabled by default, but can be disabled by setting
``om_enable_rabbitmq_stream_fanout: false``. When changing queues to a
different type, the follow procedure will be needed.
.. warning::
Since the default changed from non-HA to Quorum queues in Bobcat release,
following procedure is required to be carried out before a SLURP upgrade to
Caracal.
Since the default changed to have all queues be of durable type in the Epoxy
release, following procedure is required to be carried out before any
upgrade to Epoxy.
1. Stop all OpenStack services which use RabbitMQ, so that they will not
attempt to recreate any queues yet.
@ -144,7 +139,7 @@ additional steps needed to migrate from transient to durable queues.
kolla-ansible genconfig
3. Reconfigure RabbitMQ if you are using
3. Reconfigure RabbitMQ if you were previously using
``om_enable_rabbitmq_high_availability``.
.. code-block:: console
@ -168,6 +163,11 @@ additional steps needed to migrate from transient to durable queues.
SLURP
~~~~~
.. note::
The version of RabbitMQ did not increase in Dalmatian, so this will not be
needed for a skip-level upgrade to Epoxy.
RabbitMQ has two major version releases per year but does not support jumping
two versions in one upgrade. So if you want to perform a skip-level upgrade,
you must first upgrade RabbitMQ to an intermediary version. To do this, Kolla