mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-25 12:38:05 +00:00
* 1172-refresh-helm-charts-in-rancher-page * wording revised, steps compressed * smoothing instructions, syncing language in similar steps * updated heading levels * versioning * versioned headings * Apply suggestions from code review Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com> * rm'd br tag, revised descr of project/namespace filter, made all nouns plural to match verb * Apply suggestions from code review missed one Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com> * Helm apps > Kubernetes apps * h3 heading and moved feature charts section * absolute link to older docs, spacing * heading levels * reorganizing/renaming helm charts in rancher section * rename some headings * changing path to apps/repositories to instead go through explore button * once > after * engineers say the default branch is set by the remote repo. Rancher will respect whatever that default is unless you specifically tell it to pull from another branch * straggler * fix in-page links after heading changed * wrong verb! * hyphen * moved section up as to not interrupt flow * moved info about upstream charts * moved line 64 to part of line 31 * Apply suggestions from code review Co-authored-by: Billy Tat <btat@suse.com> * Update versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md Co-authored-by: Billy Tat <btat@suse.com> * Update versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md Co-authored-by: Billy Tat <btat@suse.com> * Update versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md Co-authored-by: Billy Tat <btat@suse.com> * Update versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md Co-authored-by: Billy Tat <btat@suse.com> * Update docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md Co-authored-by: Billy Tat <btat@suse.com> * Update docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md Co-authored-by: Billy Tat <btat@suse.com> * Apply suggestions from code review Co-authored-by: Billy Tat <btat@suse.com> --------- Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com> Co-authored-by: Billy Tat <btat@suse.com>
This commit is contained in:
Marty Hernandez Avedon
co-authored by
Lucas Saintarbor
Billy Tat
Lucas Saintarbor
Billy Tat
parent
c256118aa9
commit
0a7c7e7230
+1
-1
@@ -78,7 +78,7 @@ A restore is performed by creating a Restore custom resource.
|
||||
1. In the left navigation bar, click **Rancher Backups > Restore**.
|
||||
:::note
|
||||
|
||||
If the Rancher Backups app is not visible, you will need to install it from the Charts page in **Apps**. Refer [here](../../../how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md#charts) for more information.
|
||||
If the Rancher Backups app is not visible, you will need to install it from the Charts page in **Apps**. Refer [here](../../../how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md#access-charts) for more information.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
+109
-83
@@ -8,19 +8,41 @@ title: Helm Charts and Apps
|
||||
|
||||
In this section, you'll learn how to manage Helm chart repositories and apps in Rancher.
|
||||
|
||||
## How Helm Charts Work in Rancher
|
||||
|
||||
Helm chart repositories in Rancher are managed using **Apps**.
|
||||
|
||||
## Helm Charts in Rancher
|
||||
Rancher uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Kubernetes applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster.
|
||||
|
||||
Rancher uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Helm applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster.
|
||||
### Catalogs, Apps, and the Rancher UI
|
||||
|
||||
[Rancher v2.4 and earlier](/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md), repositories of ready-to-deploy applications were called "catalogs". These repositories were managed through the **Catalogs** section of the UI.
|
||||
|
||||
Rancher v2.5 replaced the former catalog system with a new **Apps & Marketplace** feature.
|
||||
|
||||
Since Rancher v2.6.5, the **Apps & Marketplace** feature is named **Apps** in the UI.
|
||||
|
||||
### Versioning Scheme
|
||||
|
||||
The Rancher feature charts versioning scheme is centered around the major version of the charts and the `+up` annotation for upstream charts, where applicable.
|
||||
|
||||
**Major Version:** The major version of the charts is tied to Rancher minor versions. When you upgrade to a new Rancher minor version, you should ensure that all of your **Apps** charts are also upgraded to the correct release line for the chart.
|
||||
**Major Version:** The major versions of feature charts are tied to particular minor versions of Rancher. When you upgrade to a new Rancher minor version, you should ensure that all of your feature charts are also upgraded to the correct release line for the chart.
|
||||
|
||||
**Feature Charts:**
|
||||
**Charts based on upstream:** When you upgrade, make sure that the upstream chart version is compatible with your Rancher version. The `+up` annotation for the chart indicates which upstream version the Rancher chart is tracking. For example, `100.x.x+up16.6.0` for Monitoring tracks upstream kube-prometheus-stack `16.6.0` with some additional Rancher patches.
|
||||
|
||||
When upgrading Rancher versions, don't downgrade the version of the chart that you are using. For example, if you are using a version of Monitoring that is later than `16.6.0` in Rancher v2.5, you shouldn't upgrade to `100.x.x+up16.6.0`. Instead, you should upgrade to the appropriate version in the next release.
|
||||
|
||||
#### Prerelease Versions
|
||||
|
||||
Prereleases adhere to [the specification](https://semver.org/#spec-item-9) defined by [Semantic Versioning 2.0.0](https://semver.org/). For example, a Helm chart with a version of `0.1.3-dev.12ab4f` is considered a prerelease. Prerelease versions are not displayed by default and must be configured to do so.
|
||||
|
||||
To display prerelease versions:
|
||||
|
||||
1. Click on your user avatar in the upper right corner.
|
||||
1. Click **Preferences**.
|
||||
1. Under **Helm Charts**, select **Include Prerelease Versions**.
|
||||
|
||||
### Feature Charts
|
||||
|
||||
| **Name** | **Supported Minimum Version** | **Supported Maximum Version** |
|
||||
| ---------------- | ------------ | ------------ |
|
||||
@@ -41,81 +63,82 @@ The Rancher feature charts versioning scheme is centered around the major versio
|
||||
| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 |
|
||||
| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 |
|
||||
|
||||
<br/>
|
||||
**Charts based on upstream:** For charts that are based on upstreams, the +up annotation should inform you of what upstream version the Rancher chart is tracking. Check the upstream version compatibility with Rancher during upgrades also.
|
||||
## Access Charts
|
||||
|
||||
- As an example, `100.x.x+up16.6.0` for Monitoring tracks upstream kube-prometheus-stack `16.6.0` with some Rancher patches added to it.
|
||||
The **Charts** page contains all Rancher, Partner, and Custom charts. You can filter charts by selecting the left-most dropdown menu:
|
||||
|
||||
- On upgrades, ensure that you are not downgrading the version of the chart that you are using. For example, if you are using a version of Monitoring > `16.6.0` in Rancher 2.5, you should not upgrade to `100.x.x+up16.6.0`. Instead, you should upgrade to the appropriate version in the next release.
|
||||
* Rancher tools such as Logging or Monitoring are listed under the **Rancher** label.
|
||||
* Partner charts are under the **Partners** label.
|
||||
* Custom charts are listed under the name of their respective repository.
|
||||
|
||||
### Prerelease Versions
|
||||
|
||||
Prereleases adhere to [the specification](https://semver.org/#spec-item-9) defined by [Semantic Versioning 2.0.0](https://semver.org/). For example, a Helm chart with a version of `0.1.3-dev.12ab4f` is considered a prerelease. Prerelease versions are not displayed by default and must be configured to do so.
|
||||
|
||||
To display prerelease versions:
|
||||
|
||||
1. Click on your user avatar in the upper right corner.
|
||||
1. Click **Preferences**.
|
||||
1. Under **Helm Charts**, select **Include Prerelease Versions**.
|
||||
|
||||
### Catalogs, Apps, and the Rancher UI
|
||||
|
||||
In [Rancher v2.4 and earlier](../../../../versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md), repositories of ready-to-deploy applications were called "catalogs". These repositories were managed through the **Catalogs** section of the UI.
|
||||
|
||||
Rancher v2.5 replaced the former catalog system with a new **Apps & Marketplace** feature.
|
||||
|
||||
Since Rancher v2.6.5, the **Apps & Marketplace** feature is named **Apps** in the UI.
|
||||
|
||||
### Charts
|
||||
|
||||
From the top-left menu select **Apps** and you will be taken to the **Charts** page.
|
||||
|
||||
The **Charts** page contains all Rancher, Partner, and Custom charts.
|
||||
|
||||
* Rancher tools such as Logging or Monitoring are included under the Rancher label.
|
||||
* Partner charts reside under the Partners label.
|
||||
* Custom charts will show up under the name of the repository.
|
||||
|
||||
All three types are deployed and managed in the same way.
|
||||
All three types of charts are deployed and managed in the same way.
|
||||
|
||||
:::note
|
||||
|
||||
Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) should continue to be managed only by the Cluster Manager, and apps managed with **Apps** in the new UI must be managed only by **Apps**.
|
||||
Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) continue to be managed only by the Cluster Manager, and apps managed with **Apps** in the new UI must be managed only by **Apps**.
|
||||
|
||||
:::
|
||||
|
||||
### Repositories
|
||||
To access the **Charts** page:
|
||||
|
||||
From the left sidebar select **Repositories**.
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose charts you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Charts**.
|
||||
|
||||
These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or Git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository.
|
||||
## Manage Repositories
|
||||
|
||||
#### Add Custom Git Repositories
|
||||
The **Repositories** page lists your Helm repositories. These include traditional Helm endpoints which have an index.yaml, and Git repositories that are cloned and point to a specific branch. To use custom charts, add your repository here. After you add a repository, you can access custom charts in the **Charts** page, listed under the name of the repository.
|
||||
|
||||
Click **Create** and select the target, **Git repository containing Helm chart...** to add a custom Git repository that contains your Helm charts or cluster template definitions.
|
||||
To access the **Repositories** page:
|
||||
|
||||
You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from the default, `main`.
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
|
||||
|
||||
Whenever you add a chart repository to Rancher, it becomes available immediately.
|
||||
### Add Custom Git Repositories
|
||||
|
||||
#### Add Custom Helm Chart Repositories
|
||||
To add a custom Git repository that contains your Helm charts or cluster template definitions:
|
||||
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
|
||||
1. Click **Create**.
|
||||
1. Select the target, **Git repository containing Helm chart...**.
|
||||
1. You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from whichever branch the repo owner has set as the default. Usually, the default branch is named either `main` or `master`.
|
||||
1. Click **Create** to add the repository.
|
||||
|
||||
After you add a chart repository to Rancher, it becomes available immediately.
|
||||
|
||||
### Add Custom Helm Chart Repositories
|
||||
|
||||
You can add your own Helm chart repositories to serve chart packages to Rancher. You can use any HTTP server, as long as the server can respond to GET requests and serve YAML files and tar archives.
|
||||
|
||||
For more information on Helm chart repositories, see the [official Helm docs](https://helm.sh/docs/topics/chart_repository/).
|
||||
|
||||
To add a custom Helm chart repository to Rancher, click **Create** and select **http(s) URL to an index generated by Helm** as the target. Enter a repo name and the index URL address of the chart repository.
|
||||
To add a custom Helm chart repository to Rancher:
|
||||
|
||||
#### Add Private Git/Helm Chart Repositories
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
|
||||
1. Click **Create**.
|
||||
1. Select the target, **http(s) URL to an index generated by Helm**.
|
||||
1. Enter a repo name and the index URL address of the chart repository.
|
||||
1. Click **Create** to add the repository.
|
||||
|
||||
### Add Private Git/Helm Chart Repositories
|
||||
|
||||
You can add private Git or Helm chart repositories with SSH key credentials or an HTTP basic auth secret, such as a username and password.
|
||||
|
||||
#### Add a Private CA to Repositories
|
||||
### Add a Private CA to Repositories
|
||||
|
||||
To add a private CA to Helm chart repositories:
|
||||
To add a private CA to Helm chart repositories, you must add a base64 encoded copy of the CA certificate in DER format to the `spec.caBundle field` of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Instructions are the same for both Git-based and HTTP-based repositories:
|
||||
|
||||
- **HTTP-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:<br/>
|
||||
```
|
||||
1. Click **☰**. Under **Explore Cluster** in the left navigation menu, select a cluster.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
|
||||
1. Find the row associated with the Git-based or HTTP-based repository you want to add a private CA to, and click **⋮ > Edit YAML**.
|
||||
1. Set the `caBundle` value, as in the following example:
|
||||
|
||||
```yaml
|
||||
[...]
|
||||
spec:
|
||||
caBundle:
|
||||
@@ -123,25 +146,13 @@ To add a private CA to Helm chart repositories:
|
||||
...
|
||||
nDxZ/tNXt/WPJr/PgEB3hQdInDWYMg7vGO0Oz00G5kWg0sJ0ZTSoA10ZwdjIdGEeKlj1NlPyAqpQ+uDnmx6DW+zqfYtLnc/g6GuLLVPamraqN+gyU8CHwAWPNjZonFN9Vpg0PIk1I2zuOc4EHifoTAXSpnjfzfyAxCaZsnTptimlPFJJqAMj+FfDArGmr4=
|
||||
[...]
|
||||
```
|
||||
|
||||
|
||||
- **Git-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:<br/>
|
||||
```
|
||||
[...]
|
||||
spec:
|
||||
caBundle:
|
||||
MIIFXzCCA0egAwIBAgIUWNy8WrvSkgNzV0zdWRP79j9cVcEwDQYJKoZIhvcNAQELBQAwPzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRQwEgYDVQQKDAtNeU9yZywgSW5jLjENMAsGA1UEAwwEcm9vdDAeFw0yMTEyMTQwODMyMTdaFw0yNDEwMDMwODMyMT
|
||||
...
|
||||
nDxZ/tNXt/WPJr/PgEB3hQdInDWYMg7vGO0Oz00G5kWg0sJ0ZTSoA10ZwdjIdGEeKlj1NlPyAqpQ+uDnmx6DW+zqfYtLnc/g6GuLLVPamraqN+gyU8CHwAWPNjZonFN9Vpg0PIk1I2zuOc4EHifoTAXSpnjfzfyAxCaZsnTptimlPFJJqAMj+FfDArGmr4=
|
||||
[...]
|
||||
```
|
||||
```
|
||||
|
||||
:::note Helm chart repositories with authentication
|
||||
|
||||
The Repo.Spec contains a `disableSameOriginCheck` value that allows users to bypass the same origin checks, sending the repository Authentication information as a Basic Auth Header with all API calls. This is not recommended but can be used as a temporary solution in cases of non-standard Helm chart repositories such as those that have redirects to a different origin URL.
|
||||
The Repo.Spec contains a `disableSameOriginCheck` value. This value allows you to bypass the same origin checks, sending the repository Authentication information as a Basic Auth Header with all API calls. This is not recommended but can be used as a temporary solution in cases of non-standard Helm chart repositories, such as those that have redirects to a different origin URL.
|
||||
|
||||
To use this feature for an existing Helm chart repository, click **⋮ > Edit YAML**. On the `spec` portion of the YAML file, add `disableSameOriginCheck` and set it to `true`.
|
||||
To use this feature for an existing Helm chart repository, follow previous steps up to edit the YAML. On the `spec` portion of the YAML file, add `disableSameOriginCheck` and set it to `true`.
|
||||
|
||||
```yaml
|
||||
[...]
|
||||
@@ -156,36 +167,51 @@ spec:
|
||||
|
||||
Only Helm 3 compatible charts are supported.
|
||||
|
||||
## Deploy and Upgrade Charts
|
||||
|
||||
### Deployment and Upgrades
|
||||
To install and deploy a chart:
|
||||
|
||||
From the **Charts** tab select a chart to install. Rancher and Partner charts may have extra configurations available through custom pages or questions.yaml files, but all chart installations can modify the values.yaml and other basic settings. Once you click install, a Helm operation job is deployed, and the console for the job is displayed.
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Charts**.
|
||||
1. Select a chart, and click **Install**.
|
||||
|
||||
To view all recent changes, go to the **Recent Operations** tab. From there you can view the call that was made, conditions, events, and logs.
|
||||
Rancher and Partner charts may have extra configurations available through custom pages or questions.yaml files. However, all chart installations can modify the values.yaml and other basic settings. After you click **Install**, a Helm operation job is deployed, and the console for the job is displayed.
|
||||
|
||||
After installing a chart, you can find it in the **Installed Apps** tab. In this section you can upgrade or delete the installation, and see further details. When choosing to upgrade, the form and values presented will be the same as installation.
|
||||
To view all recent changes, click **Apps > Recent Operations** in the left navigation menu. From there you can view the calls, conditions, events, and logs.
|
||||
|
||||
Most Rancher tools have additional pages located in the toolbar below the **Apps** section to help manage and use features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information.
|
||||
After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during inital installation.
|
||||
|
||||
Most Rancher tools have additional pages located in the toolbar below the **Apps** section to help manage and use the features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information.
|
||||
|
||||
:::caution
|
||||
|
||||
If you are upgrading your chart using **Customize Helm options before upgrade**, please be aware that using the `--force` option may result in errors if your chart has immutable fields. This is because some objects in Kubernetes cannot be changed once they are created. To ensure you do not get this error you can:
|
||||
If you are upgrading your chart using **Customize Helm options before upgrade**, and your chart contains immutable fields, using the `--force` option may result in errors. This is because some objects in Kubernetes can't be changed after they're created. To prevent this error:
|
||||
|
||||
* use the default upgrade option ( i.e do not use `--force` option )
|
||||
* uninstall the existing chart and install the upgraded chart
|
||||
* delete the resources with immutable fields from the cluster before performing the `--force` upgrade
|
||||
* Use the default upgrade option (i.e don't use `--force`).
|
||||
* Uninstall the existing chart and install the upgraded chart.
|
||||
* Delete the resources with immutable fields from the cluster before performing a forced upgrade.
|
||||
|
||||
:::
|
||||
|
||||
#### Legacy Apps
|
||||
### Legacy Apps
|
||||
|
||||
The upgrade button has been removed for legacy apps from the **Apps > Installed Apps** page.
|
||||
The upgrade button isn't available for legacy apps on the **Apps > Installed Apps** page.
|
||||
|
||||
If you have a legacy app installed and want to upgrade it, the legacy [feature flag](../../advanced-user-guides/enable-experimental-features/enable-experimental-features.md) must be turned on. If you had a legacy app already running before you upgraded Rancher, this flag is automatically turned on.
|
||||
If you want to upgrade an installed legacy app, the [legacy feature flag](../../advanced-user-guides/enable-experimental-features/enable-experimental-features.md) must be turned on. This flag is automatically turned on if you had a legacy app already running before you upgraded Rancher.
|
||||
|
||||
- You can upgrade the app from cluster explorer, from the left nav section **Legacy > Project > Apps**.
|
||||
- For multi-cluster apps, go to **≡ > Multi-cluster Apps** and upgrade the app from there.
|
||||
1. Enable the [legacy feature flag](../../advanced-user-guides/enable-experimental-features/enable-experimental-features.md), if it isn't enabled already.
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose apps you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. Click **Legacy > Project > Apps**.
|
||||
|
||||
### Limitations
|
||||
If you don't see **Apps** listed under **Legacy > Project**, click the project/namespace search bar in the top navigation and select the relevant project from the dropdown menu.
|
||||
|
||||
Dashboard apps or Rancher feature charts **cannot** be installed using the Rancher CLI.
|
||||
To upgrade legacy multi-cluster apps:
|
||||
|
||||
1. Click **☰**.
|
||||
1. Under **Legacy Apps**, click **Multi-cluster Apps**.
|
||||
|
||||
## Limitations
|
||||
|
||||
Dashboard apps or Rancher feature charts can't be installed using the Rancher CLI.
|
||||
|
||||
+27
-20
@@ -12,13 +12,13 @@ In this section, you'll learn how to manage Helm chart repositories and apps in
|
||||
|
||||
In Rancher v2.5, the **Apps and Marketplace** feature replaces the catalog system.
|
||||
|
||||
In the cluster manager, Rancher uses a catalog system to import bundles of charts and then uses those charts to either deploy custom helm applications or Rancher's tools such as Monitoring or Istio. The catalog system is still available in the cluster manager in Rancher v2.5, but it is deprecated.
|
||||
In the cluster manager, Rancher uses a catalog system to import bundles of charts and then uses those charts to either deploy custom Kubernetes applications or Rancher's tools such as Monitoring or Istio. The catalog system is still available in the cluster manager in Rancher v2.5, but it is deprecated.
|
||||
|
||||
### Helm Charts in Rancher
|
||||
### How Helm Charts Work in Rancher
|
||||
|
||||
Now in the Cluster Explorer, Rancher uses a similar but simplified version of the same system. Repositories can be added in the same way that catalogs were, but are specific to the current cluster. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts.
|
||||
|
||||
### Charts
|
||||
## Charts
|
||||
|
||||
From the top-left menu select **Apps & Marketplace** and you will be taken to the **Charts** page.
|
||||
|
||||
@@ -32,21 +32,21 @@ All three types are deployed and managed in the same way.
|
||||
|
||||
> Apps managed by the Cluster Manager should continue to be managed only by the Cluster Manager, and apps managed with the Cluster Explorer must be managed only by the Cluster Explorer.
|
||||
|
||||
### Repositories
|
||||
## Repositories
|
||||
|
||||
From the left sidebar select **Repositories**.
|
||||
|
||||
These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or Git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository.
|
||||
|
||||
#### Add Custom Git Repositories
|
||||
### Add Custom Git Repositories
|
||||
|
||||
Click **Create** and select the target, **Git repository containing Helm chart...** to add a custom Git repository that contains your Helm charts or cluster template definitions.
|
||||
|
||||
You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from the default, `main`.
|
||||
You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from whichever branch the repo owner has set as the default. Usually, the default branch is either `main` or `master`.
|
||||
|
||||
Whenever you add a chart repository to Rancher, it becomes available immediately.
|
||||
|
||||
#### Add Custom Helm Chart Repositories
|
||||
### Add Custom Helm Chart Repositories
|
||||
|
||||
You can add your own Helm chart repositories to serve chart packages to Rancher. You can use any HTTP server, as long as the server can respond to GET requests and serve YAML files and tar archives.
|
||||
|
||||
@@ -54,11 +54,11 @@ For more information on Helm chart repositories, see the [official Helm docs](ht
|
||||
|
||||
To add a custom Helm chart repository to Rancher, click **Create** and select **http(s) URL to an index generated by Helm** as the target. Enter a repo name and the index URL address of the chart repository.
|
||||
|
||||
#### Add Private Git/Helm Chart Repositories
|
||||
### Add Private Git/Helm Chart Repositories
|
||||
|
||||
You can add private Git or Helm chart repositories with SSH key credentials or an HTTP basic auth secret, such as a username and password.
|
||||
|
||||
#### Add a Private CA to Repositories
|
||||
### Add a Private CA to Repositories
|
||||
|
||||
To add a private CA to Helm chart repositories:
|
||||
|
||||
@@ -81,24 +81,26 @@ To add a private CA to Helm chart repositories:
|
||||
[...]
|
||||
```
|
||||
|
||||
> **Note:** Helm chart repositories with authentication
|
||||
>
|
||||
> As of Rancher v2.5.12, a new value `disableSameOriginCheck` has been added to the Repo.Spec. This allows users to bypass the same origin checks, sending the repository Authentication information as a Basic Auth Header with all API calls. This is not recommended but can be used as a temporary solution in cases of non-standard Helm chart repositories such as those that have redirects to a different origin URL.
|
||||
>
|
||||
> To use this feature for an existing Helm chart repository, click <b>⋮ > Edit YAML</b>. On the `spec` portion of the YAML file, add `disableSameOriginCheck` and set it to `true`.
|
||||
>
|
||||
> ```yaml
|
||||
:::note Helm chart repositories with authentication
|
||||
|
||||
As of Rancher v2.5.12, a new value `disableSameOriginCheck` has been added to the Repo.Spec. This allows users to bypass the same origin checks, sending the repository Authentication information as a Basic Auth Header with all API calls. This is not recommended but can be used as a temporary solution in cases of non-standard Helm chart repositories such as those that have redirects to a different origin URL.
|
||||
|
||||
To use this feature for an existing Helm chart repository, click **⋮ > Edit YAML**. On the `spec` portion of the YAML file, add `disableSameOriginCheck` and set it to `true`.
|
||||
|
||||
```yaml
|
||||
[...]
|
||||
spec:
|
||||
disableSameOriginCheck: true
|
||||
[...]
|
||||
```
|
||||
|
||||
### Helm Compatibility
|
||||
:::
|
||||
|
||||
## Helm Compatibility
|
||||
|
||||
The Cluster Explorer only supports Helm 3 compatible charts.
|
||||
|
||||
### Deployment and Upgrades
|
||||
## Deploy and Upgrade Charts
|
||||
|
||||
From the **Charts** tab select a chart to install. Rancher and Partner charts may have extra configurations available through custom pages or questions.yaml files, but all chart installations can modify the values.yaml and other basic settings. Once you click install, a Helm operation job is deployed, and the console for the job is displayed.
|
||||
|
||||
@@ -108,7 +110,12 @@ After installing a chart, you can find it in the **Installed Apps** tab. In this
|
||||
|
||||
Most Rancher tools have additional pages located in the toolbar below the **Apps & Marketplace** section to help manage and use features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information.
|
||||
|
||||
> If you are upgrading your chart using **Customize Helm options before upgrade** , please be aware that using the `--force` option may result in errors if your chart has immutable fields. This is because some objects in Kubernetes cannot be changed once they are created. To ensure you do not get this error you can:
|
||||
* Use the default upgrade option ( i.e do not use `--force` option).
|
||||
:::caution
|
||||
|
||||
If you are upgrading your chart using **Customize Helm options before upgrade**, please be aware that using the `--force` option may result in errors if your chart has immutable fields. This is because some objects in Kubernetes cannot be changed once they are created. To ensure you do not get this error you can:
|
||||
|
||||
* Use the default upgrade option ( i.e do not use `--force` option ).
|
||||
* Uninstall the existing chart and install the upgraded chart.
|
||||
* Delete the resources with immutable fields from the cluster before performing the `--force` upgrade.
|
||||
|
||||
:::
|
||||
|
||||
+1
-1
@@ -29,7 +29,7 @@ A restore is performed by creating a Restore custom resource.
|
||||
1. In the left navigation bar, click **Rancher Backups > Restore**.
|
||||
:::note
|
||||
|
||||
If the Rancher Backups app is not visible, you will need to install it from the Charts page in **Apps & Marketplace** (Rancher before v2.6.5) or **Apps** (Rancher v2.6.5+). Refer [here](../../../how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md#charts) for more information.
|
||||
If the Rancher Backups app is not visible, you will need to install it from the Charts page in **Apps & Marketplace** (Rancher before v2.6.5) or **Apps** (Rancher v2.6.5+). Refer [here](../../../how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md#access-charts) for more information.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
+59
-66
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Helm Charts in Rancher
|
||||
title: Helm Charts and Apps
|
||||
---
|
||||
|
||||
<head>
|
||||
@@ -8,15 +8,25 @@ title: Helm Charts in Rancher
|
||||
|
||||
In this section, you'll learn how to manage Helm chart repositories and applications in Rancher.
|
||||
|
||||
## Helm Charts in Rancher
|
||||
## How Helm Charts Work in Rancher
|
||||
|
||||
Rancher uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Helm applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster.
|
||||
Rancher uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Kubernetes applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster.
|
||||
|
||||
### Changes in Rancher v2.6
|
||||
### Catalogs, Apps, and the Rancher UI
|
||||
|
||||
Starting in Rancher v2.6.0, a new versioning scheme for Rancher feature charts was implemented. The changes are centered around the major version of the charts and the +up annotation for upstream charts, where applicable.
|
||||
[Rancher v2.4 and earlier](/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md), repositories of ready-to-deploy applications were called "catalogs". These repositories were managed through the **Catalogs** section of the UI.
|
||||
|
||||
**Major Version:** The major version of the charts is tied to Rancher minor versions. When you upgrade to a new Rancher minor version, you should ensure that all of your **Apps & Marketplace** (Rancher before v2.6.5) or **Apps** (Rancher v2.6.5+) charts are also upgraded to the correct release line for the chart.
|
||||
Helm chart repositories are now managed using **Apps & Marketplace** (before Rancher v2.6.5) or **Apps** (Rancher v2.6.5 and later).
|
||||
|
||||
### Versioning Changes in Rancher v2.6
|
||||
|
||||
Starting in Rancher v2.6.0, a new versioning scheme for Rancher feature charts was implemented. The changes are centered around the major version of the charts and the `+up` annotation for upstream charts, where applicable.
|
||||
|
||||
**Major Version:** The major versions of feature charts are tied to Rancher minor versions. When you upgrade to a new Rancher minor version, you should ensure that all of your charts are also upgraded to the correct release line for the chart.
|
||||
|
||||
**Charts based on upstream:** When you upgrade, make sure that the upstream chart version is compatible with your Rancher version. The `+up` annotation for the chart indicates which upstream version the Rancher chart is tracking. For example, `100.x.x+up16.6.0` for Monitoring tracks upstream kube-prometheus-stack `16.6.0` with some additional Rancher patches.
|
||||
|
||||
When upgrading Rancher versions, don't downgrade the version of the chart that you are using. For example, if you are using a version of Monitoring that is later than `16.6.0` in Rancher v2.5, you shouldn't upgrade to `100.x.x+up16.6.0`. Instead, you should upgrade to the appropriate version in the next release.
|
||||
|
||||
:::note
|
||||
|
||||
@@ -24,7 +34,7 @@ Any major versions that are less than the ones mentioned in the table below are
|
||||
|
||||
:::
|
||||
|
||||
**Feature Charts:**
|
||||
### Feature Charts
|
||||
|
||||
| **Name** | **Supported Minimum Version** | **Supported Maximum Version** |
|
||||
| ---------------- | ------------ | ------------ |
|
||||
@@ -45,41 +55,28 @@ Any major versions that are less than the ones mentioned in the table below are
|
||||
| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 |
|
||||
| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 |
|
||||
|
||||
<br/>
|
||||
**Charts based on upstream:** For charts that are based on upstreams, the +up annotation should inform you of what upstream version the Rancher chart is tracking. Check the upstream version compatibility with Rancher during upgrades also.
|
||||
|
||||
- As an example, `100.x.x+up16.6.0` for Monitoring tracks upstream kube-prometheus-stack `16.6.0` with some Rancher patches added to it.
|
||||
|
||||
- On upgrades, ensure that you are not downgrading the version of the chart that you are using. For example, if you are using a version of Monitoring > `16.6.0` in Rancher 2.5, you should not upgrade to `100.x.x+up16.6.0`. Instead, you should upgrade to the appropriate version in the next release.
|
||||
|
||||
### Catalogs, Apps, and the Rancher UI
|
||||
|
||||
In [Rancher v2.4 and earlier](../../../../versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md), repositories of ready-to-deploy applications were called "catalogs". These repositories were managed through the **Catalogs** section of the UI.
|
||||
|
||||
Helm chart repositories are now managed using **Apps & Marketplace** (before v2.6.5) or **Apps** (Rancher v2.6.5 and later).
|
||||
|
||||
### Charts
|
||||
## Access Charts
|
||||
|
||||
<Tabs groupId="rancher-version">
|
||||
<TabItem value="Rancher v2.6.5+">
|
||||
|
||||
From the top-left menu select **Apps** and you will be taken to the Charts page.
|
||||
From the top-left menu select **Apps** and you will be taken to the **Charts** page.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="Rancher before v2.6.5">
|
||||
|
||||
From the top-left menu select **Apps & Marketplace** and you will be taken to the Charts page.
|
||||
From the top-left menu select **Apps & Marketplace** and you will be taken to the **Charts** page.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
The **Charts** page contains all Rancher, Partner, and Custom charts.
|
||||
The **Charts** page contains all Rancher, Partner, and Custom charts. You can filter charts by selecting the left-most dropdown menu:
|
||||
|
||||
* Rancher tools such as Logging or Monitoring are included under the Rancher label.
|
||||
* Partner charts reside under the Partners label.
|
||||
* Custom charts will show up under the name of the repository.
|
||||
* Rancher tools such as Logging or Monitoring are listed under the **Rancher** label.
|
||||
* Partner charts are under the **Partners** label.
|
||||
* Custom charts are listed under the name of their respective repository.
|
||||
|
||||
All three types are deployed and managed in the same way.
|
||||
All three types of charts are deployed and managed in the same way.
|
||||
|
||||
:::note
|
||||
|
||||
@@ -87,38 +84,48 @@ Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) s
|
||||
|
||||
:::
|
||||
|
||||
### Repositories
|
||||
## Manage Repositories
|
||||
|
||||
From the left sidebar select **Repositories**.
|
||||
The **Repositories** page lists your Helm repositories. These include traditional Helm endpoints which have an index.yaml, and Git repositories that are cloned and point to a specific branch. To use custom charts, add your repository here. After you add a repository, you can access custom charts in the **Charts** page, listed under the name of the repository.
|
||||
|
||||
These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or Git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository.
|
||||
To access the **Repositories** page, select **Repositories** from the left nevigation menu.
|
||||
|
||||
#### Add Custom Git Repositories
|
||||
### Add Custom Git Repositories
|
||||
|
||||
Click **Create** and select the target, **Git repository containing Helm chart...** to add a custom Git repository that contains your Helm charts or cluster template definitions.
|
||||
To add a custom Git repository that contains your Helm charts or cluster template definitions:
|
||||
|
||||
You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from the default, `main`.
|
||||
1. Select **Repositories** from the left nevigation menu.
|
||||
1. Click **Create**.
|
||||
1. Select the target, **Git repository containing Helm chart...**.
|
||||
1. You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from whichever branch the repo owner has set as the default. Usually, the default branch is named either `main` or `master`.
|
||||
1. Click **Create** to add the repository.
|
||||
|
||||
Whenever you add a chart repository to Rancher, it becomes available immediately.
|
||||
After you add a chart repository to Rancher, it becomes available immediately.
|
||||
|
||||
#### Add Custom Helm Chart Repositories
|
||||
### Add Custom Helm Chart Repositories
|
||||
|
||||
You can add your own Helm chart repositories to serve chart packages to Rancher. You can use any HTTP server, as long as the server can respond to GET requests and serve YAML files and tar archives.
|
||||
|
||||
For more information on Helm chart repositories, see the [official Helm docs](https://helm.sh/docs/topics/chart_repository/).
|
||||
|
||||
To add a custom Helm chart repository to Rancher, click **Create** and select **http(s) URL to an index generated by Helm** as the target. Enter a repo name and the index URL address of the chart repository.
|
||||
1. Select **Repositories** from the left nevigation menu.
|
||||
1. Click **Create**.
|
||||
1. Select the target, **http(s) URL to an index generated by Helm**.
|
||||
1. Enter a repo name and the index URL address of the chart repository.
|
||||
|
||||
#### Add Private Git/Helm Chart Repositories
|
||||
### Add Private Git/Helm Chart Repositories
|
||||
|
||||
You can add private Git or Helm chart repositories with SSH key credentials or an HTTP basic auth secret, such as a username and password.
|
||||
|
||||
#### Add a Private CA to Repositories
|
||||
### Add a Private CA to Repositories
|
||||
|
||||
To add a private CA to Helm chart repositories:
|
||||
|
||||
- **HTTP-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:<br/>
|
||||
```
|
||||
1. Select **Repositories** from the left nevigation menu.
|
||||
1. Find the row associated with the Git or HTTP-based repository you want to add a private CA to, and click **⋮ > Edit YAML**.
|
||||
1. Set the `caBundle` value, as in the following example:
|
||||
|
||||
```yaml
|
||||
[...]
|
||||
spec:
|
||||
caBundle:
|
||||
@@ -126,25 +133,13 @@ To add a private CA to Helm chart repositories:
|
||||
...
|
||||
nDxZ/tNXt/WPJr/PgEB3hQdInDWYMg7vGO0Oz00G5kWg0sJ0ZTSoA10ZwdjIdGEeKlj1NlPyAqpQ+uDnmx6DW+zqfYtLnc/g6GuLLVPamraqN+gyU8CHwAWPNjZonFN9Vpg0PIk1I2zuOc4EHifoTAXSpnjfzfyAxCaZsnTptimlPFJJqAMj+FfDArGmr4=
|
||||
[...]
|
||||
```
|
||||
|
||||
|
||||
- **Git-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:<br/>
|
||||
```
|
||||
[...]
|
||||
spec:
|
||||
caBundle:
|
||||
MIIFXzCCA0egAwIBAgIUWNy8WrvSkgNzV0zdWRP79j9cVcEwDQYJKoZIhvcNAQELBQAwPzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRQwEgYDVQQKDAtNeU9yZywgSW5jLjENMAsGA1UEAwwEcm9vdDAeFw0yMTEyMTQwODMyMTdaFw0yNDEwMDMwODMyMT
|
||||
...
|
||||
nDxZ/tNXt/WPJr/PgEB3hQdInDWYMg7vGO0Oz00G5kWg0sJ0ZTSoA10ZwdjIdGEeKlj1NlPyAqpQ+uDnmx6DW+zqfYtLnc/g6GuLLVPamraqN+gyU8CHwAWPNjZonFN9Vpg0PIk1I2zuOc4EHifoTAXSpnjfzfyAxCaZsnTptimlPFJJqAMj+FfDArGmr4=
|
||||
[...]
|
||||
```
|
||||
```
|
||||
|
||||
:::note Helm chart repositories with authentication
|
||||
|
||||
As of Rancher v2.6.3, a new value `disableSameOriginCheck` has been added to the Repo.Spec. This allows users to bypass the same origin checks, sending the repository Authentication information as a Basic Auth Header with all API calls. This is not recommended but can be used as a temporary solution in cases of non-standard Helm chart repositories such as those that have redirects to a different origin URL.
|
||||
|
||||
To use this feature for an existing Helm chart repository, click <b>⋮ > Edit YAML</b>. On the `spec` portion of the YAML file, add `disableSameOriginCheck` and set it to `true`.
|
||||
To use this feature for an existing Helm chart repository, click **⋮ > Edit YAML**. On the `spec` portion of the YAML file, add `disableSameOriginCheck` and set it to `true`.
|
||||
|
||||
```yaml
|
||||
[...]
|
||||
@@ -155,13 +150,13 @@ spec:
|
||||
|
||||
:::
|
||||
|
||||
### Helm Compatibility
|
||||
## Helm Compatibility
|
||||
|
||||
Only Helm 3 compatible charts are supported.
|
||||
|
||||
### Deployment and Upgrades
|
||||
## Deploy and Upgrade Charts
|
||||
|
||||
From the **Charts** tab select a chart to install. Rancher and Partner charts may have extra configurations available through custom pages or questions.yaml files, but all chart installations can modify the values.yaml and other basic settings. Once you click install, a Helm operation job is deployed, and the console for the job is displayed.
|
||||
From the **Charts** tab select a chart to install. Rancher and Partner charts may have extra configurations available through custom pages or questions.yaml files, but all chart installations can modify the values.yaml and other basic settings. After you click install, a Helm operation job is deployed, and the console for the job is displayed.
|
||||
|
||||
To view all recent changes, go to the **Recent Operations** tab. From there you can view the call that was made, conditions, events, and logs.
|
||||
|
||||
@@ -171,7 +166,7 @@ Most Rancher tools have additional pages located in the toolbar below the **Apps
|
||||
|
||||
:::caution
|
||||
|
||||
If you are upgrading your chart using **Customize Helm options before upgrade**, please be aware that using the `--force` option may result in errors if your chart has immutable fields. This is because some objects in Kubernetes cannot be changed once they are created. To ensure you do not get this error you can:
|
||||
If you are upgrading your chart using **Customize Helm options before upgrade**, please be aware that using the `--force` option may result in errors if your chart has immutable fields. This is because some objects in Kubernetes cannot be changed after they are created. To ensure you do not get this error you can:
|
||||
|
||||
* Use the default upgrade option ( i.e do not use `--force` option ).
|
||||
* Uninstall the existing chart and install the upgraded chart.
|
||||
@@ -179,17 +174,15 @@ If you are upgrading your chart using **Customize Helm options before upgrade**,
|
||||
|
||||
:::
|
||||
|
||||
#### Changes in Rancher v2.6.3
|
||||
### Changes in Rancher v2.6.3
|
||||
|
||||
The upgrade button has been removed for legacy apps from the **Apps & Marketplace > Installed Apps** page.
|
||||
The upgrade button isn't available for legacy apps on the **Apps > Installed Apps** page.
|
||||
|
||||
If you have a legacy app installed and want to upgrade it:
|
||||
|
||||
- The legacy [feature flag](../../advanced-user-guides/enable-experimental-features/enable-experimental-features.md) must be turned on. If you had a legacy app already running before you upgraded Rancher, this flag is automatically turned on.
|
||||
If you want to upgrade an installed legacy app, the [legacy feature flag](../../advanced-user-guides/enable-experimental-features/enable-experimental-features.md) must be turned on. This flag is automatically turned on if you had a legacy app already running before you upgraded Rancher.
|
||||
|
||||
- You can upgrade the app from cluster explorer, from the left nav section **Legacy > Project > Apps**.
|
||||
- For multi-cluster apps, you can go to **≡ > Multi-cluster Apps** and upgrade the app from there.
|
||||
|
||||
### Limitations
|
||||
## Limitations
|
||||
|
||||
Dashboard apps or Rancher feature charts **cannot** be installed using the Rancher CLI.
|
||||
Dashboard apps or Rancher feature charts can't be installed using the Rancher CLI.
|
||||
|
||||
+1
-1
@@ -78,7 +78,7 @@ A restore is performed by creating a Restore custom resource.
|
||||
1. In the left navigation bar, click **Rancher Backups > Restore**.
|
||||
:::note
|
||||
|
||||
If the Rancher Backups app is not visible, you will need to install it from the Charts page in **Apps**. Refer [here](../../../how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md#charts) for more information.
|
||||
If the Rancher Backups app is not visible, you will need to install it from the Charts page in **Apps**. Refer [here](../../../how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md#access-charts) for more information.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
+108
-82
@@ -8,19 +8,41 @@ title: Helm Charts and Apps
|
||||
|
||||
In this section, you'll learn how to manage Helm chart repositories and apps in Rancher.
|
||||
|
||||
## How Helm Charts Work in Rancher
|
||||
|
||||
Helm chart repositories in Rancher are managed using **Apps**.
|
||||
|
||||
## Helm Charts in Rancher
|
||||
Rancher uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Kubernetes applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster.
|
||||
|
||||
Rancher uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Helm applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster.
|
||||
### Catalogs, Apps, and the Rancher UI
|
||||
|
||||
[Rancher v2.4 and earlier](/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md), repositories of ready-to-deploy applications were called "catalogs". These repositories were managed through the **Catalogs** section of the UI.
|
||||
|
||||
Rancher v2.5 replaced the former catalog system with a new **Apps & Marketplace** feature.
|
||||
|
||||
Since Rancher v2.6.5, the **Apps & Marketplace** feature is named **Apps** in the UI.
|
||||
|
||||
### Versioning Scheme
|
||||
|
||||
The Rancher feature charts versioning scheme is centered around the major version of the charts and the `+up` annotation for upstream charts, where applicable.
|
||||
|
||||
**Major Version:** The major version of the charts is tied to Rancher minor versions. When you upgrade to a new Rancher minor version, you should ensure that all of your **Apps** charts are also upgraded to the correct release line for the chart.
|
||||
**Major Version:** The major versions of feature charts are tied to particular minor versions of Rancher. When you upgrade to a new Rancher minor version, you should ensure that all of your feature charts are also upgraded to the correct release line for the chart.
|
||||
|
||||
**Feature Charts:**
|
||||
**Charts based on upstream:** When you upgrade, make sure that the upstream chart version is compatible with your Rancher version. The `+up` annotation for the chart indicates which upstream version the Rancher chart is tracking. For example, `100.x.x+up16.6.0` for Monitoring tracks upstream kube-prometheus-stack `16.6.0` with some additional Rancher patches.
|
||||
|
||||
When upgrading Rancher versions, don't downgrade the version of the chart that you are using. For example, if you are using a version of Monitoring that is later than `16.6.0` in Rancher v2.5, you shouldn't upgrade to `100.x.x+up16.6.0`. Instead, you should upgrade to the appropriate version in the next release.
|
||||
|
||||
#### Prerelease Versions
|
||||
|
||||
Prereleases adhere to [the specification](https://semver.org/#spec-item-9) defined by [Semantic Versioning 2.0.0](https://semver.org/). For example, a Helm chart with a version of `0.1.3-dev.12ab4f` is considered a prerelease. Prerelease versions are not displayed by default and must be configured to do so.
|
||||
|
||||
To display prerelease versions:
|
||||
|
||||
1. Click on your user avatar in the upper right corner.
|
||||
1. Click **Preferences**.
|
||||
1. Under **Helm Charts**, select **Include Prerelease Versions**.
|
||||
|
||||
### Feature Charts
|
||||
|
||||
| **Name** | **Supported Minimum Version** | **Supported Maximum Version** |
|
||||
| ---------------- | ------------ | ------------ |
|
||||
@@ -41,81 +63,82 @@ The Rancher feature charts versioning scheme is centered around the major versio
|
||||
| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 |
|
||||
| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 |
|
||||
|
||||
<br/>
|
||||
**Charts based on upstream:** For charts that are based on upstreams, the +up annotation should inform you of what upstream version the Rancher chart is tracking. Check the upstream version compatibility with Rancher during upgrades also.
|
||||
## Access Charts
|
||||
|
||||
- As an example, `100.x.x+up16.6.0` for Monitoring tracks upstream kube-prometheus-stack `16.6.0` with some Rancher patches added to it.
|
||||
The **Charts** page contains all Rancher, Partner, and Custom charts. You can filter charts by selecting the left-most dropdown menu:
|
||||
|
||||
- On upgrades, ensure that you are not downgrading the version of the chart that you are using. For example, if you are using a version of Monitoring > `16.6.0` in Rancher 2.5, you should not upgrade to `100.x.x+up16.6.0`. Instead, you should upgrade to the appropriate version in the next release.
|
||||
* Rancher tools such as Logging or Monitoring are listed under the **Rancher** label.
|
||||
* Partner charts are under the **Partners** label.
|
||||
* Custom charts are listed under the name of their respective repository.
|
||||
|
||||
### Prerelease Versions
|
||||
|
||||
Prereleases adhere to [the specification](https://semver.org/#spec-item-9) defined by [Semantic Versioning 2.0.0](https://semver.org/). For example, a Helm chart with a version of `0.1.3-dev.12ab4f` is considered a prerelease. Prerelease versions are not displayed by default and must be configured to do so.
|
||||
|
||||
To display prerelease versions:
|
||||
|
||||
1. Click on your user avatar in the upper right corner.
|
||||
1. Click **Preferences**.
|
||||
1. Under **Helm Charts**, select **Include Prerelease Versions**.
|
||||
|
||||
### Catalogs, Apps, and the Rancher UI
|
||||
|
||||
In [Rancher v2.4 and earlier](../../../../versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md), repositories of ready-to-deploy applications were called "catalogs". These repositories were managed through the **Catalogs** section of the UI.
|
||||
|
||||
Rancher v2.5 replaced the former catalog system with a new **Apps & Marketplace** feature.
|
||||
|
||||
Since Rancher v2.6.5, the **Apps & Marketplace** feature is named **Apps** in the UI.
|
||||
|
||||
### Charts
|
||||
|
||||
From the top-left menu select **Apps** and you will be taken to the **Charts** page.
|
||||
|
||||
The **Charts** page contains all Rancher, Partner, and Custom charts.
|
||||
|
||||
* Rancher tools such as Logging or Monitoring are included under the Rancher label.
|
||||
* Partner charts reside under the Partners label.
|
||||
* Custom charts will show up under the name of the repository.
|
||||
|
||||
All three types are deployed and managed in the same way.
|
||||
All three types of charts are deployed and managed in the same way.
|
||||
|
||||
:::note
|
||||
|
||||
Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) should continue to be managed only by the Cluster Manager, and apps managed with **Apps** in the new UI must be managed only by **Apps**.
|
||||
Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) continue to be managed only by the Cluster Manager, and apps managed with **Apps** in the new UI must be managed only by **Apps**.
|
||||
|
||||
:::
|
||||
|
||||
### Repositories
|
||||
To access the **Charts** page:
|
||||
|
||||
From the left sidebar select **Repositories**.
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose charts you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Charts**.
|
||||
|
||||
These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or Git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository.
|
||||
## Manage Repositories
|
||||
|
||||
#### Add Custom Git Repositories
|
||||
The **Repositories** page lists your Helm repositories. These include traditional Helm endpoints which have an index.yaml, and Git repositories that are cloned and point to a specific branch. To use custom charts, add your repository here. After you add a repository, you can access custom charts in the **Charts** page, listed under the name of the repository.
|
||||
|
||||
Click **Create** and select the target, **Git repository containing Helm chart...** to add a custom Git repository that contains your Helm charts or cluster template definitions.
|
||||
To access the **Repositories** page:
|
||||
|
||||
You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from the default, `main`.
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
|
||||
|
||||
Whenever you add a chart repository to Rancher, it becomes available immediately.
|
||||
### Add Custom Git Repositories
|
||||
|
||||
#### Add Custom Helm Chart Repositories
|
||||
To add a custom Git repository that contains your Helm charts or cluster template definitions:
|
||||
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
|
||||
1. Click **Create**.
|
||||
1. Select the target, **Git repository containing Helm chart...**.
|
||||
1. You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from whichever branch the repo owner has set as the default. Usually, the default branch is named either `main` or `master`.
|
||||
1. Click **Create** to add the repository.
|
||||
|
||||
After you add a chart repository to Rancher, it becomes available immediately.
|
||||
|
||||
### Add Custom Helm Chart Repositories
|
||||
|
||||
You can add your own Helm chart repositories to serve chart packages to Rancher. You can use any HTTP server, as long as the server can respond to GET requests and serve YAML files and tar archives.
|
||||
|
||||
For more information on Helm chart repositories, see the [official Helm docs](https://helm.sh/docs/topics/chart_repository/).
|
||||
|
||||
To add a custom Helm chart repository to Rancher, click **Create** and select **http(s) URL to an index generated by Helm** as the target. Enter a repo name and the index URL address of the chart repository.
|
||||
To add a custom Helm chart repository to Rancher:
|
||||
|
||||
#### Add Private Git/Helm Chart Repositories
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
|
||||
1. Click **Create**.
|
||||
1. Select the target, **http(s) URL to an index generated by Helm**.
|
||||
1. Enter a repo name and the index URL address of the chart repository.
|
||||
1. Click **Create** to add the repository.
|
||||
|
||||
### Add Private Git/Helm Chart Repositories
|
||||
|
||||
You can add private Git or Helm chart repositories with SSH key credentials or an HTTP basic auth secret, such as a username and password.
|
||||
|
||||
#### Add a Private CA to Repositories
|
||||
### Add a Private CA to Repositories
|
||||
|
||||
To add a private CA to Helm chart repositories:
|
||||
To add a private CA to Helm chart repositories, you must add a base64 encoded copy of the CA certificate in DER format to the `spec.caBundle field` of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Instructions are the same for both Git-based and HTTP-based repositories:
|
||||
|
||||
- **HTTP-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:<br/>
|
||||
```
|
||||
1. Click **☰**. Under **Explore Cluster** in the left navigation menu, select a cluster.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
|
||||
1. Find the row associated with the Git or HTTP-based repository you want to add a private CA to, and click **⋮ > Edit YAML**.
|
||||
1. Set the `caBundle` value, as in the following example:
|
||||
|
||||
```yaml
|
||||
[...]
|
||||
spec:
|
||||
caBundle:
|
||||
@@ -123,25 +146,13 @@ To add a private CA to Helm chart repositories:
|
||||
...
|
||||
nDxZ/tNXt/WPJr/PgEB3hQdInDWYMg7vGO0Oz00G5kWg0sJ0ZTSoA10ZwdjIdGEeKlj1NlPyAqpQ+uDnmx6DW+zqfYtLnc/g6GuLLVPamraqN+gyU8CHwAWPNjZonFN9Vpg0PIk1I2zuOc4EHifoTAXSpnjfzfyAxCaZsnTptimlPFJJqAMj+FfDArGmr4=
|
||||
[...]
|
||||
```
|
||||
|
||||
|
||||
- **Git-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:<br/>
|
||||
```
|
||||
[...]
|
||||
spec:
|
||||
caBundle:
|
||||
MIIFXzCCA0egAwIBAgIUWNy8WrvSkgNzV0zdWRP79j9cVcEwDQYJKoZIhvcNAQELBQAwPzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRQwEgYDVQQKDAtNeU9yZywgSW5jLjENMAsGA1UEAwwEcm9vdDAeFw0yMTEyMTQwODMyMTdaFw0yNDEwMDMwODMyMT
|
||||
...
|
||||
nDxZ/tNXt/WPJr/PgEB3hQdInDWYMg7vGO0Oz00G5kWg0sJ0ZTSoA10ZwdjIdGEeKlj1NlPyAqpQ+uDnmx6DW+zqfYtLnc/g6GuLLVPamraqN+gyU8CHwAWPNjZonFN9Vpg0PIk1I2zuOc4EHifoTAXSpnjfzfyAxCaZsnTptimlPFJJqAMj+FfDArGmr4=
|
||||
[...]
|
||||
```
|
||||
```
|
||||
|
||||
:::note Helm chart repositories with authentication
|
||||
|
||||
The Repo.Spec contains a `disableSameOriginCheck` value that allows users to bypass the same origin checks, sending the repository Authentication information as a Basic Auth Header with all API calls. This is not recommended but can be used as a temporary solution in cases of non-standard Helm chart repositories such as those that have redirects to a different origin URL.
|
||||
The Repo.Spec contains a `disableSameOriginCheck` value. This value allows you to bypass the same origin checks, sending the repository Authentication information as a Basic Auth Header with all API calls. This is not recommended but can be used as a temporary solution in cases of non-standard Helm chart repositories, such as those that have redirects to a different origin URL.
|
||||
|
||||
To use this feature for an existing Helm chart repository, click **⋮ > Edit YAML**. On the `spec` portion of the YAML file, add `disableSameOriginCheck` and set it to `true`.
|
||||
To use this feature for an existing Helm chart repository, follow previous steps up to edit the YAML. On the `spec` portion of the YAML file, add `disableSameOriginCheck` and set it to `true`.
|
||||
|
||||
```yaml
|
||||
[...]
|
||||
@@ -156,36 +167,51 @@ spec:
|
||||
|
||||
Only Helm 3 compatible charts are supported.
|
||||
|
||||
## Deploy and Upgrade Charts
|
||||
|
||||
### Deployment and Upgrades
|
||||
To install and deploy a chart:
|
||||
|
||||
From the **Charts** tab select a chart to install. Rancher and Partner charts may have extra configurations available through custom pages or questions.yaml files, but all chart installations can modify the values.yaml and other basic settings. Once you click install, a Helm operation job is deployed, and the console for the job is displayed.
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose charts you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Charts**.
|
||||
1. Select a chart, and click **Install**.
|
||||
|
||||
To view all recent changes, go to the **Recent Operations** tab. From there you can view the call that was made, conditions, events, and logs.
|
||||
Rancher and Partner charts may have extra configurations available through custom pages or questions.yaml files. However, all chart installations can modify the values.yaml and other basic settings. After you click **Install**, a Helm operation job is deployed, and the console for the job is displayed.
|
||||
|
||||
After installing a chart, you can find it in the **Installed Apps** tab. In this section you can upgrade or delete the installation, and see further details. When choosing to upgrade, the form and values presented will be the same as installation.
|
||||
To view all recent changes, click **Apps > Recent Operations** in the left navigation menu. From there you can view the calls, conditions, events, and logs.
|
||||
|
||||
Most Rancher tools have additional pages located in the toolbar below the **Apps** section to help manage and use features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information.
|
||||
After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during inital installation.
|
||||
|
||||
Most Rancher tools have additional pages located in the toolbar below the **Apps** section to help manage and use the features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information.
|
||||
|
||||
:::caution
|
||||
|
||||
If you are upgrading your chart using **Customize Helm options before upgrade**, please be aware that using the `--force` option may result in errors if your chart has immutable fields. This is because some objects in Kubernetes cannot be changed once they are created. To ensure you do not get this error you can:
|
||||
If you are upgrading your chart using **Customize Helm options before upgrade**, and your chart contains immutable fields, using the `--force` option may result in errors. This is because some objects in Kubernetes can't be changed after they're created. To prevent this error:
|
||||
|
||||
* Use the default upgrade option ( i.e do not use `--force` option).
|
||||
* Use the default upgrade option (i.e don't use `--force`).
|
||||
* Uninstall the existing chart and install the upgraded chart.
|
||||
* Delete the resources with immutable fields from the cluster before performing the `--force` upgrade.
|
||||
* Delete the resources with immutable fields from the cluster before performing a forced upgrade.
|
||||
|
||||
:::
|
||||
|
||||
#### Legacy Apps
|
||||
### Legacy Apps
|
||||
|
||||
The upgrade button has been removed for legacy apps from the **Apps > Installed Apps** page.
|
||||
The upgrade button isn't available for legacy apps on the **Apps > Installed Apps** page.
|
||||
|
||||
If you have a legacy app installed and want to upgrade it, the legacy [feature flag](../../advanced-user-guides/enable-experimental-features/enable-experimental-features.md) must be turned on. If you had a legacy app already running before you upgraded Rancher, this flag is automatically turned on.
|
||||
If you want to upgrade an installed legacy app, the [legacy feature flag](../../advanced-user-guides/enable-experimental-features/enable-experimental-features.md) must be turned on. This flag is automatically turned on if you had a legacy app already running before you upgraded Rancher.
|
||||
|
||||
- You can upgrade the app from cluster explorer, from the left nav section **Legacy > Project > Apps**.
|
||||
- For multi-cluster apps, go to **≡ > Multi-cluster Apps** and upgrade the app from there.
|
||||
1. Enable the [legacy feature flag](../../advanced-user-guides/enable-experimental-features/enable-experimental-features.md), if it isn't enabled already.
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose apps you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. Click **Legacy > Project > Apps**.
|
||||
|
||||
### Limitations
|
||||
If you don't see **Apps** listed under **Legacy > Project**, click the project/namespace search bar in the top navigation and select the relevant project from the dropdown menu.
|
||||
|
||||
Dashboard apps or Rancher feature charts **cannot** be installed using the Rancher CLI.
|
||||
To upgrade legacy multi-cluster apps:
|
||||
|
||||
1. Click **☰**.
|
||||
1. Under **Legacy Apps**, click **Multi-cluster Apps**.
|
||||
|
||||
## Limitations
|
||||
|
||||
Dashboard apps or Rancher feature charts can't be installed using the Rancher CLI.
|
||||
|
||||
+1
-1
@@ -53,7 +53,7 @@ A restore is performed by creating a Restore custom resource.
|
||||
1. In the left navigation bar, click **Rancher Backups > Restore**.
|
||||
:::note
|
||||
|
||||
If the Rancher Backups app is not visible, you will need to install it from the Charts page in **Apps**. Refer [here](../../../how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md#charts) for more information.
|
||||
If the Rancher Backups app is not visible, you will need to install it from the Charts page in **Apps**. Refer [here](../../../how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md#access-charts) for more information.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
+108
-82
@@ -8,19 +8,41 @@ title: Helm Charts and Apps
|
||||
|
||||
In this section, you'll learn how to manage Helm chart repositories and apps in Rancher.
|
||||
|
||||
## How Helm Charts Work in Rancher
|
||||
|
||||
Helm chart repositories in Rancher are managed using **Apps**.
|
||||
|
||||
## Helm Charts in Rancher
|
||||
Rancher uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Kubernetes applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster.
|
||||
|
||||
Rancher uses a catalog-like system to import bundles of charts from repositories and then uses those charts to either deploy custom Helm applications or Rancher's tools such as Monitoring or Istio. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts. Any additional repositories are only added to the current cluster.
|
||||
### Catalogs, Apps, and the Rancher UI
|
||||
|
||||
[Rancher v2.4 and earlier](/versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md), repositories of ready-to-deploy applications were called "catalogs". These repositories were managed through the **Catalogs** section of the UI.
|
||||
|
||||
Rancher v2.5 replaced the former catalog system with a new **Apps & Marketplace** feature.
|
||||
|
||||
Since Rancher v2.6.5, the **Apps & Marketplace** feature is named **Apps** in the UI.
|
||||
|
||||
### Versioning Scheme
|
||||
|
||||
The Rancher feature charts versioning scheme is centered around the major version of the charts and the `+up` annotation for upstream charts, where applicable.
|
||||
|
||||
**Major Version:** The major version of the charts is tied to Rancher minor versions. When you upgrade to a new Rancher minor version, you should ensure that all of your **Apps** charts are also upgraded to the correct release line for the chart.
|
||||
**Major Version:** The major versions of feature charts are tied to particular minor versions of Rancher. When you upgrade to a new Rancher minor version, you should ensure that all of your feature charts are also upgraded to the correct release line for the chart.
|
||||
|
||||
**Feature Charts:**
|
||||
**Charts based on upstream:** When you upgrade, make sure that the upstream chart version is compatible with your Rancher version. The `+up` annotation for the chart indicates which upstream version the Rancher chart is tracking. For example, `100.x.x+up16.6.0` for Monitoring tracks upstream kube-prometheus-stack `16.6.0` with some additional Rancher patches.
|
||||
|
||||
When upgrading Rancher versions, don't downgrade the version of the chart that you are using. For example, if you are using a version of Monitoring that is later than `16.6.0` in Rancher v2.5, you shouldn't upgrade to `100.x.x+up16.6.0`. Instead, you should upgrade to the appropriate version in the next release.
|
||||
|
||||
#### Prerelease Versions
|
||||
|
||||
Prereleases adhere to [the specification](https://semver.org/#spec-item-9) defined by [Semantic Versioning 2.0.0](https://semver.org/). For example, a Helm chart with a version of `0.1.3-dev.12ab4f` is considered a prerelease. Prerelease versions are not displayed by default and must be configured to do so.
|
||||
|
||||
To display prerelease versions:
|
||||
|
||||
1. Click on your user avatar in the upper right corner.
|
||||
1. Click **Preferences**.
|
||||
1. Under **Helm Charts**, select **Include Prerelease Versions**.
|
||||
|
||||
### Feature Charts
|
||||
|
||||
| **Name** | **Supported Minimum Version** | **Supported Maximum Version** |
|
||||
| ---------------- | ------------ | ------------ |
|
||||
@@ -41,81 +63,81 @@ The Rancher feature charts versioning scheme is centered around the major versio
|
||||
| rancher-vsphere-csi | 100.3.0+up2.5.1-rancher1 | 100.3.0+up2.5.1-rancher1 |
|
||||
| rancher-wins-upgrader | 0.0.100 | 100.0.1+up0.0.1 |
|
||||
|
||||
<br/>
|
||||
**Charts based on upstream:** For charts that are based on upstreams, the +up annotation should inform you of what upstream version the Rancher chart is tracking. Check the upstream version compatibility with Rancher during upgrades also.
|
||||
## Access Charts
|
||||
|
||||
- As an example, `100.x.x+up16.6.0` for Monitoring tracks upstream kube-prometheus-stack `16.6.0` with some Rancher patches added to it.
|
||||
The **Charts** page contains all Rancher, Partner, and Custom charts. You can filter charts by selecting the left-most dropdown menu:
|
||||
|
||||
- On upgrades, ensure that you are not downgrading the version of the chart that you are using. For example, if you are using a version of Monitoring > `16.6.0` in Rancher 2.5, you should not upgrade to `100.x.x+up16.6.0`. Instead, you should upgrade to the appropriate version in the next release.
|
||||
* Rancher tools such as Logging or Monitoring are listed under the **Rancher** label.
|
||||
* Partner charts are under the **Partners** label.
|
||||
* Custom charts are listed under the name of their respective repository.
|
||||
|
||||
### Prerelease Versions
|
||||
|
||||
Prereleases adhere to [the specification](https://semver.org/#spec-item-9) defined by [Semantic Versioning 2.0.0](https://semver.org/). For example, a Helm chart with a version of `0.1.3-dev.12ab4f` is considered a prerelease. Prerelease versions are not displayed by default and must be configured to do so.
|
||||
|
||||
To display prerelease versions:
|
||||
|
||||
1. Click on your user avatar in the upper right corner.
|
||||
1. Click **Preferences**.
|
||||
1. Under **Helm Charts**, select **Include Prerelease Versions**.
|
||||
|
||||
### Catalogs, Apps, and the Rancher UI
|
||||
|
||||
In [Rancher v2.4 and earlier](../../../../versioned_docs/version-2.0-2.4/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md), repositories of ready-to-deploy applications were called "catalogs". These repositories were managed through the **Catalogs** section of the UI.
|
||||
|
||||
Rancher v2.5 replaced the former catalog system with a new **Apps & Marketplace** feature.
|
||||
|
||||
Since Rancher v2.6.5, the **Apps & Marketplace** feature is named **Apps** in the UI.
|
||||
|
||||
### Charts
|
||||
|
||||
From the top-left menu select **Apps** and you will be taken to the **Charts** page.
|
||||
|
||||
The **Charts** page contains all Rancher, Partner, and Custom charts.
|
||||
|
||||
* Rancher tools such as Logging or Monitoring are included under the Rancher label.
|
||||
* Partner charts reside under the Partners label.
|
||||
* Custom charts will show up under the name of the repository.
|
||||
|
||||
All three types are deployed and managed in the same way.
|
||||
All three types of charts are deployed and managed in the same way.
|
||||
|
||||
:::note
|
||||
|
||||
Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) should continue to be managed only by the Cluster Manager, and apps managed with **Apps** in the new UI must be managed only by **Apps**.
|
||||
Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) continue to be managed only by the Cluster Manager, and apps managed with **Apps** in the new UI must be managed only by **Apps**.
|
||||
|
||||
:::
|
||||
|
||||
### Repositories
|
||||
To access the **Charts** page:
|
||||
|
||||
From the left sidebar select **Repositories**.
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose charts you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Charts**.
|
||||
|
||||
These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or Git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository.
|
||||
## Manage Repositories
|
||||
|
||||
#### Add Custom Git Repositories
|
||||
The **Repositories** page lists your Helm repositories. These include traditional Helm endpoints which have an index.yaml, and Git repositories that are cloned and point to a specific branch. To use custom charts, add your repository here. After you add a repository, you can access custom charts in the **Charts** page, listed under the name of the repository.
|
||||
|
||||
Click **Create** and select the target, **Git repository containing Helm chart...** to add a custom Git repository that contains your Helm charts or cluster template definitions.
|
||||
To access the **Repositories** page:
|
||||
|
||||
You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from the default, `main`.
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
|
||||
|
||||
Whenever you add a chart repository to Rancher, it becomes available immediately.
|
||||
### Add Custom Git Repositories
|
||||
|
||||
#### Add Custom Helm Chart Repositories
|
||||
To add a custom Git repository that contains your Helm charts or cluster template definitions:
|
||||
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose repositories you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
|
||||
1. Click **Create**.
|
||||
1. Select the target, **Git repository containing Helm chart...**.
|
||||
1. You must enter a name and a Git repository URL. The other fields, including the description, are optional. Enter an alternative branch name if you don't want to pull from whichever branch the repo owner has set as the default. Usually, the default branch is named either `main` or `master`.
|
||||
1. Click **Create** to add the repository.
|
||||
|
||||
After you add a chart repository to Rancher, it becomes available immediately.
|
||||
|
||||
### Add Custom Helm Chart Repositories
|
||||
|
||||
You can add your own Helm chart repositories to serve chart packages to Rancher. You can use any HTTP server, as long as the server can respond to GET requests and serve YAML files and tar archives.
|
||||
|
||||
For more information on Helm chart repositories, see the [official Helm docs](https://helm.sh/docs/topics/chart_repository/).
|
||||
|
||||
To add a custom Helm chart repository to Rancher, click **Create** and select **http(s) URL to an index generated by Helm** as the target. Enter a repo name and the index URL address of the chart repository.
|
||||
To add a custom Helm chart repository to Rancher:
|
||||
|
||||
#### Add Private Git/Helm Chart Repositories
|
||||
1. Click **☰**. Under **Explore Cluster** in the left navigation menu, select a cluster.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Charts**.
|
||||
1. Click **Create**.
|
||||
1. Select the target, **http(s) URL to an index generated by Helm**.
|
||||
1. Enter a repo name and the index URL address of the chart repository.
|
||||
1. Click **Create** to add the repository.
|
||||
|
||||
### Add Private Git/Helm Chart Repositories
|
||||
|
||||
You can add private Git or Helm chart repositories with SSH key credentials or an HTTP basic auth secret, such as a username and password.
|
||||
|
||||
#### Add a Private CA to Repositories
|
||||
### Add a Private CA to Repositories
|
||||
|
||||
To add a private CA to Helm chart repositories:
|
||||
To add a private CA to Helm chart repositories, you must add a base64 encoded copy of the CA certificate in DER format to the `spec.caBundle field` of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Instructions are the same for both Git-based and HTTP-based repositories:
|
||||
|
||||
- **HTTP-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:<br/>
|
||||
```
|
||||
1. Click **☰**. Under **Explore Cluster** in the left navigation menu, select a cluster.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Repositories**.
|
||||
1. Find the row associated with the Git or HTTP-based repository you want to add a private CA to, and click **⋮ > Edit YAML**.
|
||||
1. Set the `caBundle` value, as in the following example:
|
||||
|
||||
```yaml
|
||||
[...]
|
||||
spec:
|
||||
caBundle:
|
||||
@@ -123,25 +145,13 @@ To add a private CA to Helm chart repositories:
|
||||
...
|
||||
nDxZ/tNXt/WPJr/PgEB3hQdInDWYMg7vGO0Oz00G5kWg0sJ0ZTSoA10ZwdjIdGEeKlj1NlPyAqpQ+uDnmx6DW+zqfYtLnc/g6GuLLVPamraqN+gyU8CHwAWPNjZonFN9Vpg0PIk1I2zuOc4EHifoTAXSpnjfzfyAxCaZsnTptimlPFJJqAMj+FfDArGmr4=
|
||||
[...]
|
||||
```
|
||||
|
||||
|
||||
- **Git-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:<br/>
|
||||
```
|
||||
[...]
|
||||
spec:
|
||||
caBundle:
|
||||
MIIFXzCCA0egAwIBAgIUWNy8WrvSkgNzV0zdWRP79j9cVcEwDQYJKoZIhvcNAQELBQAwPzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRQwEgYDVQQKDAtNeU9yZywgSW5jLjENMAsGA1UEAwwEcm9vdDAeFw0yMTEyMTQwODMyMTdaFw0yNDEwMDMwODMyMT
|
||||
...
|
||||
nDxZ/tNXt/WPJr/PgEB3hQdInDWYMg7vGO0Oz00G5kWg0sJ0ZTSoA10ZwdjIdGEeKlj1NlPyAqpQ+uDnmx6DW+zqfYtLnc/g6GuLLVPamraqN+gyU8CHwAWPNjZonFN9Vpg0PIk1I2zuOc4EHifoTAXSpnjfzfyAxCaZsnTptimlPFJJqAMj+FfDArGmr4=
|
||||
[...]
|
||||
```
|
||||
```
|
||||
|
||||
:::note Helm chart repositories with authentication
|
||||
|
||||
The Repo.Spec contains a `disableSameOriginCheck` value that allows users to bypass the same origin checks, sending the repository Authentication information as a Basic Auth Header with all API calls. This is not recommended but can be used as a temporary solution in cases of non-standard Helm chart repositories such as those that have redirects to a different origin URL.
|
||||
The Repo.Spec contains a `disableSameOriginCheck` value. This value allows you to bypass the same origin checks, sending the repository Authentication information as a Basic Auth Header with all API calls. This is not recommended but can be used as a temporary solution in cases of non-standard Helm chart repositories, such as those that have redirects to a different origin URL.
|
||||
|
||||
To use this feature for an existing Helm chart repository, click **⋮ > Edit YAML**. On the `spec` portion of the YAML file, add `disableSameOriginCheck` and set it to `true`.
|
||||
To use this feature for an existing Helm chart repository, follow previous steps up to edit the YAML. On the `spec` portion of the YAML file, add `disableSameOriginCheck` and set it to `true`.
|
||||
|
||||
```yaml
|
||||
[...]
|
||||
@@ -156,35 +166,51 @@ spec:
|
||||
|
||||
Only Helm 3 compatible charts are supported.
|
||||
|
||||
### Deployment and Upgrades
|
||||
## Deploy and Upgrade Charts
|
||||
|
||||
From the **Charts** tab select a chart to install. Rancher and Partner charts may have extra configurations available through custom pages or questions.yaml files, but all chart installations can modify the values.yaml and other basic settings. Once you click install, a Helm operation job is deployed, and the console for the job is displayed.
|
||||
To install and deploy a chart:
|
||||
|
||||
To view all recent changes, go to the **Recent Operations** tab. From there you can view the call that was made, conditions, events, and logs.
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose charts you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. In the left navigation menu on the **Cluster Dashboard**, click **Apps > Charts**.
|
||||
1. Select a chart, and click **Install**.
|
||||
|
||||
After installing a chart, you can find it in the **Installed Apps** tab. In this section you can upgrade or delete the installation, and see further details. When choosing to upgrade, the form and values presented will be the same as installation.
|
||||
Rancher and Partner charts may have extra configurations available through custom pages or questions.yaml files. However, all chart installations can modify the values.yaml and other basic settings. After you click **Install**, a Helm operation job is deployed, and the console for the job is displayed.
|
||||
|
||||
Most Rancher tools have additional pages located in the toolbar below the **Apps** section to help manage and use features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information.
|
||||
To view all recent changes, click **Apps > Recent Operations** in the left navigation menu. From there you can view the calls, conditions, events, and logs.
|
||||
|
||||
After installing a chart, you can view it by clicking **Apps > Installed Apps** in the left navigation menu. You can upgrade or delete the installation, and see further details. Upgrading uses the same forms and values as you saw during inital installation.
|
||||
|
||||
Most Rancher tools have additional pages located in the toolbar below the **Apps** section to help manage and use the features. These pages include links to dashboards, forms to easily add Custom Resources, and additional information.
|
||||
|
||||
:::caution
|
||||
|
||||
If you are upgrading your chart using **Customize Helm options before upgrade**, please be aware that using the `--force` option may result in errors if your chart has immutable fields. This is because some objects in Kubernetes cannot be changed once they are created. To ensure you do not get this error you can:
|
||||
If you are upgrading your chart using **Customize Helm options before upgrade**, and your chart contains immutable fields, using the `--force` option may result in errors. This is because some objects in Kubernetes can't be changed after they're created. To prevent this error:
|
||||
|
||||
* Use the default upgrade option ( i.e do not use `--force` option).
|
||||
* Use the default upgrade option (i.e don't use `--force`).
|
||||
* Uninstall the existing chart and install the upgraded chart.
|
||||
* Delete the resources with immutable fields from the cluster before performing the `--force` upgrade.
|
||||
* Delete the resources with immutable fields from the cluster before performing a forced upgrade.
|
||||
|
||||
:::
|
||||
|
||||
#### Legacy Apps
|
||||
### Legacy Apps
|
||||
|
||||
The upgrade button has been removed for legacy apps from the **Apps > Installed Apps** page.
|
||||
The upgrade button isn't available for legacy apps on the **Apps > Installed Apps** page.
|
||||
|
||||
If you have a legacy app installed and want to upgrade it, the legacy [feature flag](../../advanced-user-guides/enable-experimental-features/enable-experimental-features.md) must be turned on. If you had a legacy app already running before you upgraded Rancher, this flag is automatically turned on.
|
||||
If you want to upgrade an installed legacy app, the [legacy feature flag](../../advanced-user-guides/enable-experimental-features/enable-experimental-features.md) must be turned on. This flag is automatically turned on if you had a legacy app already running before you upgraded Rancher.
|
||||
|
||||
- You can upgrade the app from cluster explorer, from the left nav section **Legacy > Project > Apps**.
|
||||
- For multi-cluster apps, go to **≡ > Multi-cluster Apps** and upgrade the app from there.
|
||||
1. Enable the [legacy feature flag](../../advanced-user-guides/enable-experimental-features/enable-experimental-features.md), if it isn't enabled already.
|
||||
1. Click **☰ > Cluster Management**.
|
||||
1. Find the name of the cluster whose apps you want to access. Click **Explore** at the end of the cluster's row.
|
||||
1. Click **Legacy > Project > Apps**.
|
||||
|
||||
### Limitations
|
||||
If you don't see **Apps** listed under **Legacy > Project**, click the project/namespace search bar in the top navigation and select the relevant project from the dropdown menu.
|
||||
|
||||
Dashboard apps or Rancher feature charts **cannot** be installed using the Rancher CLI.
|
||||
To upgrade legacy multi-cluster apps:
|
||||
|
||||
1. Click **☰**.
|
||||
1. Under **Legacy Apps**, click **Multi-cluster Apps**.
|
||||
|
||||
## Limitations
|
||||
|
||||
Dashboard apps or Rancher feature charts can't be installed using the Rancher CLI.
|
||||
Reference in New Issue
Block a user