From 4b43589319482486063cd62b660293716e11ddc2 Mon Sep 17 00:00:00 2001 From: MBishop17 Date: Wed, 17 Oct 2018 14:51:09 -0700 Subject: [PATCH] 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