diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/libpod.conf.5.md | 6 | ||||
| -rw-r--r-- | docs/podman-rm.1.md | 3 | ||||
| -rw-r--r-- | docs/podman-rmi.1.md | 3 | ||||
| -rw-r--r-- | docs/podman-search.1.md | 4 | ||||
| -rw-r--r-- | docs/podman.1.md | 14 |
5 files changed, 22 insertions, 8 deletions
diff --git a/docs/libpod.conf.5.md b/docs/libpod.conf.5.md index 097d0764a..c28c80b56 100644 --- a/docs/libpod.conf.5.md +++ b/docs/libpod.conf.5.md @@ -16,10 +16,10 @@ libpod to manage containers. Default OCI runtime to use if nothing is specified in **runtimes** **runtimes** - For each OCI runtime, specify a list of paths to look for. The first one found is used. + For each OCI runtime, specify a list of paths to look for. The first one found is used. If the paths are empty or no valid path was found, then the `$PATH` environment variable will be used as the fallback. **conmon_path**="" - Paths to search for the Conmon container manager binary + Paths to search for the conmon container manager binary. If the paths are empty or no valid path was found, then the `$PATH` environment variable will be used as the fallback. **conmon_env_vars**="" Environment variables to pass into Conmon @@ -99,7 +99,7 @@ libpod to manage containers. a slirp4netns network. If "" is used then the binary is looked up using the $PATH environment variable. **events_logger**="" - Default method to use when logging events. Valid values are "journald" and "file". + Default method to use when logging events. Valid values are "file", "journald", and "none". **detach_keys**="" Keys sequence used for detaching a container diff --git a/docs/podman-rm.1.md b/docs/podman-rm.1.md index 32a8c2943..7f39c09ad 100644 --- a/docs/podman-rm.1.md +++ b/docs/podman-rm.1.md @@ -69,7 +69,8 @@ podman rm -f --latest ## Exit Status **_0_** if all specified containers removed **_1_** if one of the specified containers did not exist, and no other failures -**_125_** if command fails for a reason other then an container did not exist +**_2_** if one of the specified containers is paused or running +**_125_** if the command fails for a reason other than container did not exist or is paused/running ## SEE ALSO podman(1), podman-image-rm(1) diff --git a/docs/podman-rmi.1.md b/docs/podman-rmi.1.md index 2cba8a22d..6b242c94e 100644 --- a/docs/podman-rmi.1.md +++ b/docs/podman-rmi.1.md @@ -43,7 +43,8 @@ podman rmi -a -f ## Exit Status **_0_** if all specified images removed **_1_** if one of the specified images did not exist, and no other failures -**_125_** if command fails for a reason other then an image did not exist +**_2_** if one of the specified images has child images or is being used by a container +**_125_** if the command fails for a reason other than an image did not exist or is in use ## SEE ALSO podman(1) diff --git a/docs/podman-search.1.md b/docs/podman-search.1.md index f0a696494..c68f94347 100644 --- a/docs/podman-search.1.md +++ b/docs/podman-search.1.md @@ -11,8 +11,8 @@ podman\-search - Search a registry for an image The user can specify which registry to search by prefixing the registry in the search term (example **registry.fedoraproject.org/fedora**), default is the registries in the **registries.search** table in the config file - **/etc/containers/registries.conf**. -The number of results can be limited using the **--limit** flag. If more than one registry -is being searched, the limit will be applied to each registry. The output can be filtered +The default number of results is 25. The number of results can be limited using the **--limit** flag. +If more than one registry is being searched, the limit will be applied to each registry. The output can be filtered using the **--filter** flag. To get all available images in a registry without a specific search term, the user can just enter the registry name with a trailing "/" (example **registry.fedoraproject.org/**). Note, searching without a search term will only work for registries that implement the v2 API. diff --git a/docs/podman.1.md b/docs/podman.1.md index 022514a80..12b7866ca 100644 --- a/docs/podman.1.md +++ b/docs/podman.1.md @@ -36,6 +36,10 @@ Note: CGroup manager is not supported in rootless mode when using CGroups Versio Path to where the cpu performance results should be written +**--events-logger**=*type* + +Backend to use for storing events. Allowed values are **file**, **journald**, and **none**. + **--hooks-dir**=*path* Each `*.json` file in the path configures a hook for Podman containers. For more details on the syntax of the JSON files and the semantics of hook injection, see `oci-hooks(5)`. Podman and libpod currently support both the 1.0.0 and 0.1.0 hook schemas, although the 0.1.0 schema is deprecated. @@ -219,7 +223,7 @@ When Podman runs in rootless mode, the file `$HOME/.config/containers/mounts.con ## Rootless mode Podman can also be used as non-root user. When podman runs in rootless mode, a user namespace is automatically created for the user, defined in /etc/subuid and /etc/subgid. -Containers created by a non-root user are not visible to other users and are not seen or managed by podman running as root. +Containers created by a non-root user are not visible to other users and are not seen or managed by Podman running as root. It is required to have multiple uids/gids set for an user. Be sure the user is present in the files `/etc/subuid` and `/etc/subgid`. @@ -240,6 +244,14 @@ Images are pulled under `XDG_DATA_HOME` when specified, otherwise in the home di Currently the slirp4netns package is required to be installed to create a network device, otherwise rootless containers need to run in the network namespace of the host. +### **NOTE:** Unsupported file systems in rootless mode + +The Overlay file system (OverlayFS) is not supported in rootless mode. The fuse-overlayfs package is a tool that provides the functionality of OverlayFS in user namespace that allows mounting file systems in rootless environments. It is recommended to install the fuse-overlayfs package and to enable it by adding `mount_program = "/usr/bin/fuse-overlayfs"` under `[storage.options]` in the `~/.config/containers/storage.conf` file. + +The Network File System (NFS) and other distributed file systems (for example: Lustre, Spectrum Scale, the General Parallel File System (GPFS)) are not supported when running in rootless mode as these file systems do not understand user namespace. However, rootless Podman can make use of an NFS Homedir by modifying the `~/.config/containers/storage.conf` to have the `graphroot` option point to a directory stored on local (Non NFS) storage. + +For more information, please refer to the [Podman Troubleshooting Page](https://github.com/containers/libpod/blob/master/troubleshooting.md). + ## SEE ALSO `containers-mounts.conf(5)`, `containers-registries.conf(5)`, `containers-storage.conf(5)`, `buildah(1)`, `libpod.conf(5)`, `oci-hooks(5)`, `policy.json(5)`, `subuid(5)`, `subgid(5)`, `slirp4netns(1)` |