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

Refresh documentation for waitForPodsReady #2541

Merged
merged 10 commits into from
Jul 8, 2024
Merged

Refresh documentation for waitForPodsReady #2541

merged 10 commits into from
Jul 8, 2024

Conversation

mimowo
Copy link
Contributor

@mimowo mimowo commented Jul 5, 2024

What type of PR is this?

/kind documentation
/kind cleanup

What this PR does / why we need it:

  • To fix the documentation of some of the fields. In particular this is no longer true, since blockAdmission can be false
  • To rename the user-facing name of the feature to make the feature more discoverable. Most users want to achieve "all-or-nothing scheduling", rather than enable "Sequential admission", so the current names makes it hard to find

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Other names of the feature / admin task considered:

  1. Setup Timeout-based all-or-nothing
  2. Setup Workload startup time

Any of these works for me.

Does this PR introduce a user-facing change?

Improve the documentation for the waitForPodsReady

@mimowo
Improve docs for Wait For Pods Ready
d91bd1f
@mimowo
Improve documentation for wait for pods ready
74fca05 
- Fix / improve field comments for the API
- Rename the user-facing name of the feature to "all-or-nothing with ready Pods"
@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jul 5, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mimowo

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 approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 5, 2024
@netlify Netlify
Copy link

netlify bot commented Jul 5, 2024 •
edited
Loading

✅ Deploy Preview for kubernetes-sigs-kueue canceled.

Name Link
🔨 Latest commit 27b0944
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/668bca8d222dc90008c90ed6

@mimowo
Copy link
Contributor Author

mimowo commented Jul 5, 2024

/cc @alculquicondor @mwielgus @PBundyra

alculquicondor
alculquicondor reviewed Jul 5, 2024
View reviewed changes
site/static/_redirects Outdated Show resolved Hide resolved
apis/config/v1beta1/configuration_types.go Outdated
// and defaults to true otherwise.
// BlockAdmission when true, cluster queue will block admissions for all
// subsequent jobs until the jobs reach the PodsReady=true condition.
// It defaults to false if Enable is false and defaults to true otherwise.
Copy link
Contributor

Choose a reason for hiding this comment

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

uhm...
Maybe we can say that this setting is only honored if Enable is set to true, instead of playing words about what the default is.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adjusted. I hope we could also make the defaulting logic simpler in the future. maybe just set it to false regardless or Enable?

PBundyra
PBundyra reviewed Jul 8, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
mimowo and others added 8 commits July 8, 2024 10:01
@mimowo
Review remarks
305280b
@mimowo @PBundyra
Update site/content/en/docs/tasks/manage/setup_wait_for_pods_ready.md
b1a08a1 
Co-authored-by: Patryk Bundyra <73306396+PBundyra@users.noreply.github.com>
@mimowo @PBundyra
Update site/content/en/docs/tasks/manage/setup_wait_for_pods_ready.md
25ae003 
Co-authored-by: Patryk Bundyra <73306396+PBundyra@users.noreply.github.com>
@mimowo @PBundyra
Update site/content/en/docs/overview/_index.md
2b6f72b 
Co-authored-by: Patryk Bundyra <73306396+PBundyra@users.noreply.github.com>
@mimowo @PBundyra
Update site/content/en/docs/concepts/workload.md
0735401 
Co-authored-by: Patryk Bundyra <73306396+PBundyra@users.noreply.github.com>
@mimowo @PBundyra
Update README.md
6e09c3d 
Co-authored-by: Patryk Bundyra <73306396+PBundyra@users.noreply.github.com>
@mimowo
Update docs
3158db3
@mimowo
revert adding of tag
27b0944
tenzen-y
tenzen-y reviewed Jul 8, 2024
View reviewed changes
Copy link
Member

@tenzen-y tenzen-y left a comment

Choose a reason for hiding this comment

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

Great documentation improvements!
Thank you!

LGTM

@PBundyra
Copy link
Contributor

PBundyra commented Jul 8, 2024

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 8, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 333c50da5a80c445e0171b9faf9d040158f4b7b2

@k8s-ci-robot k8s-ci-robot merged commit b70fdcd into kubernetes-sigs:main Jul 8, 2024
16 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v0.8 milestone Jul 8, 2024
@tenzen-y
Copy link
Member

tenzen-y commented Jul 8, 2024

/cherry-pick website

@k8s-infra-cherrypick-robot
Copy link

@tenzen-y: new pull request created: #2554

In response to this:

/cherry-pick website

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-infra-cherrypick-robot k8s-infra-cherrypick-robot mentioned this pull request Jul 8, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alculquicondor alculquicondor alculquicondor left review comments

@tenzen-y tenzen-y tenzen-y left review comments

@PBundyra PBundyra PBundyra left review comments

@kerthcet kerthcet Awaiting requested review from kerthcet

@mwielgus mwielgus Awaiting requested review from mwielgus

Assignees

@PBundyra PBundyra

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/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
v0.8
Development

Successfully merging this pull request may close these issues.
6 participants
@mimowo @k8s-ci-robot @PBundyra @tenzen-y @k8s-infra-cherrypick-robot @alculquicondor