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
versioned_docs/version-2.5/how-to-guides/new-user-guides/helm-charts-in-rancher.md
+20 -19
View File
@@ -1,30 +1,32 @@
---
title: Helm Charts in Rancher
title: Helm Charts and Apps
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/pages-for-subheaders/helm-charts-in-rancher"/>
</head>
In this section, you'll learn how to manage Helm chart repositories and applications in Rancher.
In this section, you'll learn how to manage Helm chart repositories and apps in Rancher.
### Changes in Rancher v2.5
## Catalogs and Changes in Rancher v2.5
In Rancher v2.5, the Apps and Marketplace feature replaced the catalog system.
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.
### Helm Charts 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
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.
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.
@@ -32,7 +34,7 @@ All three types are deployed and managed in the same way.
### 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.
@@ -96,18 +98,17 @@ spec:
The Cluster Explorer only supports Helm 3 compatible charts.
### 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 & Marketplace"_ 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 & 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 )
* uninstall the existing chart and install the upgraded chart
* delete the resources with immutable fields from the cluster before performing the _"--force"_ upgrade
> 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.