Skip to content

Commit be3d95b

Browse files
Make it clearer how nodes are started, stopped and restarted
in CLI, Debian, RPM, generic UNIX guides References #1573
1 parent c5b1715 commit be3d95b

File tree

4 files changed

+64
-7
lines changed

4 files changed

+64
-7
lines changed

site/cli.md

+56
Original file line numberDiff line numberDiff line change
@@ -528,6 +528,62 @@ and so on.
528528
[RabbitMQ Networking guide](networking.html) contains a section on troubleshooting of networking-related issues.
529529

530530

531+
## <a id="managing-nodes" class="anchor" href="#managing-nodes">Managing Nodes</a>
532+
533+
### Getting node status
534+
535+
To retrieve node status, use `rabbitmq-diagnostics status` or `rabbitmq-diagnostics.bat status`
536+
with an optional `--node` target:
537+
538+
<pre class="lang-bash">
539+
rabbitmqctl shutdown
540+
</pre>
541+
542+
<pre class="lang-bash">
543+
rabbitmqctl shutdown --node [email protected]
544+
</pre>
545+
546+
<pre class="lang-powershell">
547+
rabbitmqctl.bat shutdown
548+
</pre>
549+
550+
<pre class="lang-powershell">
551+
rabbitmqctl.bat shutdown --node [email protected]
552+
</pre>
553+
554+
### Starting a node
555+
556+
How RabbitMQ nodes are started depends on the package type used:
557+
558+
* When using Debian and RPM packages on modern Linux distributions, nodes are [managed using `systemd`](./install-debian.html#managing-service)
559+
* When using Windows installer, nodes are usually [managed by the Windows service manager](./install-windows.html#managing)
560+
* When using Homebrew formula, nodes are managed using `brew services`
561+
* When using generic UNIX build or binary Windows build, nodes are started using `sbin/rabbitmq-server` and `sbin/rabbitmq-server.bat`, respectively, in the installation root
562+
563+
### Stopping a node
564+
565+
To stop a node, consider using the same service management tooling used when starting
566+
the node, which depends on the package typed used when RabbitMQ was installed.
567+
568+
To stop a node using RabbitMQ CLI tools, use
569+
`rabbitmqctl shutdown` or `rabbitmqctl.bat shutdown` with an optional `--node` target:
570+
571+
<pre class="lang-bash">
572+
rabbitmqctl shutdown
573+
</pre>
574+
575+
<pre class="lang-bash">
576+
rabbitmqctl shutdown --node [email protected]
577+
</pre>
578+
579+
<pre class="lang-powershell">
580+
rabbitmqctl.bat shutdown
581+
</pre>
582+
583+
<pre class="lang-powershell">
584+
rabbitmqctl.bat shutdown --node [email protected]
585+
</pre>
586+
531587
## <a id="http-api-cli" class="anchor" href="#http-api-cli">rabbitmqadmin</a>
532588

533589
[rabbitmqadmin](./management-cli.html) is a command line tool that's built on top of [RabbitMQ HTTP API](./management.html).

site/install-debian.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ Key sections of this guide are
3535
* [Privilege requirements](#sudo-requirements)
3636
* Quick start installation snippet that [uses Cloudsmith](#apt-quick-start-cloudsmith) repositories
3737
* Quick start installation snippets that [uses PackageCloud](#apt-quick-start-packagecloud) and Launchpad repositories
38+
* [Manage the service](#managing-service) (start it, stop it, and get its status)
39+
* How to [inspect node and service logs](#server-logs)
3840

3941
[Supported Erlang versions](which-erlang.html) will be provisioned from one of the [modern Erlang apt repositories](#erlang-repositories)
4042
on [Ubuntu Launchpad](https://launchpad.net/~rabbitmq/+archive/ubuntu/rabbitmq-erlang) or [Cloudsmith.io](https://cloudsmith.io/~rabbitmq/repos/rabbitmq-erlang/packages/).
@@ -45,11 +47,6 @@ should refer to
4547
* Manual installation using [apt and the Cloudsmith](#apt-cloudsmith) repository
4648
* Manual installation using [apt the PackageCloud](#apt-packagecloud) and Launchpad repositories
4749

48-
Service management is covered in
49-
50-
* [Manage the service](#managing-service)
51-
* How to [inspect node and service logs](#server-logs)
52-
5350
More advanced topics include
5451

5552
* [Version Pinning](#apt-pinning) of apt packages

site/install-generic-unix.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,13 @@ It is minimalistic and not opinionated in how it is installed, configured and ma
2424
This package is recommended in environments where more opinionated installation options
2525
(the [Debian](./install-debian.html) or [RPM packages](./install-rpm.html), [Homebrew](./install-homebrew.html), BSD ports) cannot be used.
2626
It is also the most convenient option for running multiple versions on the same machine
27-
in development environments, e.g. [preview release](./snapshots.html) testing.
27+
in development environments.
28+
2829
There's a separate [binary package for Windows](./install-windows-manual.html).
2930

31+
Unlike with the cases of [Debian](./install-debian.html), [RPM](./install-rpm.html) and [Windows installer](./install-windows.html) packages,
32+
[node management](#running-generic-unix) with this package type is performed solely using
33+
[RabbitMQ CLI tools](./cli.html) or by the operator setting up e.g. a `systemd` service manually.
3034

3135
## <a id="downloads" class="anchor" href="#downloads">Downloads</a>
3236

site/install-rpm.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ such as Fedora, RHEL and CentOS. It covers a number of topics:
4141
* [Package dependencies](#package-dependencies)
4242
* [Supported distributions](#supported-distributions)
4343
* [Privilege requirements](#sudo-requirements)
44-
* How to [manage the service](#managing-service)
44+
* How to [manage the service](#managing-service) (start it, stop it, and get its status)
4545
* How to [inspect node and service logs](#server-logs)
4646
* Installation on [older distributions](#yum-legacy)
4747
* [Package downloads](#downloads)

0 commit comments

Comments
 (0)