1libpod.conf(5)                File Formats Manual               libpod.conf(5)
2
3
4

NAME

6       libpod.conf - libpod configuration file
7
8

DESCRIPTION

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

OPTIONS

15       image_default_transport=""
16         Default transport method for pulling and pushing images
17
18
19       runtime=""
20         Default OCI runtime to use if nothing is specified in runtimes
21
22
23       runtimes
24         For each OCI runtime, specify a list of paths to look for.  The first
25       one found is used.
26
27
28       conmon_path=""
29         Paths to search for the Conmon container manager binary
30
31
32       conmon_env_vars=""
33         Environment variables to pass into Conmon
34
35
36       cgroup_manager=""
37         Specify the CGroup Manager to use; valid values are "systemd" and
38       "cgroupfs"
39
40
41       init_path=""
42         Path to the container-init binary, which forwards signals and reaps
43       processes within containers.  Note that the container-init binary will
44       only be used when the --init for podman-create and podman-run is set.
45
46
47       hooks_dir=["path", ...]
48
49
50       Each *.json file in the path configures a hook for Podman containers.
51       For more details on the syntax of the JSON files and the semantics of
52       hook injection, see oci-hooks(5).  Podman and libpod currently support
53       both the 1.0.0 and 0.1.0 hook schemas, although the 0.1.0 schema is
54       deprecated.
55
56
57       Paths listed later in the array have higher precedence (oci-hooks(5)
58       discusses directory precedence).
59
60
61       For the annotation conditions, libpod uses any annotations set in the
62       generated OCI configuration.
63
64
65       For the bind-mount conditions, only mounts explicitly requested by the
66       caller via --volume are considered.  Bind mounts that libpod inserts by
67       default (e.g. /dev/shm) are not considered.
68
69
70       Podman and libpod currently support an additional precreate state which
71       is called before the runtime's create operation.  Unlike the other
72       stages, which receive the container state on their standard input,
73       precreate hooks receive the proposed runtime configuration on their
74       standard input.  They may alter that configuration as they see fit, and
75       write the altered form to their standard output.
76
77
78       WARNING: the precreate hook lets you do powerful things, such as adding
79       additional mounts to the runtime configuration.  That power also makes
80       it easy to break things.  Before reporting libpod errors, try running
81       your container with precreate hooks disabled to see if the problem is
82       due to one of your hooks.
83
84
85       static_dir=""
86         Directory for persistent libpod files (database, etc)
87         By default this will be configured relative to where
88       containers/storage
89         stores containers
90
91
92       tmp_dir=""
93         Directory for temporary files
94         Must be a tmpfs (wiped after reboot)
95
96
97       max_log_size=""
98         Maximum size of log files (in bytes)
99
100
101       no_pivot_root=""
102         Whether to use chroot instead of pivot_root in the runtime
103
104
105       cni_config_dir=""
106         Directory containing CNI plugin configuration files
107
108
109       cni_plugin_dir=""
110         Directories where CNI plugin binaries may be located
111
112
113       infra_image = ""
114         Infra (pause) container image name for pod infra containers.  When
115       running a pod, we
116         start a pause process in a container to hold open the namespaces
117       associated with the
118         pod.  This container and process, basically sleep/pause for the
119       lifetime of the pod.
120
121
122       infra_command=""
123         Command to run the infra container
124
125
126       namespace=""
127         Default libpod namespace. If libpod is joined to a namespace, it will
128       see only containers and pods
129         that were created in the same namespace, and will create new
130       containers and pods in that namespace.
131         The default namespace is "", which corresponds to no namespace. When
132       no namespace is set, all
133         containers and pods are visible.
134
135
136       label="true|false"
137         Indicates whether the containers should use label separation.
138
139
140       num_locks=""
141         Number of locks available for containers and pods. Each created
142       container or pod consumes one lock.
143         The default number available is 2048.
144         If this is changed, a lock renumbering must be performed, using the
145       podman system renumber command.
146
147
148       volume_path=""
149         Directory where named volumes will be created in using the default
150       volume driver.
151         By default this will be configured relative to where
152       containers/storage stores containers.
153
154
155       network_cmd_path=""
156         Path to the command binary to use for setting up a network.  It is
157       currently only used for setting up
158         a slirp4netns network.  If "" is used then the binary is looked up
159       using the $PATH environment variable.
160
161
162       events_logger=""
163         Default method to use when logging events. Valid values are
164       "journald" and "file".
165
166

FILES

168       /usr/share/containers/libpod.conf, default libpod configuration path
169
170
171       /etc/containers/libpod.conf, override libpod configuration path
172
173

HISTORY

175       Apr 2018, Originally compiled by Nathan Williams
176       ⟨nath.e.will@gmail.com⟩
177
178
179
180                                                                libpod.conf(5)
Impressum