docs(api): clarify env var key constraints for env-from fields#137283
Conversation
|
Welcome @LarytheLord! |
|
This issue is currently awaiting triage. If a SIG or subproject determines this is a relevant issue, they will accept it by applying the The 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. |
|
Hi @LarytheLord. Thanks for your PR. I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
|
Release-note block has been added ( Since this is my first PR in |
|
This PR may require API review. If so, when the changes are ready, complete the pre-review checklist and request an API review. Status of requested reviews is tracked in the API Review project. |
|
/assign thockin Quick follow-up for maintainers: This PR only updates API field descriptions for clarity (no behavior/schema changes). If appropriate, could a Kubernetes org member help with:
I can adjust wording further if preferred. |
|
/approve cancel Small clarifier: this PR is comments-only (no API schema/behavior/defaulting change), and just aligns internal wording with the already-clear external wording for env-from key constraints. If this looks reasonable, a quick |
|
/ok-to-test |
|
LGTM label has been added. DetailsGit tree hash: d5d9081c4582f0bfb9dd7d8eaa65a0f3125c13de |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: thockin 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 |
What this PR does
Removes stale
C_IDENTIFIERwording from three core API comments and aligns them with the current env-var key wording used elsewhere in core types and generated API docs.Updated fields:
EnvFromSource.PrefixContainer.EnvFromEphemeralContainerCommon.EnvFromNew wording:
may consist of any printable ASCII characters except '='.Why
pkg/apis/core/types.gostill had a few legacyC_IDENTIFIERreferences while related env-var comments already use the newer wording (for exampleEnvVar.Name,FileKeySelector.Key, and correspondingcore/v1comments). This PR makes those remaining comments consistent.Ref: kubernetes/website#51187
Verification
hack/update-openapi-spec.shon this branch.git statusclean after generation).