From fe2591054cb47c6f97d66b1e7bf0f32f94704189 Mon Sep 17 00:00:00 2001 From: Lokesh Mandvekar Date: Sun, 11 Mar 2018 13:28:43 -0400 Subject: [PATCH] add storage.conf and manpage in contrib/ These files are used by deb and rpm packages, so I'd rather have them upstream than maintain in 2 separate places. Signed-off-by: Lokesh Mandvekar --- contrib/containers-storage.conf.5.md | 60 ++++++++++++++++++++++++++++ contrib/storage.conf | 28 +++++++++++++ 2 files changed, 88 insertions(+) create mode 100644 contrib/containers-storage.conf.5.md create mode 100644 contrib/storage.conf diff --git a/contrib/containers-storage.conf.5.md b/contrib/containers-storage.conf.5.md new file mode 100644 index 00000000..a4ad674c --- /dev/null +++ b/contrib/containers-storage.conf.5.md @@ -0,0 +1,60 @@ +% storage.conf(5) Container Storage Configuration File +% 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. + +# 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: + +**graphroot**="" + container storage graph dir (default: "/var/lib/containers/storage") + Default directory to store all writable content created by container storage programs. + +**runroot**="" + container storage run dir (default: "/var/run/containers/storage") + Default directory to store all temporary writable content created by container storage programs. + +**driver**="" + container storage driver (default is "overlay") + Default Copy On Write (COW) container storage driver. + +### 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. + +**size**="" + Maximum size of a container image. Default is 10GB. This flag can be used to set quota + on the size of container images. + +**override_kernel_check**="" + Tell storage drivers to ignore kernel version checks. Some storage drivers assume that if a kernel is too + old, the driver is not supported. But for kernels that have had the drivers backported, this flag + allows users to override the checks. + +# HISTORY +May 2017, Originally compiled by Dan Walsh +Format copied from crio.conf man page created by Aleksa Sarai diff --git a/contrib/storage.conf b/contrib/storage.conf new file mode 100644 index 00000000..4a697833 --- /dev/null +++ b/contrib/storage.conf @@ -0,0 +1,28 @@ +# storage.conf is the configuration file for all tools +# that share the containers/storage libraries +# See man 5 containers-storage.conf for more information + +# The "container storage" table contains all of the server options. +[storage] + +# Default Storage Driver +driver = "overlay" + +# Temporary storage location +runroot = "/var/run/containers/storage" + +# Primary read-write location of container storage +graphroot = "/var/lib/containers/storage" + +[storage.options] +# AdditionalImageStores is used to pass paths to additional read-only image stores +# Must be comma separated list. +additionalimagestores = [ +] + +# Size is used to set a maximum size of the container image. Only supported by +# certain container storage drivers (currently overlay, zfs, vfs, btrfs) +size = "" + +# OverrideKernelCheck tells the driver to ignore kernel checks based on kernel version +override_kernel_check = "true"