Add Helm 3 CLI download links alongside Helm 4 - #1197
Conversation
|
Skipping CI for Draft Pull Request. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Central YAML (inherited) Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
🔗 Linked repositories identifiedCodeRabbit considers these linked repositories for cross-repo context during reviews:
🚧 Files skipped from review as they are similar to previous changes (1)
📜 Recent review details🧰 Additional context used🔀 Multi-repo contextNo additional cross-repository context was found beyond the prior findings. The change is confined to a manifest and is compatible with the existing WalkthroughUpdates the Helm 4 CLI bundle URL and adds a ChangesHelm CLI download resources
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 13 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (13 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
webbnh
left a comment
There was a problem hiding this comment.
This looks OK to me, but I've got a suggestion, a question, and a proposed revision (I'll let you guess which is which 😉).
/lgtm
| @@ -16,3 +16,22 @@ spec: | |||
| links: | |||
| - href: 'https://mirror.openshift.com/pub/cgw/helm/4.1.4' | |||
There was a problem hiding this comment.
Consider updating this to 4.2.3.
(Presumably, this would be better done in a separate PR, but the additional hassle doesn't seem worthwhile, given the narrow scope and low complexity of this PR.)
| Helm 3 is a package manager for Kubernetes that simplifies deploying and managing | ||
| applications using Helm Charts. Helm 3 remains available for existing workflows. |
There was a problem hiding this comment.
Just out of curiosity, why does the first sentence use verbiage different from the Helm 4 text?
Regardless, given that we're including that second sentence, we might want to go all-in and say something like "Helm 3 continues to be provided for operational continuity, but it will not be compatible with future releases of OCP and so customers are encouraged to upgrade to Helm 4." (I suggest conferring with Marina and Jocelyn on detailed content and wording.)
There was a problem hiding this comment.
So, we are concerned that having it on the console will imply support, we simply should redirect to the compatibility matrix then: https://access.redhat.com/articles/7145580 .
I would say, under both sections:
For Helm CLI compatibility with OpenShift releases refer to article https://access.redhat.com/articles/7145580.
There was a problem hiding this comment.
we are concerned that having it on the console will imply support
@mkumku, we expect that this documentation is version-specific -- e.g., the change proposed here is specifically for OCP 5.0. We will backport this change to OCP 4.22, and presumably it will propagate automatically to OCP 4.23. For OCP 5.2 (and, perhaps for 5.1), we will remove the Helm v3 section.
So, while I have no objection to adding a reference to a support statement, I don't think it's necessary; and, I don't think it's really useful to make a statement about compatibility -- what we are advertising here is supposed to be compatible with the platform where it is being advertised!
There was a problem hiding this comment.
I don't know how these changes relate to the content served from https://console.redhat.com/openshift/downloads -- that content seems to be version independent, which poses exactly the compatibility challenges that you are raising. If that content comes from here, then, yeah, we definitely need pointers from here to both compatibility and support documentation. 😛
There was a problem hiding this comment.
So do I add a link to compatibility matrix or not? 😕
There was a problem hiding this comment.
Hi Sowmya, since this is the OCP cluster, where you know the version of the cluster and you can adjust the version of Helm you are pointing to, then probably you can skip the link to the support matrix.
My only question to you, since we cannot use latest for Helm v4, do you plan updating this link with each z-stream release of Helm?
Maybe we can simply point to this directory: https://mirror.openshift.com/pub/cgw/helm/ . This directory will contain all the available Helm v4 binaries. And then this will remove the need of submitting a new PR with each z-release. And then it will make sense to share the compatibility matrix page.
I will leave this between you and @webbnh to decide what makes more sense from development workflow. Both options work for me.
Helm 3 remains available for existing workflows. This adds a separate ConsoleCLIDownload resource so both versions appear on the CLI downloads page. Update Helm 4 latest link. Co-authored-by: Cursor <cursoragent@cursor.com>
d674c34 to
b16ee7e
Compare
Align the first sentence with Helm 4 wording and add a note encouraging customers to upgrade to Helm 4, as Helm 3 will not be compatible with future OCP releases. Co-authored-by: Cursor <cursoragent@cursor.com>
|
@sowmya-sl: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
webbnh
left a comment
There was a problem hiding this comment.
This looks good for now. Let's merge it as is and then open another PR to work on the Helm v4 download link: we should make it point to the directory which contains all the versions, and we should change the link text to something like "Helm v4 Downloads Directory".
/lgtm
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: sowmya-sl, webbnh The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
/verified by CI |
|
@webbnh: This PR has been marked as verified by DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
@sowmya-sl (or @spadgett or anyone else with write access to the repo...), I believe that the Jira for this PR is OSDOCS-20110. If you could fix the title and ask the bot to confirm it, we can move this PR closer to merging.... |
Helm 3 remains available for existing workflows. This adds a separate ConsoleCLIDownload resource so both versions appear on the CLI downloads page.
Reviewers and assignees:
Summary by CodeRabbit
Summary by CodeRabbit