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