Merge pull request #1641 from blgm/rename_node_docs_improvement

Additional info for `rabbitmqctl rename_cluster_node` man page

Author: dumbbell

docs/rabbitmqctl.8

@@ -431,6 +431,46 @@ to the node
 .Qq rabbit@cordelia
 .sp
 .Dl rabbitmqctl rename_cluster_node rabbit@misshelpful rabbit@cordelia
+.Pp
+Note that this command only changes the local database.
+It may also be necessary to rename the local database directories,
+and to configure the new node name.
+For example:
+.sp
+.Bl -enum -compact
+.It
+Stop the node:
+.sp
+.Dl rabbitmqctl stop rabbit@misshelpful
+.sp
+.It
+Rename the node in the local database:
+.sp
+.Dl rabbitmqctl rename_cluster_node rabbit@misshelpful rabbit@cordelia
+.sp
+.It
+Rename the local database directories (note, you do not need to do this if you have set the RABBITMQ_MNESIA_DIR environment variable):
+.sp
+.Bd -literal -offset indent -compact
+mv \\
+  /var/lib/rabbitmq/mnesia/rabbit\\@misshelpful \\
+  /var/lib/rabbitmq/mnesia/rabbit\\@cordelia
+mv \\
+  /var/lib/rabbitmq/mnesia/rabbit\\@misshelpful-rename \\
+  /var/lib/rabbitmq/mnesia/rabbit\\@cordelia-rename
+mv \\
+  /var/lib/rabbitmq/mnesia/rabbit\\@misshelpful-plugins-expand \\
+  /var/lib/rabbitmq/mnesia/rabbit\\@cordelia-plugins-expand
+.Ed
+.sp
+.It
+If you have
+.Ar /etc/rabbitmq/rabbitmq-env.conf
+and configured the node name there, update this configuration.
+.sp
+.It
+Start the node when ready
+.El
 .\" ------------------------------------
 .It Cm update_cluster_nodes Ar clusternode
 .Bl -tag -width Ds