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

kubectl wait --for flag help text improvements #122319

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

kubectl wait --for flag help text improvements #122319

wants to merge 1 commit into from

Conversation

omertuc
Copy link
Contributor

@omertuc omertuc commented Dec 14, 2023 •
edited

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Two changes:

  • Changed wording The default condition-value is true to ...is True
    instead, as in status conditions the status field has a string type
    and not a boolean type. and in the apimachinery meta v1 constant
    ConditionTrue the value is uppercase: "True". Reading it in the
    help text with lowercase gave me the impression that it's a boolean
    value and not a string value, or even if it were a string then that it
    should be lowercase "true". I feel that when it's written in
    uppercase that confusion is eliminated somewhat

  • Added a remark about how generation comparison works. I was stumped by
    why my wait call would timeout, because when I looking at the resource
    condition in practice with kubectl get it seemed to match my wait
    query. I had to dig in the kubectl source code to find that it also
    takes observedGeneration into account to realize I was timing out
    because the condition's generation was not being updated correctly by
    the controller.

Which issue(s) this PR fixes:

N/A

Special notes for your reviewer:

None

Does this PR introduce a user-facing change?

Changed the help text for the kubectl --for flag

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

@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. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Dec 14, 2023
@k8s-ci-robot
Copy link
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.

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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Dec 14, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @omertuc. 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.

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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added needs-priority Indicates a PR lacks a `priority/foo` label and requires one. area/kubectl sig/cli Categorizes an issue or PR as relevant to SIG CLI. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Dec 14, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: omertuc
Once this PR has been reviewed and has the lgtm label, please assign deads2k for approval. 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

@omertuc
kubectl wait --for flag help text improvements
36f3b5d 
Two changes:

* Changed wording `The default condition-value is true` to `...is True`
  instead, as in status conditions the `status` field has a string type
  and not a boolean type. and in the apimachinery meta v1 constant
  `ConditionTrue` the value is uppercase: `"True"`. Reading it in the
  help text with lowercase gave me the impression that it's a boolean
  value and not a string value, or even if it were a string then that it
  should be lowercase `"true"`. I feel that when it's written in
  uppercase that confusion is eliminated somewhat

* Added a remark about how generation comparison works. I was stumped by
  why my wait call would timeout, because when I looking at the resource
  condition in practice with `kubectl get` it seemed to match my `wait`
  query. I had to dig in the `kubectl` source code to find that it also
  takes `observedGeneration` into account to realize I was timing out
  because the condition's generation was not being updated correctly by
  the controller.
@omertuc omertuc mentioned this pull request Dec 14, 2023
Closed
@dims dims added the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Mar 5, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

@k8s-ci-robot
Copy link
Contributor

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

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/test-infra repository.

@omertuc
Copy link
Contributor Author

omertuc commented Apr 4, 2024

/reopen

@k8s-ci-robot
Copy link
Contributor

@omertuc: Reopened this PR.

In response to this:

/reopen

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/test-infra repository.

@k8s-ci-robot k8s-ci-robot reopened this Apr 4, 2024
@omertuc
Copy link
Contributor Author

omertuc commented Apr 4, 2024

/remove-lifecycle rotten

@k8s-ci-robot
Copy link
Contributor

Please note that we're already in Test Freeze for the release-1.30 branch. This means every merged PR will be automatically fast-forwarded via the periodic ci-fast-forward job to the release branch of the upcoming v1.30.0 release.

Fast forwards are scheduled to happen every 6 hours, whereas the most recent run was: Wed Apr 3 02:18:49 UTC 2024.

@k8s-ci-robot k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Apr 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ardaguclu ardaguclu Awaiting requested review from ardaguclu

@seans3 seans3 Awaiting requested review from seans3

Assignees
No one assigned
Labels
area/kubectl cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. 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. release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/cli Categorizes an issue or PR as relevant to SIG CLI. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
SIG CLI
Status: In Progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@omertuc @k8s-ci-robot @k8s-triage-robot @dims