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

Wrong explanation of initialDelaySeconds in configuring Probes #48519

Open
qiyueyao opened this issue Oct 23, 2024 · 4 comments · May be fixed by #48536
Open

Wrong explanation of initialDelaySeconds in configuring Probes #48519

qiyueyao opened this issue Oct 23, 2024 · 4 comments · May be fixed by #48536
Assignees
@qiyueyao
Labels
needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.

Comments

@qiyueyao
Copy link

qiyueyao commented Oct 23, 2024 •
edited
Loading

This is a Bug Report

Problem: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes mentioned If the value of periodSeconds is greater than initialDelaySeconds then the initialDelaySeconds will be ignored. However, in fact, initialDelaySeconds will not be ignored. Code Reference

Proposed Solution:
Remove this sentence, or modify the explanation to the correct one.

Page to Update:
https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/

Additional Information:
Affecting all /language.
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Oct 23, 2024
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

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-sigs/prow repository.

@qiyueyao qiyueyao mentioned this issue Oct 23, 2024
Closed
@tnqn
Copy link
Member

tnqn commented Oct 24, 2024

@qiyueyao The link of "Code Reference" seems wrong. To clarify a bit the observation that "the first probe happens around initialDelaySeconds+periodSeconds": the probe doesn't wait for initialDelaySeconds to start; it starts immediately but is canceled if the container hasn’t been running for the duration of initialDelaySeconds. Therefore, the 1st probe happens after initialDelaySeconds but not necessarily after initialDelaySeconds+periodSeconds.

@qiyueyao
Copy link
Author

@qiyueyao The link of "Code Reference" seems wrong. To clarify a bit the observation that "the first probe happens around initialDelaySeconds+periodSeconds": the probe doesn't wait for initialDelaySeconds to start; it starts immediately but is canceled if the container hasn’t been running for the duration of initialDelaySeconds. Therefore, the 1st probe happens after initialDelaySeconds but not necessarily after initialDelaySeconds+periodSeconds.

Thanks this explains better, I have updated code reference.

@qiyueyao qiyueyao linked a pull request Oct 24, 2024 that will close this issue
Open
@T-Lakshmi
Copy link
Contributor

/assign @qiyueyao

PR working on this issue #48536

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

@qiyueyao qiyueyao

Labels
needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Remove incorrect/vague explanation of probe config qiyueyao/website
4 participants
@tnqn @k8s-ci-robot @qiyueyao @T-Lakshmi