package
0.12.1
Repository: https://github.com/hanks177/podman.git
Documentation: pkg.go.dev

# README

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.

# Packages

Package hook is the 0.1.0 hook configuration structure.
Package hook is the 1.0.0 hook configuration structure.
Package exec provides utilities for executing Open Container Initative runtime hooks.

# Functions

New creates a new hook manager.
Read reads a hook JSON file, verifies it, and returns the hook configuration.
ReadDir reads hook JSON files from a directory into the given map, clobbering any previous entries with the same filenames.

# Constants

DefaultDir is the default directory containing system hook configuration files.
OverrideDir is the directory for hook configuration files overriding the default entries.
Version is the current hook configuration version.

# Variables

ErrNoJSONSuffix represents hook-add attempts where the filename does not end in '.json'.
Readers registers per-version hook readers.

# Structs

Manager provides an opaque interface for managing CRI-O hooks.