From ab8ce0fb261336e1d32dcf3cee4de0bc0da1b6a4 Mon Sep 17 00:00:00 2001 From: MBishop17 Date: Wed, 5 Dec 2018 15:02:59 -0800 Subject: [PATCH 1/4] made text easier to understand, corrected broken link --- .../v2.x/en/installation/server-tags/_index.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 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 589c3844a80..785268f2f91 100644 --- a/content/rancher/v2.x/en/installation/server-tags/_index.md +++ b/content/rancher/v2.x/en/installation/server-tags/_index.md @@ -27,15 +27,21 @@ When installing, upgrading, or rolling back Rancher Server in a [high availabili ### Helm Chart Repositories -Rancher provides two different Helm chart repositories to choose from. We align our latest and stable Helm chart repositories with the Docker tags that are used for a single node installation. Therefore, the `rancher-latest` repository will contain charts for all the Rancher versions that have been tagged as `rancher/rancher:latest`. When a Rancher version has been promoted to the `rancher/rancher:stable`, it will get added to the `rancher-stable` repository. +Rancher provides two different Helm chart repositories to choose from. +We align our latest and stable Helm chart repositories with the Docker tags that are used for a single node installation. +Therefore, the `rancher-latest` repository will contain charts for all the Rancher versions that have been tagged as `rancher/rancher:latest`. +When a Rancher version has been promoted to the `rancher/rancher:stable`, it will get added to the `rancher-stable` repository. + +Each Helm chart repository is named for the labels attached to each Rancher image. In other words, the `rancher-latest` repository contains charts labeled as `rancher/rancher:latest`, the `rancher-stable` repository +contains charts labeled `rancher/rancher:stable`, etc.) Type | Command to Add the Repo | Description of the Repo -----------|-----|------------- 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. rancher-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 select these repos are available in [High Availability Install]({{< baseurl >}}/rancher/v2.x/en/installation/ha). +Instructions on when to select these repos are available below in [Switching to a Different Helm Chart Repository](#switching-to-a-different-helm-chart-repository). > **Note:** The introduction of the `rancher-latest` and `rancher-stable` Helm Chart repositories was introduced after Rancher v2.1.0, so the `rancher-stable` repository contains some Rancher versions that were never marked as `rancher/rancher:stable`. The versions of Rancher that were tagged as `rancher/rancher:stable` prior to v2.1.0 are v2.0.4, v2.0.6, v2.0.8. Post v2.1.0, all charts in the `rancher-stable` repository will correspond with any Rancher version tagged as `stable`. @@ -52,7 +58,7 @@ NAME CHART VERSION APP VERSION DESCRIPTION rancher-latest/rancher 2018.10.1 v2.1.0 Install Rancher Server to manage Kubernetes clusters acro... ``` -### Switching to a different Helm Chart Repository +### Switching to a Different Helm Chart Repository After installing Rancher, if you want to change which Helm chart repository to install Rancher from, you will need to follow these steps. From 65e6c88f2a8a0fe0f51726972c935ef604446cfb Mon Sep 17 00:00:00 2001 From: MBishop17 Date: Wed, 5 Dec 2018 15:08:39 -0800 Subject: [PATCH 2/4] fixed inconsistent titles --- content/rancher/v2.x/en/installation/ha/_index.md | 8 ++++---- .../v2.x/en/installation/ha/create-nodes-lb/_index.md | 4 ++-- .../rancher/v2.x/en/installation/ha/helm-init/_index.md | 2 +- .../v2.x/en/installation/ha/helm-rancher/_index.md | 2 +- .../v2.x/en/installation/ha/kubernetes-rke/_index.md | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/content/rancher/v2.x/en/installation/ha/_index.md b/content/rancher/v2.x/en/installation/ha/_index.md index 9bfb6cb8e56..b1948da6086 100644 --- a/content/rancher/v2.x/en/installation/ha/_index.md +++ b/content/rancher/v2.x/en/installation/ha/_index.md @@ -30,10 +30,10 @@ The following CLI tools are required for this install. Please make sure these to ## Installation Outline -1. [Create Nodes and Load Balancer]({{< baseurl >}}/rancher/v2.x/en/installation/ha/create-nodes-lb/) -1. [Install Kubernetes with RKE]({{< baseurl >}}/rancher/v2.x/en/installation/ha/kubernetes-rke/) -1. [Initialize Helm (tiller)]({{< baseurl >}}/rancher/v2.x/en/installation/ha/helm-init/) -1. [Install Rancher]({{< baseurl >}}/rancher/v2.x/en/installation/ha/helm-rancher/) +- [Create Nodes and Load Balancer]({{< baseurl >}}/rancher/v2.x/en/installation/ha/create-nodes-lb/) +- [Install Kubernetes with RKE]({{< baseurl >}}/rancher/v2.x/en/installation/ha/kubernetes-rke/) +- [Initialize Helm (tiller)]({{< baseurl >}}/rancher/v2.x/en/installation/ha/helm-init/) +- [Install Rancher]({{< baseurl >}}/rancher/v2.x/en/installation/ha/helm-rancher/) ## Additional Install Options diff --git a/content/rancher/v2.x/en/installation/ha/create-nodes-lb/_index.md b/content/rancher/v2.x/en/installation/ha/create-nodes-lb/_index.md index c9d51f538d3..fe1fc598302 100644 --- a/content/rancher/v2.x/en/installation/ha/create-nodes-lb/_index.md +++ b/content/rancher/v2.x/en/installation/ha/create-nodes-lb/_index.md @@ -1,5 +1,5 @@ --- -title: 1—Create Nodes and Load Balancer +title: "1. Create Nodes and Load Balancer" weight: 185 --- @@ -21,7 +21,7 @@ Configure a load balancer as a basic Layer 4 TCP forwarder. The exact configurat #### Examples -* [NGINX]({{< baseurl >}}/rancher/v2.x/en/installation/ha/create-nodes-lb/nginx/) +* [Nginx]({{< baseurl >}}/rancher/v2.x/en/installation/ha/create-nodes-lb/nginx/) * [Amazon NLB]({{< baseurl >}}/rancher/v2.x/en/installation/ha/create-nodes-lb/nlb/) ### [Next: Install Kubernetes with RKE]({{< baseurl >}}/rancher/v2.x/en/installation/ha/kubernetes-rke/) diff --git a/content/rancher/v2.x/en/installation/ha/helm-init/_index.md b/content/rancher/v2.x/en/installation/ha/helm-init/_index.md index 8ecf3f686d5..1eea31c0f40 100644 --- a/content/rancher/v2.x/en/installation/ha/helm-init/_index.md +++ b/content/rancher/v2.x/en/installation/ha/helm-init/_index.md @@ -1,5 +1,5 @@ --- -title: 3 - Initialize Helm (Install tiller) +title: "3. Initialize Helm (Install Tiller)" weight: 195 --- 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 6e7646069f4..261529b24e4 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 @@ -1,5 +1,5 @@ --- -title: 4 - Install Rancher +title: "4. Install Rancher" weight: 200 --- diff --git a/content/rancher/v2.x/en/installation/ha/kubernetes-rke/_index.md b/content/rancher/v2.x/en/installation/ha/kubernetes-rke/_index.md index b6bff6add8d..53173622670 100644 --- a/content/rancher/v2.x/en/installation/ha/kubernetes-rke/_index.md +++ b/content/rancher/v2.x/en/installation/ha/kubernetes-rke/_index.md @@ -1,5 +1,5 @@ --- -title: 2—Install Kubernetes with RKE +title: "2. Install Kubernetes with RKE" weight: 190 --- From 2b53af8d26bc42ba55766d20f5a1a80de5a024a1 Mon Sep 17 00:00:00 2001 From: MBishop17 Date: Wed, 5 Dec 2018 15:24:57 -0800 Subject: [PATCH 3/4] minor fixes --- content/rancher/v2.x/en/installation/ha/_index.md | 5 +++-- .../upgrades/ha-server-upgrade-helm-airgap/_index.md | 5 ++++- .../en/upgrades/upgrades/ha-server-upgrade-helm/_index.md | 4 +++- 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/content/rancher/v2.x/en/installation/ha/_index.md b/content/rancher/v2.x/en/installation/ha/_index.md index b1948da6086..e1cd38a4014 100644 --- a/content/rancher/v2.x/en/installation/ha/_index.md +++ b/content/rancher/v2.x/en/installation/ha/_index.md @@ -41,10 +41,11 @@ The following CLI tools are required for this install. Please make sure these to ## Previous Methods -> #### **Important: RKE add-on install is only supported up to Rancher v2.0.8** +[RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/installation/ha/rke-add-on/) + +> ##### **Important: RKE add-on install is only supported up to Rancher v2.0.8** > >Please use the Rancher helm chart to install HA Rancher. For details, see the [HA Install - Installation Outline]({{< baseurl >}}/rancher/v2.x/en/installation/ha/#installation-outline). > >If you are currently using the RKE add-on install method, see [Migrating from an HA RKE Add-on Install]({{< baseurl >}}/rancher/v2.x/en/upgrades/upgrades/migrating-from-rke-add-on/) for details on how to move to using the helm chart. -* [RKE add-on install]({{< baseurl >}}/rancher/v2.x/en/installation/ha/rke-add-on/) 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 3d7d0c93e50..40e061d4d07 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 @@ -35,7 +35,10 @@ The following instructions will guide you through upgrading a high-availability helm repo update ``` -2. Get the [repository name that you installed Rancher]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/#helm-chart-repositories) with. + +2. Get the repository name that you used to install Rancher. + + For information about the repos and their differences, see [Helm Chart Repositories]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/#helm-chart-repositories). ``` helm repo list 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 0bcb9627e52..27df9bd9c4d 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 @@ -47,7 +47,9 @@ The following instructions will guide you through upgrading a high-availability helm repo update ``` -2. Get the [repository name that you installed Rancher]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/#helm-chart-repositories) with. +2. Get the repository name that you used to install Rancher. + + For information about the repos and their differences, see [Helm Chart Repositories]({{< baseurl >}}/rancher/v2.x/en/installation/server-tags/#helm-chart-repositories). ``` helm repo list From 833ff311b5728c1a3e4d61113390419c4643516f Mon Sep 17 00:00:00 2001 From: MBishop17 Date: Wed, 5 Dec 2018 14:25:52 -0800 Subject: [PATCH 4/4] made table easier to understand --- .../rancher/v2.x/en/catalog/custom/_index.md | 65 ++++--------------- 1 file changed, 14 insertions(+), 51 deletions(-) diff --git a/content/rancher/v2.x/en/catalog/custom/_index.md b/content/rancher/v2.x/en/catalog/custom/_index.md index f438ba9a0df..b553ec9d658 100644 --- a/content/rancher/v2.x/en/catalog/custom/_index.md +++ b/content/rancher/v2.x/en/catalog/custom/_index.md @@ -37,56 +37,19 @@ Rancher supports two different types of charts: ## Chart Directory Structure -The following table demonstrates the directory structure for a chart, which can be found in a chart directory: `charts/%application%/%app version%/`. This information is helpful when customizing charts for a custom catalog. Files denoted with **Rancher Specific** are specific to Rancher charts, but are optional for chart customization. +The following table demonstrates the directory structure for a chart, which can be found in a chart directory: `charts///`. This information is helpful when customizing charts for a custom catalog. Files denoted with **Rancher Specific** are specific to Rancher charts, but are optional for chart customization. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Sub-Directory FileDescription
app-readme.md Rancher Specific: Text displayed in the charts header within the Rancher UI.
charts/Directory containing dependency charts.
Chart.ymlRequired Helm chart information file.
questions.ymlRancher Specific: File containing form questions displayed within the Rancher UI. Questions display in Configuration Options.
README.mdOptional: Helm Readme file displayed within Rancher UI. This text displays in Detailed Descriptions.
requirements.ymlOptional YAML file listing dependencies for the chart.
templates/A directory of templates that, when combined with values.yml, generates Kubernetes YAML.
values.ymlThe default configuration values for the chart.
+``` +charts/// +|--charts/ # Directory containing dependency charts. +|--templates/ # Directory containing templates that, when combined with values.yml, generates Kubernetes YAML. +|--app-readme.md # Text displayed in the charts header within the Rancher UI.* +|--Chart.yml # Required Helm chart information file. +|--questions.yml # Form questions displayed within the Rancher UI. Questions display in Configuration Options.* +|--README.md # Optional: Helm Readme file displayed within Rancher UI. This text displays in Detailed Descriptions. +|--requirements.yml # Optional: YAML file listing dependencies for the chart. +|--values.yml # Default configuration values for the chart. +``` ## Rancher Chart Additional Files @@ -96,7 +59,7 @@ Before you create your own custom catalog, you should have a basic understanding A file that provides descriptive text in the chart's UI header. The following image displays the difference between a Rancher chart (which includes `app-readme.md`) and a native Helm chart (which does not). - Rancher Chart with app-readme.md (left) vs. Helm Chart without (right) +
Rancher Chart with app-readme.md (left) vs. Helm Chart without (right)
![app-readme.md]({{< baseurl >}}/img/rancher/app-readme.png) @@ -105,7 +68,7 @@ Before you create your own custom catalog, you should have a basic understanding A file that contains questions for a form. These form questions simplify deployment of a chart. Without it, you must configure the deployment using key value pairs, which is more difficult. The following image displays the difference between a Rancher chart (which includes `questions.yml`) and a native Helm chart (which does not). - Rancher Chart with questions.yml (left) vs. Helm Chart without (right) +
Rancher Chart with questions.yml (left) vs. Helm Chart without (right)
![questions.yml]({{< baseurl >}}/img/rancher/questions.png)