libpod.conf man page

libpod.conf — libpod configuration file


The libpod.conf file is the default configuration file for all tools using libpod to manage containers.


 Default transport method for pulling and pushing images

 Default OCI runtime to use if nothing is specified in runtimes

 For each OCI runtime, specify a list of paths to look for.  The first one found is used.

 Paths to search for the Conmon container manager binary

 Environment variables to pass into Conmon

 Specify the CGroup Manager to use; valid values are "systemd" and "cgroupfs"

 Path to the container-init binary, which forwards signals and reaps processes within containers.  Note that the container-init binary will only be used when the --init for podman-create and podman-run is set.

hooks_dir=["path", ...]

Each *.json file in the path configures a hook for Podman containers.  For more details on the syntax of the JSON files and the semantics of hook injection, see oci-hooks(5).  Podman and libpod currently support both the 1.0.0 and 0.1.0 hook schemas, although the 0.1.0 schema is deprecated.

Paths listed later in the array higher precedence (oci-hooks(5) discusses directory precedence).

For the annotation conditions, libpod uses any annotations set in the generated OCI configuration.

For the bind-mount conditions, only mounts explicitly requested by the caller via --volume are considered.  Bind mounts that libpod inserts by default (e.g. /dev/shm) are not considered.

Podman and libpod currently support an additional precreate state which is called before the runtime's create operation.  Unlike the other stages, which receive the container state on their standard input, precreate hooks receive the proposed runtime configuration on their standard input.  They may alter that configuration as they see fit, and write the altered form to their standard output.

WARNING: the precreate hook lets you do powerful things, such as adding additional mounts to the runtime configuration.  That power also makes it easy to break things.  Before reporting libpod errors, try running your container with precreate hooks disabled to see if the problem is due to one of your hooks.

 Directory for persistent libpod files (database, etc)
 By default this will be configured relative to where containers/storage
 stores containers

 Directory for temporary files
 Must be a tmpfs (wiped after reboot)

 Maximum size of log files (in bytes)

 Whether to use chroot instead of pivot_root in the runtime

 Directory containing CNI plugin configuration files

 Directories where CNI plugin binaries may be located

pause_image = ""
 Pause container image name for pod pause containers.  When running a pod, we
 start a pause processes in a container to hold open the namespaces associated with the
 pod.  This container and process, basically sleep/pause for the lifetime of the pod.

 Command to run the pause container

 Default libpod namespace. If libpod is joined to a namespace, it will see only containers and pods
 that were created in the same namespace, and will create new containers and pods in that namespace.
 The default namespace is "", which corresponds to no namespace. When no namespace is set, all
 containers and pods are visible.

 Indicates whether the containers should use label separation.

 Number of locks available for containers and pods. Each created container or pod consumes one lock.
 The default number available is 2048.
 If this is changed, a lock renumbering must be performed, using the podman system renumber command.

 Directory where named volumes will be created in using the default volume driver.
 By default this will be configured relative to where containers/storage stores containers.

 Path to the command binary to use for setting up a network.  It is currently only used for setting up
 a slirp4netns network.  If "" is used then the binary is looked up using the $PATH environment variable.


/usr/share/containers/libpod.conf, default libpod configuration path

/etc/containers/libpod.conf, override libpod configuration path


Apr 2018, Originally compiled by Nathan Williams  ⟨⟩

Referenced By

podman(1), podman-create(1), podman-run(1), podman-system-renumber(1).