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