Skip to content

Commit

Permalink
Clean up failover documentation
Browse files Browse the repository at this point in the history
Change-Id: I4af587e27521d471b34823bc2d21c21e433edd03
Reviewed-on: http://review.couchbase.org/81535
Reviewed-by: Michael Wiederhold <mike@couchbase.com>
Tested-by: Michael Wiederhold <mike@couchbase.com>
  • Loading branch information
mattcarabine authored and Michael Wiederhold committed Jul 31, 2017
1 parent 201e2f4 commit 0887a91
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions docs/couchbase-cli-failover.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ couchbase-cli-failover(1)

NAME
----
couchbase-cli-failover - Failover a server in the cluster
couchbase-cli-failover - Failover a node in the cluster


SYNOPSIS
Expand All @@ -16,22 +16,20 @@ SYNOPSIS
DESCRIPTION
-----------

This command fails over one or more servers. Servers can be either hard failed
This command fails over one or more nodes. Nodes can be either hard failed
over or gracefully failed over. A hard failover means that the failover happens
immediately, but risk potential data loss. Graceful failover ensures that
replication is up to date before the server is failed over so that there is no
data loss, but the failover is not immediate. Using the --force flag means that
the failover should be a hard failover. If the --force flag is not specified
then the failover will be graceful. Note that if a server is already down you
must hard fail it over.
immediately, but risks potential data loss. Graceful failover ensures that
replication is up to date before the node is failed over so that there is no
data loss, but the failover is not immediate. Note that if a node is already down
you must perform a hard failover.

OPTIONS
-------

include::part-common-options.txt[]

--server-failover <server_list>::
A comma separated list of servers to failover.
A comma separated list of nodes to failover.

--force::
Specifying this flag signifies that the nodes to be failed over should be
Expand All @@ -43,7 +41,7 @@ include::part-common-options.txt[]

--no-progress-bar::
Disables showing the progress bar which tracks the progress of the
rebalance. Note that a rebalance only occurs for graceful failovers (eg.
rebalance. Note that a rebalance only occurs for graceful failovers (e.g.
non-forced failovers). The failover command will still wait for rebalance
completion even if this flag is specified, but the progress bar will not
be shown.
Expand All @@ -58,12 +56,12 @@ include::part-host-formats.txt[]
EXAMPLES
--------

To hard fail over a server run the following command:
To hard fail over a node run the following command:

$ couchbase-cli failover -c 192.168.1.5:8091 --username Administrator \
--password password --server-failover 192.168.1.6:8091 --force

To gracefully failover a server run the following command:
To gracefully failover a node run the following command:

$ couchbase-cli failover -c 192.168.1.5:8091 --username Administrator \
--password password --server-failover 192.168.1.6:8091
Expand Down

0 comments on commit 0887a91

Please sign in to comment.