1storage.conf(5) May 2017 storage.conf(5)
2
6 storage.conf - Syntax of Container Storage configuration file
7
11 The STORAGE configuration file specifies all of the available container
12 storage options for tools using shared container storage, but in a TOML
13 format that can be more easily modified and versioned.
14
18 The [TOML format][toml] is used as the encoding of the configuration
19 file. Every option and subtable listed here is nested under a global
20 "storage" table. No bare options are used. The format of TOML can be
21 simplified to:
22 [table]
25 option = value
26 [table.subtable1]
28 option = value
29 [table.subtable2]
31 option = value
32
36 The storage table supports the following options:
37 graphroot=""
40 container storage graph dir (default: "/var/lib/containers/storage")
41 Default directory to store all writable content created by container
42 storage programs
43 runroot=""
46 container storage run dir (default: "/var/run/containers/storage")
47 Default directory to store all temporary writable content created by
48 container storage programs
49 driver=""
52 container storage driver (default: "overlay")
53 Default Copy On Write (COW) container storage driver
54 Valid drivers are "overlay", "vfs", "devmapper", "aufs", "btrfs", and
55 "zfs"
56 Some drivers (for example, "zfs", "btrfs", and "aufs") may not work
57 if your kernel lacks support for the filesystem
58 STORAGE OPTIONS TABLE
61 The storage.options table supports the following options:
62 additionalimagestores=[]
65 Paths to additional container image stores. Usually these are
66 read/only and stored on remote network shares.
67 size=""
70 Maximum size of a container image. This flag can be used to set
71 quota on the size of container images. (default: 10GB)
72 mount_program=""
75 Specifies the path to a custom program to use instead for mounting
76 the file system.
77 mountopt=""
80 Comma separated list of default options to be used to mount container
83 images. Suggested value "nodev".
84 [storage.options.thinpool]
87 Storage Options for thinpool
90 The storage.options.thinpool table supports the following options:
93 autoextend_percent=""
96 Tells the thinpool driver the amount by which the thinpool needs to be
99 grown. This is specified in terms of % of pool size. So a value of 20
100 means that when threshold is hit, pool will be grown by 20% of existing
101 pool size. (default: 20%)
102 autoextend_threshold=""
105 Tells the driver the thinpool extension threshold in terms of
108 percentage of pool size. For example, if threshold is 60, that means
109 when pool is 60% full, threshold has been hit. (default: 80%)
110 basesize=""
113 Specifies the size to use when creating the base device, which limits
116 the size of images and containers. (default: 10g)
117 blocksize=""
120 Specifies a custom blocksize to use for the thin pool. (default: 64k)
123 directlvm_device=""
126 Specifies a custom block storage device to use for the thin pool.
129 Required for using graphdriver devicemapper.
130 directlvm_device_force=""
133 Tells driver to wipe device (directlvm_device) even if device already
136 has a filesystem. (default: false)
137 fs="xfs"
140 Specifies the filesystem type to use for the base device. (default:
143 xfs)
144 log_level=""
147 Sets the log level of devicemapper.
150 0: LogLevelSuppress 0 (default)
153 2: LogLevelFatal
154 3: LogLevelErr
155 4: LogLevelWarn
156 5: LogLevelNotice
157 6: LogLevelInfo
158 7: LogLevelDebug
159 min_free_space=""
163 Specifies the min free space percent in a thin pool required for new
166 device creation to succeed. Valid values are from 0% - 99%. Value 0%
167 disables. (default: 10%)
168 mkfsarg=""
171 Specifies extra mkfs arguments to be used when creating the base
174 device.
175 use_deferred_removal=""
178 Marks devicemapper block device for deferred removal. If the device is
181 in use when its driver attempts to remove it, the driver tells the
182 kernel to remove the device as soon as possible. Note this does not
183 free up the disk space, use deferred deletion to fully remove the
184 thinpool. (default: true).
185 use_deferred_deletion=""
188 Marks thinpool device for deferred deletion. If the thinpool is in use
191 when the driver attempts to delete it, the driver will attempt to
192 delete device every 30 seconds until successful, or when it restarts.
193 Deferred deletion permanently deletes the device and all data stored in
194 the device will be lost. (default: true).
195 xfs_nospace_max_retries=""
198 Specifies the maximum number of retries XFS should attempt to complete
201 IO when ENOSPC (no space) error is returned by underlying storage
202 device. (default: 0, which means to try continuously.)
203 ostree_repo=""
206 Tell storage drivers to use the specified OSTree repository. Some
207 storage drivers, such as overlay, might use
208 skip_mount_home=""
211 Tell storage drivers to not create a PRIVATE bind mount on their home
212 directory.
213
217 May 2017, Originally compiled by Dan Walsh ⟨dwalsh@redhat.com⟩ Format
218 copied from crio.conf man page created by Aleksa Sarai ⟨asarai@suse.de⟩
219Dan Walsh Container Storage Configuration File storage.conf(5)