a415a1
% containers-storage.conf(5) Container Storage Configuration File
a415a1
% Dan Walsh
a415a1
% May 2017
a415a1
a415a1
# NAME
a415a1
storage.conf - Syntax of Container Storage configuration file
a415a1
a415a1
## DESCRIPTION
a415a1
The STORAGE configuration file specifies all of the available container storage options for tools using shared container storage, but in a TOML format that can be more easily modified and versioned.
a415a1
a415a1
## FORMAT
a415a1
The [TOML format][toml] is used as the encoding of the configuration file.
a415a1
Every option and subtable listed here is nested under a global "storage" table.
a415a1
No bare options are used. The format of TOML can be simplified to:
a415a1
a415a1
    [table]
a415a1
    option = value
a415a1
a415a1
    [table.subtable1]
a415a1
    option = value
a415a1
a415a1
    [table.subtable2]
a415a1
    option = value
a415a1
a415a1
## STORAGE TABLE
a415a1
a415a1
The `storage` table supports the following options:
a415a1
a415a1
**driver**=""
5f1c70
  Copy On Write (COW) container storage driver. Valid drivers are "overlay", "vfs", "devmapper", "aufs", "btrfs", and "zfs". Some drivers (for example, "zfs", "btrfs", and "aufs") may not work if your kernel lacks support for the filesystem.
5f1c70
This field is required to guarantee proper operation.
5f1c70
Valid rootless drivers are "btrfs", "overlay", and "vfs".
5f1c70
Rootless users default to the driver defined in the system configuration when possible.
5f1c70
When the system configuration uses an unsupported rootless driver, rootless users default to "overlay" if available, otherwise "vfs".
a415a1
a415a1
**graphroot**=""
a415a1
  container storage graph dir (default: "/var/lib/containers/storage")
5f1c70
Default directory to store all writable content created by container storage programs.
5f1c70
The rootless graphroot path supports environment variable substitutions (ie. `$HOME/containers/storage`).
5f1c70
When changing the graphroot location on an SELINUX system, ensure the labeling matches the default locations labels with the following commands:
893b01
bafb64
```
bafb64
# semanage fcontext -a -e /var/lib/containers/storage /NEWSTORAGEPATH
bafb64
# restorecon -R -v /NEWSTORAGEPATH
bafb64
```
bafb64
5f1c70
In rootless mode you would set
a415a1
bafb64
```
bafb64
# semanage fcontext -a -e $HOME/.local/share/containers NEWSTORAGEPATH
bafb64
$ restorecon -R -v /NEWSTORAGEPATH
bafb64
```
a415a1
**rootless_storage_path**="$HOME/.local/share/containers/storage"
5f1c70
  Storage path for rootless users. By default the graphroot for rootless users is set to `$XDG_DATA_HOME/containers/storage`, if XDG_DATA_HOME is set. Otherwise `$HOME/.local/share/containers/storage` is used. This field can be used if administrators need to change the storage location for all users. The rootless storage path supports environment variable substitutions (ie. `$HOME/containers/storage`)
a415a1
5f1c70
A common use case for this field is to provide a local storage directory when user home directories are NFS-mounted (podman does not support container storage over NFS).
a415a1
a415a1
**runroot**=""
a415a1
  container storage run dir (default: "/run/containers/storage")
5f1c70
Default directory to store all temporary writable content created by container storage programs. The rootless runroot path supports environment variable substitutions (ie. `$HOME/containers/storage`)
5f1c70
5f1c70
**driver_priority**=[]
5f1c70
  Priority list for the storage drivers that will be tested one after the other to pick the storage driver if it is not defined. The first storage driver in this list that can be used, will be picked as the new one and all subsequent ones will not be tried. If all drivers in this list are not viable, then **all** known drivers will be tried and the first working one will be picked.
5f1c70
By default, the storage driver is set via the `driver` option. If it is not defined, then the best driver will be picked according to the current platform. This option allows you to override this internal priority list with a custom one to prefer certain drivers.
5f1c70
Setting this option only has an effect if the local storage has not been initialized yet and the driver name is not set.
a415a1
a415a1
### STORAGE OPTIONS TABLE
a415a1
a415a1
The `storage.options` table supports the following options:
a415a1
a415a1
**additionalimagestores**=[]
a415a1
  Paths to additional container image stores. Usually these are read/only and stored on remote network shares.
a415a1
893b01
**pull_options** = {enable_partial_images = "false", use_hard_links = "false", ostree_repos=""}
893b01
893b01
Allows specification of how storage is populated when pulling images. This
893b01
option can speed the pulling process of images compressed with format zstd:chunked. Containers/storage looks
893b01
for files within images that are being pulled from a container registry that
893b01
were previously pulled to the host.  It can copy or create
893b01
a hard link to the existing file when it finds them, eliminating the need to pull them from the
893b01
container registry. These options can deduplicate pulling of content, disk
893b01
storage of content and can allow the kernel to use less memory when running
893b01
containers.
893b01
893b01
containers/storage supports four keys
893b01
  * enable_partial_images="true" | "false"
893b01
    Tells containers/storage to look for files previously pulled in storage
893b01
    rather then always pulling them from the container registry.
893b01
  * use_hard_links = "false" | "true"
893b01
    Tells containers/storage to use hard links rather then create new files in
893b01
    the image, if an identical file already existed in storage.
893b01
  * ostree_repos = ""
893b01
    Tells containers/storage where an ostree repository exists that might have
893b01
    previously pulled content which can be used when attempting to avoid
893b01
    pulling content from the container registry
893b01
a415a1
**remap-uids=**""
a415a1
**remap-gids=**""
a415a1
  Remap-UIDs/GIDs is the mapping from UIDs/GIDs as they should appear inside of a container, to the UIDs/GIDs outside of the container, and the length of the range of UIDs/GIDs.  Additional mapped sets can be listed and will be heeded by libraries, but there are limits to the number of mappings which the kernel will allow when you later attempt to run a container.
a415a1
a415a1
  Example
a415a1
     remap-uids = 0:1668442479:65536
a415a1
     remap-gids = 0:1668442479:65536
a415a1
a415a1
  These mappings tell the container engines to map UID 0 inside of the container to UID 1668442479 outside.  UID 1 will be mapped to 1668442480. UID 2 will be mapped to 1668442481, etc, for the next 65533 UIDs in succession.
a415a1
a415a1
**remap-user**=""
a415a1
**remap-group**=""
a415a1
  Remap-User/Group is a user name which can be used to look up one or more UID/GID ranges in the /etc/subuid or /etc/subgid file.  Mappings are set up starting with an in-container ID of 0 and then a host-level ID taken from the lowest range that matches the specified name, and using the length of that range. Additional ranges are then assigned, using the ranges which specify the lowest host-level IDs first, to the lowest not-yet-mapped in-container ID, until all of the entries have been used for maps.
a415a1
a415a1
  Example
a415a1
     remap-user = "containers"
a415a1
     remap-group = "containers"
a415a1
a415a1
**root-auto-userns-user**=""
a415a1
  Root-auto-userns-user is a user name which can be used to look up one or more UID/GID ranges in the /etc/subuid and /etc/subgid file.  These ranges will be partitioned to containers configured to create automatically a user namespace.  Containers configured to automatically create a user namespace can still overlap with containers having an explicit mapping set.  This setting is ignored when running as rootless.
a415a1
a415a1
**auto-userns-min-size**=1024
a415a1
  Auto-userns-min-size is the minimum size for a user namespace created automatically.
a415a1
a415a1
**auto-userns-max-size**=65536
a415a1
  Auto-userns-max-size is the maximum size for a user namespace created automatically.
a415a1
a415a1
**disable-volatile**=true
a415a1
  If disable-volatile is set, then the "volatile" mount optimization is disabled for all the containers.
a415a1
a415a1
### STORAGE OPTIONS FOR AUFS TABLE
a415a1
a415a1
The `storage.options.aufs` table supports the following options:
a415a1
a415a1
**mountopt**=""
a415a1
  Comma separated list of default options to be used to mount container images.  Suggested value "nodev". Mount options are documented in the mount(8) man page.
a415a1
a415a1
### STORAGE OPTIONS FOR BTRFS TABLE
a415a1
a415a1
The `storage.options.btrfs` table supports the following options:
a415a1
a415a1
**min_space**=""
a415a1
  Specifies the min space in a btrfs volume.
a415a1
a415a1
**size**=""
a415a1
  Maximum size of a container image.   This flag can be used to set quota on the size of container images. (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes))
a415a1
a415a1
### STORAGE OPTIONS FOR THINPOOL (devicemapper) TABLE
a415a1
a415a1
The `storage.options.thinpool` table supports the following options for the `devicemapper` driver:
a415a1
a415a1
**autoextend_percent**=""
a415a1
  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: 20%)
a415a1
a415a1
**autoextend_threshold**=""
a415a1
  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. (default: 80%)
a415a1
a415a1
**basesize**=""
a415a1
  Specifies the size to use when creating the base device, which limits the size of images and containers. (default: 10g)
a415a1
a415a1
**blocksize**=""
a415a1
  Specifies a custom blocksize to use for the thin pool. (default: 64k)
a415a1
a415a1
**directlvm_device**=""
a415a1
  Specifies a custom block storage device to use for the thin pool. Required for using graphdriver `devicemapper`.
a415a1
a415a1
**directlvm_device_force**=""
a415a1
  Tells driver to wipe device (directlvm_device) even if device already has a filesystem.  (default: false)
a415a1
a415a1
**fs**="xfs"
a415a1
  Specifies the filesystem type to use for the base device. (default: xfs)
a415a1
a415a1
**log_level**=""
a415a1
  Sets the log level of devicemapper.
a415a1
a415a1
    0: LogLevelSuppress 0 (default)
a415a1
    2: LogLevelFatal
a415a1
    3: LogLevelErr
a415a1
    4: LogLevelWarn
a415a1
    5: LogLevelNotice
a415a1
    6: LogLevelInfo
a415a1
    7: LogLevelDebug
a415a1
a415a1
**metadata_size**=""
a415a1
  metadata_size is used to set the `pvcreate --metadatasize` options when creating thin devices. (Default 128k)
a415a1
a415a1
**min_free_space**=""
a415a1
  Specifies the min free space percent in a thin pool required for new device creation to succeed. Valid values are from 0% - 99%. Value 0% disables. (default: 10%)
a415a1
a415a1
**mkfsarg**=""
a415a1
  Specifies extra mkfs arguments to be used when creating the base device.
a415a1
a415a1
**mountopt**=""
a415a1
  Comma separated list of default options to be used to mount container images.  Suggested value "nodev". Mount options are documented in the mount(8) man page.
a415a1
a415a1
**size**=""
a415a1
  Maximum size of a container image.  This flag can be used to set quota on the size of container images. (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes))
a415a1
a415a1
**use_deferred_deletion**=""
a415a1
  Marks thinpool device for deferred deletion. If the thinpool is in use when the driver attempts to delete it, the driver will attempt to delete device every 30 seconds until successful, or when it restarts.  Deferred deletion permanently deletes the device and all data stored in the device will be lost. (default: true).
a415a1
a415a1
**use_deferred_removal**=""
a415a1
  Marks devicemapper block device for deferred removal.  If the device is in use when its driver attempts to remove it, the driver tells the kernel to remove the device as soon as possible.  Note this does not free up the disk space, use deferred deletion to fully remove the thinpool.  (default: true).
a415a1
a415a1
**xfs_nospace_max_retries**=""
a415a1
  Specifies the maximum number of retries XFS should attempt to complete IO when ENOSPC (no space) error is returned by underlying storage device. (default: 0, which means to try continuously.)
a415a1
a415a1
### STORAGE OPTIONS FOR OVERLAY TABLE
a415a1
a415a1
The `storage.options.overlay` table supports the following options:
a415a1
a415a1
**ignore_chown_errors** = "false"
a415a1
  ignore_chown_errors can be set to allow a non privileged user running with a  single UID within a user namespace to run containers. The user can pull and use any image even those with multiple uids.  Note multiple UIDs will be squashed down to the default uid in the container.  These images will have no separation between the users in the container. (default: false)
a415a1
a415a1
**inodes**=""
a415a1
  Maximum inodes in a read/write layer.   This flag can be used to set a quota on the inodes allocated for a read/write layer of a container.
a415a1
a415a1
**force_mask** = "0000|shared|private"
a415a1
  ForceMask specifies the permissions mask that is used for new files and
5f1c70
directories. The values "shared" and "private" are accepted.  (default: ""). Octal permission
a415a1
masks are also accepted.
a415a1
5f1c70
- ``: Not set
5f1c70
  All files/directories, get set with the permissions identified within the
a415a1
image.
a415a1
5f1c70
- `private`: it is equivalent to 0700.
5f1c70
  All files/directories get set with 0700 permissions.  The owner has rwx
a415a1
access to the files. No other users on the system can access the files.
a415a1
This setting could be used with networked based home directories.
a415a1
5f1c70
- `shared`: it is equivalent to 0755.
5f1c70
  The owner has rwx access to the files and everyone else can read, access
a415a1
and execute them. This setting is useful for sharing containers storage
a415a1
with other users.  For instance, a storage owned by root could be shared
a415a1
to rootless users as an additional store.
a415a1
NOTE:  All files within the image are made readable and executable by any
a415a1
user on the system. Even /etc/shadow within your image is now readable by
a415a1
any user.
a415a1
a415a1
  `OCTAL`: Users can experiment with other OCTAL Permissions.
a415a1
a415a1
Note: The force_mask Flag is an experimental feature, it could change in the
a415a1
future.  When "force_mask" is set the original permission mask is stored in the
a415a1
"user.containers.override_stat" xattr and the "mount_program" option must be
a415a1
specified. Mount programs like "/usr/bin/fuse-overlayfs" present the extended
5f1c70
attribute permissions to processes within containers rather than the
a415a1
"force_mask"  permissions.
a415a1
a415a1
**mount_program**=""
a415a1
  Specifies the path to a custom program to use instead of using kernel defaults
a415a1
for mounting the file system. In rootless mode, without the CAP_SYS_ADMIN
a415a1
capability, many kernels prevent mounting of overlay file systems, requiring
a415a1
you to specify a mount_program. The mount_program option is also required on
a415a1
systems where the underlying storage is btrfs, aufs, zfs, overlay, or ecryptfs
a415a1
based file systems.
a415a1
  mount_program = "/usr/bin/fuse-overlayfs"
a415a1
a415a1
**mountopt**=""
a415a1
  Comma separated list of default options to be used to mount container images.  Suggested value "nodev". Mount options are documented in the mount(8) man page.
a415a1
893b01
**skip_mount_home=""**
893b01
  Tell storage drivers to not create a PRIVATE bind mount on their home directory.
893b01
a415a1
**size**=""
a415a1
  Maximum size of a read/write layer.   This flag can be used to set quota on the size of a read/write layer of a container. (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes))
a415a1
a415a1
### STORAGE OPTIONS FOR VFS TABLE
a415a1
a415a1
The `storage.options.vfs` table supports the following options:
a415a1
a415a1
**ignore_chown_errors** = "false"
a415a1
  ignore_chown_errors can be set to allow a non privileged user running with a  single UID within a user namespace to run containers. The user can pull and use any image even those with multiple uids.  Note multiple UIDs will be squashed down to the default uid in the container.  These images will have no separation between the users in the container. (default: false)
a415a1
a415a1
### STORAGE OPTIONS FOR ZFS TABLE
a415a1
a415a1
The `storage.options.zfs` table supports the following options:
a415a1
a415a1
**fsname**=""
a415a1
  File System name for the zfs driver
a415a1
a415a1
**mountopt**=""
a415a1
  Comma separated list of default options to be used to mount container images.  Suggested value "nodev". Mount options are documented in the mount(8) man page.
a415a1
a415a1
**size**=""
a415a1
  Maximum size of a container image.   This flag can be used to set quota on the size of container images. (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes))
a415a1
a415a1
## SELINUX LABELING
a415a1
a415a1
When running on an SELinux system, if you move the containers storage graphroot directory, you must make sure the labeling is correct.
a415a1
a415a1
Tell SELinux about the new containers storage by setting up an equivalence record. This tells SELinux to label content under the new path, as if it was stored under `/var/lib/containers/storage`.
a415a1
a415a1
```
a415a1
semanage fcontext -a -e /var/lib/containers NEWSTORAGEPATH
a415a1
restorecon -R -v NEWSTORAGEPATH
a415a1
```
a415a1
bafb64
In rootless mode, you would set
bafb64
bafb64
```
bafb64
semanage fcontext -a -e $HOME/.local/share/containers NEWSTORAGEPATH
bafb64
restorecon -R -v NEWSTORAGEPATH
bafb64
```
bafb64
a415a1
The semanage command above tells SELinux to setup the default labeling of `NEWSTORAGEPATH` to match `/var/lib/containers`.  The `restorecon` command tells SELinux to apply the labels to the actual content.
a415a1
a415a1
Now all new content created in these directories will automatically be created with the correct label.
a415a1
a415a1
## QUOTAS
a415a1
a415a1
Container storage implements `XFS project quota controls` for overlay storage
a415a1
containers and volumes. The directory used to store the containers must be an
a415a1
`XFS` file system and be mounted with the `pquota` option.
a415a1
a415a1
Example /etc/fstab entry:
a415a1
```
a415a1
/dev/podman/podman-var /var xfs defaults,x-systemd.device-timeout=0,pquota 1 2
a415a1
```
a415a1
a415a1
Container storage generates project ids for each container and builtin volume, but these project ids need to be unique for the XFS file system.
a415a1
a415a1
The xfs_quota tool can be used to assign a project id to the storage driver directory, e.g.:
a415a1
a415a1
```
a415a1
echo 100000:/var/lib/containers/storage/overlay >> /etc/projects
a415a1
echo 200000:/var/lib/containers/storage/volumes >> /etc/projects
a415a1
echo storage:100000 >> /etc/projid
a415a1
echo volumes:200000 >> /etc/projid
a415a1
xfs_quota -x -c 'project -s storage volumes' /<xfs mount point>
a415a1
```
a415a1
a415a1
In the example above, the storage directory project id will be used as a "start offset"
a415a1
and all containers will be assigned larger project ids (e.g. >= 100000).
a415a1
Then the volumes directory project id will be used as a "start offset"
a415a1
and all volumes will be assigned larger project ids (e.g. >= 200000).
a415a1
This is a way to prevent xfs_quota management from conflicting with containers/storage.
a415a1
a415a1
## FILES
a415a1
bafb64
Distributions often provide a `/usr/share/containers/storage.conf` file to define default storage configuration. Administrators can override this file by creating `/etc/containers/storage.conf` to specify their own configuration. Likewise rootless users can create a storage.conf file to override the system storage.conf files. Files should be stored in the `$XDG_CONFIG_HOME/containers/storage.conf` file.  If `$XDG_CONFIG_HOME` is not set then the file `$HOME/.config/containers/storage.conf` is used.
bafb64
5f1c70
Note: The storage.conf file overrides all other storage.conf files. Container
bafb64
engines run by users with a storage.conf file in their home directory do not
bafb64
use options in the system storage.conf files.
a415a1
a415a1
/etc/projects - XFS persistent project root definition
a415a1
/etc/projid -  XFS project name mapping file
a415a1
a415a1
## SEE ALSO
a415a1
`semanage(8)`, `restorecon(8)`, `mount(8)`, `fuse-overlayfs(1)`, `xfs_quota(8)`, `projects(5)`, `projid(5)`
a415a1
a415a1
## HISTORY
a415a1
May 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>
a415a1
Format copied from crio.conf man page created by Aleksa Sarai <asarai@suse.de>