diff --git a/containers-storage.conf.5.md b/containers-storage.conf.5.md index 838726b..ce6032b 100644 --- a/containers-storage.conf.5.md +++ b/containers-storage.conf.5.md @@ -27,45 +27,37 @@ No bare options are used. The format of TOML can be simplified to: The `storage` table supports the following options: **driver**="" - container storage driver - Default 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. - This field is required to guarantee proper operation. - Valid rootless drivers are "btrfs", "overlay", and "vfs". - Rootless users default to the driver defined in the system configuration when possible. - When the system configuration uses an unsupported rootless driver, rootless users default to "overlay" if available, otherwise "vfs". + 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. +This field is required to guarantee proper operation. +Valid rootless drivers are "btrfs", "overlay", and "vfs". +Rootless users default to the driver defined in the system configuration when possible. +When the system configuration uses an unsupported rootless 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: +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 +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 substitutions (ie. `$HOME/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 substitutions (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 container storage over NFS). +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). **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 variable substitutions (ie. `$HOME/containers/storage`) +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`) ### STORAGE OPTIONS TABLE @@ -216,21 +208,20 @@ The `storage.options.overlay` table supports the following options: **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. (default: ""). Octal permission +directories. The values "shared" and "private" are accepted. (default: ""). Octal permission masks are also accepted. - ``: Not set - All files/directories, get set with the permissions identified within the +- ``: 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 +- `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 +- `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. diff --git a/containers-transports.5.md b/containers-transports.5.md index 6c94d0a..b79f1e5 100644 --- a/containers-transports.5.md +++ b/containers-transports.5.md @@ -11,6 +11,11 @@ containers-transports - description of supported transports for copying and stor Tools which use the containers/image library, including skopeo(1), buildah(1), podman(1), all share a common syntax for referring to container images in various locations. The general form of the syntax is _transport:details_, where details are dependent on the specified transport, which are documented below. +The semantics of the image names ultimately depend on the environment where +they are evaluated. For example: if evaluated on a remote server, image names +might refer to paths on that server; relative paths are relative to the current +directory of the image consumer. + ### **containers-storage**:[**[**storage-specifier**]**]{image-id|docker-reference[@image-id]} An image located in a local containers storage. diff --git a/containers.conf b/containers.conf index b246363..a929420 100644 --- a/containers.conf +++ b/containers.conf @@ -605,6 +605,12 @@ log_driver = "journald" # #volume_path = "/var/lib/containers/storage/volumes" +# Default timeout (in seconds) for volume plugin operations. +# Plugins are external programs accessed via a REST API; this sets a timeout +# for requests to that API. +# A value of 0 is treated as no timeout. +#volume_plugin_timeout = 5 + # Paths to look for a valid OCI runtime (crun, runc, kata, runsc, krun, etc) [engine.runtimes] #crun = [ @@ -665,9 +671,16 @@ log_driver = "journald" # #disk_size=10 -# The image used when creating a podman-machine VM. +# Default image URI when creating a new VM using `podman machine init`. +# Options: On Linux/Mac, `testing`, `stable`, `next`. On Windows, the major +# version of the OS (e.g `36`) for Fedora 36. For all platforms you can +# alternatively specify a custom download URL to an image. Container engines +# translate URIs $OS and $ARCH to the native OS and ARCH. URI +# "https://example.com/$OS/$ARCH/foobar.ami" becomes +# "https://example.com/linux/amd64/foobar.ami" on a Linux AMD machine. +# The default value is `testing`. # -#image = "testing" +# image = "testing" # Memory in MB a machine is created with. # diff --git a/containers.conf.5.md b/containers.conf.5.md index 1f2bd5e..b64e475 100644 --- a/containers.conf.5.md +++ b/containers.conf.5.md @@ -197,9 +197,9 @@ the container. Indicates whether the container engine uses MAC(SELinux) container separation via labeling. This option is ignored on disabled systems. -**log_driver**="k8s-file" +**log_driver**="" -Logging driver for the container. Available options: `k8s-file` and `journald`. +Logging driver for the container. Currently available options are k8s-file, journald, none and passthrough, with json-file aliased to k8s-file for scripting compatibility. The journald driver is used by default if the systemd journal is readable and writable. Otherwise, the k8s-file driver is used. **log_size_max**=-1 @@ -441,7 +441,7 @@ and the logfile will not be rotated. **events_logger**="journald" -The default method to use when logging events. +The default method to use when logging events. The default method is different based on the platform that Podman is being run upon. To determine the current value, @@ -711,11 +711,13 @@ The size of the disk in GB created when init-ing a podman-machine VM **image**="" -Default image used when creating a new VM using `podman machine init`. +Default image URI when creating a new VM using `podman machine init`. Options: On Linux/Mac, `testing`, `stable`, `next`. On Windows, the major -version of the OS (e.g `35`). For all platforms you can alternatively specify -a custom path or download URL to an image. The default is `testing` on -Linux/Mac, and `35` on Windows. +version of the OS (e.g `36`) for Fedora 36. For all platforms you can +alternatively specify a custom download URL to an image. Container engines +translate URIs $OS and $ARCH to the native OS and ARCH. URI "https://example.com/$OS/$ARCH/foobar.ami" would become "https://example.com/linux/amd64/foobar.ami" on a Linux AMD machine. +The default value +is `testing` on Linux/Mac, and on Windows. **memory**=2048