Add configurable grace period to probes

[ehashman]

Enhancement Description

• One-line enhancement description (can be used as a release note): Add configurable gracePeriodSeconds field to liveness probes
• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/tree/master/keps/sig-node/2238-liveness-probe-grace-period
• Discussion Link: terminationGracePeriodSeconds is overloaded kubernetes#64715 (comment)
• Primary contact (assignee): @rphillips
• Responsible SIGs: SIG Node
• Enhancement target (which target equals to which milestone):
  • Alpha release target (x.y): 1.21
  • Beta release target (x.y): 1.22
  • Stable release target (x.y): 1.28
• Alpha
  • KEP (k/enhancements) update PR(s):
    • Configurable probe termination grace periods #2241
  • Code (k/k) update PR(s):
    • Add Probe-level terminationGracePeriodSeconds kubernetes#99375
  • Docs (k/website) update PR(s):
    • Add documentation for Liveness Probe Grace Periods website#27084
• Beta
  • KEP (k/enhancements) update PR(s):
    • Update probe grace period KEP to beta #2638
  • Code (k/k) update PR(s):
    • Fix TerminationGracePeriodSeconds is negative (part 1) kubernetes#98866
    • Fix pkg/api/pod/util tests to ensure feature gate is set kubernetes#103420
    • Code changes for Probe-level Termination Grace Period Beta kubernetes#103168
    • Add validation for Prober TerminationGracePeriodSeconds kubernetes#103245
    • feat: set ProbeTerminationGracePeriod default to true kubernetes#108541
    • Add unit tests for grace period in killContainer func kubernetes#110733
  • Docs (k/website) update(s):
    • KEP-2238 probe-level grace period changes for beta/1.22 website#28930
    • [dev-1.25] Update feature gate docs for probe-level termination grace period website#34665
• Stable
  • KEP (k/enhancements) update PR(s): bump probe termination to ga for 1.28 (missed 1.27) #3986
  • Code (k/k) update PR(s): ProbeTerminationGracePeriod promote to GA kubernetes#114307
  • Docs (k/website) update(s):

/sig node

[ehashman]

/milestone v1.21

[arunmk]

@ehashman I am one of the enhancement shadows for v1.21 and am reviewing this KEP. We have the enhancements freeze coming up on 2/9. Could you mention if PR #2241 be merged by then?

I looked at the PR and things seem ok from a KEP standpoint with the exception of the empty Graduation Criteria section. We will be needing that also to be present (for the current alpha phase at least) at the enhancements freeze deadline.

Thanks!

[arunmk]

Hi @ehashman

Enhancements Freeze is 1 day away, Feb 9th EOD PST

Enhancements team is aware that KEP update is currently in progress (PR #2241). I do not see a graduation criteria section in the PR and will need some details. The KEP looks good.

Any enhancements that do not complete the following requirements by the freeze will require an exception.

Assuming that the PR is merged, this would be the state of the KEP:
[DONE] The KEP must be merged in an implementable state
[DONE] The KEP must have test plans
[DONE] The KEP must have graduation criteria: this is missing in the PR
[DONE] The KEP must have a production readiness review

EDIT: updated with new commit in the PR. Note that the PR still needs to be merged by the enhancements freeze.

[ehashman]

Done; this was sort of implicit and I have added it explicitly.

[arunmk]

Thanks @ehashman. I will update the earlier status inline. (I'm not sure how rigorously the template is to be followed, but it is useful to follow it for the first few iterations so that we know what issues would arise).

[arunmk]

Hi @ehashman,

Since your Enhancement is scheduled to be in 1.21, please keep in mind the important upcoming dates:

• Tuesday, March 9th: Week 9 - Code Freeze
• Tuesday, March 16th: Week 10 - Docs Placeholder PR deadline
  • If this enhancement requires new docs or modification to existing docs, please follow the steps in the Open a placeholder PR doc to open a PR against k/website repo.

As a reminder, please link all of your k/k PR(s) and k/website PR(s) to this issue so we can track them.

Thanks!

[ehashman]

Thanks @arunmk, I was hoping to have some code out for this last week but didn't get a chance to work on it. Hoping today or tomorrow...

[arunmk]

Hi @ehashman ,

Enhancements team is currently tracking the following PR

• Add Probe-level terminationGracePeriodSeconds kubernetes#99375

I went through the review comments and there are a few comments requiring some decisions and there is also an api-review initiated. This is the only PR but it is a fairly large one at 15 KLOC. Since there are a few decision points and some test related comments, and also since the code freeze is one week away at 3/9, I am tagging this as At Risk for now.

Please do let me know if you think otherwise and the tag can be revised.

Thanks!

[arunmk]

Hi @ehashman,

A friendly reminder that Code freeze is 4 days away, March 9th EOD PST

Any enhancements that are NOT code complete by the freeze will be removed from the milestone and will require an exception to be added back.

Please also keep in mind that if this enhancement requires new docs or modification to existing docs, you'll need to follow the steps in the Open a placeholder PR doc to open a PR against k/website repo by March 16th EOD PST

Thanks!

[annajung]

Hi @ehashman, with code freeze now in effect, we are removing this enhancement from 1.21 release due to kubernetes/kubernetes#99375 not being merged or approved.

Feel free to file an exception to add this back into the release. thanks!

[ehashman]

Hi @annajung,

This was basically approved, but the API reviewer didn't do a /approve to make it Official. I just finished rebasing the PR and I will have reviewers take another look today. Will you still need me to send a full exception email? Landing this PR (+ docs) is the only requirement for alpha graduation.

[ehashman]

Filed exception request: https://groups.google.com/g/kubernetes-sig-node/c/fg6Gd8m9jHc/m/u6KOEZYwAAAJ

[annajung]

Hi @ehashman, with kubernetes/kubernetes#99375 merged in, we're marking this as code complete for the 1.21 release. Thank you

[ehashman]

/milestone v1.22

[SergeyKanzhelev]

/milestone v1.28

[SergeyKanzhelev]

/label lead-opted-in

[npolshakova]

Hi @rphillips @ehashman 👋, 1.28 Enhancements team here!

Just checking in as we approach enhancements freeze on 01:00 UTC Friday, 16th June 2023.

This enhancement is targeting for stage stable for 1.28 (correct me, if otherwise.)

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: 1.28
• KEP readme has a updated detailed test plan section filled out
• KEP readme has up to date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements.

The status of this enhancement is marked as tracked 🎉. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

[AdminTurnedDevOps]

Hey @ehashman

1.28 Docs Shadow here.

Does this enhancement work planned for 1.28 require any new docs or modification to existing docs?

If so, please follows the steps here to open a PR against dev-1.28 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday 20th July 2023.

Also, take a look at Documenting for a release to get yourself familiarize with the docs requirement for the release.

Thank you!

[Rishit-dagli]

Hey @ehashman , could you please create a docs PR even if it is a draft PR with no content yet against dev-1.28 branch in the k/website repo. The deadline to create this draft PR is Thursday 20th July 2023.

[aramase]

Hey again @rphillips👋

Just checking in as we approach Code freeze at 01:00 UTC Friday, 19th July 2023 .

Here’s the enhancement’s state for the upcoming code freeze:

• All the PRs that are related to your enhancement are linked in the above issue description (for tracking purposes). This includes code, tests, and documentation related PR/s.
• All code related PR/s are merged or are in merge-ready state ( i.e they have approved and lgtm labels applied) by the code freeze deadline. This includes any tests related PR/s too.

I don't see any code (k/k) update PR(s) in the issue description so if there are any k/k related PR(s) that we should be tracking for this KEP please link them in the issue description above.

As always, we are here to help if any questions come up. Thanks!

[Atharva-Shinde]

Hey @ehashman @rphillips @SergeyKanzhelev I don't see any implementation i.e code related PRs(merged or open) that are associated with this KEP for the current v1.28 milestone. But if there are code PRs that were merged/merge-ready state then please link all the related PRs ASAP. Until then unfortunately this enhancement is being removed from the v1.28 milestone.

If you still wish to progress this enhancement in v1.28, please file an exception request. Thanks!

/milestone clear

[sftim]

kubernetes/kubernetes#114307 has merged. If we are graduating this feature, we'll need accompanying docs PRs.

[SergeyKanzhelev]

@rphillips can you please update docs and than close this KEP issue?

[SergeyKanzhelev]

/milestone v1.28

Reapplying 1.28 to keep the metadata consistent. Since the product code was changed we just need to close on this by updating docs

[npolshakova]

Removing this from the project board as it's not targeting the 1.29 milestone
/remove-label lead-opted-in

[salehsedghpour]

Hello 👋 1.30 Enhancements Lead here,

I'm closing milestone 1.28 now,
If you wish to progress this enhancement in v1.30, please follow the instructions here to opt in the enhancement and make sure the lead-opted-in label is set so it can get added to the tracking board and finally add /milestone v1.30. Thanks!

/milestone clear

[k8s-triage-robot]

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

This bot triages un-triaged issues 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 issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

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

/lifecycle stale

[k8s-triage-robot]

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

This bot triages un-triaged issues 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 issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle rotten
• Close this issue with /close
• Offer to help out with Issue Triage

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

/lifecycle rotten

[k8s-triage-robot]

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

This bot triages issues 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 issue is closed

You can:

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

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

/close not-planned

[k8s-ci-robot]

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to this:

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

This bot triages issues 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 issue is closed

You can:

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

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

/close not-planned

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.