[PROTOTYPE] Inform agent-shutdown hook of reason for agent shutdown. #3315
Conversation
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
When running the agent-shutdown hook, the following environment variables may be set: - BUILDKITE_AGENT_SHUTDOWN_REASON: The reason the buildkite-agent process is shutting down, "IDLE" for the idle timeout expiring or "SIGNAL" for SIGINT/SIGTERM/etc. - BUILDKITE_AGENT_SHUTDOWN_SIGNAL: The signal which caused the agent to shut down (e.g. "SIGINT"). My use case for this is triggering a system shutdown from the agent shutdown hook when the agent has shut down due to inactivity, I can imagine it getting used for other cluster orchestration things too.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When running the agent-shutdown hook, the following environment variables may be set:
BUILDKITE_AGENT_SHUTDOWN_REASON: The reason the buildkite-agent process is shutting down, "IDLE" for the idle timeout expiring or "SIGNAL" for SIGINT/SIGTERM/etc.
BUILDKITE_AGENT_SHUTDOWN_SIGNAL: The signal which caused the agent to shut down (e.g. "SIGINT").
My use case for this is triggering a system shutdown from the agent shutdown hook when the agent has shut down due to inactivity, I can imagine it getting used for other cluster orchestration things too.
See also: https://forum.buildkite.community/t/provide-termination-reason-to-agent-shutdown-hook/4364