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

Merge pull request #1046 from rancher/staging

Browse Source 
small fixes around helm
This commit is contained in:
Denise
2018-12-05 17:49:33 -08:00
committed by GitHub
parent 77542a9bda facf8ceecd
commit 20359b790e
9 changed files with 42 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/rancher/v2.x/en/catalog/custom/_index.md
+14 -51
View File
@@ -37,56 +37,19 @@ Rancher supports two different types of charts:
## Chart Directory Structure ## 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/<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.
<table> ```
<tbody> charts/<APPLICATION>/<APP_VERSION>/
<tr> |--charts/ # Directory containing dependency charts.
<td>Sub-Directory </td> |--templates/ # Directory containing templates that, when combined with values.yml, generates Kubernetes YAML.
<td>File</td> |--app-readme.md # Text displayed in the charts header within the Rancher UI.*
<td>Description</td> |--Chart.yml # Required Helm chart information file.
</tr> |--questions.yml # Form questions displayed within the Rancher UI. Questions display in Configuration Options.*
<tr> |--README.md # Optional: Helm Readme file displayed within Rancher UI. This text displays in Detailed Descriptions.
<td> </td> |--requirements.yml # Optional: YAML file listing dependencies for the chart.
<td> <code>app-readme.md</code></td> |--values.yml # Default configuration values for the chart.
<td> <strong>Rancher Specific:</strong> Text displayed in the charts header within the Rancher UI.</td> ```
</tr>
<tr>
<td><code>charts/</code></td>
<td></td>
<td>Directory containing dependency charts.</td>
</tr>
<tr>
<td> </td>
<td><code>Chart.yml</code></td>
<td>Required Helm chart information file.</td>
</tr>
<tr>
<td> </td>
<td><code>questions.yml</code></td>
<td><strong>Rancher Specific:</strong> File containing form questions displayed within the Rancher UI. Questions display in <strong>Configuration Options</strong>.</td>
</tr>
<tr>
<td> </td>
<td><code>README.md</code></td>
<td>Optional: Helm Readme file displayed within Rancher UI. This text displays in <strong>Detailed Descriptions</strong>.</td>
</tr>
<td></td>
<td><code>requirements.yml</code></td>
<td>Optional YAML file listing dependencies for the chart.</td>
</tr>
<tr>
<td><code>templates/</code></td>
<td></td>
<td>A directory of templates that, when combined with <code>values.yml</code>, generates Kubernetes YAML.</td>
</tr>
<tr>
<td> </td>
<td><code>values.yml</code></td>
<td>The default configuration values for the chart.</td>
</tr>
</tbody>
</table>
## Rancher Chart Additional Files ## 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). 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).
<small>Rancher Chart with <code>app-readme.md</code> (left) vs. Helm Chart without (right)</small> <figcaption>Rancher Chart with <code>app-readme.md</code> (left) vs. Helm Chart without (right)</figcaption>
![app-readme.md]({{< baseurl >}}/img/rancher/app-readme.png) ![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). 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).
<small>Rancher Chart with <code>questions.yml</code> (left) vs. Helm Chart without (right)</small> <figcaption>Rancher Chart with <code>questions.yml</code> (left) vs. Helm Chart without (right)</figcaption>
![questions.yml]({{< baseurl >}}/img/rancher/questions.png) ![questions.yml]({{< baseurl >}}/img/rancher/questions.png)
content/rancher/v2.x/en/installation/ha/_index.md
+7 -6
View File
@@ -30,10 +30,10 @@ The following CLI tools are required for this install. Please make sure these to
## Installation Outline ## Installation Outline
1. [Create Nodes and Load Balancer]({{< baseurl >}}/rancher/v2.x/en/installation/ha/create-nodes-lb/) - [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/) - [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/) - [Initialize Helm (tiller)]({{< baseurl >}}/rancher/v2.x/en/installation/ha/helm-init/)
1. [Install Rancher]({{< baseurl >}}/rancher/v2.x/en/installation/ha/helm-rancher/) - [Install Rancher]({{< baseurl >}}/rancher/v2.x/en/installation/ha/helm-rancher/)
## Additional Install Options ## Additional Install Options
@@ -41,10 +41,11 @@ The following CLI tools are required for this install. Please make sure these to
## Previous Methods ## 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). >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. >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/)
content/rancher/v2.x/en/installation/ha/create-nodes-lb/_index.md
+2 -2
View File
@@ -1,5 +1,5 @@
--- ---
title: 1—Create Nodes and Load Balancer title: "1. Create Nodes and Load Balancer"
weight: 185 weight: 185
--- ---
@@ -21,7 +21,7 @@ Configure a load balancer as a basic Layer 4 TCP forwarder. The exact configurat
#### Examples #### 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/) * [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/) ### [Next: Install Kubernetes with RKE]({{< baseurl >}}/rancher/v2.x/en/installation/ha/kubernetes-rke/)
content/rancher/v2.x/en/installation/ha/helm-init/_index.md
+1 -1
View File
@@ -1,5 +1,5 @@
--- ---
title: 3 - Initialize Helm (Install tiller) title: "3. Initialize Helm (Install Tiller)"
weight: 195 weight: 195
--- ---
content/rancher/v2.x/en/installation/ha/helm-rancher/_index.md
+1 -1
View File
@@ -1,5 +1,5 @@
--- ---
title: 4 - Install Rancher title: "4. Install Rancher"
weight: 200 weight: 200
--- ---
content/rancher/v2.x/en/installation/ha/kubernetes-rke/_index.md
+1 -1
View File
@@ -1,5 +1,5 @@
--- ---
title: 2—Install Kubernetes with RKE title: "2. Install Kubernetes with RKE"
weight: 190 weight: 190
--- ---
content/rancher/v2.x/en/installation/server-tags/_index.md
+9 -3
View File
@@ -27,15 +27,21 @@ When installing, upgrading, or rolling back Rancher Server in a [high availabili
### Helm Chart Repositories ### 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 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-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. 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.
<br/> <br/>
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`. > **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... 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. After installing Rancher, if you want to change which Helm chart repository to install Rancher from, you will need to follow these steps.
content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm-airgap/_index.md
+4 -1
View File
@@ -35,7 +35,10 @@ The following instructions will guide you through upgrading a high-availability
helm repo update 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 helm repo list
content/rancher/v2.x/en/upgrades/upgrades/ha-server-upgrade-helm/_index.md
+3 -1
View File
@@ -47,7 +47,9 @@ The following instructions will guide you through upgrading a high-availability
helm repo update 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 helm repo list