Skip to content
New issue

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

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

Already on GitHub? # to your account

Be more clear on the expected format of --wait option #3419

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

Conversation

radeksm
Copy link

@radeksm radeksm commented Nov 13, 2023

This is just a very minor follow up on this pull request 3418.

kind create cluster --help does not explain what is expected format of --wait option. This is documented well in site/content/docs/user/quick-start.md but this simple change to command line help is going to save some time and confusion.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 13, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: radeksm
Once this PR has been reviewed and has the lgtm label, please assign aojea 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

@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 Nov 13, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @radeksm. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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 the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 13, 2023
Copy link
Member

@neolit123 neolit123 left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 13, 2023
@neolit123
Copy link
Member

/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 Nov 13, 2023
@radeksm
Copy link
Author

radeksm commented Nov 13, 2023

/test pull-kind-e2e-kubernetes-1-24

@stmcginnis
Copy link
Contributor

/lgtm

@BenTheElder
Copy link
Member

FWIW, this problem exists in kubectl as well, e.g. kubectl wait --help --timeout docs, these are go https://pkg.go.dev/time#Duration if we want to be more specific.

This change seems fine, but I prefer to align with kubectl where possible on the CLI flags and behaviors for consistency, maybe we need (or have already and can just reference?) a kubernetes.io docs page to cover these duration strings, they're used in other places in the project.

@radeksm
Copy link
Author

radeksm commented Nov 14, 2023

FWIW, this problem exists in kubectl as well, e.g. kubectl wait --help --timeout docs, these are go https://pkg.go.dev/time#Duration if we want to be more specific.

This change seems fine, but I prefer to align with kubectl where possible on the CLI flags and behaviors for consistency, maybe we need (or have already and can just reference?) a kubernetes.io docs page to cover these duration strings, they're used in other places in the project.

@BenTheElder I will create new pull req to adjust in for kubectl so we can make it more clear and consistent.

Actually the same kind of inconsistency exists in kubectl on blow three subcommands too:

kubectl drain --timeout=...
kubectl wait  --timeout=...
kubectl delete  --timeout=...

@radeksm
Copy link
Author

radeksm commented Nov 14, 2023

/test pull-kind-e2e-kubernetes-1-24
/test pull-kind-e2e-kubernetes-1-25

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 14, 2023
@k8s-ci-robot
Copy link
Contributor

New changes are detected. LGTM label has been removed.

@radeksm
Copy link
Author

radeksm commented Nov 15, 2023

/retest

@radeksm
Copy link
Author

radeksm commented Nov 15, 2023

/test pull-kind-e2e-kubernetes-1-24

3 similar comments
@radeksm
Copy link
Author

radeksm commented Nov 15, 2023

/test pull-kind-e2e-kubernetes-1-24

@radeksm
Copy link
Author

radeksm commented Nov 16, 2023

/test pull-kind-e2e-kubernetes-1-24

@radeksm
Copy link
Author

radeksm commented Nov 16, 2023

/test pull-kind-e2e-kubernetes-1-24

@aojea
Copy link
Contributor

aojea commented Nov 16, 2023

1.24 seems to be permanently failing https://prow.k8s.io/pr-history/?org=kubernetes-sigs&repo=kind&pr=3419, keep retesting is not going to solve the problem ;)

@radeksm
Copy link
Author

radeksm commented Nov 16, 2023

1.24 seems to be permanently failing https://prow.k8s.io/pr-history/?org=kubernetes-sigs&repo=kind&pr=3419, keep retesting is not going to solve the problem ;)

Yeahhh but it seems to be not related to my change and I thought it's some CI problem with lack of resources. It was the same with pull-kind-e2e-kubernetes-1-25 which eventually passed.
Sorry but I am not familiar with the CI.

@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Nov 16, 2023

@radeksm: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-kind-e2e-kubernetes-1-24 56db128 link true /test pull-kind-e2e-kubernetes-1-24

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

Copy link
Member

@BenTheElder BenTheElder left a comment

Choose a reason for hiding this comment

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

... we (=kind approvers) really should've gotten back to this PR a very long time ago, apologies, I have mostly been chasing bug fixes and debugging when I have time, I'm aiming to make sure we keep up with the PR backlog going forward.

I have one minor correction request, if you're not available after some time given the duration we can apply it in a follow-up so as to retain the attribution for this commit.

@@ -83,7 +83,7 @@ func NewCommand(logger log.Logger, streams cmd.IOStreams) *cobra.Command {
&flags.Wait,
"wait",
time.Duration(0),
"wait for control plane node to be ready (default 0s)",
"the length of time to wait for control plane node to be ready (default 0s). Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"the length of time to wait for control plane node to be ready (default 0s). Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.",
"the length of time to wait for control plane node to be ready (default 0s). Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't wait.",

(I see this is 1:1 from kubectl, we are doing something slightly different here so one small tweak)

@BenTheElder BenTheElder assigned aojea and BenTheElder and unassigned neolit123 Jan 23, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants