public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-25 12:38:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

#1163 Title change 'Helm Charts in Rancher' and add 'Catalogs' heading for SEO (#1170)

Browse Source 
* 1163 Title change 'Helm Charts in Rancher' and add 'Catalogs' heading for SEO

* versioning + formatting

* casing, periods

* formatting force

* Apply suggestions from code review

Co-authored-by: Sunil Singh <sunil.singh@suse.com>

* moved and renamed section about catalogs

* .

---------

Co-authored-by: Sunil Singh <sunil.singh@suse.com>
This commit is contained in:
Marty Hernandez Avedon
2024-03-14 14:10:19 -04:00
committed by GitHub
co-authored by Sunil Singh
parent 4db4014a20
commit 31cdce4a59
10 changed files with 157 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md
+35 -22
View File
@@ -1,12 +1,18 @@
---
title: Helm Charts in Rancher
title: Helm Charts and Apps
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/helm-charts-in-rancher"/>
</head>
In this section, you'll learn how to manage Helm chart repositories and applications in Rancher. Helm chart repositories are managed using **Apps**. It 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.
In this section, you'll learn how to manage Helm chart repositories and apps 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 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.
### Versioning Scheme
@@ -52,27 +58,35 @@ To display prerelease versions:
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.
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.
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
* 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.
:::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 <b>Apps</b> in the new UI must be managed only by <b>Apps</b>.
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**.
:::
### Repositories
From the left sidebar select _"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.
@@ -127,7 +141,7 @@ To add a private CA to Helm chart repositories:
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.
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
[...]
@@ -145,21 +159,21 @@ Only Helm 3 compatible charts are supported.
### Deployment and Upgrades
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. Once 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.
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.
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.
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.
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.
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.
:::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 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 )
* 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
* delete the resources with immutable fields from the cluster before performing the `--force` upgrade
:::
@@ -167,12 +181,11 @@ If you are upgrading your chart using _"Customize Helm options before upgrade"_
The upgrade button has been removed for legacy apps from the **Apps > Installed Apps** page.
If you have a legacy app installed and want to upgrade it:
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.
- The legacy [feature flag](../../advanced-user-guides/enable-experimental-features/enable-experimental-features.md) must be turned on (if it's not turned on automatically because of having a legacy app before upgrading)
- 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
- 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.
### Limitations
Dashboard apps or Rancher feature charts **cannot** be installed using the Rancher CLI.
Dashboard apps or Rancher feature charts **cannot** be installed using the Rancher CLI.