f2048a
% storage.conf(5) Container Storage Configuration File
f2048a
% Dan Walsh
f2048a
% May 2017
f2048a
f2048a
# NAME
f2048a
storage.conf - Syntax of Container Storage configuration file
f2048a
f2048a
# DESCRIPTION
f2048a
The STORAGE configuration file specifies all of the available container storage options
f2048a
for tools using shared container storage, but in a TOML format that can be more easily modified
f2048a
and versioned.
f2048a
f2048a
# FORMAT
f2048a
The [TOML format][toml] is used as the encoding of the configuration file.
f2048a
Every option and subtable listed here is nested under a global "storage" table.
f2048a
No bare options are used. The format of TOML can be simplified to:
f2048a
f2048a
    [table]
f2048a
    option = value
f2048a
f2048a
    [table.subtable1]
f2048a
    option = value
f2048a
f2048a
    [table.subtable2]
f2048a
    option = value
f2048a
f2048a
## STORAGE TABLE
f2048a
f2048a
The `storage` table supports the following options:
f2048a
f2048a
**graphroot**=""
f2048a
  container storage graph dir (default: "/var/lib/containers/storage")
f2048a
  Default directory to store all writable content created by container storage programs
f2048a
f2048a
**runroot**=""
f2048a
  container storage run dir (default: "/var/run/containers/storage")
f2048a
  Default directory to store all temporary writable content created by container storage programs
f2048a
f2048a
**driver**=""
f2048a
  container storage driver (default is "overlay")
f2048a
  Default Copy On Write (COW) container storage driver
f2048a
f2048a
### STORAGE OPTIONS TABLE 
f2048a
f2048a
The `storage.options` table supports the following options:
f2048a
f2048a
**additionalimagestores**=[]
f2048a
  Paths to additional container image stores. Usually these are read/only and stored on remote network shares.
f2048a
f2048a
**size**=""
f2048a
  Maximum size of a container image.  Default is 10GB.  This flag can be used to set quota
f2048a
  on the size of container images.
f2048a
f2048a
**override_kernel_check**=""
f2048a
  Tell storage drivers to ignore kernel version checks.  Some storage drivers assume that if a kernel is too
f2048a
  old, the driver is not supported.  But for kernels that have had the drivers backported, this flag
f2048a
  allows users to override the checks
f2048a
f2048a
[storage.options.thinpool]
f2048a
f2048a
Storage Options for thinpool
f2048a
f2048a
The `storage.options.thinpool` table supports the following options:
f2048a
f2048a
**autoextend_percent**=""
f2048a
f2048a
Tells the thinpool driver the amount by which the thinpool needs to be grown. This is specified in terms of % of pool size. So a value of 20 means that when threshold is hit, pool will be grown by 20% of existing pool size. (Default is 20%)
f2048a
f2048a
**autoextend_threshold**=""
f2048a
f2048a
Tells the driver the thinpool extension threshold in terms of percentage of pool size. For example, if threshold is 60, that means when pool is 60% full, threshold has been hit. (80% is the default)
f2048a
f2048a
**basesize**=""
f2048a
f2048a
Specifies the size to use when creating the base device, which limits the size of images and containers. (10g is the default)
f2048a
f2048a
**blocksize**=""
f2048a
f2048a
Specifies a custom blocksize to use for the thin pool. (64k is the default)
f2048a
f2048a
**directlvm_device**=""
f2048a
f2048a
Specifies a custom block storage device to use for the thin pool. Required if you setup devicemapper
f2048a
f2048a
**directlvm_device_force**=""
f2048a
f2048a
Tells driver to wipe device (directlvm_device) even if device already has a filesystem.  Default is False
f2048a
f2048a
**fs**="xfs"
f2048a
f2048a
Specifies the filesystem type to use for the base device. (Default is xfs)
f2048a
f2048a
**log_level**=""
f2048a
f2048a
Sets the log level of devicemapper.
f2048a
f2048a
    0: LogLevelSuppress 0 (Default)
f2048a
    2: LogLevelFatal
f2048a
    3: LogLevelErr
f2048a
    4: LogLevelWarn
f2048a
    5: LogLevelNotice
f2048a
    6: LogLevelInfo
f2048a
    7: LogLevelDebug
f2048a
f2048a
**min_free_space**=""
f2048a
f2048a
Specifies the min free space percent in a thin pool require for new device creation to succeed. Valid values are from 0% - 99%. Value 0% disables (10% is the default)
f2048a
f2048a
**mkfsarg**=""
f2048a
f2048a
Specifies extra mkfs arguments to be used when creating the base device.
f2048a
f2048a
**mountopt**=""
f2048a
f2048a
Specifies extra mount options used when mounting the thin devices.
f2048a
f2048a
**use_deferred_removal**=""
f2048a
f2048a
Marks device for deferred removal.  If the device is in use when it driver attempts to remove it, driver will tell the kernel to remove it as soon as possible.  (Default is true).
f2048a
f2048a
**use_deferred_deletion**=""
f2048a
f2048a
Marks device for deferred deletion. If the device is in use when it driver attempts to delete it, driver continue to attempt to delete device every 30 seconds, or when it restarts.  (Default is true).
f2048a
f2048a
**xfs_nospace_max_retries**=""
f2048a
f2048a
Specifies the maximum number of retries XFS should attempt to complete IO when ENOSPC (no space) error is returned by underlying storage device. (Default is 0, which means to try continuously.
f2048a
f2048a
# HISTORY
f2048a
May 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>
f2048a
Format copied from crio.conf man page created by Aleksa Sarai <asarai@suse.de>