podman/pkg/hooks
samc24 d6ea4b4139 Improved hooks monitoring
...to work for specific edge cases with a simpler solution.
Re-reads hooks directories after any changes are detected by the watchers.
Added monitoring test for adding a different invalid hook to primary directory.
Some issues with prior code:
- ReadDir would stop when it encounters an invalid hook, rather than registering an error but continuing to read the valid hook.
- Wouldn’t account for Rename and Chmod events.
- After doing a mv of the hooks file instead of rm, it would still think the hooks file is in the directory, but it has been moved to another location.
- If a hook file was renamed, it would register the renamed file as a separate hook and not delete the original, so it would then execute the hook twice - once for the renamed file, and once for the original name which it did not delete.

Signed-off-by: samc24 <sam.chaturvedi24@gmail.com>
2019-07-25 09:52:45 -04:00
..
0.1.0 trivial cleanups from golang 2019-07-03 15:41:33 -05:00
1.0.0 trivial cleanups from golang 2019-07-03 15:41:33 -05:00
docs Fix example in oci-hooks.5.md 2019-06-18 18:43:21 +02:00
exec golangci-lint round #3 2019-07-21 14:22:39 -05:00
README.md hooks/README: Fix some Markdown typos (e.g. missing runc target) 2018-05-21 14:09:25 +00:00
hooks.go Improved hooks monitoring 2019-07-25 09:52:45 -04:00
hooks_test.go Potentially breaking: Make hooks sort order locale-independent 2019-04-09 21:08:44 +02:00
monitor.go Improved hooks monitoring 2019-07-25 09:52:45 -04:00
monitor_test.go Improved hooks monitoring 2019-07-25 09:52:45 -04:00
read.go Improved hooks monitoring 2019-07-25 09:52:45 -04:00
read_test.go switch projectatomic to containers 2018-08-16 17:12:36 +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.