RABBITMQ-UPGRADE(8)

🌸 rabbitmq-upgrade(8) — glow-up szn for your RabbitMQ nodes 💅

okay so bestie, real talk: this is a page from the System Manager's Manual, and it's literally the manual for rabbitmq-upgrade, the little command-line bestie you call on when you're upgrading RabbitMQ nodes. Think of it as the backstage crew for your cluster's glow-up. 👑

✨ NAME ✨

rabbitmq-upgrade — the RabbitMQ installation upgrade tools, aka your upgrade-era support system 🫶

✨ SYNOPSIS ✨

rabbitmq-upgrade [-q] [-s] [-l] [-n node] [-t timeout] command
                 [command_options]

✨ DESCRIPTION ✨

So rabbitmq-upgrade is a command line tool, and its whole personality is providing the commands you need during the upgrade of RabbitMQ nodes. It's giving "I'm only here for the transition era."

Wanna actually learn about RabbitMQ installation upgrades? The upgrade guide is right here, no gatekeeping:

https://www.rabbitmq.com/docs/upgrade

✨ OPTIONS ✨

• -n node — picks the node you're talking to. The default is "rabbit@target-hostname", where target-hostname is the local host. So on a host named "myserver.example.com", the node name will usually be "rabbit@myserver" (unless RABBITMQ_NODENAME has been overridden, in which case, respect the override bestie 💅). The output of hostname -s is usually the correct suffix to use after the @ sign. If you wanna know how a RabbitMQ node gets configured, that's rabbitmq-server(8)'s whole thing.
• -q, --quiet — quiet output mode is selected. Informational messages get reduced when quiet mode is in effect. less yapping, same tea 🍵
• -s, --silent — silent output mode is selected. Informational messages are reduced and table headers are suppressed when silent mode is in effect. literally the introvert mode of output modes 🙈
• -t timeout, --timeout timeout — operation timeout, in seconds. important caveat: not all commands support timeouts. Default is infinity, which is a mood honestly ♾️
• -l, --longnames — you must specify this when the cluster is configured to use long (FQDN) node names. no cap, mandatory. to learn more, hit up the RabbitMQ Clustering guide: https://www.rabbitmq.com/docs/clustering
• --erlang-cookie cookie — the shared secret used to authenticate to the target node. lowkey please prefer using a local file or the RABBITMQ_ERLANG_COOKIE environment variable instead of putting this option on the command line, okay? 🔐 to learn more, the RabbitMQ CLI Tools guide has you: https://www.rabbitmq.com/docs/cli

---

🎀 COMMANDS 🎀

help

Displays general help plus the commands that rabbitmq-upgrade supports. it's the "what can u even do" command, iconic.

post_upgrade

Runs post-upgrade tasks. In the current version, it performs the rebalance of mirrored and quorum queues across all nodes in the cluster. yes, it's doing the whole "everybody share the load" moment ✨

await_online_quorum_plus_one

Waits for all quorum queues to have an above minimum online quorum. Why do we care? Because this makes sure that no queues would lose their quorum if the target node is shut down. it's giving protective bestie energy fr fr 🫶

drain

Puts the node in maintenance mode. Such nodes will not serve any client traffic or considered for hosting any queue leader replicas. so basically: node is on a spa day, do not disturb 💆‍♀️

To learn more, see the RabbitMQ Upgrade guide: https://www.rabbitmq.com/docs/upgrade#maintenance-mode

revive

Puts the node out of maintenance and into regular operating mode. Such nodes will again serve client traffic and considered for queue leader replica placement. spa day over, back to being a main character 🔥

To learn more, see the RabbitMQ Upgrade guide: https://www.rabbitmq.com/docs/upgrade#maintenance-mode

---

👑 SEE ALSO 👑

the whole friend group shows up here:

• rabbitmqctl(8)
• rabbitmq-diagnostics(8)
• rabbitmq-server(8)
• rabbitmq-queues(8)
• rabbitmq-streams(8)
• rabbitmq-service(8)
• rabbitmq-env.conf(5)

💜 AUTHOR 💜

The RabbitMQ Team <contact-tanzu-data.pdl@broadcom.com> — they made this, we stan 🌈

---

and that's the whole page bestie, you ate 💅 this cutie was brought to you by RabbitMQ Server (the source/version vibe, yk how it is) and it's dated June 22, 2023 — periodt. 🎀💖