diff --git a/content/rancher/v2.x/en/backups/_index.md b/content/rancher/v2.x/en/backups/_index.md new file mode 100644 index 00000000000..6c9c7fed1f1 --- /dev/null +++ b/content/rancher/v2.x/en/backups/_index.md @@ -0,0 +1,18 @@ +--- +title: Backups and Rollbacks +weight: 1000 +--- + +This section is devoted to protecting your Rancher Server data in a disaster scenario. + +- [Backups](./backups/) + + To protect yourself from a disaster scenario, you should create Rancher backups on a regular basis. + +- [Restorations](./restorations/) + + In a disaster scenario, you can restore your `etcd` database by restoring a backup. + +- [Rollbacks](./rollbacks/) + + If an upgrade does not complete successfully, you can revert you Rancher Server to its previous version along with its data prior to upgrade. diff --git a/content/rancher/v2.x/en/upgrades/backups/_index.md b/content/rancher/v2.x/en/backups/backups/_index.md similarity index 100% rename from content/rancher/v2.x/en/upgrades/backups/_index.md rename to content/rancher/v2.x/en/backups/backups/_index.md diff --git a/content/rancher/v2.x/en/upgrades/backups/ha-backups/_index.md b/content/rancher/v2.x/en/backups/backups/ha-backups/_index.md similarity index 79% rename from content/rancher/v2.x/en/upgrades/backups/ha-backups/_index.md rename to content/rancher/v2.x/en/backups/backups/ha-backups/_index.md index 53414c1c622..e3cc076f3b4 100644 --- a/content/rancher/v2.x/en/upgrades/backups/ha-backups/_index.md +++ b/content/rancher/v2.x/en/backups/backups/ha-backups/_index.md @@ -6,43 +6,23 @@ aliases: --- This section describes how to create backups of your high-availability Rancher install. +>**Prerequisites:** {{< requirements_rollback >}} + ## Backup Outline Backing up your high-availability Rancher cluster is process that involves completing multiple tasks. -1. [Meet Backup Prerequisites](#1-meet-backup-prerequisites) - - Before starting, make sure you have the files needed to create backups. - -1. [Take Snapshots of the `etcd` Database](#2-take-snapshots-of-the-etcd-database) +1. [Take Snapshots of the `etcd` Database](#1-take-snapshots-of-the-etcd-database) Take snapshots of your current `etcd` database using Rancher Kubernetes Engine (RKE). -1. [Store Snapshot(s) Externally](#3-backup-snapshots-to-a-safe-location) +1. [Store Snapshot(s) Externally](#2-backup-snapshots-to-a-safe-location) After taking your snapshots, export them to a safe location that won't be affected if your cluster encounters issues.
-### 1. Meet Backup Prerequisites -Begin by gathering the files that you need to create backups of your Rancher install. - -#### Prerequisites - -- Rancher Kubernetes Engine v0.1.7 or later - - The commands for taking `etcd` snapshots are only available in RKE v0.1.7 and later. - -- rancher-cluster.yml - - You'll need the RKE config file you used for Rancher install, `rancher-cluster.yml`. You created this file during your chosen high-availability installation scenario: -
-
- - [High Availability Installation]({{< baseurl >}}/rancher/v2.x/en/installation/ha-server-install) - - [High Availability Installation with External Load Balancer]({{< baseurl >}}/rancher/v2.x/en/installation/ha-server-install-external-lb) - -
-### 2. Take Snapshots of the `etcd` Database +### 1. Take Snapshots of the `etcd` Database Take snapshots of your `etcd` database. You can use these snapshots later to recover from a disaster scenario. There are two ways to take snapshots: recurringly, or as a one-off. Each option is better suited to a specific use case. Read the short description below each link to know when to use each option. @@ -111,7 +91,7 @@ When you're about to upgrade Rancher or restore it to a previous snapshot, you s **Result:** RKE takes a snapshot of `etcd` running on each `etcd` node. The file is saved to `/opt/rke/etcd-snapshots`. -### 3. Backup Snapshots to a Safe Location +### 2. Backup Snapshots to a Safe Location After taking the `etcd` snapshots, save them to a safe location so that they're unaffected if your cluster experiences a disaster scenario. This location should be persistent. diff --git a/content/rancher/v2.x/en/upgrades/backups/single-node-backups/_index.md b/content/rancher/v2.x/en/backups/backups/single-node-backups/_index.md similarity index 100% rename from content/rancher/v2.x/en/upgrades/backups/single-node-backups/_index.md rename to content/rancher/v2.x/en/backups/backups/single-node-backups/_index.md diff --git a/content/rancher/v2.x/en/upgrades/restorations/_index.md b/content/rancher/v2.x/en/backups/restorations/_index.md similarity index 100% rename from content/rancher/v2.x/en/upgrades/restorations/_index.md rename to content/rancher/v2.x/en/backups/restorations/_index.md diff --git a/content/rancher/v2.x/en/upgrades/restorations/ha-restoration/_index.md b/content/rancher/v2.x/en/backups/restorations/ha-restoration/_index.md similarity index 100% rename from content/rancher/v2.x/en/upgrades/restorations/ha-restoration/_index.md rename to content/rancher/v2.x/en/backups/restorations/ha-restoration/_index.md diff --git a/content/rancher/v2.x/en/upgrades/restorations/single-node-restoration/_index.md b/content/rancher/v2.x/en/backups/restorations/single-node-restoration/_index.md similarity index 100% rename from content/rancher/v2.x/en/upgrades/restorations/single-node-restoration/_index.md rename to content/rancher/v2.x/en/backups/restorations/single-node-restoration/_index.md diff --git a/content/rancher/v2.x/en/upgrades/rollbacks/_index.md b/content/rancher/v2.x/en/backups/rollbacks/_index.md similarity index 100% rename from content/rancher/v2.x/en/upgrades/rollbacks/_index.md rename to content/rancher/v2.x/en/backups/rollbacks/_index.md diff --git a/content/rancher/v2.x/en/upgrades/rollbacks/ha-server-rollbacks/_index.md b/content/rancher/v2.x/en/backups/rollbacks/ha-server-rollbacks/_index.md similarity index 91% rename from content/rancher/v2.x/en/upgrades/rollbacks/ha-server-rollbacks/_index.md rename to content/rancher/v2.x/en/backups/rollbacks/ha-server-rollbacks/_index.md index b5d2fb47bc1..913a2f12409 100644 --- a/content/rancher/v2.x/en/upgrades/rollbacks/ha-server-rollbacks/_index.md +++ b/content/rancher/v2.x/en/backups/rollbacks/ha-server-rollbacks/_index.md @@ -8,7 +8,11 @@ If you upgrade Rancher, but the upgrade does not complete successfully, you may - Restore the `etcd` snapshot taken before upgrade. - Run the command to revert to your prior version of Rancher. ->**Warning!** Rolling back to a previous version of Rancher destroys any changes made to Rancher following the upgrade. Unrecoverable data loss may occur. +>**Warning!** +> +> Rolling back to a previous version of Rancher destroys any changes made to Rancher following the upgrade. Unrecoverable data loss may occur. +> +>**Prerequisites:** {{< requirements_rollback >}} 1. Open **Terminal** and change directory to the location of the RKE binary that you used during upgrade. diff --git a/content/rancher/v2.x/en/upgrades/rollbacks/single-node-rollbacks/_index.md b/content/rancher/v2.x/en/backups/rollbacks/single-node-rollbacks/_index.md similarity index 100% rename from content/rancher/v2.x/en/upgrades/rollbacks/single-node-rollbacks/_index.md rename to content/rancher/v2.x/en/backups/rollbacks/single-node-rollbacks/_index.md diff --git a/content/rancher/v2.x/en/upgrades/_index.md b/content/rancher/v2.x/en/upgrades/_index.md index e7b449b88bd..e36a8a0d0dc 100644 --- a/content/rancher/v2.x/en/upgrades/_index.md +++ b/content/rancher/v2.x/en/upgrades/_index.md @@ -1,22 +1,22 @@ --- -title: Upgrades -weight: 1000 +title: Upgrade Scenarios +weight: 25 --- -This section is devoted to upgrading your Rancher Server, as well as other procedures related to upgrades and system maintenance. +### Upgrading from Rancher 2.x.x -- [Upgrade Scenarios](./upgrade-scenarios/) +Each new version of Rancher 2.x.x supports upgrades from previous versions of Rancher 2.x.x. This section will be updated as soon as the first release post 2.0 is available. - When a new version of Rancher is released, follow these instructions to upgrade to the latest version. +Complete one of the upgrade procedures below based on your Rancher installation: -- [Backups](./backups/) +- [Single Node Upgrade](./single-node-upgrade/) +- [High Availability Upgrade](./ha-server-upgrade/) +- [Air Gap Upgrade](./air-gap-upgrade/) - To protect yourself from a disaster scenario, you should create Rancher backups on a regular basis. +### Migrating from Rancher 1.6.x -- [Restorations](./restorations/) +Until Rancher 2.1 is released, migrating to from Rancher 1.6.x to 2.x.x is not supported due to major code rewrites. - In a disaster scenario, you can restore your `etcd` database by restoring a backup. +For the 2.1 release, we plan to release a tool that converts Rancher Compose to Kubernetes YAML. This tool will help our Cattle users migrate from Rancher 1.6.x to 2.x.x. However, we understand that there is a learning curve switching from Cattle to Kubernetes as you deploy new workloads. Therefore, this release will include a cheatsheet for those that enjoy Cattle's simplicity but want to quickly create those workloads in Kubernetes. -- [Rollbacks](./rollbacks/) - - If an upgrade does not complete successfully, you can revert you Rancher Server to its previous version along with its data prior to upgrade. +We will continue support for Rancher 1.6.x for a minimum of one year after the 2.1 release so that 1.6.x users can plan and complete migration. \ No newline at end of file diff --git a/content/rancher/v2.x/en/upgrades/upgrade-scenarios/air-gap-upgrade/_index.md b/content/rancher/v2.x/en/upgrades/air-gap-upgrade/_index.md similarity index 100% rename from content/rancher/v2.x/en/upgrades/upgrade-scenarios/air-gap-upgrade/_index.md rename to content/rancher/v2.x/en/upgrades/air-gap-upgrade/_index.md diff --git a/content/rancher/v2.x/en/upgrades/upgrade-scenarios/ha-server-upgrade/_index.md b/content/rancher/v2.x/en/upgrades/ha-server-upgrade/_index.md similarity index 93% rename from content/rancher/v2.x/en/upgrades/upgrade-scenarios/ha-server-upgrade/_index.md rename to content/rancher/v2.x/en/upgrades/ha-server-upgrade/_index.md index cd73242de9c..aa513dbeb65 100644 --- a/content/rancher/v2.x/en/upgrades/upgrade-scenarios/ha-server-upgrade/_index.md +++ b/content/rancher/v2.x/en/upgrades/ha-server-upgrade/_index.md @@ -5,14 +5,15 @@ weight: 1020 To upgrade Rancher 2.x running in a high availability configuration, run an upgrade command that points to your upgrade config file. >**Prerequisites:** -> +{{< requirements_rollback >}} + >- Install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) on your workstation. >- Confirm that the following path exists on your workstation: `~/.kube/`. If it doesn't, create it yourself. >- Copy `kube_config_rancher-cluster.yml`, which is automatically generated after [Rancher Server installation]({{< baseurl >}}/rancher/v2.x/en/installation/ha-server-install#part-11-backup-kube-config-rancher-cluster-yml), to the `~/.kube/` directory. 1. From your workstation, open **Terminal**. -1. Change directory to the location of the RKE binary. Your `kube_config_rancher-cluster.yml` file must reside in the same directory. +1. Change directory to the location of the RKE binary. Your `rancher-cluster.yml` file must reside in the same directory. 1. Enter the following command. Replace `` with any name that you want to use for the snapshot (e.g. `upgrade.db`). diff --git a/content/rancher/v2.x/en/upgrades/upgrade-scenarios/single-node-upgrade/_index.md b/content/rancher/v2.x/en/upgrades/single-node-upgrade/_index.md similarity index 100% rename from content/rancher/v2.x/en/upgrades/upgrade-scenarios/single-node-upgrade/_index.md rename to content/rancher/v2.x/en/upgrades/single-node-upgrade/_index.md diff --git a/content/rancher/v2.x/en/upgrades/upgrade-scenarios/_index.md b/content/rancher/v2.x/en/upgrades/upgrade-scenarios/_index.md deleted file mode 100644 index e36a8a0d0dc..00000000000 --- a/content/rancher/v2.x/en/upgrades/upgrade-scenarios/_index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Upgrade Scenarios -weight: 25 ---- - -### Upgrading from Rancher 2.x.x - -Each new version of Rancher 2.x.x supports upgrades from previous versions of Rancher 2.x.x. This section will be updated as soon as the first release post 2.0 is available. - -Complete one of the upgrade procedures below based on your Rancher installation: - -- [Single Node Upgrade](./single-node-upgrade/) -- [High Availability Upgrade](./ha-server-upgrade/) -- [Air Gap Upgrade](./air-gap-upgrade/) - -### Migrating from Rancher 1.6.x - -Until Rancher 2.1 is released, migrating to from Rancher 1.6.x to 2.x.x is not supported due to major code rewrites. - -For the 2.1 release, we plan to release a tool that converts Rancher Compose to Kubernetes YAML. This tool will help our Cattle users migrate from Rancher 1.6.x to 2.x.x. However, we understand that there is a learning curve switching from Cattle to Kubernetes as you deploy new workloads. Therefore, this release will include a cheatsheet for those that enjoy Cattle's simplicity but want to quickly create those workloads in Kubernetes. - -We will continue support for Rancher 1.6.x for a minimum of one year after the 2.1 release so that 1.6.x users can plan and complete migration. \ No newline at end of file diff --git a/layouts/shortcodes/requirements_rollback.html b/layouts/shortcodes/requirements_rollback.html new file mode 100644 index 00000000000..d0d9cd6f81c --- /dev/null +++ b/layouts/shortcodes/requirements_rollback.html @@ -0,0 +1,12 @@ +
+ +
\ No newline at end of file