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

Add a high level description of graceful shutdown #473

Merged
merged 1 commit into from
Oct 19, 2023
Merged

Add a high level description of graceful shutdown #473

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions modules/concepts/pages/operations/graceful_shutdown.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
= Graceful shutdown

The article https://cloud.google.com/blog/products/containers-kubernetes/kubernetes-best-practices-terminating-with-grace[Kubernetes best practices: terminating with grace] describes how a graceful shutdown works in Kubernetes.
Graceful shutdown refers to the managed, controlled shutdown of service instances in the manner intended by the software authors.
Typically, an instance will receive a signal indicating the intent for the server to shut down, and it will initiate a controlled shutdown.
This could include closing open file handles, updating the instance state in the cluster and emitting a message that the server is closing down.
This contrasts with an uncontrolled shutdown where a process is terminated immediately and is unable to perform any of its normal shutdown activities.

Our operators add the needed shutdown mechanism for their products that support graceful shutdown.
In the event that a service instance is unable to shut down in a reasonable amount of time, a timeout is set after which the process will be forcibly terminated to prevent a stuck server from remaining in the shutting down state indefinitely.
The article https://cloud.google.com/blog/products/containers-kubernetes/kubernetes-best-practices-terminating-with-grace[Kubernetes best practices: terminating with grace] describes how a graceful shutdown on Kubernetes works in detail.

Our operators add the needed shutdown mechanism for their products that support graceful shutdown.
They also configure a sensible amount of time Pods are granted to properly shut down without disrupting the availability of the product.

If you are not satisfied with the default values, you can set the graceful shutdown timeout as follows:

[source,yaml]
Expand Down