Skip to content

Commit 3883623

Browse files
Remove rabbitmqctl(8) entry of (now a no-op) rename_cluster_node and friends
1 parent a5b46fb commit 3883623

File tree

1 file changed

+1
-119
lines changed

1 file changed

+1
-119
lines changed

deps/rabbit/docs/rabbitmqctl.8

Lines changed: 1 addition & 119 deletions
Original file line numberDiff line numberDiff line change
@@ -463,124 +463,6 @@ is part of, as a ram node:
463463
To learn more, see the
464464
.Lk https://www.rabbitmq.com/clustering.html "RabbitMQ Clustering guide".
465465
.\" ------------------------------------------------------------------
466-
.It Cm rename_cluster_node Ar oldnode1 Ar newnode1 Op Ar oldnode2 Ar newnode2 ...
467-
.Pp
468-
Supports renaming of cluster nodes in the local database.
469-
.Pp
470-
This subcommand causes
471-
.Nm
472-
to temporarily become the node in order to make the change.
473-
The local cluster node must therefore be completely stopped; other nodes
474-
can be online or offline.
475-
.Pp
476-
This subcommand takes an even number of arguments, in pairs representing
477-
the old and new names for nodes.
478-
You must specify the old and new names for this node and for any other
479-
nodes that are stopped and being renamed at the same time.
480-
.Pp
481-
It is possible to stop all nodes and rename them all simultaneously (in
482-
which case old and new names for all nodes must be given to every node)
483-
or stop and rename nodes one at a time (in which case each node only
484-
needs to be told how its own name is changing).
485-
.Pp
486-
For example, this command will rename the node
487-
.Qq rabbit@misshelpful
488-
to the node
489-
.Qq rabbit@cordelia
490-
.sp
491-
.Dl rabbitmqctl rename_cluster_node rabbit@misshelpful rabbit@cordelia
492-
.Pp
493-
Note that this command only changes the local database.
494-
It may also be necessary to rename the local database directories
495-
and configure the new node name.
496-
For example:
497-
.sp
498-
.Bl -enum -compact
499-
.It
500-
Stop the node:
501-
.sp
502-
.Dl rabbitmqctl stop rabbit@misshelpful
503-
.sp
504-
.It
505-
Rename the node in the local database:
506-
.sp
507-
.Dl rabbitmqctl rename_cluster_node rabbit@misshelpful rabbit@cordelia
508-
.sp
509-
.It
510-
Rename the local database directories (note, you do not need to do this
511-
if you have set the RABBITMQ_MNESIA_DIR environment variable):
512-
.sp
513-
.Bd -literal -offset indent -compact
514-
mv \\
515-
/var/lib/rabbitmq/mnesia/rabbit\\@misshelpful \\
516-
/var/lib/rabbitmq/mnesia/rabbit\\@cordelia
517-
mv \\
518-
/var/lib/rabbitmq/mnesia/rabbit\\@misshelpful-rename \\
519-
/var/lib/rabbitmq/mnesia/rabbit\\@cordelia-rename
520-
mv \\
521-
/var/lib/rabbitmq/mnesia/rabbit\\@misshelpful-plugins-expand \\
522-
/var/lib/rabbitmq/mnesia/rabbit\\@cordelia-plugins-expand
523-
.Ed
524-
.sp
525-
.It
526-
If node name is configured e.g. using
527-
.Ar /etc/rabbitmq/rabbitmq-env.conf
528-
, it also needs to be updated there.
529-
.sp
530-
.It
531-
Start the node when ready
532-
.El
533-
.\" ------------------------------------------------------------------
534-
.It Cm update_cluster_nodes Ar clusternode
535-
.Bl -tag -width Ds
536-
.It Ar clusternode
537-
The node to consult for up-to-date information.
538-
.El
539-
.Pp
540-
Instructs an already clustered node to contact
541-
.Ar clusternode
542-
to cluster when booting up.
543-
This is different from
544-
.Cm join_cluster
545-
since it does not join any cluster - it checks that the node is already
546-
in a cluster with
547-
.Ar clusternode .
548-
.Pp
549-
The need for this command is motivated by the fact that clusters can
550-
change while a node is offline.
551-
Consider a situation where node
552-
.Va rabbit@A
553-
and
554-
.Va rabbit@B
555-
are clustered.
556-
.Va rabbit@A
557-
goes down,
558-
.Va rabbit@C
559-
clusters with
560-
.Va rabbit@B ,
561-
and then
562-
.Va rabbit@B
563-
leaves the cluster.
564-
When
565-
.Va rabbit@A
566-
starts back up, it'll try to contact
567-
.Va rabbit@B ,
568-
but this will fail since
569-
.Va rabbit@B
570-
is not in the cluster anymore.
571-
The following command will rename node
572-
.Va rabbit@B
573-
to
574-
.Va rabbit@C
575-
on node
576-
.Va rabbitA
577-
.sp
578-
.Dl update_cluster_nodes -n Va rabbit@A Va rabbit@B Va rabbit@C
579-
.Pp
580-
To learn more, see the
581-
.Lk https://www.rabbitmq.com/clustering.html "RabbitMQ Clustering guide"
582-
.El
583-
.\" ------------------------------------------------------------------
584466
.\" ## Classic Mirrored Queues
585467
.\" ------------------------------------------------------------------
586468
.Ss Replication
@@ -598,7 +480,7 @@ The queue will block while synchronisation takes place (all publishers
598480
and consumers using the queue will block or temporarily see no activity).
599481
This command can only be used with mirrored queues.
600482
To learn more, see the
601-
.Lk https://www.rabbitmq.com/ha.html "RabbitMQ Mirroring guide"
483+
.Lk https://www.rabbitmq.com/ha.html "RabbitMQ Classic Queue Mirroring guide"
602484
.Pp
603485
Note that queues with unsynchronised replicas and active consumers
604486
will become synchronised eventually (assuming that consumers make progress).

0 commit comments

Comments
 (0)