From 856472b8369a702ff683dfc5e28de11c2405bf3e Mon Sep 17 00:00:00 2001 From: Matt Crees Date: Tue, 13 Jan 2026 10:28:23 +0000 Subject: RabbitMQ: document handling stream replicas Closes-Bug: #2138290 Change-Id: Ic5fc1b7e801b28a2bb20b4a60146ac443ffe5ef0 Signed-off-by: Matt Crees --- doc/source/reference/message-queues/rabbitmq.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'doc/source') 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 + +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 +`__. +This should be executed from a host running the RabbitMQ container. +Currently, membership changes for streams `is not entirely safe +`__, so this +script should only be used when the RabbitMQ cluster is in a known healthy +state. -- cgit v1.2.3