container/podman
container/podman
1
0
Fork 0
mirror of https://github.com/containers/podman synced 2024-10-20 01:03:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
podman/pkg/hooks
History
W. Trevor King 8f198e67ca hooks/1.0.0: Fix 'annotation' -> 'annotations' in JSON 
This typo from 68eb128f (pkg/hooks: Version the hook structure and add
1.0.0 hooks, 2018-04-27, #686) was causing any 'annotations' entries
in hook JSON to be silently ignored.

Signed-off-by: W. Trevor King <wking@tremily.us>

Closes: #887
Approved by: rhatdan
2018-06-04 13:01:56 +00:00
..
0.1.0 pkg/hooks: Version the hook structure and add 1.0.0 hooks 2018-05-11 16:26:35 +00:00
1.0.0 hooks/1.0.0: Fix 'annotation' -> 'annotations' in JSON 2018-06-04 13:01:56 +00:00
docs oci-hooks.5: Discuss directory precedence and monitoring 2018-05-21 13:36:17 +00:00
exec hooks/exec: Allow successful reaps for 0s post-kill timeouts 2018-06-01 08:28:06 +00:00
hooks.go hooks: Rename Hooks() output to extensionStageHooks 2018-05-31 14:11:52 +00:00
hooks_test.go hooks: Rename Hooks() output to extensionStageHooks 2018-05-31 14:11:52 +00:00
monitor.go hooks: Fix monitoring of multiple directories 2018-05-17 22:39:13 +00:00
monitor_test.go hooks: Fix monitoring of multiple directories 2018-05-17 22:39:13 +00:00
read.go hooks: Fail ReadDir if a configured hook executable is missing 2018-06-04 13:01:56 +00:00
read_test.go hooks: Fail ReadDir if a configured hook executable is missing 2018-06-04 13:01:56 +00:00
README.md hooks/README: Fix some Markdown typos (e.g. missing runc target) 2018-05-21 14:09:25 +00:00
version.go pkg/hooks: Version the hook structure and add 1.0.0 hooks 2018-05-11 16:26:35 +00:00

README.md

OCI Hooks Configuration

For POSIX platforms, the OCI runtime configuration supports hooks for configuring custom actions related to the life cycle of the container. The way you enable the hooks above is by editing the OCI runtime configuration before running the OCI runtime (e.g. runc). CRI-O and podman create create the OCI configuration for you, and this documentation allows developers to configure them to set their intended hooks.

One problem with hooks is that the runtime actually stalls execution of the container before running the hooks and stalls completion of the container, until all hooks complete. This can cause some performance issues. Also a lot of hooks just check if certain configuration is set and then exit early, without doing anything. For example the oci-systemd-hook only executes if the command is init or systemd, otherwise it just exits. This means if we automatically enabled all hooks, every container would have to execute oci-systemd-hook, even if they don't run systemd inside of the container. Performance would also suffer if we exectuted each hook at each stage (pre-start, post-start, and post-stop).

The hooks configuration is documented in oci-hooks.5.