KEP 4960: Container Stop Signals #49857
Conversation
k8s-ci-robot
added
cncf-cla: yes
k8s-ci-robot
added
the
size/S
k8s-ci-robot
added
needs-rebase
sreeram-venkitesh
force-pushed
the
4960-container-stop-signals
branch
from
5ae9029 to
76aad78
Compare
k8s-ci-robot
removed
the
needs-rebase
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
k8s-ci-robot
added
size/S
👷 Deploy Preview for kubernetes-io-vnext-staging processing.
|
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
k8s-ci-robot
added
the
do-not-merge/work-in-progress
| @@ -47,6 +47,11 @@ parameters are passed to the handler. | |||
| A more detailed description of the termination behavior can be found in | |||
| [Termination of Pods](/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination). | |||
|
|
|||
| `StopSignal` | |||
There was a problem hiding this comment.
This isn't a hook; it's a separate part of Pod lifecycle configuration.
(I'm disagreeing with the KEP, here, which calls it a hook; however, a hook such as preStop is very different from specifying a signal to be emitted).
I recommend you add a new detail within https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination
Mention that even if you don't specify a stop signal within the Pod manifest:
- the container runtime attempts to signal graceful termination
- the signalling mechanism is OS-dependent
and then, do mention that you can customise the signal for Linux Pods, by adding a StopSignal entry within lifecycle:
The https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/ page should link to Pod termination (but it already does, so no special change needed). The Pod termination page should also link to https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/ (but it already does, so no special change needed there either).
| defaultValue: false | ||
| fromVersion: "1.33" | ||
| --- | ||
| Enables usage of the StopSignal lifecycle hook for containers for configuring custom [stop signals](https://docs.docker.com/reference/dockerfile/#stopsignal) using which the containers would be stopped. |
There was a problem hiding this comment.
Don't link to Docker documentation; link to Kubernetes docs instead.
| The StopSignal hook can be used to define a stop signal which would be sent to the container when it is | ||
| stopped. This is equivalent to the `STOPSIGNAL` instruction that we configure when building container images. |
There was a problem hiding this comment.
Prepend “For Linux Pods“ here.
| `StopSignal` | ||
|
|
||
| The StopSignal hook can be used to define a stop signal which would be sent to the container when it is | ||
| stopped. This is equivalent to the `STOPSIGNAL` instruction that we configure when building container images. |
There was a problem hiding this comment.
Is this correct?
| stopped. This is equivalent to the `STOPSIGNAL` instruction that we configure when building container images. | |
| stopped. If you set this, it overrides any `STOPSIGNAL` instruction defined within the container image. |
Description
Docs for KEP 4960: Container Stop Signals.
Related PRs
Issue
Closes: nil, part of kubernetes/enhancements#4960