Skip to content

docs(api): clarify env var key constraints for env-from fields#137283

Merged
k8s-ci-robot merged 1 commit intokubernetes:masterfrom
LarytheLord:docs/envvar-c-identifier-wording-51187
Mar 4, 2026
Merged

docs(api): clarify env var key constraints for env-from fields#137283
k8s-ci-robot merged 1 commit intokubernetes:masterfrom
LarytheLord:docs/envvar-c-identifier-wording-51187

Conversation

@LarytheLord
Copy link
Copy Markdown
Contributor

@LarytheLord LarytheLord commented Feb 27, 2026

What this PR does

Removes stale C_IDENTIFIER wording 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.Prefix
  • Container.EnvFrom
  • EphemeralContainerCommon.EnvFrom

New wording: may consist of any printable ASCII characters except '='.

Why

pkg/apis/core/types.go still had a few legacy C_IDENTIFIER references while related env-var comments already use the newer wording (for example EnvVar.Name, FileKeySelector.Key, and corresponding core/v1 comments). This PR makes those remaining comments consistent.

Ref: kubernetes/website#51187

Verification

  • Ran hack/update-openapi-spec.sh on this branch.
  • No additional generated-file deltas were produced (git status clean after generation).
NONE

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Feb 27, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Welcome @LarytheLord!

It looks like this is your first PR to kubernetes/kubernetes 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kubernetes has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Details

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 kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 27, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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 kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-priority Indicates a PR lacks a `priority/foo` label and requires one. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 27, 2026
@k8s-ci-robot k8s-ci-robot added kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API sig/apps Categorizes an issue or PR as relevant to SIG Apps. and removed do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. labels Feb 27, 2026
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. label Feb 27, 2026
@github-project-automation github-project-automation bot moved this to Needs Triage in SIG Apps Feb 27, 2026
@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Feb 27, 2026
@LarytheLord
Copy link
Copy Markdown
Contributor Author

Release-note block has been added (NONE).

Since this is my first PR in kubernetes/kubernetes, could a Kubernetes org member please take a quick look and, if appropriate, run /ok-to-test?

@k8s-triage-robot
Copy link
Copy Markdown

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.

@LarytheLord
Copy link
Copy Markdown
Contributor Author

/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:

  • /ok-to-test
  • triage/priority labels (/triage accepted, /priority backlog)

I can adjust wording further if preferred.

@LarytheLord
Copy link
Copy Markdown
Contributor Author

/approve cancel
/sig api-machinery
/assign liggitt

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 would unblock it.

@k8s-ci-robot k8s-ci-robot added the sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. label Feb 27, 2026
@seans3
Copy link
Copy Markdown
Contributor

seans3 commented Mar 3, 2026

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 3, 2026
Copy link
Copy Markdown
Member

@thockin thockin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 4, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

LGTM label has been added.

DetailsGit tree hash: d5d9081c4582f0bfb9dd7d8eaa65a0f3125c13de

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[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

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 4, 2026
@k8s-ci-robot k8s-ci-robot merged commit f82c373 into kubernetes:master Mar 4, 2026
13 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.36 milestone Mar 4, 2026
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in SIG Apps Mar 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/apps Categorizes an issue or PR as relevant to SIG Apps. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

7 participants