Update types.go to fix resizePolicy documentation for ephemeral conta… #1
Conversation
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
…iners What type of PR is this? /kind documentation What this PR does / why we need it: This PR fixes the incorrect API documentation for the resizePolicy field in the EphemeralContainer struct. It clarifies that the resizePolicy field does not apply to ephemeral containers because they do not support resource requests or limits. These changes ensure accuracy and reduce confusion for Kubernetes users. Which issue(s) this PR fixes: Fixes kubernetes#128384 Special notes for your reviewer: Changes were made to the staging/src/k8s.io/api/core/v1/types.go file. Comments were added to clarify the limitations of the resizePolicy field for ephemeral containers. Does this PR introduce a user-facing change? NONE Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: NONE
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 type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR fixes the incorrect API documentation for the resizePolicy field in the EphemeralContainer struct. It clarifies that the resizePolicy field does not apply to ephemeral containers because they do not support resource requests or limits. These changes ensure accuracy and reduce confusion for Kubernetes users.
Which issue(s) this PR fixes:
Fixes kubernetes#128384
Special notes for your reviewer:
Changes were made to the staging/src/k8s.io/api/core/v1/types.go file.
Comments were added to clarify the limitations of the resizePolicy field for ephemeral containers.
Does this PR introduce a user-facing change?
NONE
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:
NONE