Maintenance windows

Manage cluster maintenance windows and set exclusion periods

Yugabyte occasionally performs maintenance on clusters. This can include infrastructure and database upgrades. Depending on the type of maintenance, your cluster may be restarted, which disrupts service briefly. Yugabyte notifies you in advance of any upcoming maintenance via email. One week before a scheduled maintenance, an Upcoming Maintenance badge is displayed on the cluster.

Yugabyte only performs cluster maintenance, including database upgrades, during scheduled maintenance windows. The maintenance window is a weekly four hour interval during which Yugabyte may perform maintenance on the cluster.

You can manage when maintenance is done on Dedicated clusters (these features are not available for Sandbox clusters) in the following ways:

You set the cluster maintenance window, exclusion periods, and review upcoming maintenance events using the cluster Maintenance tab.

Cluster Maintenance page

To view details of upcoming scheduled maintenance, click the Upcoming Maintenance badge, or select the maintenance in the Scheduled Maintenance list to display the Maintenance Details.

To delay a scheduled maintenance, click Delay to next available window on the Maintenance Details sheet.

If the scheduled maintenance is a database upgrade, you can start the upgrade by clicking Upgrade Now on the Maintenance Details sheet.

Set the cluster maintenance window schedule

To set the maintenance window for a cluster:

  1. On the Maintenance tab, click Edit Maintenance Preferences to display the Maintenance Preferences dialog.
  2. Choose a day of the week.
  3. Set the start time.
  4. Click Save.

Set a maintenance exclusion period

To set the maintenance exclusion period for a cluster:

  1. On the Maintenance tab, click Edit Maintenance Preferences to display the Maintenance Preferences dialog.
  2. Set a start date and end date. The exclusion period includes the day of the start date, and every day up to, but not including, the end date.
  3. Click Save.

What to expect during maintenance

Yugabyte performs rolling maintenance and upgrades on multi-node clusters with zero downtime. However, the cluster is still subject to the following:

  • Dropped connections - Connections to the stopped node are dropped. Verify your connection pool, driver, and application to ensure they handle dropped connections correctly. Any failures need to be retried.
  • Less bandwidth - During maintenance, traffic is diverted to the running nodes. To mitigate this, set your maintenance window to a low traffic period. You can also add nodes (scale out) prior to the upgrade.
  • Not highly available - During maintenance, one node is always offline. In a multi-node cluster (that is, with a replication factor of 3), if one of the remaining nodes goes down, you can no longer access the database.

Critical maintenance

Yugabyte occasionally performs critical maintenance on clusters. This includes routine but time-sensitive maintenance and emergency updates. As with regular maintenance, Yugabyte notifies you in advance of any upcoming critical maintenance via email.

Critical maintenance includes the following:

  • node operating system updates
  • YugabyteDB server setting updates
  • rotating SSL certificates used for encrypting communication between nodes
  • security updates

Critical maintenance is performed during the next scheduled maintenance window.

Critical maintenance events also override any exclusion periods, can't be delayed, and take precedence over any already scheduled regular maintenance.