5dd126
# This file is is the configuration file for all tools
e2e81a
# that use the containers/storage library. The storage.conf file
e2e81a
# overrides all other storage.conf files. Container engines using the
e2e81a
# container/storage library do not inherit fields from other storage.conf
e2e81a
# files.
e2e81a
#
e2e81a
#  Note: The storage.conf file overrides other storage.conf files based on this precedence:
e2e81a
#      /usr/containers/storage.conf
e2e81a
#      /etc/containers/storage.conf
e2e81a
#      $HOME/.config/containers/storage.conf
e2e81a
#      $XDG_CONFIG_HOME/containers/storage.conf (If XDG_CONFIG_HOME is set)
5dd126
# See man 5 containers-storage.conf for more information
5dd126
# The "container storage" table contains all of the server options.
5dd126
[storage]
5dd126
5dd126
# Default Storage Driver, Must be set for proper operation.
5dd126
driver = "overlay"
5dd126
5dd126
# Temporary storage location
5dd126
runroot = "/run/containers/storage"
5dd126
5dd126
# Primary Read/Write location of container storage
e2e81a
# When changing the graphroot location on an SELINUX system, you must
e2e81a
# ensure  the labeling matches the default locations labels with the
e2e81a
# following commands:
e2e81a
# semanage fcontext -a -e /var/lib/containers/storage /NEWSTORAGEPATH
e2e81a
# restorecon -R -v /NEWSTORAGEPATH
5dd126
graphroot = "/var/lib/containers/storage"
5dd126
e2e81a
5dd126
# Storage path for rootless users
5dd126
#
5dd126
# rootless_storage_path = "$HOME/.local/share/containers/storage"
5dd126
5dd126
[storage.options]
5dd126
# Storage options to be passed to underlying storage drivers
5dd126
5dd126
# AdditionalImageStores is used to pass paths to additional Read/Only image stores
5dd126
# Must be comma separated list.
5dd126
additionalimagestores = [
5dd126
]
5dd126
169ddb
# Allows specification of how storage is populated when pulling images. This
169ddb
# option can speed the pulling process of images compressed with format
169ddb
# zstd:chunked. Containers/storage looks for files within images that are being
169ddb
# pulled from a container registry that were previously pulled to the host.  It
169ddb
# can copy or create a hard link to the existing file when it finds them,
169ddb
# eliminating the need to pull them from the container registry. These options
169ddb
# can deduplicate pulling of content, disk storage of content and can allow the
169ddb
# kernel to use less memory when running containers.
169ddb
169ddb
# containers/storage supports four keys
169ddb
#   * enable_partial_images="true" | "false"
169ddb
#     Tells containers/storage to look for files previously pulled in storage
169ddb
#     rather then always pulling them from the container registry.
169ddb
#   * use_hard_links = "false" | "true"
169ddb
#     Tells containers/storage to use hard links rather then create new files in
169ddb
#     the image, if an identical file already existed in storage.
169ddb
#   * ostree_repos = ""
169ddb
#     Tells containers/storage where an ostree repository exists that might have
169ddb
#     previously pulled content which can be used when attempting to avoid
169ddb
#     pulling content from the container registry
169ddb
pull_options = {enable_partial_images = "false", use_hard_links = "false", ostree_repos=""}
169ddb
5dd126
# Remap-UIDs/GIDs is the mapping from UIDs/GIDs as they should appear inside of
5dd126
# a container, to the UIDs/GIDs as they should appear outside of the container,
5dd126
# and the length of the range of UIDs/GIDs.  Additional mapped sets can be
5dd126
# listed and will be heeded by libraries, but there are limits to the number of
5dd126
# mappings which the kernel will allow when you later attempt to run a
5dd126
# container.
5dd126
#
5dd126
# remap-uids = 0:1668442479:65536
5dd126
# remap-gids = 0:1668442479:65536
5dd126
5dd126
# Remap-User/Group is a user name which can be used to look up one or more UID/GID
5dd126
# ranges in the /etc/subuid or /etc/subgid file.  Mappings are set up starting
5dd126
# with an in-container ID of 0 and then a host-level ID taken from the lowest
5dd126
# range that matches the specified name, and using the length of that range.
5dd126
# Additional ranges are then assigned, using the ranges which specify the
5dd126
# lowest host-level IDs first, to the lowest not-yet-mapped in-container ID,
5dd126
# until all of the entries have been used for maps.
5dd126
#
5dd126
# remap-user = "containers"
5dd126
# remap-group = "containers"
5dd126
5dd126
# Root-auto-userns-user is a user name which can be used to look up one or more UID/GID
5dd126
# ranges in the /etc/subuid and /etc/subgid file.  These ranges will be partitioned
5dd126
# to containers configured to create automatically a user namespace.  Containers
5dd126
# configured to automatically create a user namespace can still overlap with containers
5dd126
# having an explicit mapping set.
5dd126
# This setting is ignored when running as rootless.
5dd126
# root-auto-userns-user = "storage"
5dd126
#
5dd126
# Auto-userns-min-size is the minimum size for a user namespace created automatically.
5dd126
# auto-userns-min-size=1024
5dd126
#
5dd126
# Auto-userns-max-size is the minimum size for a user namespace created automatically.
5dd126
# auto-userns-max-size=65536
5dd126
5dd126
[storage.options.overlay]
5dd126
# ignore_chown_errors can be set to allow a non privileged user running with
5dd126
# a single UID within a user namespace to run containers. The user can pull
5dd126
# and use any image even those with multiple uids.  Note multiple UIDs will be
5dd126
# squashed down to the default uid in the container.  These images will have no
5dd126
# separation between the users in the container. Only supported for the overlay
5dd126
# and vfs drivers.
5dd126
#ignore_chown_errors = "false"
5dd126
5dd126
# Inodes is used to set a maximum inodes of the container image.
5dd126
# inodes = ""
5dd126
5dd126
# Path to an helper program to use for mounting the file system instead of mounting it
5dd126
# directly.
5dd126
#mount_program = "/usr/bin/fuse-overlayfs"
5dd126
5dd126
# mountopt specifies comma separated list of extra mount options
5dd126
mountopt = "nodev,metacopy=on"
5dd126
5dd126
# Set to skip a PRIVATE bind mount on the storage home directory.
5dd126
# skip_mount_home = "false"
5dd126
5dd126
# Size is used to set a maximum size of the container image.
5dd126
# size = ""
5dd126
5dd126
# ForceMask specifies the permissions mask that is used for new files and
5dd126
# directories.
5dd126
#
5dd126
# The values "shared" and "private" are accepted.
5dd126
# Octal permission masks are also accepted.
5dd126
#
5dd126
#  "": No value specified.
5dd126
#     All files/directories, get set with the permissions identified within the
5dd126
#     image.
5dd126
#  "private": it is equivalent to 0700.
5dd126
#     All files/directories get set with 0700 permissions.  The owner has rwx
5dd126
#     access to the files. No other users on the system can access the files.
5dd126
#     This setting could be used with networked based homedirs.
5dd126
#  "shared": it is equivalent to 0755.
5dd126
#     The owner has rwx access to the files and everyone else can read, access
5dd126
#     and execute them. This setting is useful for sharing containers storage
5dd126
#     with other users.  For instance have a storage owned by root but shared
5dd126
#     to rootless users as an additional store.
5dd126
#     NOTE:  All files within the image are made readable and executable by any
5dd126
#     user on the system. Even /etc/shadow within your image is now readable by
5dd126
#     any user.
5dd126
#
5dd126
#   OCTAL: Users can experiment with other OCTAL Permissions.
5dd126
#
5dd126
#  Note: The force_mask Flag is an experimental feature, it could change in the
5dd126
#  future.  When "force_mask" is set the original permission mask is stored in
5dd126
#  the "user.containers.override_stat" xattr and the "mount_program" option must
5dd126
#  be specified. Mount programs like "/usr/bin/fuse-overlayfs" present the
5dd126
#  extended attribute permissions to processes within containers rather then the
5dd126
#  "force_mask"  permissions.
5dd126
#
5dd126
# force_mask = ""
5dd126
5dd126
[storage.options.thinpool]
5dd126
# Storage Options for thinpool
5dd126
5dd126
# autoextend_percent determines the amount by which pool needs to be
5dd126
# grown. This is specified in terms of % of pool size. So a value of 20 means
5dd126
# that when threshold is hit, pool will be grown by 20% of existing
5dd126
# pool size.
5dd126
# autoextend_percent = "20"
5dd126
5dd126
# autoextend_threshold determines the pool extension threshold in terms
5dd126
# of percentage of pool size. For example, if threshold is 60, that means when
5dd126
# pool is 60% full, threshold has been hit.
5dd126
# autoextend_threshold = "80"
5dd126
5dd126
# basesize specifies the size to use when creating the base device, which
5dd126
# limits the size of images and containers.
5dd126
# basesize = "10G"
5dd126
5dd126
# blocksize specifies a custom blocksize to use for the thin pool.
5dd126
# blocksize="64k"
5dd126
5dd126
# directlvm_device specifies a custom block storage device to use for the
5dd126
# thin pool. Required if you setup devicemapper.
5dd126
# directlvm_device = ""
5dd126
5dd126
# directlvm_device_force wipes device even if device already has a filesystem.
5dd126
# directlvm_device_force = "True"
5dd126
5dd126
# fs specifies the filesystem type to use for the base device.
5dd126
# fs="xfs"
5dd126
5dd126
# log_level sets the log level of devicemapper.
5dd126
# 0: LogLevelSuppress 0 (Default)
5dd126
# 2: LogLevelFatal
5dd126
# 3: LogLevelErr
5dd126
# 4: LogLevelWarn
5dd126
# 5: LogLevelNotice
5dd126
# 6: LogLevelInfo
5dd126
# 7: LogLevelDebug
5dd126
# log_level = "7"
5dd126
5dd126
# min_free_space specifies the min free space percent in a thin pool require for
5dd126
# new device creation to succeed. Valid values are from 0% - 99%.
5dd126
# Value 0% disables
5dd126
# min_free_space = "10%"
5dd126
5dd126
# mkfsarg specifies extra mkfs arguments to be used when creating the base
5dd126
# device.
5dd126
# mkfsarg = ""
5dd126
5dd126
# metadata_size is used to set the `pvcreate --metadatasize` options when
5dd126
# creating thin devices. Default is 128k
5dd126
# metadata_size = ""
5dd126
5dd126
# Size is used to set a maximum size of the container image.
5dd126
# size = ""
5dd126
5dd126
# use_deferred_removal marks devicemapper block device for deferred removal.
5dd126
# If the thinpool is in use when the driver attempts to remove it, the driver
5dd126
# tells the kernel to remove it as soon as possible. Note this does not free
5dd126
# up the disk space, use deferred deletion to fully remove the thinpool.
5dd126
# use_deferred_removal = "True"
5dd126
5dd126
# use_deferred_deletion marks thinpool device for deferred deletion.
5dd126
# If the device is busy when the driver attempts to delete it, the driver
5dd126
# will attempt to delete device every 30 seconds until successful.
5dd126
# If the program using the driver exits, the driver will continue attempting
5dd126
# to cleanup the next time the driver is used. Deferred deletion permanently
5dd126
# deletes the device and all data stored in device will be lost.
5dd126
# use_deferred_deletion = "True"
5dd126
5dd126
# xfs_nospace_max_retries specifies the maximum number of retries XFS should
5dd126
# attempt to complete IO when ENOSPC (no space) error is returned by
5dd126
# underlying storage device.
5dd126
# xfs_nospace_max_retries = "0"