From daa6b625a5a74ee6e22d1588a04fa5b254c366e7 Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Tue, 28 Aug 2018 10:49:14 -0700 Subject: [PATCH] making version date placeholder edits and changing first intruction to connect to the rancher server NODE --- .../backups/single-node-backups/_index.md | 21 +++++++++-------- .../single-node-restoration/_index.md | 21 +++++++++-------- .../rollbacks/single-node-rollbacks/_index.md | 17 +++++++------- .../upgrades/single-node-upgrade/_index.md | 23 ++++++++++--------- 4 files changed, 43 insertions(+), 39 deletions(-) diff --git a/content/rancher/v2.x/en/backups/backups/single-node-backups/_index.md b/content/rancher/v2.x/en/backups/backups/single-node-backups/_index.md index e853f12932d..9ea7cce9ddf 100644 --- a/content/rancher/v2.x/en/backups/backups/single-node-backups/_index.md +++ b/content/rancher/v2.x/en/backups/backups/single-node-backups/_index.md @@ -13,7 +13,7 @@ After completing your single node installation of Rancher, we recommend creating During creation of your backup, you'll enter a series of commands, filling placeholders with data from your environment. These placeholders are denoted with angled brackets and all capital letters (``). Here's an example of a command with a placeholder: ``` -docker run --volumes-from rancher-data- -v $PWD:/backup alpine tar zcvf /backup/rancher-data-backup-.tar.gz /var/lib/rancher +docker run --volumes-from rancher-data- -v $PWD:/backup alpine tar zcvf /backup/rancher-data-backup--.tar.gz /var/lib/rancher ``` In this command, `` is a placeholder for the date that the data container and backup were created. `9-27-18` for example. @@ -23,11 +23,12 @@ Cross reference the image and reference table below to learn how to obtain this Terminal `docker ps` Command, Displaying Where to Find `` and `` ![Placeholder Reference]({{< baseurl >}}/img/rancher/placeholder-ref.png) -| Placeholder | Example | Description | -| -------------------------- | -------------------------- | ----------------- | -| `` | `v2.0.5` | The rancher/rancher image you pulled for initial install.| -| `` | `festive_mestorf` | The name of your Rancher container.| -| `` | `9-27-18` | The date that the data container or backup was created. | +| Placeholder | Example | Description | +| -------------------------- | -------------------------- | --------------------------------------------------------- | +| `` | `v2.0.5` | The rancher/rancher image you pulled for initial install. | +| `` | `festive_mestorf` | The name of your Rancher container. | +| `` | `v2.0.5` | The version of Rancher that you're creating a backup for. | +| `` | `9-27-18` | The date that the data container or backup was created. |
You can obtain `` and `` by logging into your Rancher Server by remote connection and entering the command to view the containers that are running: `docker ps`. You can also view containers that are stopped using a different command: `docker ps -a`. Use these commands for help anytime during while creating backups. @@ -37,7 +38,7 @@ You can obtain `` and `` by loggi This procedure creates a backup that you can restore to in case Rancher encounters a disaster scenario. -1. Using a remote Terminal connection, log into your Rancher Server. +1. Using a remote Terminal connection, log into the node running your Rancher Server. 1. Stop the container currently running Rancher Server. Replace `` with the [name of your Rancher container](#before-you-start). @@ -50,15 +51,15 @@ This procedure creates a backup that you can restore to in case Rancher encounte docker create --volumes-from --name rancher-data- rancher/rancher: ``` -1. From the data container that you just created (`rancher-data-`), create a backup tarball (`rancher-data-backup-.tar.gz`). Use the following command, replacing each [placeholder](#before-you-start). +1. From the data container that you just created (`rancher-data-`), create a backup tarball (`rancher-data-backup--.tar.gz`). Use the following command, replacing each [placeholder](#before-you-start). ``` - docker run --volumes-from rancher-data- -v $PWD:/backup alpine tar zcvf /backup/rancher-data-backup-.tar.gz /var/lib/rancher + docker run --volumes-from rancher-data- -v $PWD:/backup alpine tar zcvf /backup/rancher-data-backup--.tar.gz /var/lib/rancher ``` **Step Result:** A stream of commands runs on screen. -1. Enter the `dir` command to confirm that the backup tarball was created. It will have a name similar to `rancher-data-backup-.tar.gz`. +1. Enter the `dir` command to confirm that the backup tarball was created. It will have a name similar to `rancher-data-backup--.tar.gz`. 1. Move your backup tarball to a safe location external from your Rancher Server. Then delete the `rancher-data-` container from your Rancher Server. diff --git a/content/rancher/v2.x/en/backups/restorations/single-node-restoration/_index.md b/content/rancher/v2.x/en/backups/restorations/single-node-restoration/_index.md index f8b2df54892..0a09c1c0684 100644 --- a/content/rancher/v2.x/en/backups/restorations/single-node-restoration/_index.md +++ b/content/rancher/v2.x/en/backups/restorations/single-node-restoration/_index.md @@ -15,21 +15,22 @@ During restoration of your backup, you'll enter a series of commands, filling pl ``` docker run --volumes-from -v $PWD:/backup alpine sh -c "rm /var/lib/rancher/* -rf && -tar zxvf /backup/rancher-data-backup-" +tar zxvf /backup/rancher-data-backup--" ``` -In this command, `` and `` are environment variables for your Rancher deployment. +In this command, `` and `-` are environment variables for your Rancher deployment. Cross reference the image and reference table below to learn how to obtain this placeholder data. Write down or copy this information before starting the [procedure below](#creating-a-backup). Terminal `docker ps` Command, Displaying Where to Find `` and `` ![Placeholder Reference]({{< baseurl >}}/img/rancher/placeholder-ref.png) -| Placeholder | Example | Description | -| -------------------------- | -------------------------- | ----------------- | -| `` | `v2.0.5` | The rancher/rancher image you pulled for initial install.| -| `` | `festive_mestorf` | The name of your Rancher container.| -| `` | `9-27-18` | The date that the data container or backup was created. | +| Placeholder | Example | Description | +| -------------------------- | -------------------------- | --------------------------------------------------------- | +| `` | `v2.0.5` | The rancher/rancher image you pulled for initial install. | +| `` | `festive_mestorf` | The name of your Rancher container. | +| `` | `v2.0.5` | The version number for your Rancher backup. | +| `` | `9-27-18` | The date that the data container or backup was created. |
You can obtain `` and `` by logging into your Rancher Server by remote connection and entering the command to view the containers that are running: `docker ps`. You can also view containers that are stopped using a different command: `docker ps -a`. Use these commands for help anytime during while creating backups. @@ -38,7 +39,7 @@ You can obtain `` and `` by loggi Using a [backup]({{< baseurl >}}/rancher/v2.x/en/backups/backups/single-node-backups/) that you created earlier, restore Rancher to its last known healthy state. -1. Using a remote Terminal connection, log into your Rancher Server. +1. Using a remote Terminal connection, log into the node running your Rancher Server. 1. Stop the container currently running Rancher Server. Replace `` with the [name of your Rancher container](#before-you-start). @@ -47,7 +48,7 @@ Using a [backup]({{< baseurl >}}/rancher/v2.x/en/backups/backups/single-node-bac ``` 1. Move the backup tarball that you created during completion of [Creating Backups—Single Node Installs]({{< baseurl >}}/rancher/v2.x/en/backups/backups/single-node-backups/) onto your Rancher Server. Change to the directory that you moved it to. Enter `dir` to confirm that it's there. - If you followed the naming convention we suggested in [Creating Backups—Single Node Installs]({{< baseurl >}}/rancher/v2.x/en/backups/backups/single-node-backups/), it will have a name similar to `rancher-data-backup-.tar.gz`. + If you followed the naming convention we suggested in [Creating Backups—Single Node Installs]({{< baseurl >}}/rancher/v2.x/en/backups/backups/single-node-backups/), it will have a name similar to `rancher-data-backup--.tar.gz`. 1. Enter the following command to delete your current state data and replace it with your backup data, replacing the [placeholders](#before-you-start). Don't forget to close the quotes. @@ -56,7 +57,7 @@ Using a [backup]({{< baseurl >}}/rancher/v2.x/en/backups/backups/single-node-bac ``` docker run --volumes-from -v $PWD:/backup alpine sh -c "rm /var/lib/rancher/* -rf && - tar zxvf /backup/rancher-data-backup-.tar.gz" + tar zxvf /backup/rancher-data-backup--.tar.gz" ``` **Step Result:** A series of commands should run. diff --git a/content/rancher/v2.x/en/upgrades/rollbacks/single-node-rollbacks/_index.md b/content/rancher/v2.x/en/upgrades/rollbacks/single-node-rollbacks/_index.md index 2ad84586374..87d23448cad 100644 --- a/content/rancher/v2.x/en/upgrades/rollbacks/single-node-rollbacks/_index.md +++ b/content/rancher/v2.x/en/upgrades/rollbacks/single-node-rollbacks/_index.md @@ -26,11 +26,12 @@ Cross reference the image and reference table below to learn how to obtain this Terminal `docker ps` Command, Displaying Where to Find `` and `` ![Placeholder Reference]({{< baseurl >}}/img/rancher/placeholder-ref-2.png) -| Placeholder | Example | Description | -| -------------------------- | -------------------------- | ----------------- | -| `` | `v2.0.5` | The rancher/rancher image you used before upgrade.| -| `` | `festive_mestorf` | The name of your Rancher container.| -| `` | `9-27-18` | The date that the data container or backup was created. | +| Placeholder | Example | Description | +| -------------------------- | -------------------------- | ------------------------------------------------------- | +| `` | `v2.0.5` | The rancher/rancher image you used before upgrade. | +| `` | `festive_mestorf` | The name of your Rancher container. | +| `` | `v2.0.5` | The version of Rancher that the backup is for. | +| `` | `9-27-18` | The date that the data container or backup was created. |
You can obtain `` and `` by logging into your Rancher Server by remote connection and entering the command to view the containers that are running: `docker ps`. You can also view containers that are stopped using a different command: `docker ps -a`. Use these commands for help anytime during while creating backups. @@ -41,7 +42,7 @@ If you have issues upgrading Rancher, roll it back to its lastest known healthy >**Warning!** Rolling back to a previous version of Rancher destroys any changes made to Rancher following the upgrade. Unrecoverable data loss may occur. -1. Using a remote Terminal connection, log into your Rancher Server. +1. Using a remote Terminal connection, log into the node running your Rancher Server. 1. Pull the version of Rancher that you were running prior to upgrade. Replace the `` with [that version](#before-you-start). @@ -60,14 +61,14 @@ If you have issues upgrading Rancher, roll it back to its lastest known healthy 1. Move the backup tarball that you created during completion of [Single Node Upgrade]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/single-node-upgrade/) onto your Rancher Server. Change to the directory that you moved it to. Enter `dir` to confirm that it's there. - If you followed the naming convention we suggested in [Single Node Upgrade]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/single-node-upgrade/), it will have a name similar to (`rancher-data-backup-.tar.gz`). + If you followed the naming convention we suggested in [Single Node Upgrade]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/single-node-upgrade/), it will have a name similar to (`rancher-data-backup--.tar.gz`). 1. Run the following command to replace the data in the `rancher-data` container with the data in the backup tarball, replacing the [placeholder](#before-you-start). Don't forget to close the quotes. ``` docker run --volumes-from rancher-data -v $PWD:/backup alpine sh -c "rm /var/lib/rancher/* -rf - && tar zxvf /backup/rancher-data-backup-.tar.gz" + && tar zxvf /backup/rancher-data-backup--.tar.gz" ``` 1. Start a new Rancher Server container with the `` tag [placeholder](#before-you-start) pointing to the data container. diff --git a/content/rancher/v2.x/en/upgrades/upgrades/single-node-upgrade/_index.md b/content/rancher/v2.x/en/upgrades/upgrades/single-node-upgrade/_index.md index d2a91a4e8d0..6061a7a0dd8 100644 --- a/content/rancher/v2.x/en/upgrades/upgrades/single-node-upgrade/_index.md +++ b/content/rancher/v2.x/en/upgrades/upgrades/single-node-upgrade/_index.md @@ -12,21 +12,22 @@ During upgrade, you'll enter a series of commands, filling placeholders with dat ``` -docker run --volumes-from rancher-data -v $PWD:/backup alpine tar zcvf /backup/rancher-data-backup-.tar.gz /var/lib/rancher +docker run --volumes-from rancher-data -v $PWD:/backup alpine tar zcvf /backup/rancher-data-backup--.tar.gz /var/lib/rancher ``` -In this command, `` is the date of backup creation. +In this command, `-` is the the version number and date of creation for a backup of Rancher. Cross reference the image and reference table below to learn how to obtain this placeholder data. Write down or copy this information before starting the [procedure below](#completing-the-upgrade). Terminal `docker ps` Command, Displaying Where to Find `` and `` ![Placeholder Reference]({{< baseurl >}}/img/rancher/placeholder-ref.png) -| Placeholder | Example | Description | -| -------------------------- | -------------------------- | ----------------- | -| `` | `v2.0.5` | The rancher/rancher image you pulled for initial install.| -| `` | `festive_mestorf` | The name of your Rancher container.| -| `` | `9-27-18` | The date that the data container or backup was created. | +| Placeholder | Example | Description | +| -------------------------- | -------------------------- | --------------------------------------------------------- | +| `` | `v2.0.5` | The rancher/rancher image you pulled for initial install. | +| `` | `festive_mestorf` | The name of your Rancher container. | +| `` | `v2.0.5` | The version of Rancher that you're creating a backup for. | +| `` | `9-27-18` | The date that the data container or backup was created. |
You can obtain `` and `` by logging into your Rancher Server by remote connection and entering the command to view the containers that are running: `docker ps`. You can also view containers that are stopped using a different command: `docker ps -a`. Use these commands for help anytime during while creating backups. @@ -35,7 +36,7 @@ You can obtain `` and `` by loggi During upgrade, you create a copy of the data from your current Rancher container and a backup in case something goes wrong. Then you deploy the new version of Rancher in a new container using your existing data. -1. Using a remote Terminal connection, log into your Rancher Server. +1. Using a remote Terminal connection, log into the node running your Rancher Server. 1. Stop the container currently running Rancher Server. Replace `` with the [name of your Rancher container](#before-you-start). @@ -50,18 +51,18 @@ During upgrade, you create a copy of the data from your current Rancher containe docker create --volumes-from --name rancher-data rancher/rancher: ``` -1. From the data container that you just created (`rancher-data`), create a backup tarball (`rancher-data-backup-.tar.gz`). +1. From the data container that you just created (`rancher-data`), create a backup tarball (`rancher-data-backup--.tar.gz`). This tarball will serve as a rollback point if something goes wrong during upgrade. Use the following command, replacing each [placeholder](#before-you-start). ``` - docker run --volumes-from rancher-data -v $PWD:/backup alpine tar zcvf /backup/rancher-data-backup-.tar.gz /var/lib/rancher + docker run --volumes-from rancher-data -v $PWD:/backup alpine tar zcvf /backup/rancher-data-backup--.tar.gz /var/lib/rancher ``` **Step Result:** When you enter this command, a series of commands should run. -1. Enter the `dir` command to confirm that the backup tarball was created. It will have a name similar to `rancher-data-backup-`. +1. Enter the `dir` command to confirm that the backup tarball was created. It will have a name similar to `rancher-data-backup--`. ![Backup Backup Tarball]({{< baseurl >}}/img/rancher/dir-backup-tarball.png)