RabbitMQ¶
This page is the starting point for RabbitMQ, the rabbitmq role: the containers rabbitmq and outward_rabbitmq, on
the control nodes of the example inventory. Two plays apply the role, rabbitmq and outward-rabbitmq, and they share
the tag rabbitmq. The lists below say where the study covers how to operate it, its impact, its dependencies and the
evidence, what to check around a run and what stays open; the service card follows them.
Where to look¶
Operate¶
- Scenario: Change control-plane membership §2
- Command: Change control-plane membership §1.1, Command quick lookup by tag
Impact and risk¶
Dependencies¶
- Dependencies: Component dependencies §1, Component dependencies §2
Evidence¶
- Fact sheet: fact sheet B §2
- Image side: Kolla images
§4 (row
rabbitmq), Kolla images §5 - Also: handlers: Tags §5
Before and after a run¶
- Pre-execution checklist, step 3 (batch size):
ANSIBLE_SERIALcoversreconfigure/upgradeand-e kolla_serial=Ncoversdeploy; mariadb and rabbitmq ignore it. - Pre-execution checklist, step 5 (health gates): before the run, check RabbitMQ: cluster status, no partitions. Repeat after each batch.
- Tags §3.1, row
rabbitmq: safe on its own "yes on a healthy cluster; membership changes are R3"; prerequisites: no partitions, all nodes running. - R3, precautions for a change of RabbitMQ group membership, password or port: plan as a
maintenance; batch with
--limit; verify RabbitMQ cluster health first. - R10, precautions for a RabbitMQ image change (
upgrade): maintenance window; watch for agent and compute services reported down.
Known limits and open points¶
- Known bugs and limitations, first row
rabbitmq: outward RabbitMQpulllooks upoutward_rabbitmq_services. Status: CODE: with outward RabbitMQ enabled, that variable is not defined anywhere, thevarslookup raises an undefined-variable error and "Pull images" fails on the outward-rabbitmq hosts. - Known bugs and limitations, second row
rabbitmq: the image writes.erlang.cookieonly in the bootstrap container (new volume); a cookie change recreates the brokers (env compare) but they keep the old cookie, whilekolla_toolboxgets the new one. Status: CODE; consequences NOT AVAILABLE. - What is not known, row "RabbitMQ": the sources do not establish whether nova-compute heartbeats are lost and services are reported down during the upgrade outage (R10); whether, during a one-by-one restart, nova-compute and the agents lose RPC, RPC-backed API calls time out and the agents reconnect by themselves; the consequences of a changed Erlang cookie.
- Q14, answered from the source CODE: RabbitMQ writes the Erlang cookie only in its bootstrap container.
- F6, "Global inputs are rendered into per-host files":
enable_*flags, RabbitMQ/memcached membership, service passwords and the external FQDN end up in compute-side files CODE. - fact sheet B
§2.8,
"Operationally notable behaviour, risks and oddities", eight items: reconfigure with a config change; upgrade = full
outage of the message bus; uncontrolled full stop; scaling the rabbitmq group changes
transport_urlin about 36 services; password change; thekolla-ansible pullbug with outward rabbitmq enabled;check.ymlis empty, andrabbitmq_hostnameis dead code; the precheck does N² lookups. - Kolla images §6, items 9 and 10: the RabbitMQ cookie is fixed at bootstrap CODE (consequences NOT AVAILABLE); recursive chown on data volumes at every start, the RabbitMQ mnesia directory among them CODE.
Service card¶
The rows of the card are explained in How to read a service card.
| Item | Value |
|---|---|
| Play | site.yml:535, site.yml:555 |
| Tags | rabbitmq |
| Play host patterns | rabbitmq, outward-rabbitmq |
| Node types in play (example inventory) | control |
| Node types running its containers | control |
| Containers | rabbitmq, outward_rabbitmq |
deploy/reconfigure flow (tasks/) |
config → check-containers → bootstrap → flush handlers |
| Task files | bootstrap.yml, check-containers.yml, check.yml, config.yml, deploy-containers.yml, deploy.yml, loadbalancer.yml, main.yml, precheck.yml, pull.yml, reconfigure.yml, restart_services.yml, stop.yml, upgrade.yml |
| Templates | advanced.config.j2, definitions.json.j2, erl_inetrc.j2, rabbitmq-env.conf.j2, rabbitmq.conf.j2, rabbitmq.json.j2 |
| Handlers (definition order) | Restart first rabbitmq container; Restart remaining rabbitmq containers |
| Key variables | enable_rabbitmq, om_rpc_*, rabbitmq_*, rpc_transport_url |
| Role dependencies | common (meta) |
Related¶
- Change control-plane membership — changing the
rabbitmqmembership changes the transport URL everywhere - Update container images §4 — with a tag change applied by
deploy, RabbitMQ is restarted node by node, not stopped cluster-wide - Component dependencies §1 — RabbitMQ hosts are listed one by one in the configs of the services that use them
- Common: fluentd, cron, kolla_toolbox —
kolla_toolboxgets the new cookie whenrabbitmq_cluster_cookiechanges - Pre-execution checklist — the eight checks before every production run
- Components — the other component pages