fix: correct cleanPodPolicy default in generated docs - #827
Merged
google-oss-prow[bot] merged 1 commit intoJul 9, 2026
Merged
Conversation
immanuwell
force-pushed
the
fix/cleanpodpolicy-default-docs
branch
from
July 4, 2026 10:22
bef611e to
f9b3b2b
Compare
Member
|
@immanuwell Thank you for your contribution, it seems that generated codes are out dated. Can you verify and fix that? https://github.com/kubeflow/mpi-operator/actions/runs/28703199713/job/85237964347?pr=827 |
Signed-off-by: immanuwell <pchpr.00@list.ru>
immanuwell
force-pushed
the
fix/cleanpodpolicy-default-docs
branch
from
July 8, 2026 16:47
f9b3b2b to
e06e925
Compare
Member
Author
|
@tenzen-y done, regenerated it, PTAL |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: tenzen-y 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
2 participants
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.
Problem
SetDefaults_MPIJobdefaults omittedcleanPodPolicytoNone, but the shipped CRD, deploy yaml, swagger, and python sdk docs sayRunning.That is a pretty easy footgun in the wild.
Fix
Update the source comment and regenerate the published API surfaces so they all say
Defaults to None.Repro
pkg/apis/kubeflow/v2beta1/default.goand seepolicy.CleanPodPolicy = ptr.To(CleanPodPolicyNone).deploy/v2beta1/mpi-operator.yaml, and seeDefault to Running.spec.runPolicy.cleanPodPolicyin anMPIJob. The real default isNone, so the docs were off.Validation
go test ./pkg/apis/kubeflow/v2beta1 ./pkg/apis/kubeflow/validation ./pkg/controller