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

Upgrade Procedures

      +
      Multiple procedures are provided for the upgrade of a Couchbase-Server cluster.

      This section provides step-by-step instructions for the upgrade of multi-node Couchbase-Server clusters. Each procedure addresses a specific context and its associated dependencies: for information on how to select the appropriate procedure, see the information provided in Upgrade Procedure-Selection.

      Additionally provided on this page is guidance for Upgrading Developer Clusters — which are frequently single-node clusters.

      Upgrading Multi-Node Clusters

      The procedures for upgrading multi-node clusters are presented as follows:

      • Upgrade an Offline Cluster. This is the simplest procedure for the upgrade of a multi-node cluster. Note, however, that it requires cluster-downtime.

      • Upgrade an Online Cluster. This allows the cluster to continue serving data, for the duration of the upgrade. Two options are provided:

        • Upgrade a Reduced-Capacity, Online Cluster. If no additional nodes are available to facilitate the upgrade-procedure, the procedure can be completed with the existing cluster-nodes, provided that it is acceptable for the cluster to serve data, during the upgrade, at reduced capacity.

        • Upgrade a Full-Capacity, Online Cluster. If additional nodes are available to facilitate the upgrade-procedure, the procedure can be completed with the cluster continuing to serve data at full capacity.

      • Upgrade an IPv6 Cluster. Special instructions are provided for the upgrade of IPv6 clusters.

      Upgrading Developer Clusters

      Clusters are frequently established for development purposes. When these are multi-node, the upgrade procedures listed above, in Upgrading Multi-Node Clusters, can be followed.

      However, clusters established for development purposes are frequently single-node clusters. Single-node clusters are unsupported: nevertheless, they can be upgraded by following subsets of the instructions provided for multi-node clusters; as described below. Before following these procedures, developers should become familiar with the Upgrade Paths; and, if appropriate, with the information provided in Upgrade an IPv6 Cluster.

      Upgrading Linux- and Windows-Based Single-Node Clusters

      The cluster should be taken offline (such that no application access is possible) for the duration of the upgrade process. Therefore, the step-by-step procedure provided in Upgrade an Offline Cluster can be followed. Note that when following the steps in the stage named Upgrade Each Individual Node, the final step can be omitted (since only one node needs to be upgraded).

      Upgrading MacOS-Based Clusters

      Command-line expressions for upgrade are not supported for MacOS: therefore, a MacOS-based cluster must be upgraded by means of install command-line expressions. As with Linux- and Windows-based single-node clusters, a MacOS-based single-node cluster should remain offline for the duration of the upgrade process.

      Therefore, to upgrade a MacOS-based single-node cluster, proceed as follows:

      1. Follow the instructions provided for offline multi-node clusters, in Stage One: Prepare the Cluster (which is part of the procedure Upgrade an Offline Cluster).

      2. Follow the instructions provided for online multi-node clusters, in Stage Three: Upgrade the Removed Node (which is part of the procedure Upgrade a Reduced-Capacity, Online Cluster).

      3. Follow the instructions provided for offline multi-node clusters, in Stage Three: Bring the Cluster Back Online (which is part of the procedure Upgrade an Offline Cluster).

      This concludes the upgrade procedure.