diff options
| author | Matt Crees <mattc@stackhpc.com> | 2026-01-13 10:28:23 +0000 |
|---|---|---|
| committer | Matt Crees <mattc@stackhpc.com> | 2026-02-18 13:11:27 +0000 |
| commit | 856472b8369a702ff683dfc5e28de11c2405bf3e (patch) | |
| tree | 43f59a5da7829881c847b4275b4fffd5063ddd88 /doc/source/reference/message-queues | |
| parent | 7d89d6afbef6fcb352c30f9fe04a72fbeca1f18f (diff) | |
| download | kolla-ansible-856472b8369a702ff683dfc5e28de11c2405bf3e.tar.gz kolla-ansible-856472b8369a702ff683dfc5e28de11c2405bf3e.zip | |
RabbitMQ: document handling stream replicas
Closes-Bug: #2138290
Change-Id: Ic5fc1b7e801b28a2bb20b4a60146ac443ffe5ef0
Signed-off-by: Matt Crees <mattc@stackhpc.com>
Diffstat (limited to 'doc/source/reference/message-queues')
| -rw-r--r-- | doc/source/reference/message-queues/rabbitmq.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/source/reference/message-queues/rabbitmq.rst b/doc/source/reference/message-queues/rabbitmq.rst index 375d58fe4..3bd364564 100644 --- a/doc/source/reference/message-queues/rabbitmq.rst +++ b/doc/source/reference/message-queues/rabbitmq.rst @@ -159,3 +159,22 @@ different type, the follow procedure will be needed. .. code-block:: console kolla-ansible deploy --tags <service-tags> + +Handling Stream Replicas +~~~~~~~~~~~~~~~~~~~~~~~~ + +RabbitMQ streams are expected to be replicated across the nodes in the +cluster. However, RabbitMQ itself will only create replicas of a stream when +the stream is initially declared. This means that any streams declared when a +RabbitMQ node is out of service must be explicitly managed by an operator. +RabbitMQ documents how to manage stream replicas here: +https://www.rabbitmq.com/docs/streams#member-management + +An example script to create any missing stream replicas can be found under +`kolla-ansible/contrib/ops/rabbitmq/rabbitmq-repair-stream-replicas.sh +<https://opendev.org/openstack/kolla-ansible/src/branch/master/contrib/ops/rabbitmq/rabbitmq-repair-stream-replicas.sh>`__. +This should be executed from a host running the RabbitMQ container. +Currently, membership changes for streams `is not entirely safe +<https://github.com/rabbitmq/rabbitmq-server/discussions/14246>`__, so this +script should only be used when the RabbitMQ cluster is in a known healthy +state. |