A newer version of this documentation is available.

View Latest

Upgrading to Couchbase Server 5.5

Upgrading to the latest version of Couchbase Server helps you leverage the latest features and keeps your clusters running well. The following table summarizes the new features in this release and provides a handy reference to help you upgrade to this release.

Table 1. Couchbase Server 5.5 Features and Upgrade Strategy
Feature Upgrade Level Upgrade Type Upgrade Path Mixed Mode Dependencies Additional Information

Data compression - data service

Cluster

Offline/Online

Direct

No

None

None

Data compression - XDCR

Cluster

Offline/Online

Direct

No

None

None

N1QL Auditing

Cluster

Offline/Online

Direct

No

None

None

N1QL TCO/Performance comparison

Node

Offline/Online

Direct

Yes

None

None

N1QL backfill configurability

Node

Offline/Online

Direct

Yes

None

None

ANSI JOINS

Node

Offline/Online

Direct

Yes

None

None

CURL() Whitelisting

Node

Offline/Online

Direct

Yes

None

None

ALTER INDEX

Cluster

Offline/Online

Direct

No

All the query and index services nodes must be on version 5.5

None

Index Partitioning

Index service - Cluster

Query Service - Node

Offline/Online

Direct

Index service - No

Query service - Yes

All the index service nodes must be on version 5.5, and at least one query node must be on version 5.5

None

Aggregate Pushdown

Index service - Cluster

Query Service - Node

Offline/Online

Direct

Index service - No

Query service - Yes

All the index service nodes must be on version 5.5, and at least one query node must be on version 5.5

None

Meta() xattrs

Cluster

Offline/Online

Direct

No

Both index and query nodes must be on version 5.5

Without the upgrade, the META().xattrs will evaluate to MISSING, leading to wrong results.

Analytics Service (Developer Preview)

Cluster

Offline/Online

Direct

No

The cluster should have only one build version.

None

Eventing Service

Cluster

Offline/Online

Direct

No

All data and eventing nodes must be running version 5.5.

None

Full Text Search - Improved Indexing Implementation (Developer Preview)

Cluster

Offline/Online

Direct

No

None

Newly created indexes will use the new format.

Response Time Observability

Cluster

Offline/Online

Direct

No

None

None

IPv6

Cluster

Offline or Online using unidirectional replication

Direct

No

Operating system must support dual stack.

See Migrating Data from an IPv4 Cluster to an IPv6 Cluster for details.

x.509 client authentication

Cluster

Offline/Online

Direct

No

None

None

Log redaction

Cluster

Offline/Online

Direct

No

None

None

SCRAM-SHA for non-TLS XDCR connections

Cluster

Offline/Online

Direct

No

In the mixed mode, non-TLS connections will fall back to using certificate for authentication.

None

None

Max TTL

Cluster

Offline/Online

Direct

No

None

None

Enhancements to cbbackupmgr

Cluster

Offline/Online

Direct

No

None

None

Doc Editor

Node

Offline/Online

Direct

Yes

None

None

Migrating Data from an IPv4 Cluster to an IPv6 Cluster

You can migrate data from an IPv4 cluster to an IPv6 cluster with an offline upgrade, or online by using unilateral replication. You must ensure that your operating system has dual stack support.

Offline Upgrade from an IPv4 Cluster to an IPv6 Cluster

Prerequisites: Ensure that the source cluster is on an operating system with dual stack support.

Follow the instructions available in the section Performing the Offline Upgrade. When all the nodes are offline, restart each node with IPv6 enabled. See Using IPv6 With Couchbase for instructions to enable IPv6.

Online Upgrade from an IPv4 Cluster to an IPv6 Cluster using XDCR

Prerequisites: Ensure that the source cluster is running Couchbase Server 5.5 on an operating system with dual stack support, and the destination cluster is running Couchbase Server 5.5 on an IPv6 network.

Steps:

  1. Upgrade the source cluster to Couchbase Server version 5.5.

  2. Create a new cluster with IPv6 enabled and configured. See Using IPv6 With Couchbase for instructions to enable IPv6. Note that this cluster needs to be sized appropriately for the workload, but does not need to be identical to the source cluster.

  3. Create a cluster reference and replication stream from the source to the destination cluster. At this point, the destination cluster is not receiving any application load directly, other than the replication traffic from the source cluster.

  4. Monitor the XDCR queue from the source until all mutations are replicated to the destination cluster.

  5. Reconfigure the application to start accessing the destination cluster.

  6. Once all your applications have been moved, you can decommission the source cluster.

IPv4 and IPv6 clusters cannot be paired for bi-directional (active-active) XDCR replication. For bi-directional replication, both clusters need to be using IPv4 or IPv6.