podman/pkg/hooks
Valentin Rothberg 8489dc4345 move go module to v2
With the advent of Podman 2.0.0 we crossed the magical barrier of go
modules.  While we were able to continue importing all packages inside
of the project, the project could not be vendored anymore from the
outside.

Move the go module to new major version and change all imports to
`github.com/containers/libpod/v2`.  The renaming of the imports
was done via `gomove` [1].

[1] https://github.com/KSubedi/gomove

Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
2020-07-06 15:50:12 +02:00
..
0.1.0 move go module to v2 2020-07-06 15:50:12 +02:00
1.0.0 make lint: include unit tests 2020-01-14 10:51:59 +01:00
docs Add codespell to validate spelling mistakes in code. 2020-01-11 06:32:19 -05:00
exec Turn on More linters 2020-06-15 07:05:56 -04:00
README.md hooks/README: Fix some Markdown typos (e.g. missing runc target) 2018-05-21 14:09:25 +00:00
hooks.go move go module to v2 2020-07-06 15:50:12 +02:00
hooks_test.go move go module to v2 2020-07-06 15:50:12 +02:00
monitor.go move go module to v2 2020-07-06 15:50:12 +02:00
monitor_test.go Improved hooks monitoring 2019-07-25 09:52:45 -04:00
read.go move go module to v2 2020-07-06 15:50:12 +02:00
read_test.go move go module to v2 2020-07-06 15:50:12 +02: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.