mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-05-22 21:05:13 +00:00
Add Rancher Cluster Backups documentation
This commit is contained in:
moelsayed
committed by
Denise Schannon
Denise Schannon
parent
2d38a1803c
commit
57832507f4
@@ -13,6 +13,7 @@ Rancher contains a variety of tools that aren't included in Kubernetes to assist
|
||||
- [Pipelines](#pipelines)
|
||||
- [Monitoring](#monitoring)
|
||||
- [Global DNS](#global-dns)
|
||||
- [Cluster Backups](#cluster-backups)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
@@ -105,3 +106,13 @@ _Available as v2.2.0_
|
||||
When creating applications that span multiple Kubernetes clusters, a Global DNS entry can be created to route traffic to the endpoints in all of the different clusters. An external DNS server will need be programmed to assign a fully qualified domain name (a.k.a FQDN) to your application. Rancher will use the FQDN you provide and the IP addresses where your application is running to program the DNS. Rancher will gather endpoints from all the Kubernetes clusters running your application and program the DNS.
|
||||
|
||||
For more information on how to use this feature, see [Global DNS]({{< baseurl >}}/rancher/v2.x/en/tools/globaldns/).
|
||||
|
||||
## Cluster Backups
|
||||
|
||||
_Available as v2.2.0_
|
||||
|
||||
Using Rancher, you can manage ETCD databases snapshots for your Kubernetes clusters directly from the UI. Rancher will allow you to configure your RKE and Custom clusters with local snapshots which resides on your ETCD plane nodes, or with an external S3 compatible provider for off-site backups.
|
||||
|
||||
From the Rancher UI, you will be able to restore your Kubernetes cluster to a previously taken backup on an existing set of ETCD nodes. Or if all ETCD nodes are down, you can replace them with the new set of nodes and perform the recovery from the backup on them.
|
||||
|
||||
For more information on how to use this feature, see [Cluster Backups]({{< baseurl >}}/rancher/v2.x/en/tools/cluster-backups/).
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
---
|
||||
title: Cluster Backups
|
||||
weight: 10000
|
||||
---
|
||||
_Available as of v2.2.0_
|
||||
|
||||
Using Rancher, you can now backup and restore your RKE or Custom Kubernetes clusters directly from the UI.
|
||||
|
||||
Using Rancher you can can configure local snapshots on your ETCD plane nodes, as well as configure remote backups to an S3 compatible target which allows you to restore your cluster even if all nodes are lost.
|
||||
|
||||
When Cluster Backup is enabled, it's also possible to do one-time snapshots along with configured recurring snapshots.
|
||||
|
||||
> **Note:** Cluster Backup is only available for [RKE Clusters]({{< baseurl >}}rancher/v2.x/en/cluster-provisioning/rke-clusters/) and [Custom Clusters]({{< baseurl >}}rancher/v2.x/en/cluster-provisioning/custom-clusters/).
|
||||
|
||||
## Configuring Cluster Backups
|
||||
As of version 2.0.0, all newly provisioned clusters have Local Cluster Backups enabled by default. For cluster provisioned with older versions of Rancher, see [How to enable Cluster backups for existing clusters]({{< baseurl >}}/rancher/v2.x/en/tools/cluster-backups/existing-clusters/)
|
||||
|
||||
To configure or disable Cluster Backups, you need to access the Cluster Backup configuration section. This is available during initial cluster configuration or later by editing the cluster.
|
||||
- While on the **Add Cluster** or **Edit** cluster view, click on **Show advanced options**
|
||||
- Click on the "Advanced Cluster Options" tab to expand the configuration.
|
||||
|
||||
| Option | Description | Default value|
|
||||
| --- | ---| --- |
|
||||
|etcd Snapshot Backup Target| Select cluster backup target | local|
|
||||
|Recurring etcd Snapshot Enabled| Enable/Disable recurring snapshot | Yes|
|
||||
| Recurring etcd Snapshot Creation Period | Time in hours between recurring| snapshots| 12 hours |
|
||||
|Recurring etcd Snapshot Retention Count| Number of snapshots to retain| 6 |
|
||||
|
||||
## Cluster Backup Targets
|
||||
Rancher Cluster Backup support two different backup targets:
|
||||
|
||||
* [Local Target](#local-target)
|
||||
* [S3 Target](#s3-target)
|
||||
|
||||
## Local Backup Target
|
||||
Local Backup target is the most basic backup one. It's enabled by default for all newly provisioned clusters.
|
||||
|
||||
Local Backup target works by saving local ETCD snapshot on all ETCD plane nodes at a pre-configured interval. This provides the user the ability to do point-in-time recovery, or recover from a broken ETCD cluster. However, it doesn't provide the ability to recover if all the ETCD plane nodes are lost, since the snapshots are stored locally on the nodes.
|
||||
|
||||
|
||||
## S3 Backup Target
|
||||
S3 Backup target allows the user to configure an S3 compatible backend for remote snapshot storage.
|
||||
|
||||
Having the snapshots stored remotely provides a lot of flexibility. In addition to point-in-time recovery and recovering broken ETCD cluster, this targets allows the user to recover the cluster from disaster situations like losing all nodes on the ETCD plane, essentially allowing the user to replace a broken cluster by restoring from backup.
|
||||
|
||||
When S3 target is enabled, additional configuration is required to set it up:
|
||||
|
||||
| Option | Description | Required|
|
||||
|---|---|---|
|
||||
|S3 Bucket Name| S3 bucket name where backups will be stored| Yes|
|
||||
|S3 Region|S3 region for the backup bucket|No|
|
||||
|S3 Region Endpoint|S3 regions endpoint for the backup bucket|Yes|
|
||||
|S3 Access Key|S3 access key with permission to access the backup bucket|Yes|
|
||||
|S3 Secret Key|S3 secret key with permission to access the backup bucket|Yes|
|
||||
|
||||
## Backing Up Your Cluster
|
||||
Once backup is enabled for a cluster, the backup controller will automatically start taking snapshots of the cluster ETCD database at the configured intervals.
|
||||
|
||||
It's also possible to take one-time snapshots by going to the global cluster view or the cluster view and clicking **Vertical Elipsis (...) > Snapshot Now** for your cluster.
|
||||
|
||||
## Listing Backups
|
||||
You can list all the available snapshots for your cluster by going to the cluster view and clicking **Tools > Snapshots** from the navigation bar.
|
||||
|
||||
## Restoring From Backup
|
||||
You can restore your cluster from backup at any time by going to the global cluster view or the cluster view and clicking **Vertical Elipsis (...) > Restore Snapshot** for your cluster.
|
||||
|
||||
A list of available snapshots will be available to choose from. Once you select a snapshot, click **Save**. The cluster will go into `updating` state and the restore process will start.
|
||||
|
||||
**Note:** If you are restoring a cluster with unavailable nodes, It's recommended that you delete the nodes from rancher UI before attempting to restore.
|
||||
|
||||
**Note:** It's not possible to restore from snapshots saved on S3 if you don't have S3 target configuration enabled on the cluster level. You need to enable S3 target first before trying to restore from a snapshot saved on S3.
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: Upgrading Clusters
|
||||
weight: 10000
|
||||
---
|
||||
|
||||
## Enabling Cluster Backups For Existing Clusters
|
||||
Prior to v2.2.0. Legacy RKE based backups were enabled by default. To update your cluster to use Rancher Cluster Backup, you need to apply the following steps:
|
||||
|
||||
- Edit your cluster. While in the **Edit** cluster view, click on **Show advanced options**. The UI will show a notice about upgrading the backup configuration for the cluster.
|
||||
- Click on the "Advanced Cluster Options" tab to expand the configuration.
|
||||
- Make sure the recurring snapshots are enabled, and the backup configuration are set as needed.
|
||||
- Save changes to the cluster.
|
||||
|
||||
|
||||
Once your cluster is updated, Cluster backups will be enabled and the first backup will be taken shortly.
|
||||
Reference in New Issue
Block a user