Blame containers.conf

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