Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs][cloud] Maintenance tab #11622

Merged
merged 13 commits into from
Mar 10, 2022
12 changes: 12 additions & 0 deletions docs/content/latest/yugabyte-cloud/cloud-clusters/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,16 @@ To _manage_ a cluster, select the cluster in the list to display the cluster [Ov
</a>
</div>

<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="cloud-maintenance/">
<div class="head">
<img class="icon" src="/images/section_icons/manage/backup.png" aria-hidden="true" />
<div class="title">Maintenance windows</div>
</div>
<div class="body">
Set up maintenance windows and exclusion periods for cluster upgrades.
</div>
</a>
</div>

</div>
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ To schedule backups for a cluster:
Before performing a restore, ensure the following:

- the target cluster is sized appropriately; refer to [Scale and configure clusters](../configure-clusters/)
- the target cluster doesnt have the same namespace(s) as the source cluster
- the target cluster doesn't have the same namespace(s) as the source cluster
ddhodge marked this conversation as resolved.
Show resolved Hide resolved

To review previous restores, click **Restore**.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: Maintenance windows
linkTitle: Maintenance windows
description: Manage maintenance windows for clusters in Yugabyte Cloud.
headcontent:
image: /images/section_icons/manage/backup.png
menu:
latest:
identifier: cloud-maintenance
parent: cloud-clusters
weight: 400
isTocNested: true
showAsideToc: true
---

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.
ddhodge marked this conversation as resolved.
Show resolved Hide resolved

- You can [set the maintenance window schedule](#set-the-cluster-maintenance-window-schedule).
- You can [schedule exclusion periods](#set-a-maintenance-exclusion-period), during which Yugabyte won't perform maintenance; any scheduled maintenance is delayed until the next maintenance window after the exclusion period.
- You can delay a scheduled maintenance to the next available window. You can't delay a scheduled maintenance more than 7 days in advance.

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

![Cloud Cluster Maintenance page](/images/yb-cloud/cloud-clusters-maintenance.png)

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.
1. Choose a day of the week.
1. Set the start time.
1. 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.
1. 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.
1. Click **Save**.
4 changes: 2 additions & 2 deletions docs/content/latest/yugabyte-cloud/cloud-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,12 @@ Currently self-service migration is not supported. Contact [Yugabyte Support](ht
Upgrades are automatically handled by Yugabyte. There are two types of upgrades:

Cloud console
: During a maintenance window, the Yugabyte Cloud console may be in read-only mode and not allow any edit changes. The upgrade has no impact on running clusters. We'll notify you in advance of the maintenance schedule.
: During a [maintenance window](../cloud-clusters/cloud-maintenance/), the Yugabyte Cloud console may be in read-only mode and not allow any edit changes. The upgrade has no impact on running clusters. We'll notify you in advance of the maintenance schedule.
ddhodge marked this conversation as resolved.
Show resolved Hide resolved

Cluster (YugabyteDB) version upgrade
: To keep up with the latest bug fixes, improvements, and security fixes, Yugabyte will upgrade your cluster to the [latest version](#what-version-of-yugabytedb-does-my-cluster-run-on).

: Yugabyte will notify you in advance of any upcoming upgrade via email. The email includes the date and time of the upgrade window. An Upcoming Upgrade badge is also displayed on the cluster. You can start the upgrade any time by signing in to Yugabyte Cloud, selecting the cluster, clicking the **Upcoming Upgrade** badge, and clicking **Upgrade Now**. To change the upgrade window, contact {{<support-cloud>}}.
: Yugabyte will only upgrade clusters during scheduled maintenance windows. Yugabyte will notify you in advance of any upcoming upgrade via email. The email includes the date and time of the maintenance window. An Upcoming Maintenance badge is also displayed on the cluster. You can start the upgrade any time by signing in to Yugabyte Cloud, selecting the cluster, clicking the **Upcoming Maintenance** badge, and clicking **Upgrade Now**. To delay the maintenance, click **Delay to next available window**. To manage maintenance windows, select the cluster [Maintenance tab](../cloud-clusters/cloud-maintenance/).

: The database is upgraded to the latest release in the [release track](#what-version-of-yugabytedb-does-my-cluster-run-on) that was selected when the cluster was created (either edge or stable). Free clusters are always in the edge track.
: Database upgrades of high-availability (multi-node) clusters are done on a rolling basis to avoid any downtime.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.