mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-26 04:58:07 +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
+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.
|
||||
|
||||
:::
|
||||
|
||||
Reference in New Issue
Block a user