diff --git a/docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index ba159df89cf..25cac373afb 100644 --- a/docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/docs/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -1,12 +1,18 @@ --- -title: Helm Charts in Rancher +title: Helm Charts and Apps --- -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 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) 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 ⋮ > 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, 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. \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index e80a933e2bc..1ee600f77d4 100644 --- a/sidebars.js +++ b/sidebars.js @@ -625,7 +625,7 @@ const sidebars = { }, { type: 'category', - label: 'Helm Charts in Rancher', + label: 'Helm Charts and Apps', link: { type: 'doc', id: "how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher", diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/helm-charts-in-rancher.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/helm-charts-in-rancher.md index 80fe5d50471..23619415423 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/helm-charts-in-rancher.md @@ -1,30 +1,32 @@ --- -title: Helm Charts in Rancher +title: Helm Charts and Apps --- -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. diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index 691c25eb268..a542a5b6398 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -6,7 +6,11 @@ title: Helm Charts in Rancher -In this section, you'll learn how to manage Helm chart repositories and applications in Rancher. Helm chart repositories are managed using **Apps & Marketplace** (Rancher before v2.6.5) or **Apps** (Rancher v2.6.5+). 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 applications in Rancher. + +## 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. ### Changes in Rancher v2.6 @@ -48,6 +52,11 @@ Any major versions that are less than the ones mentioned in the table below are - 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 @@ -64,11 +73,11 @@ From the top-left menu select **Apps & Marketplace** and you will be taken to th -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. @@ -80,7 +89,7 @@ Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) s ### 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. @@ -131,7 +140,6 @@ To add a private CA to Helm chart repositories: [...] ``` - :::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. @@ -151,24 +159,23 @@ spec: 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 & 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. :::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 ) - * 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 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. ::: @@ -178,9 +185,10 @@ The upgrade button has been removed for legacy apps from the **Apps & Marketplac 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 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 +- 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. + +- 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 diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index ba159df89cf..c3b49d5e505 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -1,12 +1,18 @@ --- -title: Helm Charts in Rancher +title: Helm Charts and Apps --- -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 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) 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 ⋮ > 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, 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 ) - * 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 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. ::: @@ -167,11 +181,10 @@ 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 diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md index ba159df89cf..1bf64a917ed 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher.md @@ -1,12 +1,18 @@ --- -title: Helm Charts in Rancher +title: Helm Charts and Apps --- -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 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) 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 ⋮ > 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, click **⋮ > Edit YAML**. On the `spec` portion of the YAML file, add `disableSameOriginCheck` and set it to `true`. ```yaml [...] @@ -142,24 +156,23 @@ spec: 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 ) - * 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 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. ::: @@ -167,11 +180,10 @@ 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 diff --git a/versioned_sidebars/version-2.5-sidebars.json b/versioned_sidebars/version-2.5-sidebars.json index 4209726ff77..ef33985eeb8 100644 --- a/versioned_sidebars/version-2.5-sidebars.json +++ b/versioned_sidebars/version-2.5-sidebars.json @@ -444,7 +444,7 @@ }, { "type": "category", - "label": "Helm Charts in Rancher", + "label": "Helm Charts and Apps", "link": { "type": "doc", "id": "how-to-guides/new-user-guides/helm-charts-in-rancher" diff --git a/versioned_sidebars/version-2.6-sidebars.json b/versioned_sidebars/version-2.6-sidebars.json index 1d8f14f1384..851a06e7444 100644 --- a/versioned_sidebars/version-2.6-sidebars.json +++ b/versioned_sidebars/version-2.6-sidebars.json @@ -578,7 +578,7 @@ }, { "type": "category", - "label": "Helm Charts in Rancher", + "label": "Helm Charts and Apps", "link": { "type": "doc", "id": "how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher" diff --git a/versioned_sidebars/version-2.7-sidebars.json b/versioned_sidebars/version-2.7-sidebars.json index f2463302321..02d433cf3d7 100644 --- a/versioned_sidebars/version-2.7-sidebars.json +++ b/versioned_sidebars/version-2.7-sidebars.json @@ -589,7 +589,7 @@ }, { "type": "category", - "label": "Helm Charts in Rancher", + "label": "Helm Charts and Apps", "link": { "type": "doc", "id": "how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher" diff --git a/versioned_sidebars/version-2.8-sidebars.json b/versioned_sidebars/version-2.8-sidebars.json index c1823a88108..3e770dd537d 100644 --- a/versioned_sidebars/version-2.8-sidebars.json +++ b/versioned_sidebars/version-2.8-sidebars.json @@ -589,7 +589,7 @@ }, { "type": "category", - "label": "Helm Charts in Rancher", + "label": "Helm Charts and Apps", "link": { "type": "doc", "id": "how-to-guides/new-user-guides/helm-charts-in-rancher/helm-charts-in-rancher"