From e1c94619f4276a7ebf059deba4c6ec85a8d69124 Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Tue, 16 Oct 2018 17:33:45 -0700 Subject: [PATCH 1/8] updating ha install/upgrade command --- .../air-gap-installation/install-rancher/_index.md | 4 ++-- .../v2.x/en/installation/ha/helm-rancher/_index.md | 13 ++++++++----- .../ha-server-upgrade-helm-airgap/_index.md | 6 +++--- .../upgrades/ha-server-upgrade-helm/_index.md | 8 +++++--- 4 files changed, 18 insertions(+), 13 deletions(-) diff --git a/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md b/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md index 7b7490b3938..9689a7d9163 100644 --- a/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md +++ b/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md @@ -104,10 +104,10 @@ Install the Rancher chart repo. helm repo add rancher-stable https://releases.rancher.com/server-charts/stable ``` -Fetch the latest `rancher-stable/rancher` chart. This will pull down the chart and save it in the current directory as a `.tgz` file. +Fetch the latest `rancher-latest/rancher` chart. This will pull down the chart and save it in the current directory as a `.tgz` file. ```plain -helm fetch rancher-stable/rancher +helm fetch rancher-latest/rancher ``` Render the template with the options you would use to install the chart. See [Install Rancher]({{< baseurl >}}/rancher/v2.x/en/installation/ha/helm-rancher/) for details on the various options. Remember to set the `rancherImage` option to pull the image from your private registry. This will create a `rancher` directory with the Kubernetes manifest files. diff --git a/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md b/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md index ab7f4654d31..3d9af17c245 100644 --- a/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md +++ b/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md @@ -11,10 +11,13 @@ Rancher installation is now managed using the Helm package manager for Kubernete Use `helm repo add` to add the Rancher chart repository. +>**Note:** We recommend adding the `latest` Rancher chart repository used in the command below, but you also have the option of using our `stable` repository. For more information, see [Server Tags]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/). + ``` -helm repo add rancher-stable https://releases.rancher.com/server-charts/stable +helm repo add rancher-latest https://releases.rancher.com/server-charts/latest ``` + ## Chart Versioning Notes Up until the initial helm chart release for v2.1.0, the helm chart version matched the Rancher version (i.e `appVersion`). @@ -25,7 +28,7 @@ Run `helm search rancher` to view which Rancher version will be launched for the ``` NAME CHART VERSION APP VERSION DESCRIPTION -rancher-stable/rancher 2018.10.1 v2.1.0 Install Rancher Server to manage Kubernetes clusters acro... +rancher-latest/rancher 2018.10.1 v2.1.0 Install Rancher Server to manage Kubernetes clusters acro... ``` ### Install cert-manager @@ -63,7 +66,7 @@ The only requirement is to set the `hostname` to the DNS name you pointed at you >**Using Air Gap?** [Set the `rancherImage` option]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/install-rancher/#install-rancher-using-private-registry) in your command, pointing toward your private registry. ``` -helm install rancher-stable/rancher \ +helm install rancher-latest/rancher \ --name rancher \ --namespace cattle-system \ --set hostname=rancher.my.org @@ -78,7 +81,7 @@ Set `hostname`, `ingress.tls.source=letsEncrypt` and LetsEncrypt options. >**Using Air Gap?** [Set the `rancherImage` option]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/install-rancher/#install-rancher-using-private-registry) in your command, pointing toward your private registry. ``` -helm install rancher-stable/rancher \ +helm install rancher-latest/rancher \ --name rancher \ --namespace cattle-system \ --set hostname=rancher.my.org \ @@ -97,7 +100,7 @@ Set `hostname` and `ingress.tls.source=secret`. > **Note:** If you are using a Private CA signed cert, add `--set privateCA=true` ``` -helm install rancher-stable/rancher \ +helm install rancher-latest/rancher \ --name rancher \ --namespace cattle-system \ --set hostname=rancher.my.org \ diff --git a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm-airgap/_index.md b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm-airgap/_index.md index 5095a92343c..55021f59cb3 100644 --- a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm-airgap/_index.md +++ b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm-airgap/_index.md @@ -34,7 +34,7 @@ Run `helm search rancher` to view which Rancher version will be launched for the ``` NAME CHART VERSION APP VERSION DESCRIPTION -rancher-stable/rancher 2018.10.1 v2.1.0 Install Rancher Server to manage Kubernetes clusters acro... +rancher-latest/rancher 2018.10.1 v2.1.0 Install Rancher Server to manage Kubernetes clusters acro... ``` ## Upgrade Rancher @@ -45,12 +45,12 @@ rancher-stable/rancher 2018.10.1 v2.1.0 Install Rancher Serve helm repo update ``` -1. Fetch the latest `rancher-stable/rancher` chart. +1. Fetch the latest `rancher-latest/rancher` chart. This will pull down the chart and save it in the current directory as a `.tgz` file. ```plain - helm fetch rancher-stable/rancher + helm fetch rancher-latest/rancher ``` 1. Render the upgrade template. diff --git a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md index a9fcaf3eb97..2a091738e35 100644 --- a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md +++ b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md @@ -48,7 +48,7 @@ Run `helm search rancher` to view which Rancher version will be launched for the ``` NAME CHART VERSION APP VERSION DESCRIPTION -rancher-stable/rancher 2018.10.1 v2.1.0 Install Rancher Server to manage Kubernetes clusters acro... +rancher-latest/rancher 2018.10.1 v2.1.0 Install Rancher Server to manage Kubernetes clusters acro... ``` ## Upgrade Rancher @@ -74,10 +74,12 @@ rancher-stable/rancher 2018.10.1 v2.1.0 Install Rancher Serve 3. Take all values from the previous command and use `helm` with `--set` options to upgrade Rancher to the latest version. ``` - helm upgrade rancher rancher-stable/rancher --set hostname=rancher.my.org + helm upgrade rancher rancher-latest/rancher --set hostname=rancher.my.org ``` - > **Important:** For any values listed from Step 2, you must use `--set key=value` to apply the same values to the helm chart. + > **Important:** + >- For any values listed from Step 2, you must use `--set key=value` to apply the same values to the helm chart. + >- During upgrade, you must use the Rancher chart repository that you used during initial install (the `latest` repository by default). For more information, see [Server Tags]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/) ## Rolling Back From c7bf9352509322f5a91f08264ace70524ae21cef Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Tue, 16 Oct 2018 19:07:27 -0700 Subject: [PATCH 2/8] updating server tags topic for ha --- .../restorations/ha-restoration/_index.md | 24 +++------- .../en/installation/server-tags/_index.md | 46 +++++++++++++++++-- .../ha-server-upgrade-helm-airgap/_index.md | 6 ++- .../upgrades/ha-server-upgrade-helm/_index.md | 5 +- 4 files changed, 58 insertions(+), 23 deletions(-) diff --git a/content/rancher/v2.x/en/backups/restorations/ha-restoration/_index.md b/content/rancher/v2.x/en/backups/restorations/ha-restoration/_index.md index 221d4d74ff9..0ae9fc9ad89 100644 --- a/content/rancher/v2.x/en/backups/restorations/ha-restoration/_index.md +++ b/content/rancher/v2.x/en/backups/restorations/ha-restoration/_index.md @@ -9,26 +9,16 @@ This procedure describes how to use RKE to restore a snapshot of the Rancher Kub ## Restore Outline -1. [Preparation](#1-preparation) + - Install utilities and create new or clean existing nodes to prepare for restore. -2. [Place Snapshot and PKI Bundle](#2-place-snapshot-and-pki-bundle) - - Pick a node and place snapshot `.db` and `pki.bundle.tar.gz` files. - -3. [Configure RKE](#3-configure-rke) - - Configure RKE `cluster.yml`. Remove `addons:` section and point configuration to the clean nodes. - -4. [Restore Database](#4-restore-database) - - Run RKE command to restore the `etcd` database to a single node. - -5. [Bring Up the Cluster](#5-bring-up-the-cluster) - - Run RKE commands to bring up cluster one a single node. Clean up old nodes. Verify and add additional nodes. +- [1. Preparation](#1-preparation) +- [2. Place Snapshot and PKI Bundle](#2-place-snapshot-and-pki-bundle) +- [3. Configure RKE](#3-configure-rke) +- [4. Restore Database](#4-restore-database) +- [5. Bring Up the Cluster](#5-bring-up-the-cluster) +
### 1. Preparation diff --git a/content/rancher/v2.x/en/installation/server-tags/_index.md b/content/rancher/v2.x/en/installation/server-tags/_index.md index 2dde9a9e39b..19394fb0593 100644 --- a/content/rancher/v2.x/en/installation/server-tags/_index.md +++ b/content/rancher/v2.x/en/installation/server-tags/_index.md @@ -1,13 +1,51 @@ --- -title: Server Tags +title: Choosing a Version of Rancher weight: 230 --- -{{< product >}} Server is distributed as a Docker image, which have _tags_ attached to them. Tags are used to identify what version is included in the image. Rancher includes additional tags that point to a specific version. Remember that if you use the additional tags, you must explicitly pull a new version of that image tag. Otherwise it will use the cached image on the host. +## Single Node Installs + +When performing single-node installs, upgrades, or rollbacks, you can use _tags_ to install a specific version of Rancher. + +### Server Tags + +Rancher Server is distributed as a Docker image, which have tags attached to them. Remember that if you use the additional tags, you must explicitly pull a new version of that image tag. Otherwise it will use the cached image on the host. You can find Rancher images at [DockerHub](https://hub.docker.com/r/rancher/rancher/tags/). -- `rancher/rancher:latest`: Our latest development release. These builds are validated through our CI automation framework. These releases are not recommended for production environments. -- `rancher/rancher:stable`: Our newest stable release. This tag is recommended for production. +| Tag | Description | +| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `rancher/rancher:latest` | Our latest development release. These builds are validated through our CI automation framework. These releases are not recommended for production environments. | +| `rancher/rancher:stable` | Our newest stable release. This tag is recommended for production. | +| `rancher/rancher:` | You can install specific versions of Rancher by using the tag from a previous release. | +
The `master` tag or any tag with a `-rc` or another suffix is meant for the {{< product >}} testing team to validate. You should not use these tags, as these builds are not officially supported. + +## High Availability Installs + +When installing, upgrading, or rolling back Rancher Server in a high availability configuration, you can choose what version of Rancher you want to use. + +The images available for installation are controlled by two factors: + +- The Rancher Helm repository that you configured (or will configure) during initial installation of Rancher Server. +- The `rancherImageTag` option, which you can set from the command line. + +### Rancher Chart Repositories + +In high availability Rancher configurations, Rancher Server is distributed by Helm chart. Therefore, as you prepare to install or upgrade a high availability Rancher configuration, you must configure a chart repository that contains Docker images for Rancher. You can install Rancher from two different repos: + +Repository | Repo Configuration Command | Description +-----------|-----|------------- +`latest` | `helm repo add rancher-latest https://releases.rancher.com/server-charts/latest` | Adds a repository of Helm charts for the latest versions of Rancher. We recommend using this repo. +`stable` | `helm repo add rancher-stable https://releases.rancher.com/server-charts/stable` | Adds a repository of Helm charts for older, stable versions of Rancher. + +>**Important!** +> +>When _upgrading_ or _rolling back_ Rancher in a high availability configuration, you must use the same repository that you used during installation. + +### Chart Option: `rancherImageTag` + +When installing Rancher in a high availability configuration, the latest version is used by default. However, if you want to install specific version of Rancher, you can set the `rancherImageTag` [option]({{< baseurl >}}/rancher/v2.x/en/installation/ha/helm-rancher/chart-options/#advanced-options). This option sets the version of Rancher that's deployed when you install by Helm chart. + +>**Note:** The versions of Rancher available in [chart repository](#rancher-chart-repositories) are different. \ No newline at end of file diff --git a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm-airgap/_index.md b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm-airgap/_index.md index 55021f59cb3..2b5187324ce 100644 --- a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm-airgap/_index.md +++ b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm-airgap/_index.md @@ -45,14 +45,18 @@ rancher-latest/rancher 2018.10.1 v2.1.0 Install Rancher Serve helm repo update ``` -1. Fetch the latest `rancher-latest/rancher` chart. +1. Fetch the latest Rancher Server chart from the helm repository that you used during installation. This will pull down the chart and save it in the current directory as a `.tgz` file. + >**Note:** This command assumes you have the `latest` Rancher helm repo configured. If you initially installed Rancher using the `stable` helm repo, replace `rancher-latest` with `rancher-stable`. For more information, see [Server Tags]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/). + ```plain helm fetch rancher-latest/rancher ``` + + 1. Render the upgrade template. Use the same `--set` values you used for the install. Remember to set the `--is-upgrade` flag for `helm`. This will create a `rancher` directory with the Kubernetes manifest files. diff --git a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md index 2a091738e35..0f1f3696715 100644 --- a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md +++ b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md @@ -46,6 +46,8 @@ Since there are times where the helm chart will require changes without any chan Run `helm search rancher` to view which Rancher version will be launched for the specific helm chart version. + + ``` NAME CHART VERSION APP VERSION DESCRIPTION rancher-latest/rancher 2018.10.1 v2.1.0 Install Rancher Server to manage Kubernetes clusters acro... @@ -78,8 +80,9 @@ rancher-latest/rancher 2018.10.1 v2.1.0 Install Rancher Serve ``` > **Important:** + > >- For any values listed from Step 2, you must use `--set key=value` to apply the same values to the helm chart. - >- During upgrade, you must use the Rancher chart repository that you used during initial install (the `latest` repository by default). For more information, see [Server Tags]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/) + >- During upgrade, you must use the Rancher chart repository that you used during initial install (the `latest` repository by default). For more information, see [Server Tags]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/). ## Rolling Back From 68c0d238a7f60fcb5052f8e9b505ac5dbddfa607 Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Tue, 16 Oct 2018 19:07:27 -0700 Subject: [PATCH 3/8] updating server tags topic for ha --- .../v2.x/en/installation/server-tags/_index.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/content/rancher/v2.x/en/installation/server-tags/_index.md b/content/rancher/v2.x/en/installation/server-tags/_index.md index 19394fb0593..8e06f99cb01 100644 --- a/content/rancher/v2.x/en/installation/server-tags/_index.md +++ b/content/rancher/v2.x/en/installation/server-tags/_index.md @@ -5,7 +5,7 @@ weight: 230 ## Single Node Installs -When performing single-node installs, upgrades, or rollbacks, you can use _tags_ to install a specific version of Rancher. +When performing single-node installs, upgrades, or rollbacks, you can use _tags_ to install a specific version of Rancher. ### Server Tags @@ -17,18 +17,18 @@ You can find Rancher images at [DockerHub](https://hub.docker.com/r/rancher/ranc | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `rancher/rancher:latest` | Our latest development release. These builds are validated through our CI automation framework. These releases are not recommended for production environments. | | `rancher/rancher:stable` | Our newest stable release. This tag is recommended for production. | -| `rancher/rancher:` | You can install specific versions of Rancher by using the tag from a previous release. | +| `rancher/rancher:` | You can install specific versions of Rancher by using the tag from a previous release. See what's available at DockerHub. |
-The `master` tag or any tag with a `-rc` or another suffix is meant for the {{< product >}} testing team to validate. You should not use these tags, as these builds are not officially supported. +>**Note:** The `master` tag or any tag with `-rc` or another suffix is meant for the Rancher testing team to validate. You should not use these tags, as these builds are not officially supported. ## High Availability Installs -When installing, upgrading, or rolling back Rancher Server in a high availability configuration, you can choose what version of Rancher you want to use. +When installing, upgrading, or rolling back Rancher Server in a [high availability configuration]({{< baseurl >}}/rancher/v2.x/en/installation/ha), you can choose what version of Rancher you want to use. The images available for installation are controlled by two factors: -- The Rancher Helm repository that you configured (or will configure) during initial installation of Rancher Server. +- The repository of Helm charts that you will configur (or have configured) during initial installation of Rancher Server. - The `rancherImageTag` option, which you can set from the command line. ### Rancher Chart Repositories @@ -37,8 +37,8 @@ In high availability Rancher configurations, Rancher Server is distributed by He Repository | Repo Configuration Command | Description -----------|-----|------------- -`latest` | `helm repo add rancher-latest https://releases.rancher.com/server-charts/latest` | Adds a repository of Helm charts for the latest versions of Rancher. We recommend using this repo. -`stable` | `helm repo add rancher-stable https://releases.rancher.com/server-charts/stable` | Adds a repository of Helm charts for older, stable versions of Rancher. +`latest` | `helm repo add rancher-latest https://releases.rancher.com/server-charts/latest` | Adds a repository of Helm charts for the latest versions of Rancher. We recommend using this repo for testing out new Rancher builds. +`stable` | `helm repo add rancher-stable https://releases.rancher.com/server-charts/stable` | Adds a repository of Helm charts for older, stable versions of Rancher. We recommend using this repo for production environments. >**Important!** > From 4b43589319482486063cd62b660293716e11ddc2 Mon Sep 17 00:00:00 2001 From: MBishop17 Date: Wed, 17 Oct 2018 14:51:09 -0700 Subject: [PATCH 4/8] updating ha install/upgrade cmds for new latest repo --- .../install-rancher/_index.md | 14 +++++------ .../en/installation/ha/helm-rancher/_index.md | 25 +++++++++++-------- .../en/installation/server-tags/_index.md | 11 ++++---- .../rollbacks/ha-server-rollbacks/_index.md | 2 +- .../ha-server-upgrade-helm-airgap/_index.md | 6 ++--- .../upgrades/ha-server-upgrade-helm/_index.md | 6 +++-- 6 files changed, 35 insertions(+), 29 deletions(-) diff --git a/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md b/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md index 9689a7d9163..81283ffc762 100644 --- a/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md +++ b/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md @@ -80,12 +80,12 @@ Fetch and render the `helm` charts on a system that has internet access. #### Cert-Manager -If you are installing Rancher with Rancher Self-Signed certificates you will need to install 'cert-manager' on your cluster. If you are installing your own certificates you may skip this section. +If you are installing Rancher with Rancher self-signed certificates you will need to install 'cert-manager' on your cluster. If you are installing your own certificates you may skip this section. -Fetch the latest `stable/cert-manager` chart. This will pull down the chart and save it in the current directory as a `.tgz` file. +Fetch the latest `cert-manager` chart from your configured repo, replacing `` with the repo you're using (`latest` or `stable`). For more information on chart repo configuration, see [Choosing a Version of Rancher: Rancher Chart Repositories]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/#rancher-chart-repositories). ```plain -helm fetch stable/cert-manager +helm fetch /cert-manager ``` Render the template with the option you would use to install the chart. Remember to set the `image.repository` option to pull the image from your private registry. This will create a `cert-manager` directory with the Kubernetes manifest files. @@ -98,16 +98,16 @@ helm template ./cert-manager-.tgz --output-dir . \ #### Rancher -Install the Rancher chart repo. +Install the Rancher chart repo. Replace `` with the repository that you're using ('latest' or 'stable'). ```plain -helm repo add rancher-stable https://releases.rancher.com/server-charts/stable +helm repo add rancher- https://releases.rancher.com/server-charts/ ``` -Fetch the latest `rancher-latest/rancher` chart. This will pull down the chart and save it in the current directory as a `.tgz` file. +Fetch the latest Rancher chart. This will pull down the chart and save it in the current directory as a `.tgz` file. Replace `` with the repo you're using (`latest` or `stable`). ```plain -helm fetch rancher-latest/rancher +helm fetch rancher-/rancher ``` Render the template with the options you would use to install the chart. See [Install Rancher]({{< baseurl >}}/rancher/v2.x/en/installation/ha/helm-rancher/) for details on the various options. Remember to set the `rancherImage` option to pull the image from your private registry. This will create a `rancher` directory with the Kubernetes manifest files. diff --git a/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md b/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md index 3d9af17c245..b9a982a5aad 100644 --- a/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md +++ b/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md @@ -9,12 +9,14 @@ Rancher installation is now managed using the Helm package manager for Kubernete ### Add the Chart Repo -Use `helm repo add` to add the Rancher chart repository. +Use `helm repo add` command to add the Rancher chart repository. ->**Note:** We recommend adding the `latest` Rancher chart repository used in the command below, but you also have the option of using our `stable` repository. For more information, see [Server Tags]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/). +Replace `` with the chart repository that you want to use (either `latest` or `stable`). + +>**Note:** For more information about each repository and which is best for your use case, see [Choosing a Version of Rancher: Rancher Chart Repositories]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/#rancher-chart-repositories). ``` -helm repo add rancher-latest https://releases.rancher.com/server-charts/latest +helm repo add rancher- https://releases.rancher.com/server-charts/ ``` @@ -37,10 +39,11 @@ rancher-latest/rancher 2018.10.1 v2.1.0 Install Rancher Serve Rancher relies on [cert-manager](https://github.com/kubernetes/charts/tree/master/stable/cert-manager) from the Kubernetes Helm stable catalog to issue self-signed or LetsEncrypt certificates. -Install `cert-manager` from the Helm stable catalog. +Install `cert-manager` from your Helm catalog. Replace `` with the repository that you configured in [Add the Chart Repo](#add-the-chart-repo) (`latest` or `stable`). + ``` -helm install stable/cert-manager \ +helm install /cert-manager \ --name cert-manager \ --namespace kube-system ``` @@ -61,12 +64,12 @@ There are three options for the source of the certificate. The default is for Rancher to generate a CA and use the `cert-manager` to issue the certificate for access to the Rancher server interface. -The only requirement is to set the `hostname` to the DNS name you pointed at your load balancer. +The only requirement is to set the `hostname` to the DNS name you pointed at your load balancer. Replace `` with the repository that you configured in [Add the Chart Repo](#add-the-chart-repo) (`latest` or `stable`). >**Using Air Gap?** [Set the `rancherImage` option]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/install-rancher/#install-rancher-using-private-registry) in your command, pointing toward your private registry. ``` -helm install rancher-latest/rancher \ +helm install rancher-/rancher \ --name rancher \ --namespace cattle-system \ --set hostname=rancher.my.org @@ -76,12 +79,12 @@ helm install rancher-latest/rancher \ Use [LetsEncrypt](https://letsencrypt.org/)'s free service to issue trusted SSL certs. This configuration uses http validation so the Load Balancer must have a Public DNS record and be accessible from the internet. -Set `hostname`, `ingress.tls.source=letsEncrypt` and LetsEncrypt options. +Set `hostname`, `ingress.tls.source=letsEncrypt` and LetsEncrypt options. Replace `` with the repository that you configured in [Add the Chart Repo](#add-the-chart-repo) (`latest` or `stable`). >**Using Air Gap?** [Set the `rancherImage` option]({{< baseurl >}}/rancher/v2.x/en/installation/air-gap-installation/install-rancher/#install-rancher-using-private-registry) in your command, pointing toward your private registry. ``` -helm install rancher-latest/rancher \ +helm install rancher-/rancher \ --name rancher \ --namespace cattle-system \ --set hostname=rancher.my.org \ @@ -95,12 +98,12 @@ Create Kubernetes secrets from your own certificates for Rancher to use. > **Note:** The common name for the cert will need to match the `hostname` option or the ingress controller will fail to provision the site for Rancher. -Set `hostname` and `ingress.tls.source=secret`. +Set `hostname` and `ingress.tls.source=secret`. Replace `` with the repository that you configured in [Add the Chart Repo](#add-the-chart-repo) (`latest` or `stable`). > **Note:** If you are using a Private CA signed cert, add `--set privateCA=true` ``` -helm install rancher-latest/rancher \ +helm install rancher-/rancher \ --name rancher \ --namespace cattle-system \ --set hostname=rancher.my.org \ diff --git a/content/rancher/v2.x/en/installation/server-tags/_index.md b/content/rancher/v2.x/en/installation/server-tags/_index.md index 8e06f99cb01..c46f16e76c6 100644 --- a/content/rancher/v2.x/en/installation/server-tags/_index.md +++ b/content/rancher/v2.x/en/installation/server-tags/_index.md @@ -5,13 +5,11 @@ weight: 230 ## Single Node Installs -When performing single-node installs, upgrades, or rollbacks, you can use _tags_ to install a specific version of Rancher. +When performing [single-node installs]({{< baseurl >}}/rancher/v2.x/en/installation/single-node), upgrades, or rollbacks, you can use _tags_ to install a specific version of Rancher. ### Server Tags -Rancher Server is distributed as a Docker image, which have tags attached to them. Remember that if you use the additional tags, you must explicitly pull a new version of that image tag. Otherwise it will use the cached image on the host. -You can find Rancher images at [DockerHub](https://hub.docker.com/r/rancher/rancher/tags/). - +Rancher Server is distributed as a Docker image, which have tags attached to them. You can specify this tag when entering the command to deploy Rancher. Remember that if you use a tag without an explicit version (like `latest` or `stable`), you must explicitly pull a new version of that image tag. Otherwise any image cached on the host will be used. | Tag | Description | | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -20,6 +18,7 @@ You can find Rancher images at [DockerHub](https://hub.docker.com/r/rancher/ranc | `rancher/rancher:` | You can install specific versions of Rancher by using the tag from a previous release. See what's available at DockerHub. |
+ >**Note:** The `master` tag or any tag with `-rc` or another suffix is meant for the Rancher testing team to validate. You should not use these tags, as these builds are not officially supported. ## High Availability Installs @@ -28,7 +27,7 @@ When installing, upgrading, or rolling back Rancher Server in a [high availabili The images available for installation are controlled by two factors: -- The repository of Helm charts that you will configur (or have configured) during initial installation of Rancher Server. +- The repository of Helm charts that you will configure (or have configured) during initial installation of Rancher Server. - The `rancherImageTag` option, which you can set from the command line. ### Rancher Chart Repositories @@ -39,6 +38,8 @@ Repository | Repo Configuration Command | Description -----------|-----|------------- `latest` | `helm repo add rancher-latest https://releases.rancher.com/server-charts/latest` | Adds a repository of Helm charts for the latest versions of Rancher. We recommend using this repo for testing out new Rancher builds. `stable` | `helm repo add rancher-stable https://releases.rancher.com/server-charts/stable` | Adds a repository of Helm charts for older, stable versions of Rancher. We recommend using this repo for production environments. +
+Instructions on when to make these configurations are available in [High Availability Install]({{< baseurl >}}/rancher/v2.x/en/installation/ha). >**Important!** > diff --git a/content/rancher/v2.x/en/upgrades/rollbacks/ha-server-rollbacks/_index.md b/content/rancher/v2.x/en/upgrades/rollbacks/ha-server-rollbacks/_index.md index 1a8cd596d01..04e1b27935d 100644 --- a/content/rancher/v2.x/en/upgrades/rollbacks/ha-server-rollbacks/_index.md +++ b/content/rancher/v2.x/en/upgrades/rollbacks/ha-server-rollbacks/_index.md @@ -12,4 +12,4 @@ To restore Rancher follow the procedure detailed here: [Restoring Backups — Hi Restoring a snapshot of the Rancher Server cluster will revert Rancher to the version and state at the time of the snapshot. -> **Note:** Managed cluster are authoritative for their state. This means restoring the rancher server will not revert workload deployments or changes made on managed clusters after the snapshot was taken. +>**Note:** Managed cluster are authoritative for their state. This means restoring the rancher server will not revert workload deployments or changes made on managed clusters after the snapshot was taken. diff --git a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm-airgap/_index.md b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm-airgap/_index.md index 2b5187324ce..708862ae83c 100644 --- a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm-airgap/_index.md +++ b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm-airgap/_index.md @@ -47,12 +47,12 @@ rancher-latest/rancher 2018.10.1 v2.1.0 Install Rancher Serve 1. Fetch the latest Rancher Server chart from the helm repository that you used during installation. - This will pull down the chart and save it in the current directory as a `.tgz` file. + This command will pull down the chart and save it in the current directory as a `.tgz` file. Replace `` with the name of the repository that you used during installation (either `stable` or `latest`). - >**Note:** This command assumes you have the `latest` Rancher helm repo configured. If you initially installed Rancher using the `stable` helm repo, replace `rancher-latest` with `rancher-stable`. For more information, see [Server Tags]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/). + >**Note:** During upgrades, you must fetch from the chart repo that you configured initial installation (either the `stable` or `latest` repository). For more information, see [Choosing a Version of Rancher: Rancher Chart Repositories]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/#rancher-chart-repositories). ```plain - helm fetch rancher-latest/rancher + helm fetch rancher-/rancher ``` diff --git a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md index 0f1f3696715..35ce584dbd5 100644 --- a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md +++ b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md @@ -75,14 +75,16 @@ rancher-latest/rancher 2018.10.1 v2.1.0 Install Rancher Serve 3. Take all values from the previous command and use `helm` with `--set` options to upgrade Rancher to the latest version. + Replace `` with the name of the repository that you used during installation (either `stable` or `latest`). + ``` - helm upgrade rancher rancher-latest/rancher --set hostname=rancher.my.org + helm upgrade rancher rancher-/rancher --set hostname=rancher.my.org ``` > **Important:** > >- For any values listed from Step 2, you must use `--set key=value` to apply the same values to the helm chart. - >- During upgrade, you must use the Rancher chart repository that you used during initial install (the `latest` repository by default). For more information, see [Server Tags]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/). + >- During upgrade, you must use the Rancher chart repository that you used during initial install (either the `stable` or `latest` repository). For more information, see [Choosing a Version of Rancher: Rancher Chart Repositories]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/#rancher-chart-repositories). ## Rolling Back From 4911d6066d68c038d7ac5b17e3a1c419652ffd57 Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Wed, 17 Oct 2018 16:51:01 -0700 Subject: [PATCH 5/8] fixing fetch instructions for cert manager --- .../air-gap-installation/install-rancher/_index.md | 4 ++-- .../rancher/v2.x/en/installation/ha/helm-rancher/_index.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md b/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md index 81283ffc762..0808d5a3988 100644 --- a/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md +++ b/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md @@ -82,10 +82,10 @@ Fetch and render the `helm` charts on a system that has internet access. If you are installing Rancher with Rancher self-signed certificates you will need to install 'cert-manager' on your cluster. If you are installing your own certificates you may skip this section. -Fetch the latest `cert-manager` chart from your configured repo, replacing `` with the repo you're using (`latest` or `stable`). For more information on chart repo configuration, see [Choosing a Version of Rancher: Rancher Chart Repositories]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/#rancher-chart-repositories). +Fetch the latest `cert-manager` chart from your Helm catalog. ```plain -helm fetch /cert-manager +helm fetch stable/cert-manager ``` Render the template with the option you would use to install the chart. Remember to set the `image.repository` option to pull the image from your private registry. This will create a `cert-manager` directory with the Kubernetes manifest files. diff --git a/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md b/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md index b9a982a5aad..9a2b7830a7d 100644 --- a/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md +++ b/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md @@ -39,11 +39,11 @@ rancher-latest/rancher 2018.10.1 v2.1.0 Install Rancher Serve Rancher relies on [cert-manager](https://github.com/kubernetes/charts/tree/master/stable/cert-manager) from the Kubernetes Helm stable catalog to issue self-signed or LetsEncrypt certificates. -Install `cert-manager` from your Helm catalog. Replace `` with the repository that you configured in [Add the Chart Repo](#add-the-chart-repo) (`latest` or `stable`). +Install `cert-manager` from your Helm catalog. ``` -helm install /cert-manager \ +helm install stable/cert-manager \ --name cert-manager \ --namespace kube-system ``` From 5a5ed49bc0104d067917ddc81c0ddc73fda5f51a Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Thu, 18 Oct 2018 11:49:50 -0700 Subject: [PATCH 6/8] updates per Denise --- .../air-gap-installation/install-rancher/_index.md | 4 ++-- .../rancher/v2.x/en/installation/ha/helm-rancher/_index.md | 2 +- content/rancher/v2.x/en/installation/server-tags/_index.md | 2 +- .../en/upgrades/upgrades/ha-server-upgrade-helm/_index.md | 5 +---- 4 files changed, 5 insertions(+), 8 deletions(-) diff --git a/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md b/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md index 0808d5a3988..31115d326cf 100644 --- a/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md +++ b/content/rancher/v2.x/en/installation/air-gap-installation/install-rancher/_index.md @@ -82,7 +82,7 @@ Fetch and render the `helm` charts on a system that has internet access. If you are installing Rancher with Rancher self-signed certificates you will need to install 'cert-manager' on your cluster. If you are installing your own certificates you may skip this section. -Fetch the latest `cert-manager` chart from your Helm catalog. +Fetch the latest `cert-manager` chart from the [official Helm catalog](https://github.com/helm/charts/tree/master/stable). ```plain helm fetch stable/cert-manager @@ -98,7 +98,7 @@ helm template ./cert-manager-.tgz --output-dir . \ #### Rancher -Install the Rancher chart repo. Replace `` with the repository that you're using ('latest' or 'stable'). +Install the Rancher chart repo. Replace `` with the [repository that you're using]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/#rancher-chart-repositories) ('latest' or 'stable'). ```plain helm repo add rancher- https://releases.rancher.com/server-charts/ diff --git a/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md b/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md index 9a2b7830a7d..b5a65209d2d 100644 --- a/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md +++ b/content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md @@ -39,7 +39,7 @@ rancher-latest/rancher 2018.10.1 v2.1.0 Install Rancher Serve Rancher relies on [cert-manager](https://github.com/kubernetes/charts/tree/master/stable/cert-manager) from the Kubernetes Helm stable catalog to issue self-signed or LetsEncrypt certificates. -Install `cert-manager` from your Helm catalog. +Install `cert-manager` from the [official Helm catalog](https://github.com/helm/charts/tree/master/stable). ``` diff --git a/content/rancher/v2.x/en/installation/server-tags/_index.md b/content/rancher/v2.x/en/installation/server-tags/_index.md index c46f16e76c6..0dff0b3d694 100644 --- a/content/rancher/v2.x/en/installation/server-tags/_index.md +++ b/content/rancher/v2.x/en/installation/server-tags/_index.md @@ -49,4 +49,4 @@ Instructions on when to make these configurations are available in [High Availab When installing Rancher in a high availability configuration, the latest version is used by default. However, if you want to install specific version of Rancher, you can set the `rancherImageTag` [option]({{< baseurl >}}/rancher/v2.x/en/installation/ha/helm-rancher/chart-options/#advanced-options). This option sets the version of Rancher that's deployed when you install by Helm chart. ->**Note:** The versions of Rancher available in [chart repository](#rancher-chart-repositories) are different. \ No newline at end of file +>**Note:** When using this option, you should avoid installing older versions of Rancher using newer Helm charts. \ No newline at end of file diff --git a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md index 35ce584dbd5..9a81b95187e 100644 --- a/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md +++ b/content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md @@ -81,10 +81,7 @@ rancher-latest/rancher 2018.10.1 v2.1.0 Install Rancher Serve helm upgrade rancher rancher-/rancher --set hostname=rancher.my.org ``` - > **Important:** - > - >- For any values listed from Step 2, you must use `--set key=value` to apply the same values to the helm chart. - >- During upgrade, you must use the Rancher chart repository that you used during initial install (either the `stable` or `latest` repository). For more information, see [Choosing a Version of Rancher: Rancher Chart Repositories]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/#rancher-chart-repositories). + > **Important:** For any values listed from Step 2, you must use `--set key=value` to apply the same values to the helm chart. ## Rolling Back From 6ab685d918a340141cbdc3f5e3b03b66de2339cf Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Thu, 18 Oct 2018 12:50:33 -0700 Subject: [PATCH 7/8] removing image tag section, adding repo options to chart-option section --- .../ha/helm-rancher/chart-options/_index.md | 11 +++++++++++ .../v2.x/en/installation/server-tags/_index.md | 13 +------------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/content/rancher/v2.x/en/installation/ha/helm-rancher/chart-options/_index.md b/content/rancher/v2.x/en/installation/ha/helm-rancher/chart-options/_index.md index d94356b3115..bde16f2f6f9 100644 --- a/content/rancher/v2.x/en/installation/ha/helm-rancher/chart-options/_index.md +++ b/content/rancher/v2.x/en/installation/ha/helm-rancher/chart-options/_index.md @@ -37,6 +37,17 @@ weight: 276
+### Available Chart Repositories + +When installing or upgrading Rancher, you can pull one of two repositories: the `latest` Rancher chart repo or the `stable` chart repo. You can switch between these two repos by entering one of the following commands in the table below. Enter the command for the repository that you want to use _before_ installation or upgrade. + + +Repository | Repo Configuration Command | Description +-----------|-----|------------- +`latest` | `helm repo add rancher-latest https://releases.rancher.com/server-charts/latest` | Adds a repository of Helm charts for the latest versions of Rancher. We recommend using this repo for testing out new Rancher builds. +`stable` | `helm repo add rancher-stable https://releases.rancher.com/server-charts/stable` | Adds a repository of Helm charts for older, stable versions of Rancher. We recommend using this repo for production environments. + + ### API Audit Log Enabling the [API Audit Log](https://rancher.com/docs/rancher/v2.x/en/installation/api-auditing/). diff --git a/content/rancher/v2.x/en/installation/server-tags/_index.md b/content/rancher/v2.x/en/installation/server-tags/_index.md index 0dff0b3d694..1696ac5c70d 100644 --- a/content/rancher/v2.x/en/installation/server-tags/_index.md +++ b/content/rancher/v2.x/en/installation/server-tags/_index.md @@ -23,12 +23,7 @@ Rancher Server is distributed as a Docker image, which have tags attached to the ## High Availability Installs -When installing, upgrading, or rolling back Rancher Server in a [high availability configuration]({{< baseurl >}}/rancher/v2.x/en/installation/ha), you can choose what version of Rancher you want to use. - -The images available for installation are controlled by two factors: - -- The repository of Helm charts that you will configure (or have configured) during initial installation of Rancher Server. -- The `rancherImageTag` option, which you can set from the command line. +When installing, upgrading, or rolling back Rancher Server in a [high availability configuration]({{< baseurl >}}/rancher/v2.x/en/installation/ha), you can choose what repository from which to pull your Rancher images. ### Rancher Chart Repositories @@ -44,9 +39,3 @@ Instructions on when to make these configurations are available in [High Availab >**Important!** > >When _upgrading_ or _rolling back_ Rancher in a high availability configuration, you must use the same repository that you used during installation. - -### Chart Option: `rancherImageTag` - -When installing Rancher in a high availability configuration, the latest version is used by default. However, if you want to install specific version of Rancher, you can set the `rancherImageTag` [option]({{< baseurl >}}/rancher/v2.x/en/installation/ha/helm-rancher/chart-options/#advanced-options). This option sets the version of Rancher that's deployed when you install by Helm chart. - ->**Note:** When using this option, you should avoid installing older versions of Rancher using newer Helm charts. \ No newline at end of file From f650d0c8df2b420a6c0191db7ceb043f73a70724 Mon Sep 17 00:00:00 2001 From: Mark Bishop Date: Thu, 18 Oct 2018 13:00:43 -0700 Subject: [PATCH 8/8] removing repos from chart options --- .../ha/helm-rancher/chart-options/_index.md | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/content/rancher/v2.x/en/installation/ha/helm-rancher/chart-options/_index.md b/content/rancher/v2.x/en/installation/ha/helm-rancher/chart-options/_index.md index bde16f2f6f9..d94356b3115 100644 --- a/content/rancher/v2.x/en/installation/ha/helm-rancher/chart-options/_index.md +++ b/content/rancher/v2.x/en/installation/ha/helm-rancher/chart-options/_index.md @@ -37,17 +37,6 @@ weight: 276
-### Available Chart Repositories - -When installing or upgrading Rancher, you can pull one of two repositories: the `latest` Rancher chart repo or the `stable` chart repo. You can switch between these two repos by entering one of the following commands in the table below. Enter the command for the repository that you want to use _before_ installation or upgrade. - - -Repository | Repo Configuration Command | Description ------------|-----|------------- -`latest` | `helm repo add rancher-latest https://releases.rancher.com/server-charts/latest` | Adds a repository of Helm charts for the latest versions of Rancher. We recommend using this repo for testing out new Rancher builds. -`stable` | `helm repo add rancher-stable https://releases.rancher.com/server-charts/stable` | Adds a repository of Helm charts for older, stable versions of Rancher. We recommend using this repo for production environments. - - ### API Audit Log Enabling the [API Audit Log](https://rancher.com/docs/rancher/v2.x/en/installation/api-auditing/).