-
Notifications
You must be signed in to change notification settings - Fork 131
[adapters] checkpoint-suspend on SIGTERM #6482
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.
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
Open
swanandx
wants to merge
2
commits into
main
Choose a base branch
from
checkpoint-on-sigterm
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+160
−11
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| --- | ||
| title: Clean shutdown on SIGTERM | ||
| sidebar_position: 30 | ||
| --- | ||
|
|
||
| # Clean shutdown on SIGTERM | ||
|
|
||
| When Feldera stops a pipeline through its own control plane (for example, a | ||
| graceful `/stop`), the pipeline checkpoints its state and suspends before the | ||
| pods are removed. But a pipeline pod can also be terminated by the | ||
| infrastructure with no Feldera involvement — Kubernetes node drain, eviction, | ||
| Karpenter consolidation, or `kubectl delete`. These deliver `SIGTERM` to the | ||
| pipeline process. | ||
|
|
||
| By default the pipeline reacts to `SIGTERM` with a graceful *HTTP* shutdown: it | ||
| drains in-flight requests and exits, but it does **not** checkpoint. Any state | ||
| accumulated since the last checkpoint is lost and must be recomputed on the next | ||
| start. | ||
|
|
||
| Setting `FELDERA_CLEAN_SHUTDOWN_ON_SIGTERM` makes the pipeline run the same | ||
| checkpoint-and-suspend flow as a graceful stop when it receives `SIGTERM`, so an | ||
| infrastructure-initiated termination resumes from a fresh checkpoint. | ||
|
|
||
| ## Environment variables | ||
|
|
||
| | Variable | Default | Meaning | | ||
| | --- | --- | --- | | ||
| | `FELDERA_CLEAN_SHUTDOWN_ON_SIGTERM` | off | When truthy (`1`, `true`, `yes`, `on`; case-insensitive), checkpoint and suspend on `SIGTERM` before shutting down. | | ||
|
|
||
| ## Kubernetes: `terminationGracePeriodSeconds` | ||
|
|
||
| The feature only has an effect when the pod is given enough time to checkpoint | ||
| before the kernel kills it. Kubernetes sends `SIGTERM`, waits | ||
| `terminationGracePeriodSeconds`, then sends `SIGKILL`. If the grace period is | ||
| `0` (or too short to finish a checkpoint), the pod is `SIGKILL`ed and the | ||
| checkpoint is truncated — the same outcome as not enabling the feature. | ||
|
|
||
| When enabling `FELDERA_CLEAN_SHUTDOWN_ON_SIGTERM`: | ||
|
|
||
| - Set the pipeline pod's `terminationGracePeriodSeconds` comfortably above the | ||
| expected checkpoint time (which scales with state size and object-store | ||
| latency). This is the only deadline: the pipeline waits for the checkpoint to | ||
| finish, and if it wedges, Kubernetes `SIGKILL`s the pod when the grace period | ||
| ends. | ||
|
|
||
| ## Other signals | ||
|
|
||
| With the feature enabled the pipeline installs its own handlers for `SIGTERM` | ||
| (checkpoint, then shut down) and `SIGINT` / Ctrl-C (immediate graceful shutdown, | ||
| no checkpoint). Default handling of other signals such as `SIGHUP` and `SIGQUIT` | ||
| is no longer installed; in a Kubernetes deployment only `SIGTERM` (then | ||
| `SIGKILL`) is sent, so this does not affect normal operation. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.