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

Manage Nodes and Clusters

      +
      A Couchbase-Server cluster consists of one or more nodes, each of which is a system running an instance of Couchbase Server.

      Managing Nodes and Clusters

      A Couchbase Server node is a physical or virtual machine that hosts a single instance of Couchbase Server. A conceptual overview is provided in Nodes. The current section provides step-by-step procedures for node-management. This includes:

      • Initializing and provisioning a node, thereby making it a one-node cluster.

      • Adding and removing nodes from clusters.

      • Listing nodes currently in the cluster.

      • Performing failover on nodes, when they need to be removed from the cluster.

      • Rebalancing the cluster, after a node has been removed for scheduled or otherwise planned maintenance.

      • Recovering a node, following failover.

      • Applying node-to-node encryption, to ensure security of communications across the cluster.

      • Changing the cluster’s address family.

      Prerequisites

      Before proceeding with the instructions in this section, you must have installed and started Couchbase Server.

      For links to all per platform installation-instructions, see Install.

      For information on starting and stopping Couchbase Server on different platforms, see Startup and Shutdown.

      Certificate Management

      The examples in this section assume that nodes are protected with the out-of-the-box, self-signed SSL/TLS certificate that is provided with Couchbase Server by default. This allows nodes to be added to the cluster with no need for explicit certificate-related management; since each node has the same certificate. However, this certificate is only intended for use in pre-production environments.

      If, across the cluster, an authority-signed certificate is substituted for the default (as would be required for production deployments), no further node can subsequently be added until a certificate signed by the same authority has been installed on it. An attempt incorporate into a cluster a new node that is not appropriately certificate-protected results in an error. For more information, see Node Certificates.

      Node Management and Community Edition

      Couchbase has modified the license restrictions to its Community Edition package for Couchbase Server Version 7.0 and higher. In consequence, the size of an individual cluster running Community Edition is restricted to five nodes. See Couchbase Modifies License of Free Community Edition Package, for further information on the new restrictions.

      If an administrator attempts to add a sixth node to a five-node cluster running Community Edition Version 7.0 or higher, the following notification is provided, at the lower-left of Couchbase Web Console:

      sixth node addition message ce

      Community-Edition administrators who wish to upgrade cluster of six or more nodes to version 7.0 of Couchbase Server are recommended to consult Couchbase Modifies License of Free Community Edition Package, for guidance.