public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-25 04:28:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

making updates per review.

Browse Source
This commit is contained in:
Mark Bishop
2018-08-28 14:44:38 -07:00
committed by Denise Schannon
parent 377ac36ca3
commit 1bd2323a19
7 changed files with 68 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/rancher/v2.x/en/backups/backups/single-node-backups/_index.md
+16 -19
View File
@@ -13,27 +13,24 @@ 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 (`<EXAMPLE>`). Here's an example of a command with a placeholder:
```
docker run --volumes-from rancher-data-<RANCHER_VERSION> -v $PWD:/backup alpine tar zcvf /backup/rancher-data-backup-<RANCHER_VERSION>.tar.gz /var/lib/rancher
docker run --volumes-from rancher-data-<DATE> -v $PWD:/backup alpine tar zcvf /backup/rancher-data-backup-<DATE>.tar.gz /var/lib/rancher
```
In this command, `<RANCHER_VERSION>` is a placeholder for the version of Rancher running in your environment. `v2.0.5` for example.
In this command, `<DATE>` is a placeholder for the date that the data container and backup were created. `9-27-18` for example.
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).
<sup>Terminal `docker ps` Command and Rancher UI, Displaying Where to Find Placeholders</sup>
<sup>Terminal `docker ps` Command, Displaying Where to Find `<RANCHER_CONTAINER_TAG>` and `<RANCHER_CONTAINER_NAME>`</sup>
![Placeholder Reference]({{< baseurl >}}/img/rancher/placeholder-ref.png)
| Legend | Placeholder | Example | Description |
| ------ | -------------------------- | -------------------------- | ----------------- |
| A | `<RANCHER_CONTAINER_TAG>` | `v2.0.5` | The rancher/rancher image you pulled for initial install.|
| B | `<RANCHER_CONTAINER_NAME>` | `festive_mestorf` | The name of your Rancher container.|
| C | `<RANCHER_VERSION>` | `v2.0.5` | The version of Rancher run in your container. |
| Placeholder | Example | Description |
| -------------------------- | -------------------------- | ----------------- |
| `<RANCHER_CONTAINER_TAG>` | `v2.0.5` | The rancher/rancher image you pulled for initial install.|
| `<RANCHER_CONTAINER_NAME>` | `festive_mestorf` | The name of your Rancher container.|
| `<DATE>` | `9-27-18` | The date that the data container or backup was created. |
<br/>
- Obtain `<RANCHER_CONTAINER_TAG>` and `<RANCHER_CONTAINER_NAME>` by logging into your Rancher Server by remote connection and entering `docker ps`.
- Obtain `<RANCHER_VERSION>` by logging into Rancher and viewing the bottom left of the browser window.
You can obtain `<RANCHER_CONTAINER_TAG>` and `<RANCHER_CONTAINER_NAME>` 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.
## Creating a Backup
@@ -45,25 +42,25 @@ This procedure creates a backup that you can restore to in case Rancher encounte
1. Stop the container currently running Rancher Server. Replace `<RANCHER_CONTAINER_NAME>` with the [name of your Rancher container](#before-you-start).
```
docker stop <RANCHER_CONTAINER_NAME>x
docker stop <RANCHER_CONTAINER_NAME>
```
1. <a id="backup"></a>Use the command below, replacing each [placeholder](#before-you-start), to create a data container from the Rancher container that you just stopped.
```
docker create --volumes-from <RANCHER_CONTAINER_NAME> --name rancher-data-<RANCHER_VERSION> rancher/rancher:<RANCHER_CONTAINER_TAG>
docker create --volumes-from <RANCHER_CONTAINER_NAME> --name rancher-data-<DATE> rancher/rancher:<RANCHER_CONTAINER_TAG>
```
1. <a id="tarball"></a>From the data container that you just created (`rancher-data-<RANCHER_VERSION>`), create a backup tarball (`rancher-data-backup-<RANCHER_VERSION>.tar.gz`). Use the following command, replacing each [placeholder](#before-you-start).
1. <a id="tarball"></a>From the data container that you just created (`rancher-data-<DATE>`), create a backup tarball (`rancher-data-backup-<DATE>.tar.gz`). Use the following command, replacing each [placeholder](#before-you-start).
```
docker run --volumes-from rancher-data-<RANCHER_VERSION> -v $PWD:/backup alpine tar zcvf /backup/rancher-data-backup-<RANCHER_VERSION>.tar.gz /var/lib/rancher
docker run --volumes-from rancher-data-<DATE> -v $PWD:/backup alpine tar zcvf /backup/rancher-data-backup-<DATE>.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-<RANCHER_VERSION>`.
1. Enter the `dir` command to confirm that the backup tarball was created. It will have a name similar to `rancher-data-backup-<DATE>.tar.gz`.
![Backup Backup Tarball]({{< baseurl >}}/img/rancher/dir-backup-tarball.png)
1. Move your backup tarball to a safe location external from your Rancher Server. Then delete the `rancher-data-<DATE>` container from your Rancher Server.
1. Restart Rancher Server. Replace `<RANCHER_CONTAINER_NAME>` with the name of your [Rancher container](#before-you-start).
@@ -71,4 +68,4 @@ This procedure creates a backup that you can restore to in case Rancher encounte
docker start <RANCHER_CONTAINER_NAME>
```
**Result:** A backup tarball of your Rancher Server data is created. Make note of the current directory, as this is where the tarball resides. See [Restoring Backups: Single Node Installs]({{< baseurl >}}/rancher/v2.x/en/backups/restorations/single-node-restoration) if you need to restore backup data.
**Result:** A backup tarball of your Rancher Server data is created. See [Restoring Backups: Single Node Installs]({{< baseurl >}}/rancher/v2.x/en/backups/restorations/single-node-restoration) if you need to restore backup data.
content/rancher/v2.x/en/backups/restorations/single-node-restoration/_index.md
+16 -21
View File
@@ -15,30 +15,28 @@ During restoration of your backup, you'll enter a series of commands, filling pl
```
docker run --volumes-from <RANCHER_CONTAINER_NAME> -v $PWD:/backup
alpine sh -c "rm /var/lib/rancher/* -rf &&
tar zxvf /backup/rancher-data-backup-<RANCHER_VERSION>"
tar zxvf /backup/rancher-data-backup-<DATE>"
```
In this command, `<RANCHER_CONTAINER_NAME>` and `<RANCHER_VERSION>` are environment variables for your Rancher deployment.
In this command, `<RANCHER_CONTAINER_NAME>` and `<DATE>` 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](#restoring-backups).
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).
<sup>Terminal `docker ps` Command and Rancher UI, Displaying Where to Find Placeholders</sup>
<sup>Terminal `docker ps` Command, Displaying Where to Find `<RANCHER_CONTAINER_TAG>` and `<RANCHER_CONTAINER_NAME>`</sup>
![Placeholder Reference]({{< baseurl >}}/img/rancher/placeholder-ref.png)
| Legend | Placeholder | Example | Description |
| ------ | -------------------------- | -------------------------- | ----------------- |
| A | `<RANCHER_CONTAINER_TAG>` | `v2.0.5` | The rancher/rancher image you pulled for install.|
| B | `<RANCHER_CONTAINER_NAME>` | `festive_mestorf` | The name of your Rancher container.|
| C | `<RANCHER_VERSION>` | `v2.0.5` | The version of Rancher run in your container. |
| Placeholder | Example | Description |
| -------------------------- | -------------------------- | ----------------- |
| `<RANCHER_CONTAINER_TAG>` | `v2.0.5` | The rancher/rancher image you pulled for initial install.|
| `<RANCHER_CONTAINER_NAME>` | `festive_mestorf` | The name of your Rancher container.|
| `<DATE>` | `9-27-18` | The date that the data container or backup was created. |
<br/>
- Obtain `<RANCHER_CONTAINER_TAG>` and `<RANCHER_CONTAINER_NAME>` by logging into your Rancher Server by remote connection and entering `docker ps`.
- Obtain `<RANCHER_VERSION>` by logging into Rancher and viewing the bottom left of the browser window.
You can obtain `<RANCHER_CONTAINER_TAG>` and `<RANCHER_CONTAINER_NAME>` 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.
## Restoring Backups
Using a backup that you created earlier, restore Rancher to its last known healthy state.
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.
@@ -47,21 +45,18 @@ Using a backup that you created earlier, restore Rancher to its last known healt
```
docker stop <RANCHER_CONTAINER_NAME>
```
1. Make sure you're in your home directory (`cd ~`). Enter `dir` to make sure the tarball you created during [Step 4]({{< baseurl >}}/rancher/v2.x/en/backups/backups/single-node-backups/#tarball) while following [Creating Backups—Single Node Installs]({{< baseurl >}}/rancher/v2.x/en/backups/backups/single-node-backups/) is available.
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.
It will have a name similar to `rancher-data-backup-<RANCHER_VERSION>`.
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-<DATE>.tar.gz`.
![Backup Backup Tarball]({{< baseurl >}}/img/rancher/dir-backup-tarball-clear.png)
1. Enter the following command to delete your current state data and start your backup data, replacing the [placeholders](#before-you-start). Don't forget to close the quotes.
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.
>**Warning!** This command deletes all current state data from your Rancher Server container. Any changes saved after your backup tarball was created will be lost.
```
docker run --volumes-from <RANCHER_CONTAINER_NAME> -v $PWD:/backup
alpine sh -c "rm /var/lib/rancher/* -rf &&
tar zxvf /backup/rancher-data-backup-<RANCHER_VERSION>.tar.gz"
tar zxvf /backup/rancher-data-backup-<DATE>.tar.gz"
```
**Step Result:** A series of commands should run.
@@ -72,4 +67,4 @@ Using a backup that you created earlier, restore Rancher to its last known healt
docker start <RANCHER_CONTAINER_NAME>
```
1. Wait a few moments and then open Rancher in a web browser. Confirm that the rollback succeeded and that your data is restored.
1. Wait a few moments and then open Rancher in a web browser. Confirm that the restoration succeeded and that your data is restored.
content/rancher/v2.x/en/installation/single-node/_index.md
-9
View File
@@ -162,19 +162,10 @@ For production environments, you also have the options of using [Let's Encrypt](
After you fulfill the prerequisites, you can install Rancher using a Let's Encrypt certificate by running the following command. Replace `<YOUR.DNS.NAME>` with your your domain.
<<<<<<< HEAD
```
docker run -d --restart=unless-stopped \
-p 80:80 -p 443:443 \
rancher/rancher:latest \
--acme-domain rancher.mydomain.com
```
=======
docker run -d --restart=unless-stopped \
-p 80:80 -p 443:443 \
rancher/rancher:latest \
--acme-domain <YOUR.DNS.NAME>
>>>>>>> clarifying command line for single-node install
>**Remember:** Let's Encrypt provides rate limits for requesting new certificates. Therefore, limit how often you create or destroy the container. For more information, see [Let's Encrypt documentation on rate limits](https://letsencrypt.org/docs/rate-limits/).
{{% /accordion %}}
content/rancher/v2.x/en/upgrades/rollbacks/single-node-rollbacks/_index.md
+17 -16
View File
@@ -6,7 +6,10 @@ aliases:
- /rancher/v2.x/en/upgrades/single-node-rollbacks
---
If a Rancher upgrade does not complete successfully, you'll have to roll back to the backup you created during [Single Node Upgrade]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrade-scenarios/single-node-upgrade/). This rollback restores both your previous version of Rancher and your data.
If a Rancher upgrade does not complete successfully, you'll have to roll back to your Rancher setup that you were using before [Single Node Upgrade]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrade-scenarios/single-node-upgrade/). Rolling back restores:
- Your previous version of Rancher.
- Your data backup created before upgrade.
## Before You Start
@@ -20,23 +23,21 @@ In this command, `<PRIOR_RANCHER_VERSION>` is the version of Rancher you were ru
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).
<sup>Terminal `docker ps` Command and Rancher UI, Displaying Where to Find Placeholders</sup>
![Placeholder Reference]({{< baseurl >}}/img/rancher/placeholder-ref.png)
<sup>Terminal `docker ps` Command, Displaying Where to Find `<PRIOR_RANCHER_VERSION>` and `<RANCHER_CONTAINER_NAME>`</sup>
![Placeholder Reference]({{< baseurl >}}/img/rancher/placeholder-ref-2.png)
| Legend | Placeholder | Example | Description |
| ------ | -------------------------- | -------------------------- | ----------------- |
| A | `<PRIOR_RANCHER_VERSION>` | `v2.0.5` | The rancher/rancher image you used before upgrade.|
| B | `<RANCHER_CONTAINER_NAME>` | `festive_mestorf` | The name of your Rancher container.|
| C | `<RANCHER_VERSION>` | `v2.0.5` | The version of Rancher run in your container. |
| Placeholder | Example | Description |
| -------------------------- | -------------------------- | ----------------- |
| `<PRIOR_RANCHER_VERSION>` | `v2.0.5` | The rancher/rancher image you used before upgrade.|
| `<RANCHER_CONTAINER_NAME>` | `festive_mestorf` | The name of your Rancher container.|
| `<DATE>` | `9-27-18` | The date that the data container or backup was created. |
<br/>
- Obtain `<PRIOR_RANCHER_VERSION>` and `<RANCHER_CONTAINER_NAME>` by logging into your Rancher Server by remote connection and entering `docker ps`.
- Obtain `<RANCHER_VERSION>` by logging into Rancher and viewing the bottom left of the browser window.
You can obtain `<PRIOR_RANCHER_VERSION>` and `<RANCHER_CONTAINER_NAME>` 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.
## Rolling Back Rancher
If you have issues upgrading Rancher, roll it back to its laster known healthy state by pulling the last version you used and then restoring the backup you made before upgrade.
If you have issues upgrading Rancher, roll it back to its lastest known healthy state by pulling the last version you used and then restoring the backup you made before upgrade.
>**Warning!** Rolling back to a previous version of Rancher destroys any changes made to Rancher following the upgrade. Unrecoverable data loss may occur.
@@ -57,16 +58,16 @@ If you have issues upgrading Rancher, roll it back to its laster known healthy s
```
You can obtain the name for your Rancher container by entering `docker ps`.
1. Make sure you're in your home directory (`cd ~`). Enter `dir` to make sure the tarball you created during [Step 4](({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/single-node-upgrade/#tarball)) while following [Single Node Upgrade]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/single-node-upgrade/) is available.
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.
It will have a name similar to (`rancher-data-backup-<RANCHER_VERSION>.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-<DATE>.tar.gz`).
1. Run the following command to create a data container from the backup tarball, replacing the [placeholder](#before-you-start) Don't forget to close the quotes.
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-<RANCHER_VERSION>.tar.gz"
&& tar zxvf /backup/rancher-data-backup-<DATE>.tar.gz"
```
1. Start a new Rancher Server container with the `<PRIOR_RANCHER_VERSION>` tag [placeholder](#before-you-start) pointing to the data container.
content/rancher/v2.x/en/upgrades/upgrades/single-node-upgrade/_index.md
+19 -17
View File
@@ -4,7 +4,7 @@ weight: 1010
aliases:
- /rancher/v2.x/en/upgrades/single-node-upgrade/
---
To upgrade Rancher Server 2.x when a new version is released, create a data backup for your current Rancher deployment, pull the latest image of Rancher, and then start a new Rancher container using your data backup.
To upgrade Rancher Server 2.x when a new version is released, create a data container for your current Rancher deployment, pull the latest image of Rancher, and then start a new Rancher container using your data container.
## Before You Start
@@ -12,26 +12,24 @@ 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-<RANCHER_VERSION>.tar.gz /var/lib/rancher
docker run --volumes-from rancher-data -v $PWD:/backup alpine tar zcvf /backup/rancher-data-backup-<DATE>.tar.gz /var/lib/rancher
```
In this command, `<RANCHER_VERSION>` is the version of Rancher running in your Rancher deployment before upgrade.
In this command, `<DATE>` is the date of backup creation.
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).
<<sup>Terminal `docker ps` Command and Rancher UI, Displaying Where to Find Placeholders</sup>
<sup>Terminal `docker ps` Command, Displaying Where to Find `<RANCHER_CONTAINER_TAG>` and `<RANCHER_CONTAINER_NAME>`</sup>
![Placeholder Reference]({{< baseurl >}}/img/rancher/placeholder-ref.png)
| Legend | Placeholder | Example | Description |
| ------ | -------------------------- | -------------------------- | ----------------- |
| A | `<RANCHER_CONTAINER_TAG>` | `v2.0.5` | The rancher/rancher image you pulled for install.|
| B | `<RANCHER_CONTAINER_NAME>` | `festive_mestorf` | The name of your Rancher container.|
| C | `<RANCHER_VERSION>` | `v2.0.5` | The version of Rancher run in your container. |
| Placeholder | Example | Description |
| -------------------------- | -------------------------- | ----------------- |
| `<RANCHER_CONTAINER_TAG>` | `v2.0.5` | The rancher/rancher image you pulled for initial install.|
| `<RANCHER_CONTAINER_NAME>` | `festive_mestorf` | The name of your Rancher container.|
| `<DATE>` | `9-27-18` | The date that the data container or backup was created. |
<br/>
- Obtain `<RANCHER_CONTAINER_TAG>` and `<RANCHER_CONTAINER_NAME>` by logging into your Rancher Server by remote connection and entering `docker ps`.
- Obtain `<RANCHER_VERSION>` by logging into Rancher and viewing the bottom left of the browser window.
You can obtain `<RANCHER_CONTAINER_TAG>` and `<RANCHER_CONTAINER_NAME>` 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.
## Completing the Upgrade
@@ -52,21 +50,25 @@ During upgrade, you create a copy of the data from your current Rancher containe
docker create --volumes-from <RANCHER_CONTAINER_NAME> --name rancher-data rancher/rancher:<RANCHER_CONTAINER_TAG>
```
1. <a id="tarball"></a>From the data container that you just created (`rancher-data`), create an upgrade tarball (`rancher-data-backup-<RANCHER_VERSION>.tar.gz`).
1. <a id="tarball"></a>From the data container that you just created (`rancher-data`), create a backup tarball (`rancher-data-backup-<DATE>.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-<RANCHER_VERSION>.tar.gz /var/lib/rancher
docker run --volumes-from rancher-data -v $PWD:/backup alpine tar zcvf /backup/rancher-data-backup-<DATE>.tar.gz /var/lib/rancher
```
When you enter this command, a series of commands should run.
**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-<RANCHER_VERSION>`.
1. Enter the `dir` command to confirm that the backup tarball was created. It will have a name similar to `rancher-data-backup-<DATE>`.
![Backup Backup Tarball]({{< baseurl >}}/img/rancher/dir-backup-tarball.png)
1. Move your backup tarball to a safe location external from your Rancher Server.
1. Pull the most recent image of Rancher.
```
@@ -79,7 +81,7 @@ During upgrade, you create a copy of the data from your current Rancher containe
> Example: `<registry.yourdomain.com:port>/rancher/rancher:latest`
>
1. Launch a new Rancher Server container using the `rancher-data` container.
1. Start a new Rancher Server container using the data from the `rancher-data` container.
```
docker run -d --volumes-from rancher-data --restart=unless-stopped -p 80:80 -p 443:443 rancher/rancher:latest
src/img/rancher/placeholder-ref-2.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 57 KiB

src/img/rancher/placeholder-ref.png
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 215 KiB

After

Width:  |  Height:  |  Size: 56 KiB