Skip to content

docs: Revise README#23

Open
polarathene wants to merge 1 commit into
fpco:masterfrom
polarathene:patch-1
Open

docs: Revise README#23
polarathene wants to merge 1 commit into
fpco:masterfrom
polarathene:patch-1

Conversation

@polarathene

Copy link
Copy Markdown
  • Most of the diff is formatting. Line length seemed aggressively short, even if you were not comfortable with using line-wrapping in an editor.
  • Some content was split into bullet points where it seemed appropriate. Similarly for addition of backticks, such as references to tini.
  • The Dockerfile snippet at the end was modified to:
    • Drop the alpine version, that's dated and not providing much value to the reader with a pinned version there.
    • Bump the pinned pid1 release version from 0.1.0 (2023), to the 0.1.6 (2026) release.

Comment thread README.md
Comment on lines +20 to +28
Without proper handling, signals like `SIGTERM` might not be forwarded to child processes,
and zombie processes can accumulate, leading to resource leaks.

- **Signal Forwarding:** Intercepts signals like `SIGTERM` and
`SIGINT` and forwards them to its child process, allowing for
graceful shutdown.
- **Zombie Reaping:** Acts as an init process to reap orphaned child
processes, preventing zombie process accumulation.
`pid1-rs` solves this by providing:
- **Graceful Shutdown:** Intercepts the signals `SIGTERM` and `SIGINT`,
forwarding them to the child process. If the child does not exit within
a configurable grace period (default: 2s), a `SIGKILL` is sent.
- **Zombie Reaping:** Acts as an init process to reap orphaned child processes,
preventing the accumulation of zombie processes.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I rewrote this portion, as the "Signal Forwarding" only appears to be applicable to SIGINT + SIGTERM, which is a notable difference from what tini and dumb-init offer (neither of which implements a graceful exit, given the container runtimes tend to provide this already which would conflict).

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant