Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

rebalance

      +

      Rebalances data and indexes across nodes in a cluster

      SYNOPSIS

      couchbase-cli rebalance [--cluster <url>] [--username <user>]
    [--password <password>] [--server-remove <servers>] [--no-progress-bar]
    [--no-wait]

      DESCRIPTION

      Rebalances data and indexes across all nodes in the cluster. This command should be used after nodes are added, removed, or failed over from the cluster in order to ensure that each node in the cluster has a similar "balanced" amount of data and indexes.

      To add nodes use the server-add subcommand. To remove nodes specify the list of nodes to remove using the --server-remove option in the rebalance subcommand. To failover nodes see the failover subcommand. After running the server-add or failover subcommands ensure that you run the rebalance command to balance data and indexes across the cluster.

      OPTIONS

      -c
      --cluster

      Specifies the hostname of a node in the cluster. See the HOST FORMATS section for more information on specifying a hostname.

      -u
      --username <username>

      Specifies the username of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error.

      -p
      --password <password>

      Specifies the password of the user executing the command. If you do not have a user account with permission to execute the command then it will fail with an unauthorized error. If this argument is specified, but no password is given then the command will prompt the user for a password through non-echoed stdin. You may also specify your password by using the environment variable CB_REST_PASSWORD.

      --server-remove <servers>

      A comma separated list of nodes to remove from the cluster. Each node in the list should correspond to the hostname or IP address of that server.

      --no-progress-bar

      Hides the progress bar which tracks the progress of the rebalance. This command will still wait for rebalance completion even if this flag is specified, but the progress bar will not be shown.

      --no-wait

      Specifies that this command should not wait for the completion of rebalance before exiting.

      HOST FORMATS

      When specifying a host for the couchbase-cli command the following formats are expected:

      • couchbase://<addr>

      • <addr>:<port>

      • http://<addr>:<port>

      It is recommended to use the couchbase://<addr> format for standard installations. The other two formats allow an option to take a port number which is needed for non-default installations where the admin port has been set up on a port other that 8091.

      EXAMPLES

      To rebalance a new node into the cluster you would first add a node using the server-add command and then start the rebalance with the rebalance command.

      $ couchbase-cli server-add -c 192.168.1.5:8091 --username Administrator \
 --password password --server-add 192.168.1.6:8091 \
 --server-add-username Administrator --server-add-password password
      $ couchbase-cli rebalance -c 192.168.1.5:8091 --username Administrator \
 --password password

      If you just want to remove a node from the cluster and start a rebalance, just run the rebalance command.

      $ couchbase-cli rebalance -c 192.168.1.5:8091 --username Administrator \
 --password password --server-remove 192.168.1.6:8091

      You can remove multiple nodes at once and run the rebalance with the command below. Note that it will be faster overall removing multiple nodes at once as opposed to removing them one at a time.

      $ couchbase-cli rebalance -c 192.168.1.5:8091 --username Administrator \
 --password password --server-remove 192.168.1.6:8091,192.168.1.7:8091

      To add a node and remove another node you need to run the server-add command before starting the rebalance, as shown below.

      $ couchbase-cli server-add -c 192.168.1.5:8091 --username Administrator \
 --password password --server-add 192.168.1.6:8091 \
 --server-add-username Administrator --server-add-password password
      $ couchbase-cli rebalance -c 192.168.1.5:8091 --username Administrator \
 --password password --server-remove 192.168.1.7:8091

      If you add one node to the cluster and remove a node during the same rebalance, Couchbase Server will do a "swap rebalance". This means data and indexes from the node being removed are moved to the one being added. This means the rebalance will only occur between these two nodes as opposed to involving all nodes in the cluster.

      ENVIRONMENT AND CONFIGURATION VARIABLES

      CB_REST_USERNAME

      Specifies the username to use when executing the command. This environment variable allows you to specify a default argument for the -u/--username argument on the command line.

      CB_REST_PASSWORD

      Specifies the password of the user executing the command. This environment variable allows you to specify a default argument for the -p/--password argument on the command line. It also allows the user to ensure that their password are not cached in their command line history.

      SEE ALSO

      failover, recovery, server-add

      COUCHBASE-CLI

      Part of the couchbase-cli suite