mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-05-05 20:53:33 +00:00
Expand helm requirements page to explain matching the helm policy (#1943)
* Add details on selecting proper Helm 3 version * Simplify notes about helm V2 into a single bulletpoint * Add note about tools that use helm indirectly for users * Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com> * Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com> * Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com> * Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com> * Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com> * Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com> * Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com> * Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com> * Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com> * Sync new helm docs to versioned docs * Add helm info to 2.10/2.9 docs with updated example --------- Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>
This commit is contained in:
+20
-3
@@ -12,7 +12,24 @@ This section contains the requirements for Helm, which is the tool used to insta
|
||||
|
||||
<DeprecationHelm2 />
|
||||
|
||||
## Identifying the Proper Helm v3 Version
|
||||
|
||||
Select any Helm v3 version that is officially compatible with the Kubernetes version range you are using from our [Rancher Support Matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions).
|
||||
|
||||
To apply this rule, you may need to reference two external resources:
|
||||
|
||||
- **Helm Version Compatibility:** Refer to the [Helm Version Support Policy](https://helm.sh/docs/topics/version_skew/) and select the version matching the rule for your Rancher minor target.
|
||||
- **Rancher's Kubernetes Support Range:** Use the [Rancher Support Matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions) to identify the Kubernetes versions supported by your target Rancher minor version.
|
||||
|
||||
### Example
|
||||
|
||||
- **Scenario:** You are targeting Rancher v2.11.4, which supports Kubernetes versions v1.30 through v1.32.
|
||||
- **Application:** Our rule requires a Helm version that supports this range. You can verify this by checking the Helm version's compatibility with the highest version in the range, Kubernetes v1.32.
|
||||
- **Result:** You find that both Helm v3.17 and Helm v3.18 support the Kubernetes v1.30-v1.32 range.
|
||||
- Although both work, we recommend Helm v3.18 because it is the newest Helm minor version overlapping the supported Kubernetes range.
|
||||
|
||||
## Additional Notes
|
||||
|
||||
- Helm v3.2.x or higher is required to install or upgrade Rancher v2.5.
|
||||
- Helm v2.16.0 or higher is required for Kubernetes v1.16. For the default Kubernetes version, refer to the [release notes](https://github.com/rancher/rke/releases) for the version of RKE that you are using.
|
||||
- Helm v2.15.0 should not be used, because of an issue with converting/comparing numbers.
|
||||
- Helm v2.12.0 should not be used, because of an issue with `cert-manager`.
|
||||
- Helm v2 support was removed in Rancher v2.9.x.
|
||||
- When using tools that run Helm commands for you (like Terraform), you must make sure they are configured to use the correct Helm version.
|
||||
|
||||
Reference in New Issue
Block a user