Repository navigation
fix(docs): use v2.3.0 in the installation guide - #4334
Merged
google-oss-prow[bot] merged 1 commit intoOct 27, 2026
Merged
Conversation
The installation guide pinned VERSION=v2.1.0, but the commands below it
pass --set runtimes.* and --set crds.enabled. Chart 2.1.0 has neither
key and no values.schema.json, so Helm ignores them and no
ClusterTrainingRuntimes are installed.
Bump VERSION to v2.3.0 in installation.md and data-cache.md, and add a
?ref=${VERSION} command for the built-in runtimes overlay so the
released-version kustomize path does not mix released CRDs with
runtimes from master.
Fixes kubeflow#4310
Assisted-by: Claude <[email protected]>
Signed-off-by: YoungjuKim <[email protected]>
andreyvelich
left a comment
andreyvelich
left a comment
Member
There was a problem hiding this comment.
Thanks @fjvbn2003!
/ok-to-test
/lgtm
/approve
Contributor
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: andreyvelich The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
The installation guide pins
VERSION=v2.1.0, but the--set runtimes.*and--set crds.enabledcommands on the same page need chart 2.2.0 and 2.3.0. Chart 2.1.0 has neither key and novalues.schema.json, so Helm ignores them and following the guide installs no runtimes. As discussed in #4310, this PR moves the guide to v2.3:VERSIONtov2.3.0(the latest release) indocs/operator-guides/installation.mdanddocs/user-guides/data-cache.md;?ref=${VERSION}command for the built-in runtimes overlay and keeps themasterone under "For the latest changes run", the same way the manager overlay is already shown.The chart README is not changed (see #3807).
How I tested:
2.3.0is published atoci://ghcr.io/kubeflow/charts/kubeflow-trainer, thatvalues.yamlatv2.3.0has thecrdsandruntimeskeys (and atv2.1.0has neither), and thatmanifests/overlays/runtimesandmanifests/overlays/data-cacheexist atv2.3.0.python:3.12-slimcontainer, matching.readthedocs.yaml(Python 3.12,fail_on_warning: true):master(8e07676) and with this change. The renderedinstallation.htmlanddata-cache.htmlshowexport VERSION=v2.3.0and the newruntimes?ref=${VERSION}command.git diff --checkis clean (no trailing whitespace; files end with a newline). There is no markdown linter in.pre-commit-config.yaml.AI assistance: Claude helped find this and draft the change, and the checks above were run with its help. The commit has an
Assisted-bytrailer.Which issue(s) this PR fixes (optional, in
Fixes #<issue number>, #<issue number>, ...format, will close the issue(s) when PR gets merged):Fixes #4310
Checklist:
🤖 Generated with Claude Code