Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update API comment for nodeName to match system behavior #124062

Merged
merged 1 commit into from Apr 18, 2024
Merged

Update API comment for nodeName to match system behavior #124062

merged 1 commit into from Apr 18, 2024

Conversation

alculquicondor
Copy link
Member

What type of PR is this?

/kind documentation

What this PR does / why we need it:

In light of kubernetes/enhancements#3521 (comment), updating API documentation to reflect the system behavior.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. kind/documentation Categorizes issue or PR as related to documentation. area/code-generation cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 26, 2024
@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/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. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Mar 26, 2024
@alculquicondor
Copy link
Member Author

/label api-review

@k8s-ci-robot k8s-ci-robot added the api-review Categorizes an issue or PR as actively needing an API review. label Mar 26, 2024
@alculquicondor
Copy link
Member Author

/assign @liggitt

liggitt
liggitt reviewed Mar 26, 2024
View reviewed changes
staging/src/k8s.io/api/core/v1/types.go Outdated
// requirements.
// NodeName indicates in which node this pod is scheduled.
// If empty, this pod is a candidate for scheduling by the scheduler defined in schedulerName.
// If it is non-empty, the kubelet for this node becomes responsible for the lifecycle of this pod.
Copy link
Member

Choose a reason for hiding this comment

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

we could also mention using nodeSelector and affinity.nodeAffinity to target specific nodes while still allowing scheduling to work.

Copy link
Member Author

Choose a reason for hiding this comment

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

Could I just link to the website documentation instead?

Copy link
Member

Choose a reason for hiding this comment

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

A link out is fine, but some indication this is the wrong field to use if you want scheduling involved seems important

Copy link
Member Author

Choose a reason for hiding this comment

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

Added

kannon92
kannon92 reviewed Mar 26, 2024
View reviewed changes
pkg/apis/core/types.go Outdated Show resolved Hide resolved
@alculquicondor
Update API comment for nodeName to match system behavior
1a2dba4 
Change-Id: I039b441f4525d280b1ea693d782fe0f43794d9f7
@leilajal
Copy link
Contributor

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Mar 26, 2024
@alculquicondor
Copy link
Member Author

/retest

@liggitt
Copy link
Member

liggitt commented Mar 26, 2024

/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 26, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 3d60275c75e6d9fc93d68b9d1b57c5f83f5699fa

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alculquicondor, liggitt

The full list of commands accepted by this bot can be found here.

The pull request process is described here

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 26, 2024
@k8s-ci-robot k8s-ci-robot merged commit dbaf5d6 into kubernetes:master Apr 18, 2024
14 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.31 milestone Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@liggitt liggitt liggitt left review comments

@kannon92 kannon92 kannon92 left review comments

@derekwaynecarr derekwaynecarr Awaiting requested review from derekwaynecarr

@roycaihw roycaihw Awaiting requested review from roycaihw

Assignees

@liggitt liggitt

Labels
api-review Categorizes an issue or PR as actively needing an API review. approved Indicates a PR has been approved by an approver from all required OWNERS files. area/code-generation 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 kind/documentation Categorizes issue or PR as related to documentation. 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. 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/S Denotes a PR that changes 10-29 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
API Reviews
Status: API review completed, 1.31
SIG Apps
Status: Done
Milestone
v1.31
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@alculquicondor @leilajal @liggitt @k8s-ci-robot @kannon92