56b2e4
# The containers configuration file specifies all of the available configuration
56b2e4
# command-line options/flags for container engine tools like Podman & Buildah,
56b2e4
# but in a TOML format that can be easily modified and versioned.
56b2e4
56b2e4
# Please refer to containers.conf(5) for details of all configuration options.
56b2e4
# Not all container engines implement all of the options.
56b2e4
# All of the options have hard coded defaults and these options will override
56b2e4
# the built in defaults. Users can then override these options via the command
56b2e4
# line. Container engines will read containers.conf files in up to three
56b2e4
# locations in the following order:
56b2e4
#  1. /usr/share/containers/containers.conf
56b2e4
#  2. /etc/containers/containers.conf
56b2e4
#  3. $HOME/.config/containers/containers.conf (Rootless containers ONLY)
56b2e4
#  Items specified in the latter containers.conf, if they exist, override the
56b2e4
# previous containers.conf settings, or the default settings.
56b2e4
56b2e4
[containers]
56b2e4
56b2e4
# List of devices. Specified as
56b2e4
# "<device-on-host>:<device-on-container>:<permissions>", for example:
56b2e4
# "/dev/sdc:/dev/xvdc:rwm".
56b2e4
# If it is empty or commented out, only the default devices will be used
56b2e4
#
56b2e4
# devices = []
56b2e4
56b2e4
# List of volumes. Specified as
56b2e4
# "<directory-on-host>:<directory-in-container>:<options>", for example:
56b2e4
# "/db:/var/lib/db:ro".
56b2e4
# If it is empty or commented out, no volumes will be added
56b2e4
#
56b2e4
# volumes = []
56b2e4
56b2e4
# Used to change the name of the default AppArmor profile of container engine.
56b2e4
#
56b2e4
# apparmor_profile = "container-default"
56b2e4
56b2e4
# List of annotation. Specified as
56b2e4
# "key=value"
56b2e4
# If it is empty or commented out, no annotations will be added
56b2e4
#
56b2e4
# annotations = []
56b2e4
56b2e4
# Default way to to create a cgroup namespace for the container
56b2e4
# Options are:
56b2e4
# `private` Create private Cgroup Namespace for the container.
56b2e4
# `host`    Share host Cgroup Namespace with the container.
56b2e4
#
56b2e4
# cgroupns = "private"
56b2e4
56b2e4
# Control container cgroup configuration
56b2e4
# Determines  whether  the  container will create CGroups.
56b2e4
# Options are:
56b2e4
# `enabled`   Enable cgroup support within container
56b2e4
# `disabled`  Disable cgroup support, will inherit cgroups from parent
56b2e4
# `no-conmon` Container engine runs run without conmon
56b2e4
#
56b2e4
# cgroups = "enabled"
56b2e4
56b2e4
# List of default capabilities for containers. If it is empty or commented out,
56b2e4
# the default capabilities defined in the container engine will be added.
56b2e4
#
56b2e4
# default_capabilities = [
56b2e4
#    "AUDIT_WRITE",
56b2e4
#    "CHOWN",
56b2e4
#    "DAC_OVERRIDE",
56b2e4
#    "FOWNER",
56b2e4
#    "FSETID",
56b2e4
#    "KILL",
56b2e4
#    "MKNOD",
56b2e4
#    "NET_BIND_SERVICE",
56b2e4
#    "NET_RAW",
56b2e4
#    "SETGID",
56b2e4
#    "SETPCAP",
56b2e4
#    "SETUID",
56b2e4
#    "SYS_CHROOT",
56b2e4
# ]
56b2e4
56b2e4
# A list of sysctls to be set in containers by default,
56b2e4
# specified as "name=value",
56b2e4
# for example:"net.ipv4.ping_group_range = 0 1000".
56b2e4
#
56b2e4
# default_sysctls = [
56b2e4
#  "net.ipv4.ping_group_range=0 1000",
56b2e4
# ]
56b2e4
56b2e4
# A list of ulimits to be set in containers by default, specified as
56b2e4
# "<ulimit name>=<soft limit>:<hard limit>", for example:
56b2e4
# "nofile=1024:2048"
56b2e4
# See setrlimit(2) for a list of resource names.
56b2e4
# Any limit not specified here will be inherited from the process launching the
56b2e4
# container engine.
56b2e4
# Ulimits has limits for non privileged container engines.
56b2e4
#
56b2e4
# default_ulimits = [
391ee1
#  "nofile=1280:2560",
56b2e4
# ]
56b2e4
56b2e4
# List of default DNS options to be added to /etc/resolv.conf inside of the container.
56b2e4
#
56b2e4
# dns_options = []
56b2e4
56b2e4
# List of default DNS search domains to be added to /etc/resolv.conf inside of the container.
56b2e4
#
56b2e4
# dns_searches = []
56b2e4
56b2e4
# Set default DNS servers.
56b2e4
# This option can be used to override the DNS configuration passed to the
74c329
# container. The special value "none" can be specified to disable creation of
56b2e4
# /etc/resolv.conf in the container.
56b2e4
# The /etc/resolv.conf file in the image will be used without changes.
56b2e4
#
56b2e4
# dns_servers = []
56b2e4
56b2e4
# Environment variable list for the conmon process; used for passing necessary
56b2e4
# environment variables to conmon or the runtime.
56b2e4
#
56b2e4
# env = [
56b2e4
#    "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
391ee1
#    "TERM=xterm",
56b2e4
# ]
56b2e4
56b2e4
# Pass all host environment variables into the container.
56b2e4
#
56b2e4
# env_host = false
56b2e4
56b2e4
# Default proxy environment variables passed into the container.
56b2e4
# The environment variables passed in include:
56b2e4
# http_proxy, https_proxy, ftp_proxy, no_proxy, and the upper case versions of
56b2e4
# these. This option is needed when host system uses a proxy but container
56b2e4
# should not use proxy. Proxy environment variables specified for the container
56b2e4
# in any other way will override the values passed from the host.
56b2e4
#
56b2e4
# http_proxy = true
56b2e4
56b2e4
# Run an init inside the container that forwards signals and reaps processes.
56b2e4
#
56b2e4
# init = false
56b2e4
56b2e4
#  Container init binary, if init=true, this is the init binary to be used for containers.
56b2e4
#
56b2e4
# init_path = "/usr/libexec/podman/catatonit"
56b2e4
56b2e4
# Default way to to create an IPC namespace (POSIX SysV IPC) for the container
56b2e4
# Options are:
56b2e4
# `private` Create private IPC Namespace for the container.
56b2e4
# `host`    Share host IPC Namespace with the container.
56b2e4
#
56b2e4
# ipcns = "private"
56b2e4
56b2e4
# Flag tells container engine to whether to use container separation using
56b2e4
# MAC(SELinux)labeling or not.
56b2e4
# Flag is ignored on label disabled systems.
56b2e4
#
56b2e4
# label = true
56b2e4
56b2e4
# Logging driver for the container. Available options: k8s-file and journald.
56b2e4
#
56b2e4
# log_driver = "k8s-file"
56b2e4
56b2e4
# Maximum size allowed for the container log file. Negative numbers indicate
56b2e4
# that no size limit is imposed. If positive, it must be >= 8192 to match or
56b2e4
# exceed conmon's read buffer. The file is truncated and re-opened so the
56b2e4
# limit is never exceeded.
56b2e4
#
56b2e4
# log_size_max = -1
56b2e4
56b2e4
# Default way to to create a Network namespace for the container
56b2e4
# Options are:
56b2e4
# `private` Create private Network Namespace for the container.
56b2e4
# `host`    Share host Network Namespace with the container.
56b2e4
# `none`    Containers do not use the network
56b2e4
#
56b2e4
# netns = "private"
56b2e4
56b2e4
# Create /etc/hosts for the container.  By default, container engine manage
56b2e4
# /etc/hosts, automatically adding  the container's  own  IP  address.
56b2e4
#
56b2e4
# no_hosts = false
56b2e4
56b2e4
# Maximum number of processes allowed in a container.
56b2e4
#
56b2e4
# pids_limit = 2048
56b2e4
56b2e4
# Default way to to create a PID namespace for the container
56b2e4
# Options are:
56b2e4
# `private` Create private PID Namespace for the container.
56b2e4
# `host`    Share host PID Namespace with the container.
56b2e4
#
56b2e4
# pidns = "private"
56b2e4
56b2e4
# Path to the seccomp.json profile which is used as the default seccomp profile
56b2e4
# for the runtime.
56b2e4
#
56b2e4
# seccomp_profile = "/usr/share/containers/seccomp.json"
56b2e4
56b2e4
# Size of /dev/shm. Specified as <number><unit>.
56b2e4
# Unit is optional, values:
56b2e4
# b (bytes), k (kilobytes), m (megabytes), or g (gigabytes).
56b2e4
# If the unit is omitted, the system uses bytes.
56b2e4
#
56b2e4
# shm_size = "65536k"
56b2e4
1b1052
# Set timezone in container. Takes IANA timezones as well as "local",
1b1052
# which sets the timezone in the container to match the host machine.
1b1052
#
1b1052
# tz = ""
1b1052
1b1052
# Set umask inside the container
1b1052
#
1b1052
# umask="0022"
1b1052
56b2e4
# Default way to to create a UTS namespace for the container
56b2e4
# Options are:
56b2e4
# `private`        Create private UTS Namespace for the container.
56b2e4
# `host`    Share host UTS Namespace with the container.
56b2e4
#
56b2e4
# utsns = "private"
56b2e4
56b2e4
# Default way to to create a User namespace for the container
56b2e4
# Options are:
56b2e4
# `auto`        Create unique User Namespace for the container.
56b2e4
# `host`    Share host User Namespace with the container.
56b2e4
#
56b2e4
# userns = "host"
56b2e4
56b2e4
# Number of UIDs to allocate for the automatic container creation.
74c329
# UIDs are allocated from the "container" UIDs listed in
56b2e4
# /etc/subuid & /etc/subgid
56b2e4
#
56b2e4
# userns_size=65536
56b2e4
56b2e4
# The network table contains settings pertaining to the management of
56b2e4
# CNI plugins.
56b2e4
56b2e4
[network]
56b2e4
56b2e4
# Path to directory where CNI plugin binaries are located.
56b2e4
#
56b2e4
# cni_plugin_dirs = ["/usr/libexec/cni"]
56b2e4
56b2e4
# Path to the directory where CNI configuration files are located.
56b2e4
#
56b2e4
# network_config_dir = "/etc/cni/net.d/"
56b2e4
56b2e4
[engine]
56b2e4
56b2e4
# Cgroup management implementation used for the runtime.
74c329
# Valid options "systemd" or "cgroupfs"
56b2e4
#
56b2e4
# cgroup_manager = "systemd"
56b2e4
56b2e4
# Environment variables to pass into conmon
56b2e4
#
56b2e4
# conmon_env_vars = [
56b2e4
#        "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
56b2e4
# ]
56b2e4
56b2e4
# Paths to look for the conmon container manager binary
56b2e4
#
56b2e4
# conmon_path = [
56b2e4
#        "/usr/libexec/podman/conmon",
56b2e4
#        "/usr/local/libexec/podman/conmon",
56b2e4
#        "/usr/local/lib/podman/conmon",
56b2e4
#        "/usr/bin/conmon",
56b2e4
#        "/usr/sbin/conmon",
56b2e4
#        "/usr/local/bin/conmon",
56b2e4
#        "/usr/local/sbin/conmon"
56b2e4
# ]
56b2e4
56b2e4
# Specify the keys sequence used to detach a container.
56b2e4
# Format is a single character [a-Z] or a comma separated sequence of
56b2e4
# `ctrl-<value>`, where `<value>` is one of:
56b2e4
# `a-z`, `@`, `^`, `[`, `\`, `]`, `^` or `_`
56b2e4
#
56b2e4
# detach_keys = "ctrl-p,ctrl-q"
56b2e4
56b2e4
# Determines whether engine will reserve ports on the host when they are
56b2e4
# forwarded to containers. When enabled, when ports are forwarded to containers,
56b2e4
# ports are held open by as long as the container is running, ensuring that
56b2e4
# they cannot be reused by other programs on the host. However, this can cause
56b2e4
# significant memory usage if a container has many ports forwarded to it.
56b2e4
# Disabling this can save memory.
56b2e4
#
56b2e4
# enable_port_reservation = true
56b2e4
1b1052
# Environment variables to be used when running the container engine (e.g., Podman, Buildah).
1b1052
# For example "http_proxy=internal.proxy.company.com".
1b1052
# Note these environment variables will not be used within the container.
1b1052
# Set the env section under [containers] table, if you want to set environment variables for the container.
1b1052
# env = []
1b1052
56b2e4
# Selects which logging mechanism to use for container engine events.
56b2e4
# Valid values are `journald`, `file` and `none`.
56b2e4
#
391ee1
events_logger = "file"
391ee1
391ee1
# Path to OCI hooks directories for automatically executed hooks.
391ee1
#
391ee1
# hooks_dir = [
391ee1
#     "/usr/share/containers/oci/hooks.d",
391ee1
# ]
56b2e4
56b2e4
# Default transport method for pulling and pushing for images
56b2e4
#
56b2e4
# image_default_transport = "docker://"
56b2e4
56b2e4
# Default command to run the infra container
56b2e4
#
56b2e4
# infra_command = "/pause"
56b2e4
56b2e4
# Infra (pause) container image name for pod infra containers.  When running a
56b2e4
# pod, we start a `pause` process in a container to hold open the namespaces
56b2e4
# associated with the  pod.  This container does nothing other then sleep,
56b2e4
# reserving the pods resources for the lifetime of the pod.
56b2e4
#
56b2e4
# infra_image = "k8s.gcr.io/pause:3.2"
56b2e4
56b2e4
# Specify the locking mechanism to use; valid values are "shm" and "file".
56b2e4
# Change the default only if you are sure of what you are doing, in general
56b2e4
# "file" is useful only on platforms where cgo is not available for using the
56b2e4
# faster "shm" lock type.  You may need to run "podman system renumber" after
56b2e4
# you change the lock type.
56b2e4
#
56b2e4
# lock_type** = "shm"
56b2e4
391ee1
# MultiImageArchive - if true, the container engine allows for storing archives
391ee1
# (e.g., of the docker-archive transport) with multiple images.  By default,
391ee1
# Podman creates single-image archives.
391ee1
#
391ee1
# multi_image_archive = "false"
391ee1
56b2e4
# Default engine namespace
56b2e4
# If engine is joined to a namespace, it will see only containers and pods
56b2e4
# that were created in the same namespace, and will create new containers and
56b2e4
# pods in that namespace.
56b2e4
# The default namespace is "", which corresponds to no namespace. When no
56b2e4
# namespace is set, all containers and pods are visible.
56b2e4
#
56b2e4
# namespace = ""
56b2e4
391ee1
# Path to the slirp4netns binary
391ee1
#
391ee1
# network_cmd_path=""
391ee1
56b2e4
# Whether to use chroot instead of pivot_root in the runtime
56b2e4
#
56b2e4
# no_pivot_root = false
56b2e4
56b2e4
# Number of locks available for containers and pods.
56b2e4
# If this is changed, a lock renumber must be performed (e.g. with the
56b2e4
# 'podman system renumber' command).
56b2e4
#
56b2e4
# num_locks = 2048
56b2e4
56b2e4
# Whether to pull new image before running a container
56b2e4
# pull_policy = "missing"
56b2e4
56b2e4
# Directory for persistent engine files (database, etc)
56b2e4
# By default, this will be configured relative to where the containers/storage
56b2e4
# stores containers
56b2e4
# Uncomment to change location from this default
56b2e4
#
56b2e4
# static_dir = "/var/lib/containers/storage/libpod"
56b2e4
56b2e4
# Directory for temporary files. Must be tmpfs (wiped after reboot)
56b2e4
#
56b2e4
# tmp_dir = "/var/run/libpod"
56b2e4
56b2e4
# Directory for libpod named volumes.
56b2e4
# By default, this will be configured relative to where containers/storage
56b2e4
# stores containers.
56b2e4
# Uncomment to change location from this default.
56b2e4
#
56b2e4
# volume_path = "/var/lib/containers/storage/volumes"
56b2e4
56b2e4
# Default OCI runtime
56b2e4
#
56b2e4
# runtime = "runc"
56b2e4
56b2e4
# List of the OCI runtimes that support --format=json.  When json is supported
56b2e4
# engine will use it for reporting nicer errors.
56b2e4
#
56b2e4
# runtime_supports_json = ["crun", "runc", "kata"]
56b2e4
56b2e4
# List of the OCI runtimes that supports running containers without cgroups.
56b2e4
#
56b2e4
# runtime_supports_nocgroups = ["crun"]
56b2e4
56b2e4
# List of the OCI runtimes that supports running containers with KVM Separation.
56b2e4
#
56b2e4
# runtime_supports_kvm = ["kata"]
56b2e4
1b1052
# Number of seconds to wait for container to exit before sending kill signal.
1b1052
# stop_timeout = 10
1b1052
1b1052
# Index to the active service
1b1052
# active_service = production
1b1052
1b1052
# map of service destinations
1b1052
# [service_destinations]
1b1052
#   [service_destinations.production]
1b1052
#     URI to access the Podman service
1b1052
#     Examples:
1b1052
#       rootless "unix://run/user/$UID/podman/podman.sock" (Default)
1b1052
#       rootfull "unix://run/podman/podman.sock (Default)
1b1052
#       remote rootless ssh://engineering.lab.company.com/run/user/1000/podman/podman.sock
1b1052
#       remote rootfull ssh://root@10.10.1.136:22/run/podman/podman.sock
1b1052
#     uri="ssh://user@production.example.com/run/user/1001/podman/podman.sock"
1b1052
#     Path to file containing ssh identity key
1b1052
#     identity = "~/.ssh/id_rsa"
1b1052
56b2e4
# Paths to look for a valid OCI runtime (runc, runv, kata, etc)
56b2e4
[engine.runtimes]
56b2e4
# runc = [
56b2e4
#        "/usr/bin/runc",
56b2e4
#        "/usr/sbin/runc",
56b2e4
#        "/usr/local/bin/runc",
56b2e4
#        "/usr/local/sbin/runc",
56b2e4
#        "/sbin/runc",
56b2e4
#        "/bin/runc",
56b2e4
#        "/usr/lib/cri-o-runc/sbin/runc",
56b2e4
# ]
56b2e4
56b2e4
# crun = [
56b2e4
#            "/usr/bin/crun",
56b2e4
#            "/usr/sbin/crun",
56b2e4
#            "/usr/local/bin/crun",
56b2e4
#            "/usr/local/sbin/crun",
56b2e4
#            "/sbin/crun",
56b2e4
#            "/bin/crun",
56b2e4
#            "/run/current-system/sw/bin/crun",
56b2e4
# ]
56b2e4
56b2e4
# kata = [
56b2e4
#            "/usr/bin/kata-runtime",
56b2e4
#            "/usr/sbin/kata-runtime",
56b2e4
#            "/usr/local/bin/kata-runtime",
56b2e4
#            "/usr/local/sbin/kata-runtime",
56b2e4
#            "/sbin/kata-runtime",
56b2e4
#            "/bin/kata-runtime",
56b2e4
#            "/usr/bin/kata-qemu",
56b2e4
#            "/usr/bin/kata-fc",
56b2e4
# ]
56b2e4
56b2e4
# The [engine.runtimes] table MUST be the last entry in this file.
56b2e4
# (Unless another table is added)
56b2e4
# TOML does not provide a way to end a table other than a further table being
56b2e4
# defined, so every key hereafter will be part of [runtimes] and not the main
56b2e4
# config.