Upgrading a Cluster

      +
      Upgrades and maintenance patches are scheduled as needed on clusters to provide a reliable service with the latest features.

      This page walks you through support, timeframes, and maintenance jobs for cluster upgrades in Couchbase Capella. Use the procedures on this page to view and reschedule upgrade maintenance jobs for your clusters. For an overview of clusters, see Clusters Overview.

      Couchbase Server Version Support

      You can deploy and upgrade clusters to new Couchbase Server versions as they become available on Capella. This typically includes the following releases:

      Release Introduces

      Major

      Major new features and functionality.

      Minor

      Some new features or improvements.

      Patch

      Essential fixes and improvements.

      The versions offered in Capella are supported until they reach the end of maintenance on Capella. This support typically aligns with the full maintenance lifespan of the major or minor version provided by Couchbase. See Couchbase Server Version Maintenance Support.

      To provide secure and reliable service, clusters are deployed on the latest available patch version. You can expect to be upgraded to the latest patch version shortly after it becomes available on Capella.

      In addition to Couchbase Server upgrades, Capella may schedule routine maintenance upgrades which do not upgrade the Couchbase Server version, but apply essential updates to the systems your cluster runs on.

      When maintenance or an upgrade is scheduled, you can choose to upgrade your cluster at any time before the scheduled date. When the scheduled time is reached the cluster is automatically upgraded. The notice that Capella aims to provide varies depending on the nature of the upgrade. See Cluster Upgrade Timeframes.

      Customers hosting Couchbase Capella in their own public cloud account are responsible for more of their own maintenance and security, and can continue to receive support for each version for longer time periods. Version availability, upgrade schedules, and timeframes may vary compared to the Capella hosted offering.

      Couchbase Server Version Maintenance Support

      Couchbase versions, release dates, and end of maintenance on Capella is as follows:

      Version Release Date End of Hosted Maintenance End of in-VPC Maintenance

      Couchbase Server 7.0

      July 30, 2021

      TBA

      N/A

      Couchbase Server 6.6

      December 20, 2020

      July 30, 2021

      July 30, 2022

      Couchbase Server 6.5

      January 1, 2020

      July 30, 2021

      July 30, 2022

      Cluster Upgrade Timeframes

      Within our best practice, we typically provide the notice period described below for the upgrade or maintenance types shown in the following table:

      Upgrade or Maintenance Type Description Notice Period

      Critical Upgrade

      An upgrade done in response to an urgent bug, vulnerability, or other issue impacting cluster health or performance.

      None.

      Routine Maintenance or Couchbase Server Patch

      A new Couchbase Server patch version or routine image upgrades.

      3 weeks.

      Couchbase Server Minor Release

      A new Couchbase Server minor version release.

      From launch on Capella to end of support on Capella.

      Couchbase Server Major Release

      A new Couchbase Server major release version.

      From launch on Capella to end of support on Capella.

      A shorter than best practice period might apply depending on particular circumstances.

      Maintenance Jobs

      You can view scheduled maintenance upgrade jobs for your cluster from the Maintenance tab. Maintenance job statuses are pending, running, and completed.

      All upgrades and maintenance patches have a target start time. Capella aims to start the maintenance of your cluster at this time. However, maintenance jobs are sometimes delayed when a cluster cannot be upgraded. For example, when a cluster is reconfiguring.

      For each individual maintenance job, you can:

      • View its type, status, and scheduled time to upgrade.

      • Review its overview and what’s new.

      • Reschedule it to upgrade at a different time.

      • Create a support ticket.

      When a maintenance job is scheduled, email notifications are sent to:

      • Organization Owners where one or more clusters in their organization is scheduled for maintenance.

      • Project Owners and Cluster Managers where at least one cluster on a project they have access to is scheduled for maintenance.

      You can review all scheduled maintenance jobs on the Activity tab that have run on the cluster. For more information, see Activity Explorer.

      You can reschedule the target start time for an individual maintenance job on a cluster, or choose to run the maintenance job immediately. However, maintenance jobs cannot be deferred indefinitely because each maintenance job has a latest possible upgrade date.

      When a maintenance job runs, the cluster is moved to a redeploying state while nodes are rebalanced to apply the maintenance changes. Maintenance redeployments are not time-bound, and the time taken varies depending on the size of the cluster, volume of data, and load. Couchbase Capella clusters are designed to remain available throughout the upgrade. Cluster reconfiguration options are not available during an upgrade, though data tools remain accessible in the Capella UI.

      To view an individual maintenance job:

      1. From the Projects or Clusters tab, open a cluster.

      2. Click the Maintenance tab.

      3. Click a job in the Maintenance Jobs list.

      4. Click the job’s Overview tab.

      5. Review the details.

      6. Click to close the job.

      To reschedule an individual maintenance job:

      1. On the Cluster’s Maintenance tab, click More Options (⋮) on a job in the Maintenance Jobs list.

      2. Click Reschedule.

      3. Select one of the following:

        • Run as per current schedule.

        • Choose a different schedule.

          Click the date picker and set the preferred date and start time.

        • Run Now.

      4. Click Update Schedule.

      Set a Preferred Time for all Maintenance Jobs

      You can set a preferred time and day of the week for future maintenance jobs to be scheduled. This does not reschedule maintenance jobs that are already scheduled on the Maintenance tab.

      When an upgrade or maintenance becomes available, Capella attempts to schedule the maintenance at your preferred time and day of the week. The preferred time is not a guarantee. If it is not possible to schedule the maintenance at your preferred time, the cluster is scheduled at any time within the maintenance window.

      To set a preferred maintenance time and day for all upcoming jobs:

      1. From the Projects or Clusters tab, open a cluster.

      2. Click the Maintenance tab.

      3. To change the preferred scheduled maintenance time and day, click Edit Time.

      4. Set the following fields:

        1. Day of the week.

        2. Start Time UTC in HH:MM format.

      5. Click Update.

      See Also

      See the following pages for more information about managing clusters: