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.

Upgrade Sync Gateway

    Overview of upgrade paths, version requirements, and supported approaches for upgrading Sync Gateway.

    Related Application Deployment topics: Prepare | Install | Release Notes

    Overview

    This section covers upgrading Sync Gateway to a new version. Use the pages in this section based on what you need to do:

    • Rolling Upgrade — Step-by-step procedures for upgrading a Sync Gateway cluster node by node, including version-specific requirements.

    • Cluster Compatibility Version — How to use the cluster compatibility version mechanism introduced in Sync Gateway 4.1 to upgrade without downtime and with a safe rollback path.

    • Migrate Metadata to System Collection — How to opt in to moving Sync Gateway internal metadata from the default collection to the system collection in Sync Gateway 4.1.

    For compatibility information, see the Compatibility Matrix.

    Upgrade Requirements by Version

    Sync Gateway 4.1

    Requirement Detail

    Couchbase Server

    7.6.0 or later. 7.6.6 or later required for bi-directional XDCR features.

    Unsupported settings

    The following settings are not supported and must be removed from your configuration before upgrading:
    shared_bucket_access=false
    allow_conflicts=true
    enable_star_channel=false

    Metadata migration (optional)

    Sync Gateway 4.1 introduces an opt-in migration that moves internal metadata from the default collection to the system collection. This is not required for upgrading and is never applied automatically. See Migrate Metadata to System Collection.
    Downgrading from Sync Gateway 4.1 to an earlier version is not supported after the full cluster has been upgraded. To preserve a rollback path during the upgrade window, use Cluster Compatibility Version.

    Sync Gateway 4.0

    Requirement Detail

    Couchbase Server

    7.6.0 or later. 7.6.6 or later required for bi-directional XDCR features.

    Unsupported settings

    The following settings are not supported and must be removed from your configuration before upgrading:
    shared_bucket_access=false
    allow_conflicts=true
    enable_star_channel=false
    Downgrading from Sync Gateway 4.0 to earlier versions is not supported.

    Sync Gateway 3.1

    Requirement Detail

    Couchbase Server

    See Compatibility Matrix for the minimum supported Couchbase Server version for Sync Gateway 3.1.

    Configuration

    Sync Gateway 3.1 uses Persistent Configuration by default. Upgrading to 3.1 converts existing configuration files to the persistent format automatically. This migration is a one-way process.

    Upgrading Couchbase Server

    If you also need to upgrade Couchbase Server, for more information, see the Upgrading Couchbase Server documentation for supported approaches. When running a Couchbase Server rolling upgrade alongside Sync Gateway, Server rebalance operations can cause transient connection errors between Sync Gateway and Couchbase Server.

    Related Content

    Getting Started
    Product Information
    Community

    Mobile Forum | Blog | Blog (Mobile) | Tutorials