dwww Home | Manual pages | Find package

containers-storage.conf(5)(Container) Filecontainers-storage.conf(5)(Container)

Dan Walsh May 2017

NAME
       storage.conf - Syntax of Container Storage configuration file

DESCRIPTION
       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.

FORMAT
       The  [TOML  format][toml]  is  used as the encoding of the configuration
       file.  Every option and subtable listed here is nested  under  a  global
       "storage"  table.   No  bare options are used. The format of TOML can be
       simplified to:

       [table]
       option = value

       [table.subtable1]
       option = value

       [table.subtable2]
       option = value

STORAGE TABLE
       The storage table supports the following options:

       driver=""
         Copy On Write (COW) container storage driver. Valid drivers are "over-
       lay", "vfs", "aufs", "btrfs", and  "zfs".  Some  drivers  (for  example,
       "zfs",  "btrfs",  and  "aufs") may not work if your kernel lacks support
       for the filesystem.  This field is required to guarantee  proper  opera-
       tion.   Valid rootless drivers are "btrfs", "overlay", and "vfs".  Root-
       less users default to the driver defined  in  the  system  configuration
       when  possible.  When the system configuration uses an unsupported root-
       less driver, rootless users default to "overlay" if available, otherwise
       "vfs".

       graphroot=""
         container storage graph dir  (default:  "/var/lib/containers/storage")
       Default  directory  to  store  all writable content created by container
       storage programs.  The  rootless  graphroot  path  supports  environment
       variable  substitutions  (ie.  $HOME/containers/storage).  When changing
       the graphroot location on an SELINUX system, ensure the labeling matches
       the default locations labels with the following commands:

       # semanage fcontext -a -e /var/lib/containers/storage /NEWSTORAGEPATH
       # restorecon -R -v /NEWSTORAGEPATH

       In rootless mode you would set

       # semanage fcontext -a -e $HOME/.local/share/containers NEWSTORAGEPATH
       $ restorecon -R -v /NEWSTORAGEPATH

       rootless_storage_path="$HOME/.local/share/containers/storage"
         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  sub-
       stitutions (ie. $HOME/containers/storage)

       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 con-
       tainer storage over NFS).

       imagestore=""
        The image storage path (the default is assumed to be the same as graph-
       root). Path of the imagestore, which is different from graphroot. By de-
       fault, images in the storage library are stored in the graphroot. If im-
       agestore  is  provided, newly pulled images will be stored in the image-
       store location. All other storage continues to be stored in  the  graph-
       root.  When  using  the  overlay driver, images previously stored in the
       graphroot remain accessible.  Internally,  the  storage  library  mounts
       graphroot as an additionalImageStore to allow this behavior.

       A  common  use  case for the imagestore field is users who need to split
       filesystems in different partitions. The imagestore partition stores im-
       ages and the graphroot partition stores container content  created  from
       the images.

       Imagestore, if set, must be different from graphroot.

       runroot=""
         container storage run dir (default: "/run/containers/storage") Default
       directory  to  store all temporary writable content created by container
       storage programs. The rootless runroot path supports  environment  vari-
       able substitutions (ie. $HOME/containers/storage)

       driver_priority=[]
         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.  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.   Setting  this  option only has an effect if the local storage
       has not been initialized yet and the driver name is not set.

       transient_store = "false"|"true"

       Transient store mode makes all container metadata be saved in  temporary
       storage (i.e. runroot above). This is faster, but doesn't persist across
       reboots.   Additional garbage collection must also be performed at boot-
       time, so this option should remain disabled in most configurations. (de-
       fault: false)

   STORAGE OPTIONS TABLE
       The storage.options table supports the following options:

       additionalimagestores=[]
         Paths  to  additional  container  image  stores.  Usually  these   are
       read/only and stored on remote network shares.

       root-auto-userns-user=""
         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 automati-
       cally a user namespace.  Containers configured to automatically create a
       user namespace can still overlap with containers having an explicit map-
       ping set.  This setting is ignored when running as rootless.

       auto-userns-min-size=1024
         Auto-userns-min-size is the minimum size for a user namespace  created
       automatically.

       auto-userns-max-size=65536
         Auto-userns-max-size  is the maximum size for a user namespace created
       automatically.

       disable-volatile=true
         If disable-volatile is set, then the "volatile" mount optimization  is
       disabled for all the containers.

   STORAGE PULL OPTIONS TABLE
       The storage.options.pull_options table supports the following keys:

       enable_partial_images="true"|"false"
         Enable the "zstd:chunked" feature, which allows partial pulls, reusing
         content  that  already  exists  on the system. This is disabled by de-
       fault,
         and must be explicitly enabled to be used. For more  on  zstd:chunked,
       see

       ⟨https://github.com/containers/storage/blob/main/docs/containers-stor-
       age-zstd-chunked.md⟩.
         This  is  a  "string  bool":  "false"|"true"  (cannot  be  native TOML
       boolean)

       use_hard_links="false"|"true"
         Tells containers/storage to use hard  links  rather  then  create  new
       files in
         the image, if an identical file already existed in storage.
         This  is  a  "string  bool":  "false"|"true"  (cannot  be  native TOML
       boolean)

       ostree_repos=""
         Path to an ostree repository that might have
         previously pulled content which can be used when attempting to avoid
         pulling content from the container registry.

       convert_images="false"|"true"
         If set to "true", containers/storage will convert images that are
         not already in zstd:chunked format to that format before processing
         in order to take advantage of local deduplication and hard linking.
         It is an expensive operation so it is not enabled by default.
         This is  a  "string  bool":  "false"|"true"  (cannot  be  native  TOML
       boolean)

       insecure_allow_unpredictable_image_contents="false"|"true"
         This should almost never be set.
         It allows partial pulls of images without guaranteeing that "partial
         pulls" and non-partial pulls both result in consistent image contents.
         This  allows pulling estargz images and early versions of zstd:chunked
       images;
         otherwise, these layers always use the  traditional  non-partial  pull
       path.

       This  option should be enabled extremely rarely, only if all images that
       could
         EVER be conceivably pulled on this system are guaranteed (e.g. using a
       signature policy)
         to come from a build system trusted to never attack image integrity.

       If this consistency enforcement were disabled, malicious images could be
       built
         in a way designed to evade other audit mechanisms, so presence of most
       other audit
         mechanisms is not a replacement for the above-mentioned need  for  all
       images to come
         from a trusted build system.

       As  a  side effect, enabling this option will also make image IDs unpre-
       dictable
         (usually not equal to the traditional value matching  the  config  di-
       gest).

       This is a "string bool": "false"|"true" (cannot be native TOML boolean)

   STORAGE OPTIONS FOR AUFS TABLE
       The storage.options.aufs table supports the following options:

       mountopt=""
         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.

   STORAGE OPTIONS FOR BTRFS TABLE
       The storage.options.btrfs table supports the following options:

       min_space=""
         Specifies the min space in a btrfs volume.

       size=""
         Maximum  size  of  a  container  image.   This flag can be used to set
       quota on the size of container images.  (format:  [],  where  unit  =  b
       (bytes), k (kilobytes), m (megabytes), or g (gigabytes))

   STORAGE OPTIONS FOR OVERLAY TABLE
       The storage.options.overlay table supports the following options:

       ignore_chown_errors = "false"
         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.  (de-
       fault: "false")
         This  is  a  "string  bool":  "false"|"true"  (cannot  be  native TOML
       boolean)

       inodes=""
         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.

       force_mask = "0000|shared|private"
         ForceMask specifies the permissions mask that is used  for  new  files
       and  directories.  The values "shared" and "private" are accepted.  (de-
       fault: ""). Octal permission masks are also accepted.

              • ``: Not set All files/directories, get set with the permissions
                identified within the image.

              • private: it is equivalent to 0700.  All  files/directories  get
                set  with  0700  permissions.   The owner has rwx access to the
                files. No other users on the system can access the files.  This
                setting could be used with networked based home directories.

              • shared: it is equivalent to 0755.  The owner has rwx access  to
                the  files and everyone else can read, access and execute them.
                This setting is useful  for  sharing  containers  storage  with
                other  users.   For  instance, a storage owned by root could be
                shared to rootless users as an additional  store.   NOTE:   All
                files  within the image are made readable and executable by any
                user on the system. Even /etc/shadow within your image  is  now
                readable by any user.

       OCTAL: Users can experiment with other OCTAL Permissions.

       Note: The force_mask Flag is an experimental feature, it could change in
       the  future.   When  "force_mask" is set the original permission mask is
       stored in the "user.containers.override_stat" xattr and the  "mount_pro-
       gram" option must be specified. Mount programs like "/usr/bin/fuse-over-
       layfs"  present  the  extended attribute permissions to processes within
       containers rather than the "force_mask"  permissions.

       mount_program=""
         Specifies the path to a custom program to use instead of using  kernel
       defaults  for  mounting  the  file system. In rootless mode, without the
       CAP_SYS_ADMIN capability, many kernels prevent mounting of overlay  file
       systems, requiring you to specify a mount_program. The mount_program op-
       tion  is also required on systems where the underlying storage is btrfs,
       aufs, zfs, overlay, or ecryptfs based file systems.
         mount_program = "/usr/bin/fuse-overlayfs"

       mountopt=""
         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.

       skip_mount_home="false"
         Tell storage drivers to not create a PRIVATE bind mount on their  home
       directory.
         This  is  a  "string  bool":  "false"|"true"  (cannot  be  native TOML
       boolean)

       size=""
         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: [],
       where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes))

       use_composefs = "false"
           Use ComposeFS to mount the data layers image.  ComposeFS support  is
       experimental and not recommended for production use.
           This  is  a  "string  bool":  "false"|"true"  (cannot be native TOML
       boolean)

   STORAGE OPTIONS FOR VFS TABLE
       The storage.options.vfs table supports the following options:

       ignore_chown_errors = "false"
         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.
         This  is  a  "string  bool":  "false"|"true"  (cannot  be  native TOML
       boolean)

   STORAGE OPTIONS FOR ZFS TABLE
       The storage.options.zfs table supports the following options:

       fsname=""
         File System name for the zfs driver

       mountopt=""
         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.

       size=""
         Maximum size of a container image.   This flag  can  be  used  to  set
       quota  on  the  size  of  container  images. (format: [], where unit = b
       (bytes), k (kilobytes), m (megabytes), or g (gigabytes))

SELINUX LABELING
       When running on an SELinux system, if you move  the  containers  storage
       graphroot directory, you must make sure the labeling is correct.

       Tell  SELinux  about the new containers storage by setting up an equiva-
       lence record. This tells SELinux to label content under the new path, as
       if it was stored under /var/lib/containers/storage.

       semanage fcontext -a -e /var/lib/containers NEWSTORAGEPATH
       restorecon -R -v NEWSTORAGEPATH

       In rootless mode, you would set

       semanage fcontext -a -e $HOME/.local/share/containers NEWSTORAGEPATH
       restorecon -R -v NEWSTORAGEPATH

       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.

       Now all new content created in these directories will  automatically  be
       created with the correct label.

QUOTAS
       Container  storage  implements  XFS  project  quota controls for overlay
       storage containers and volumes. The directory used to store the contain-
       ers must be an XFS file system and be mounted with the pquota option.

       Example /etc/fstab entry:

       /dev/podman/podman-var /var xfs defaults,x-systemd.device-timeout=0,pquota 1 2

       Container storage generates project ids for each container  and  builtin
       volume, but these project ids need to be unique for the XFS file system.

       The  xfs_quota  tool  can  be used to assign a project id to the storage
       driver directory, e.g.:

       echo 100000:/var/lib/containers/storage/overlay >> /etc/projects
       echo 200000:/var/lib/containers/storage/volumes >> /etc/projects
       echo storage:100000 >> /etc/projid
       echo volumes:200000 >> /etc/projid
       xfs_quota -x -c 'project -s storage volumes' /<xfs mount point>

       In the example above, the storage directory project id will be used as a
       "start offset" and all containers will be assigned  larger  project  ids
       (e.g. >= 100000).  Then the volumes directory project id will be used as
       a  "start  offset"  and  all volumes will be assigned larger project ids
       (e.g. >= 200000).  This is a way to prevent  xfs_quota  management  from
       conflicting with containers/storage.

FILES
       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  con-
       figuration.  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.

       Note: The storage.conf file overrides all other storage.conf files. Con-
       tainer engines run by users with a storage.conf file in their  home  di-
       rectory do not use options in the system storage.conf files.

       /etc/projects  -  XFS  persistent  project root definition /etc/projid -
       XFS project name mapping file

SEE ALSO
       semanage(8), restorecon(8), mount(8),  fuse-overlayfs(1),  xfs_quota(8),
       projects(5), projid(5)

HISTORY
       May   2017,   Originally   compiled   by   Dan  Walsh  dwalsh@redhat.com
       ⟨mailto:dwalsh@redhat.com⟩ Format copied from crio.conf man page created
       by Aleksa Sarai asarai@suse.de ⟨mailto:asarai@suse.de⟩

Configuration                       Storagcontainers-storage.conf(5)(Container)

Generated by dwww version 1.16 on Sat Oct 31 06:49:27 CET 2026.