diff options
| author | Michael Klishin <michael@clojurewerkz.org> | 2019-09-26 08:18:59 +0300 |
|---|---|---|
| committer | Michael Klishin <michael@clojurewerkz.org> | 2019-09-26 08:18:59 +0300 |
| commit | c7619e889e5091c67af44cadb7cc0df5894dea77 (patch) | |
| tree | ecc06798e57a5ed507514b0e612d75cd7cafde31 /docs | |
| parent | 26f02610b905c65dbd15cdc16cdc2324265a144b (diff) | |
| download | rabbitmq-server-git-c7619e889e5091c67af44cadb7cc0df5894dea77.tar.gz | |
quorum-queues(8): list arguments, add examples, wording
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/rabbitmq-queues.8 | 43 |
1 files changed, 31 insertions, 12 deletions
diff --git a/docs/rabbitmq-queues.8 b/docs/rabbitmq-queues.8 index e99d40e990..3352655db8 100644 --- a/docs/rabbitmq-queues.8 +++ b/docs/rabbitmq-queues.8 @@ -38,9 +38,9 @@ is a command line tool that provides commands used to manage queues, mainly member handling for quorum queues. See the -.Lk https://www.rabbitmq.com/quorum-queues.html "RabbitMQ quorum queue guide" +.Lk https://www.rabbitmq.com/quorum-queues.html "RabbitMQ quorum queues guide" and -.Lk https://www.rabbitmq.com/ha.html "RabbitMQ highly available (mirrored) queues guide" +.Lk https://www.rabbitmq.com/ha.html "RabbitMQ classic mirrored queues guide" to learn more about queue types in RabbitMQ. . .\" ------------------------------------------------------------------ @@ -104,39 +104,58 @@ Displays general help and commands supported by .Ss Cluster .Bl -tag -width Ds .\" ------------------------------------ -.It Cm grow +.It Cm grow Ar node Ar <all | even> Fl -vhost-pattern Ar pattern Fl -queue-pattern Ar pattern Fl -errors-only .Pp -Grows quorum queue clusters by adding a member (replica) to all or half of matching quorum queues on the given node. +Adds a new replica on the given node for all or a half of matching quorum queues. +.Pp +Example: +.Sp +.Dl rabbitmq-queues grow rabbit@newhost all --vhost-pattern "a-vhost" --queue-pattern ".*" .\" ------------------------------------ -.It Cm rebalance Op Ar type Fl -vhost-pattern Ar pattern Fl -queue-pattern Ar pattern +.It Cm rebalance Ar type Fl -vhost-pattern Ar pattern Fl -queue-pattern Ar pattern .Pp -Rebalances queues. +Rebalances queue master replicas across cluster nodes. .Pp Example: .Sp .Dl rabbitmq-queues rebalance all --vhost-pattern "a-vhost" --queue-pattern ".*" .\" ------------------------------------ -.It Cm shrink +.It Cm shrink Ar node .Pp Shrinks quorum queue clusters by removing any members (replicas) on the given node. +Example: +.Sp +.Dl rabbitmq-queues shrink rabbit@decomissioned-node .\" ------------------------------------ .El .Ss Replication .Bl -tag -width Ds .\" ------------------------------------ -.It Cm add_member +.It Cm add_member Ar queue Ar node Fl -vhost Ar virtual-host +.Pp +Adds a quorum queue member (replica) on the given node. .Pp -Adds a quorum queue member (replica) for a queue on the given node. +Example: +.Sp +.Dl rabbitmq-queues add_member --vhost "a-vhost" "a-queue" rabbit@new-node .\" ------------------------------------ -.It Cm delete_member +.It Cm delete_member Ar queue Ar node Fl -vhost Ar virtual-host +.Pp +Removes a quorum queue member (replica) on the given node. .Pp -Removes a quorum queue member (replica) for a queue on the given node. +Example: +.Sp +.Dl rabbitmq-queues delete_member --vhost "a-vhost" "a-queue" rabbit@decomissioned-node .\" ------------------------------------ .El .Ss Queues .Bl -tag -width Ds .\" ------------------------------------ -.It Cm quorum_status +.It Cm quorum_status Ar queue Fl -vhost Ar virtual-host .Pp Displays quorum status of a quorum queue. +.Pp +Example: +.Sp +.Dl rabbitmq-queues quorum_status --vhost "a-vhost" "a-queue" .\" ------------------------------------ |
