Skip to content

Commit 702ecb5

Browse files
michaelklishinmichaelklishin
authored
Merge pull request #2015 from rabbitmq/mk-man-pages-update-for-4.0
First man pages update for 4.0
2 parents 4fad6ec + b3305d8 commit 702ecb5

13 files changed

+59
-100
lines changed

‎.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,7 @@ yarn-debug.log*
2020
yarn-error.log*
2121

2222
.idea/
23+
# these can be copied from rabbitmq-server/deps/rabbit/docs by accident
24+
docs/man/*.html
25+
docs/man/*.8
26+
docs/man/*.sh

‎docs/man/rabbitmq-diagnostics.8.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -646,10 +646,10 @@ terabytes
646646
<p class="Pp">See <code class="Cm">quorum_status</code> in <a class="Xr" href="rabbitmq-queues.8.html">rabbitmq-queues(8)</a></p>
647647
</dd>
648648
<dt >
649-
#### <code class="Cm">check_if_node_is_mirror_sync_critical</code> {#check_if_node_is_mirror_sync_critical}
649+
#### <code class="Cm">check_if_cluster_has_classic_queue_mirroring_policy</code> {#check_if_cluster_has_classic_queue_mirroring_policy}
650650
</dt>
651651
<dd>
652-
<p class="Pp">See <code class="Cm">check_if_node_is_mirror_sync_critical</code> in <a class="Xr" href="rabbitmq-queues.8.html">rabbitmq-queues(8)</a></p>
652+
<p class="Pp">See <code class="Cm">check_if_cluster_has_classic_queue_mirroring_policy</code> in <a class="Xr" href="rabbitmq-queues.8.html">rabbitmq-queues(8)</a></p>
653653
</dd>
654654
<dt >
655655
#### <code class="Cm">check_if_node_is_quorum_critical</code> {#check_if_node_is_quorum_critical}
@@ -666,6 +666,6 @@ terabytes
666666
</section>
667667
<section class="Sh">
668668
## AUTHOR {#AUTHOR}
669-
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:[email protected].com">[email protected].com</a>&gt;</p>
669+
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:contact-tanzu-data.pdl@broadcom.com">contact-tanzu-data.pdl@broadcom.com</a>&gt;</p>
670670
</section>
671671
</div>

‎docs/man/rabbitmq-echopid.8.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,6 @@
3232
</section>
3333
<section class="Sh">
3434
## AUTHOR {#AUTHOR}
35-
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:[email protected].com">[email protected].com</a>&gt;</p>
35+
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:contact-tanzu-data.pdl@broadcom.com">contact-tanzu-data.pdl@broadcom.com</a>&gt;</p>
3636
</section>
3737
</div>

‎docs/man/rabbitmq-env.conf.5.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,6 @@
4747
</section>
4848
<section class="Sh">
4949
## AUTHOR {#AUTHOR}
50-
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:[email protected].com">[email protected].com</a>&gt;</p>
50+
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:contact-tanzu-data.pdl@broadcom.com">contact-tanzu-data.pdl@broadcom.com</a>&gt;</p>
5151
</section>
5252
</div>

‎docs/man/rabbitmq-plugins.8.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,6 @@
207207
</section>
208208
<section class="Sh">
209209
## AUTHOR {#AUTHOR}
210-
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:[email protected].com">[email protected].com</a>&gt;</p>
210+
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:contact-tanzu-data.pdl@broadcom.com">contact-tanzu-data.pdl@broadcom.com</a>&gt;</p>
211211
</section>
212212
</div>

‎docs/man/rabbitmq-queues.8.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,16 @@
175175
</div>
176176
</dd>
177177
<dt >
178+
#### <code class="Cm">check_if_cluster_has_classic_queue_mirroring_policy</code> {#check_if_cluster_has_classic_queue_mirroring_policy}
179+
</dt>
180+
<dd>
181+
<p class="Pp">Health check that exits with a non-zero code if there are policies in the cluster that enable classic queue mirroring. Classic queue mirroring has been deprecated since 2021 and was completely removed in the RabbitMQ 4.0 development cycle.</p>
182+
<p class="Pp">Example:</p>
183+
<div class="Bd Bd-indent lang-bash">
184+
<code class="Li">rabbitmq-queues check_if_cluster_has_classic_queue_mirroring_policy</code>
185+
</div>
186+
</dd>
187+
<dt >
178188
#### <code class="Cm">check_if_node_is_quorum_critical</code> {#check_if_node_is_quorum_critical}
179189
</dt>
180190
<dd>
@@ -193,6 +203,6 @@
193203
</section>
194204
<section class="Sh">
195205
## AUTHOR {#AUTHOR}
196-
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:[email protected].com">[email protected].com</a>&gt;</p>
206+
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:contact-tanzu-data.pdl@broadcom.com">contact-tanzu-data.pdl@broadcom.com</a>&gt;</p>
197207
</section>
198208
</div>

‎docs/man/rabbitmq-server.8.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,6 @@
8080
</section>
8181
<section class="Sh">
8282
## AUTHOR {#AUTHOR}
83-
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:[email protected].com">[email protected].com</a>&gt;</p>
83+
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:contact-tanzu-data.pdl@broadcom.com">contact-tanzu-data.pdl@broadcom.com</a>&gt;</p>
8484
</section>
8585
</div>

‎docs/man/rabbitmq-service.8.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,6 @@
102102
</section>
103103
<section class="Sh">
104104
## AUTHOR {#AUTHOR}
105-
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:[email protected].com">[email protected].com</a>&gt;</p>
105+
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:contact-tanzu-data.pdl@broadcom.com">contact-tanzu-data.pdl@broadcom.com</a>&gt;</p>
106106
</section>
107107
</div>

‎docs/man/rabbitmq-streams.8.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,16 @@
9999
<code class="Li">rabbitmq-streams stream_status --vhost "a-vhost" "a-stream"</code>
100100
</div>
101101
</dd>
102+
<dt >
103+
#### <code class="Cm">restart_stream</code> <var class="Ar">stream</var> <code class="Fl">--vhost</code> <var class="Ar">virtual-host</var> <code class="Fl">---preferred-leader-node</code> <var class="Ar">node</var> {#restart_stream}
104+
</dt>
105+
<dd>
106+
<p class="Pp">Restarts a stream including all of it's replicas. The optional preferred node flag instructs the command to try to place the leader on a specific node during the restart.</p>
107+
<p class="Pp">Example:</p>
108+
<div class="Bd Bd-indent lang-bash">
109+
<code class="Li">rabbitmq-streams restart_stream --vhost "a-vhost" "a-stream" --preferred-leader-node "node"</code>
110+
</div>
111+
</dd>
102112
</dl>
103113
</section>
104114
<section class="Ss">
@@ -435,6 +445,6 @@ inactive
435445
</section>
436446
<section class="Sh">
437447
## AUTHOR {#AUTHOR}
438-
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:[email protected].com">[email protected].com</a>&gt;</p>
448+
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:contact-tanzu-data.pdl@broadcom.com">contact-tanzu-data.pdl@broadcom.com</a>&gt;</p>
439449
</section>
440450
</div>

‎docs/man/rabbitmq-upgrade.8.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
### <code class="Cm">post_upgrade</code> {#post_upgrade}
6565
</dt>
6666
<dd>
67-
<p class="Pp">Runs post-upgrade tasks. This is a command that can be expected to evolve over time.</p>
67+
<p class="Pp">Runs post-upgrade tasks. In the current version, it performs the rebalance of mirrored and quorum queues across all nodes in the cluster.</p>
6868
</dd>
6969
<dt >
7070
### <code class="Cm">await_online_quorum_plus_one</code> {#await_online_quorum_plus_one}
@@ -94,6 +94,6 @@
9494
</section>
9595
<section class="Sh">
9696
## AUTHOR {#AUTHOR}
97-
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:[email protected].com">[email protected].com</a>&gt;</p>
97+
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:contact-tanzu-data.pdl@broadcom.com">contact-tanzu-data.pdl@broadcom.com</a>&gt;</p>
9898
</section>
9999
</div>

‎docs/man/rabbitmqctl.8.md

Lines changed: 16 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -227,11 +227,11 @@ returns a non-zero exit code if the RabbitMQ node is not running
227227
<ul class="Bl-bullet Bl-compact">
228228
<li id="disc">
229229
#### <code class="Cm">disc</code> {#change_cluster_node_type}
230-
230+
231231
</li>
232232
<li id="ram">
233233
#### <code class="Cm">ram</code> {#change_cluster_node_type}
234-
234+
235235
</li>
236236
</ul>
237237

@@ -260,7 +260,7 @@ returns a non-zero exit code if the RabbitMQ node is not running
260260
<p class="Pp">Ensures that the node will start next time, even if it was not the last to shut down.</p>
261261
<p class="Pp">Normally when you shut down a RabbitMQ cluster altogether, the first node you restart should be the last one to go down, since it may have seen things happen that other nodes did not. But sometimes that's not possible: for instance, if the entire cluster loses power then all nodes may think they were not the last to shut down.</p>
262262
<p class="Pp">In such a case you can invoke <code class="Cm">force_boot</code> while the node is down. This will tell the node to unconditionally start the next time you ask it. Any changes to the cluster after this node shut down will be lost.</p>
263-
<p class="Pp">If the last node to go down is permanently lost then you should use <code class="Cm">forget_cluster_node</code> <code class="Fl">--offline</code> instead of this command.</p>
263+
<p class="Pp">If the last node to go down is permanently lost then you should use <code class="Cm">forget_cluster_node</code> <code class="Fl">--offline</code> instead of this command, as it will ensure that mirrored queues whose leader replica was on the lost node get promoted.</p>
264264
<p class="Pp">For example, this will force the node not to wait for other nodes the next time it is started:</p>
265265
<p class="Pp"></p>
266266
<div class="Bd Bd-indent lang-bash">
@@ -322,83 +322,6 @@ returns a non-zero exit code if the RabbitMQ node is not running
322322
</div>
323323
<p class="Pp">To learn more, see the <a class="Lk" href="https://www.rabbitmq.com/clustering.html">RabbitMQ Clustering guide</a>.</p>
324324
</dd>
325-
<dt >
326-
#### <code class="Cm">rename_cluster_node</code> <var class="Ar">oldnode1</var> <var class="Ar">newnode1</var> [<var class="Ar">oldnode2</var> <var class="Ar">newnode2 ...</var>] {#rename_cluster_node}
327-
</dt>
328-
<dd>
329-
<p class="Pp">Supports renaming of cluster nodes in the local database.</p>
330-
<p class="Pp">This subcommand causes <code class="Nm">rabbitmqctl</code> to temporarily become the node in order to make the change. The local cluster node must therefore be completely stopped; other nodes can be online or offline.</p>
331-
<p class="Pp">This subcommand takes an even number of arguments, in pairs representing the old and new names for nodes. You must specify the old and new names for this node and for any other nodes that are stopped and being renamed at the same time.</p>
332-
<p class="Pp">It is possible to stop all nodes and rename them all simultaneously (in which case old and new names for all nodes must be given to every node) or stop and rename nodes one at a time (in which case each node only needs to be told how its own name is changing).</p>
333-
<p class="Pp">For example, this command will rename the node "rabbit@misshelpful" to the node "rabbit@cordelia"</p>
334-
<p class="Pp"></p>
335-
<div class="Bd Bd-indent lang-bash">
336-
<code class="Li">rabbitmqctl rename_cluster_node rabbit@misshelpful rabbit@cordelia</code>
337-
</div>
338-
<p class="Pp">Note that this command only changes the local database. It may also be necessary to rename the local database directories and configure the new node name. For example:</p>
339-
<p class="Pp"></p>
340-
<ol class="Bl-enum Bl-compact">
341-
<li>
342-
Stop the node:
343-
<p class="Pp"></p>
344-
<div class="Bd Bd-indent lang-bash">
345-
<code class="Li">rabbitmqctl stop rabbit@misshelpful</code>
346-
</div>
347-
<p class="Pp"></p>
348-
349-
</li>
350-
<li>
351-
Rename the node in the local database:
352-
<p class="Pp"></p>
353-
<div class="Bd Bd-indent lang-bash">
354-
<code class="Li">rabbitmqctl rename_cluster_node rabbit@misshelpful rabbit@cordelia</code>
355-
</div>
356-
<p class="Pp"></p>
357-
358-
</li>
359-
<li>
360-
Rename the local database directories (note, you do not need to do this if you have set the RABBITMQ_MNESIA_DIR environment variable):
361-
<p class="Pp"></p>
362-
<div class="Bd Bd-indent Li">
363-
<pre>mv \
364-
/var/lib/rabbitmq/mnesia/rabbit\@misshelpful \
365-
/var/lib/rabbitmq/mnesia/rabbit\@cordelia
366-
mv \
367-
/var/lib/rabbitmq/mnesia/rabbit\@misshelpful-rename \
368-
/var/lib/rabbitmq/mnesia/rabbit\@cordelia-rename
369-
mv \
370-
/var/lib/rabbitmq/mnesia/rabbit\@misshelpful-plugins-expand \
371-
/var/lib/rabbitmq/mnesia/rabbit\@cordelia-plugins-expand</pre>
372-
</div>
373-
<p class="Pp"></p>
374-
375-
</li>
376-
<li>
377-
If node name is configured e.g. using <var class="Ar">/etc/rabbitmq/rabbitmq-env.conf</var> , it also needs to be updated there.
378-
<p class="Pp"></p>
379-
380-
</li>
381-
<li>
382-
Start the node when ready
383-
</li>
384-
</ol>
385-
</dd>
386-
<dt >
387-
#### <code class="Cm">update_cluster_nodes</code> <var class="Ar">clusternode</var> {#update_cluster_nodes}
388-
</dt>
389-
<dd>
390-
<dl class="Bl-tag">
391-
<dt><var class="Ar">clusternode</var></dt>
392-
<dd>The node to consult for up-to-date information.</dd>
393-
</dl>
394-
<p class="Pp">Instructs an already clustered node to contact <var class="Ar">clusternode</var> to cluster when booting up. This is different from <code class="Cm">join_cluster</code> since it does not join any cluster - it checks that the node is already in a cluster with <var class="Ar">clusternode</var>.</p>
395-
<p class="Pp">The need for this command is motivated by the fact that clusters can change while a node is offline. Consider a situation where node <var class="Va">rabbit@A</var> and <var class="Va">rabbit@B</var> are clustered. <var class="Va">rabbit@A</var> goes down, <var class="Va">rabbit@C</var> clusters with <var class="Va">rabbit@B</var>, and then <var class="Va">rabbit@B</var> leaves the cluster. When <var class="Va">rabbit@A</var> starts back up, it'll try to contact <var class="Va">rabbit@B</var>, but this will fail since <var class="Va">rabbit@B</var> is not in the cluster anymore. The following command will rename node <var class="Va">rabbit@B</var> to <var class="Va">rabbit@C</var> on node <var class="Va">rabbitA</var></p>
396-
<p class="Pp"></p>
397-
<div class="Bd Bd-indent lang-bash">
398-
<code class="Li">update_cluster_nodes -n <var class="Va">rabbit@A</var> <var class="Va">rabbit@B</var> <var class="Va">rabbit@C</var></code>
399-
</div>
400-
<p class="Pp">To learn more, see the <a class="Lk" href="https://www.rabbitmq.com/clustering.html">RabbitMQ Clustering guide</a></p>
401-
</dd>
402325
</dl>
403326
</section>
404327
<section class="Ss">
@@ -1272,6 +1195,18 @@ fanout
12721195
</dt>
12731196
<dd>Bytes of memory allocated by the runtime for the queue, including stack, heap, and internal structures.</dd>
12741197
<dt >
1198+
#### <code class="Cm">mirror_pids</code> {#mirror_pids}
1199+
</dt>
1200+
<dd>
1201+
If the queue is mirrored, this lists the IDs of the mirrors (follower replicas). To learn more, see the <a class="Lk" href="https://www.rabbitmq.com/ha.html">RabbitMQ Mirroring guide</a>
1202+
</dd>
1203+
<dt >
1204+
#### <code class="Cm">synchronised_mirror_pids</code> {#synchronised_mirror_pids}
1205+
</dt>
1206+
<dd>
1207+
If the queue is mirrored, this gives the IDs of the mirrors (follower replicas) which are in sync with the leader replica. To learn more, see the <a class="Lk" href="https://www.rabbitmq.com/ha.html">RabbitMQ Mirroring guide</a>
1208+
</dd>
1209+
<dt >
12751210
#### <code class="Cm">state</code> {#state~2}
12761211
</dt>
12771212
<dd>
@@ -2622,6 +2557,6 @@ stomp_headers
26222557
</section>
26232558
<section class="Sh">
26242559
## AUTHOR {#AUTHOR}
2625-
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:[email protected].com">[email protected].com</a>&gt;</p>
2560+
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:contact-tanzu-data.pdl@broadcom.com">contact-tanzu-data.pdl@broadcom.com</a>&gt;</p>
26262561
</section>
26272562
</div>

‎versioned_docs/version-3.13/man/rabbitmq-diagnostics.8.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -646,10 +646,10 @@ terabytes
646646
<p class="Pp">See <code class="Cm">quorum_status</code> in <a class="Xr" href="rabbitmq-queues.8.html">rabbitmq-queues(8)</a></p>
647647
</dd>
648648
<dt >
649-
#### <code class="Cm">check_if_node_is_mirror_sync_critical</code> {#check_if_node_is_mirror_sync_critical}
649+
#### <code class="Cm">check_if_cluster_has_classic_queue_mirroring_policy</code> {#check_if_cluster_has_classic_queue_mirroring_policy}
650650
</dt>
651651
<dd>
652-
<p class="Pp">See <code class="Cm">check_if_node_is_mirror_sync_critical</code> in <a class="Xr" href="rabbitmq-queues.8.html">rabbitmq-queues(8)</a></p>
652+
<p class="Pp">See <code class="Cm">check_if_cluster_has_classic_queue_mirroring_policy</code> in <a class="Xr" href="rabbitmq-queues.8.html">rabbitmq-queues(8)</a></p>
653653
</dd>
654654
<dt >
655655
#### <code class="Cm">check_if_node_is_quorum_critical</code> {#check_if_node_is_quorum_critical}
@@ -666,6 +666,6 @@ terabytes
666666
</section>
667667
<section class="Sh">
668668
## AUTHOR {#AUTHOR}
669-
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:[email protected].com">[email protected].com</a>&gt;</p>
669+
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:contact-tanzu-data.pdl@broadcom.com">contact-tanzu-data.pdl@broadcom.com</a>&gt;</p>
670670
</section>
671671
</div>

‎versioned_docs/version-3.13/man/rabbitmq-queues.8.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -175,13 +175,13 @@
175175
</div>
176176
</dd>
177177
<dt >
178-
#### <code class="Cm">check_if_node_is_mirror_sync_critical</code> {#check_if_node_is_mirror_sync_critical}
178+
#### <code class="Cm">check_if_cluster_has_classic_queue_mirroring_policy</code> {#check_if_cluster_has_classic_queue_mirroring_policy}
179179
</dt>
180180
<dd>
181-
<p class="Pp">Health check that exits with a non-zero code if there are classic mirrored queues without online synchronised mirrors (queues that would potentially lose data if the target node is shut down).</p>
181+
<p class="Pp">Health check that exits with a non-zero code if there are policies in the cluster that enable classic queue mirroring. Classic queue mirroring has been deprecated since 2021 and was completely removed in the RabbitMQ 4.0 development cycle.</p>
182182
<p class="Pp">Example:</p>
183183
<div class="Bd Bd-indent lang-bash">
184-
<code class="Li">rabbitmq-queues check_if_node_is_mirror_sync_critical</code>
184+
<code class="Li">rabbitmq-queues check_if_cluster_has_classic_queue_mirroring_policy</code>
185185
</div>
186186
</dd>
187187
<dt >
@@ -203,6 +203,6 @@
203203
</section>
204204
<section class="Sh">
205205
## AUTHOR {#AUTHOR}
206-
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:[email protected].com">[email protected].com</a>&gt;</p>
206+
<p class="Pp"><span class="An">The RabbitMQ Team</span> &lt;<a class="Mt" href="mailto:contact-tanzu-data.pdl@broadcom.com">contact-tanzu-data.pdl@broadcom.com</a>&gt;</p>
207207
</section>
208208
</div>

0 commit comments

Comments
 (0)