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

docs: update doc around fetching unscheduled pods using --node= #2359

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update doc around fetching unscheduled pods using --node= #2359

wants to merge 1 commit into from

Conversation

CatherineF-dev
Copy link
Contributor

@CatherineF-dev CatherineF-dev commented Apr 3, 2024 •
edited

What this PR does / why we need it:

How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality) n/a

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #2353

@k8s-ci-robot k8s-ci-robot requested a review from mrueg April 3, 2024 12:13
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 3, 2024
@k8s-ci-robot k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 3, 2024
@dgrisonnet
Copy link
Member

/assign

@dgrisonnet
Copy link
Member

/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 Apr 4, 2024
mrueg
mrueg reviewed Apr 9, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: CatherineF-dev
Once this PR has been reviewed and has the lgtm label, please ask for approval from dgrisonnet. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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

@mrueg
Copy link
Member

mrueg commented Apr 11, 2024

Sorry, I forgot: The change needs to be made in README.md.tpl and then you'd need to run the make target to regenerate the README file with gomplate.

dgrisonnet
dgrisonnet reviewed Apr 19, 2024
View reviewed changes
README.md Outdated
| KSM --node parameter | FieldSelector | Note |
| --- | --- | --- |
| --node="node1" | kubectl get pods --field-selector spec.nodeName="node1" | Fetch all pods running on node1 |
| --node="" | kubectl get pods --field-selector spec.nodeName= | Fetch all pods without an assigned node |
Copy link
Member

Choose a reason for hiding this comment

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

Similar to my comment in #2373 (comment), I don't think that specifying --node="" is very user friendly.

We could either implicitly do it, or put it in a dedicated flag such as --fetch-unscheduled-pods

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed the documentation to --node= instead of --node="". Will it be clearer? Or we prefer --fetch-unscheduled-pods

@CatherineF-dev CatherineF-dev changed the title docs: update doc around fetching unscheduled pods using --node="" docs: update doc around fetching unscheduled pods using --node= May 9, 2024
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 14, 2024
@mrueg
Copy link
Member

mrueg commented May 16, 2024

Let's add this once #2388 is in.

We can refactor the behavior later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mrueg mrueg mrueg left review comments

@dgrisonnet dgrisonnet dgrisonnet left review comments

@rexagod rexagod Awaiting requested review from rexagod

Assignees

@dgrisonnet dgrisonnet

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

sharding with a deployment with '--resources=pods' and '--node=""' does not fetch pending pods
4 participants
@CatherineF-dev @dgrisonnet @k8s-ci-robot @mrueg