diff options
Diffstat (limited to 'docs/source/markdown')
-rw-r--r-- | docs/source/markdown/podman-build.1.md | 2 | ||||
-rw-r--r-- | docs/source/markdown/podman-container-prune.1.md | 12 | ||||
-rw-r--r-- | docs/source/markdown/podman-cp.1.md | 14 | ||||
-rw-r--r-- | docs/source/markdown/podman-create.1.md | 4 | ||||
-rw-r--r-- | docs/source/markdown/podman-generate-kube.1.md | 2 | ||||
-rw-r--r-- | docs/source/markdown/podman-image-prune.1.md | 12 | ||||
-rw-r--r-- | docs/source/markdown/podman-image-sign.1.md | 4 | ||||
-rw-r--r-- | docs/source/markdown/podman-info.1.md | 151 | ||||
-rw-r--r-- | docs/source/markdown/podman-kill.1.md | 8 | ||||
-rw-r--r-- | docs/source/markdown/podman-play-kube.1.md | 2 | ||||
-rw-r--r-- | docs/source/markdown/podman-ps.1.md | 2 | ||||
-rw-r--r-- | docs/source/markdown/podman-run.1.md | 22 | ||||
-rw-r--r-- | docs/source/markdown/podman-system-prune.1.md | 16 | ||||
-rw-r--r-- | docs/source/markdown/podman-system-service.1.md | 2 | ||||
-rw-r--r-- | docs/source/markdown/podman-volume-prune.1.md | 16 | ||||
-rw-r--r-- | docs/source/markdown/podman.1.md | 6 |
16 files changed, 181 insertions, 94 deletions
diff --git a/docs/source/markdown/podman-build.1.md b/docs/source/markdown/podman-build.1.md index c71f4fae9..67513e386 100644 --- a/docs/source/markdown/podman-build.1.md +++ b/docs/source/markdown/podman-build.1.md @@ -40,7 +40,7 @@ container images. This `buildah` code creates `buildah` containers for the `RUN` options in container storage. In certain situations, when the `podman build` crashes or users kill the `podman build` process, these external containers can be left in container storage. Use the `podman ps --all --storage` -command to see these contaienrs. External containers can be removed with the +command to see these containers. External containers can be removed with the `podman rm --storage` command. ## OPTIONS diff --git a/docs/source/markdown/podman-container-prune.1.md b/docs/source/markdown/podman-container-prune.1.md index 4b4effb0b..b199f9ebb 100644 --- a/docs/source/markdown/podman-container-prune.1.md +++ b/docs/source/markdown/podman-container-prune.1.md @@ -15,6 +15,17 @@ podman-container-prune - Remove all stopped containers from local storage Provide filter values. +The --filter flag format is of “key=value”. If there is more than one filter, then pass multiple flags (e.g., --filter "foo=bar" --filter "bif=baz") + +Supported filters: + +- `until` (_timestamp_) - only remove containers and images created before given timestamp +- `label` (label=_key_, label=_key=value_, label!=_key_, or label!=_key=value_) - only remove containers and images, with (or without, in case label!=... is used) the specified labels. + +The until filter can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m) computed relative to the machine’s time. + +The label filter accepts two formats. One is the label=... (label=_key_ or label=_key=value_), which removes containers with the specified labels. The other format is the label!=... (label!=_key_ or label!=_key=value_), which removes containers without the specified labels. + #### **--force**, **-f** Do not provide an interactive prompt for container removal. @@ -63,3 +74,4 @@ podman(1), podman-ps ## HISTORY December 2018, Originally compiled by Brent Baude (bbaude at redhat dot com) +December 2020, converted filter information from docs.docker.com documentation by Dan Walsh (dwalsh at redhat dot com) diff --git a/docs/source/markdown/podman-cp.1.md b/docs/source/markdown/podman-cp.1.md index 241a74c42..56511c244 100644 --- a/docs/source/markdown/podman-cp.1.md +++ b/docs/source/markdown/podman-cp.1.md @@ -4,9 +4,9 @@ podman\-cp - Copy files/folders between a container and the local filesystem ## SYNOPSIS -**podman cp** [*options*] [*container*:]*src_path* [*container*:]*dest_path* +**podman cp** [*container*:]*src_path* [*container*:]*dest_path* -**podman container cp** [*options*] [*container*:]*src_path* [*container*:]*dest_path* +**podman container cp** [*container*:]*src_path* [*container*:]*dest_path* ## DESCRIPTION Copy the contents of **src_path** to the **dest_path**. You can copy from the container's filesystem to the local machine or the reverse, from the local filesystem to the container. @@ -59,14 +59,6 @@ Using `-` as the *src_path* streams the contents of STDIN as a tar archive. The ## OPTIONS -#### **--extract** - -If the source is a tar archive, extract it to the provided destination (must be a directory). If the source is not a tar archive, follow the above rules. - -#### **--pause** - -Pause the container while copying into it to avoid potential security issues around symlinks. Defaults to *true*. On rootless containers with cgroups V1, defaults to false. - ## ALTERNATIVES Podman has much stronger capabilities than just `podman cp` to achieve copy files between host and container. @@ -112,8 +104,6 @@ podman cp containerID:/myapp/ /myapp/ podman cp containerID:/home/myuser/. /home/myuser/ -podman cp --extract /home/myuser/myfiles.tar.gz containerID:/myfiles - podman cp - containerID:/myfiles.tar.gz < myfiles.tar.gz ## SEE ALSO diff --git a/docs/source/markdown/podman-create.1.md b/docs/source/markdown/podman-create.1.md index b5f5591a9..8deaa8540 100644 --- a/docs/source/markdown/podman-create.1.md +++ b/docs/source/markdown/podman-create.1.md @@ -803,10 +803,6 @@ To generate systemd unit files, please see *podman generate systemd* Automatically remove the container when it exits. The default is *false*. -Note that the container will not be removed when it could not be created or -started successfully. This allows the user to inspect the container after -failure. - #### **--rootfs** If specified, the first argument refers to an exploded container on the file system. diff --git a/docs/source/markdown/podman-generate-kube.1.md b/docs/source/markdown/podman-generate-kube.1.md index ed2143388..019bae539 100644 --- a/docs/source/markdown/podman-generate-kube.1.md +++ b/docs/source/markdown/podman-generate-kube.1.md @@ -28,7 +28,7 @@ random port is assigned by Podman in the specification. Create Kubernetes Pod YAML for a container called `some-mariadb` . ``` $ sudo podman generate kube some-mariadb -# Generation of Kubenetes YAML is still under development! +# Generation of Kubernetes YAML is still under development! # # Save the output of this file and use kubectl create -f to import # it into Kubernetes. diff --git a/docs/source/markdown/podman-image-prune.1.md b/docs/source/markdown/podman-image-prune.1.md index d8558d244..73024ffb8 100644 --- a/docs/source/markdown/podman-image-prune.1.md +++ b/docs/source/markdown/podman-image-prune.1.md @@ -22,6 +22,17 @@ Remove dangling images and images that have no associated containers. Provide filter values. +The --filter flag format is of “key=value”. If there is more than one filter, then pass multiple flags (e.g., --filter "foo=bar" --filter "bif=baz") + +Supported filters: + +- `until` (_timestamp_) - only remove containers and images created before given timestamp +- `label` (label=_key_, label=_key=value_, label!=_key_, or label!=_key=value_) - only remove containers and images, with (or without, in case label!=... is used) the specified labels. + +The until filter can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m) computed relative to the machine’s time. + +The label filter accepts two formats. One is the label=... (label=_key_ or label=_key=value_), which removes images with the specified labels. The other format is the label!=... (label!=_key_ or label!=_key=value_), which removes images without the specified labels. + #### **--force**, **-f** Do not provide an interactive prompt for container removal. @@ -93,3 +104,4 @@ podman(1), podman-images ## HISTORY December 2018, Originally compiled by Brent Baude (bbaude at redhat dot com) +December 2020, converted filter information from docs.docker.com documentation by Dan Walsh (dwalsh at redhat dot com) diff --git a/docs/source/markdown/podman-image-sign.1.md b/docs/source/markdown/podman-image-sign.1.md index 7a924b80b..3e52bde30 100644 --- a/docs/source/markdown/podman-image-sign.1.md +++ b/docs/source/markdown/podman-image-sign.1.md @@ -19,6 +19,10 @@ By default, the signature will be written into `/var/lib/containers/sigstore` fo Print usage statement. +#### **--all**, **-a** + +Sign all the manifests of the multi-architecture image (default false). + #### **--cert-dir**=*path* Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. diff --git a/docs/source/markdown/podman-info.1.md b/docs/source/markdown/podman-info.1.md index dd01a0f49..4af51d3eb 100644 --- a/docs/source/markdown/podman-info.1.md +++ b/docs/source/markdown/podman-info.1.md @@ -31,17 +31,18 @@ Run podman info with plain text response: $ podman info host: arch: amd64 - buildahVersion: 1.15.0 - cgroupVersion: v1 + buildahVersion: 1.19.0-dev + cgroupManager: systemd + cgroupVersion: v2 conmon: - package: conmon-2.0.16-2.fc32.x86_64 + package: conmon-2.0.22-2.fc33.x86_64 path: /usr/bin/conmon - version: 'conmon version 2.0.16, commit: 1044176f7dd177c100779d1c63931d6022e419bd' + version: 'conmon version 2.0.22, commit: 1be6c73605006a85f7ed60b7f76a51e28eb67e01' cpus: 8 distribution: distribution: fedora - version: "32" - eventLogger: file + version: "33" + eventLogger: journald hostname: localhost.localdomain idMappings: gidmap: @@ -58,33 +59,41 @@ host: - container_id: 1 host_id: 100000 size: 65536 - kernel: 5.6.11-300.fc32.x86_64 + kernel: 5.9.11-200.fc33.x86_64 linkmode: dynamic - memFree: 1401929728 - memTotal: 16416161792 + memFree: 837505024 + memTotal: 16416481280 ociRuntime: - name: runc - package: containerd.io-1.2.10-3.2.fc31.x86_64 - path: /usr/bin/runc + name: crun + package: crun-0.16-1.fc33.x86_64 + path: /usr/bin/crun version: |- - runc version 1.0.0-rc8+dev - commit: 3e425f80a8c931f88e6d94a8c831b9d5aa481657 - spec: 1.0.1-dev + crun version 0.16 + commit: eb0145e5ad4d8207e84a327248af76663d4e50dd + spec: 1.0.0 + +SYSTEMD +SELINUX +APPARMOR +CAP +SECCOMP +EBPF +YAJL os: linux remoteSocket: - exists: false - path: /run/user/1000/podman/podman.sock - rootless: true + exists: true + path: /run/user/3267/podman/podman.sock + security: + apparmorEnabled: false + capabilities: CAP_CHOWN,CAP_DAC_OVERRIDE,CAP_FOWNER,CAP_FSETID,CAP_KILL,CAP_NET_BIND_SERVICE,CAP_SETFCAP,CAP_SETGID,CAP_SETPCAP,CAP_SETUID,CAP_SYS_CHROOT + rootless: true + seccompEnabled: true + selinuxEnabled: true slirp4netns: executable: /bin/slirp4netns - package: slirp4netns-1.0.0-1.fc32.x86_64 + package: slirp4netns-1.1.4-4.dev.giteecccdb.fc33.x86_64 version: |- - slirp4netns version 1.0.0 - commit: a3be729152a33e692cd28b52f664defbf2e7810a - libslirp: 4.2.0 - swapFree: 8291610624 - swapTotal: 8296329216 - uptime: 52h 29m 39.78s (Approximately 2.17 days) + slirp4netns version 1.1.4+dev + commit: eecccdb96f587b11d7764556ffacfeaffe4b6e11 + libslirp: 4.3.1 + SLIRP_CONFIG_VERSION_MAX: 3 + libseccomp: 2.5.0 + swapFree: 6509203456 + swapTotal: 12591292416 + uptime: 264h 14m 32.73s (Approximately 11.00 days) registries: search: - registry.fedoraproject.org @@ -94,19 +103,19 @@ registries: store: configFile: /home/dwalsh/.config/containers/storage.conf containerStore: - number: 2 + number: 3 paused: 0 running: 0 - stopped: 2 + stopped: 3 graphDriverName: overlay graphOptions: overlay.mount_program: Executable: /home/dwalsh/bin/fuse-overlayfs Package: Unknown Version: |- - fusermount3 version: 3.9.1 + fusermount3 version: 3.9.3 fuse-overlayfs: version 0.7.2 - FUSE library version 3.9.1 + FUSE library version 3.9.3 using FUSE kernel interface version 7.31 graphRoot: /home/dwalsh/.local/share/containers/storage graphStatus: @@ -115,36 +124,38 @@ store: Supports d_type: "true" Using metacopy: "false" imageStore: - number: 7 + number: 77 runRoot: /run/user/3267/containers volumePath: /home/dwalsh/.local/share/containers/storage/volumes version: - Built: 1589899246 - BuiltTime: Tue May 19 10:40:46 2020 - GitCommit: c3678ce3289f4195f3f16802411e795c6a587c9f-dirty - GoVersion: go1.14.2 + APIVersion: 3.0.0 + Built: 1608562922 + BuiltTime: Mon Dec 21 10:02:02 2020 + GitCommit: d6925182cdaf94225908a386d02eae8fd3e01123-dirty + GoVersion: go1.15.5 OsArch: linux/amd64 - APIVersion: 1 - Version: 2.0.0 + Version: 3.0.0-dev + ``` Run podman info with JSON formatted response: ``` { "host": { "arch": "amd64", - "buildahVersion": "1.15.0", - "cgroupVersion": "v1", + "buildahVersion": "1.19.0-dev", + "cgroupManager": "systemd", + "cgroupVersion": "v2", "conmon": { - "package": "conmon-2.0.16-2.fc32.x86_64", + "package": "conmon-2.0.22-2.fc33.x86_64", "path": "/usr/bin/conmon", - "version": "conmon version 2.0.16, commit: 1044176f7dd177c100779d1c63931d6022e419bd" + "version": "conmon version 2.0.22, commit: 1be6c73605006a85f7ed60b7f76a51e28eb67e01" }, "cpus": 8, "distribution": { "distribution": "fedora", - "version": "32" + "version": "33" }, - "eventLogger": "file", + "eventLogger": "journald", "hostname": "localhost.localdomain", "idMappings": { "gidmap": [ @@ -172,45 +183,51 @@ Run podman info with JSON formatted response: } ] }, - "kernel": "5.6.11-300.fc32.x86_64", - "memFree": 1380356096, - "memTotal": 16416161792, + "kernel": "5.9.11-200.fc33.x86_64", + "memFree": 894574592, + "memTotal": 16416481280, "ociRuntime": { - "name": "runc", - "package": "containerd.io-1.2.10-3.2.fc31.x86_64", - "path": "/usr/bin/runc", - "version": "runc version 1.0.0-rc8+dev\ncommit: 3e425f80a8c931f88e6d94a8c831b9d5aa481657\nspec: 1.0.1-dev" + "name": "crun", + "package": "crun-0.16-1.fc33.x86_64", + "path": "/usr/bin/crun", + "version": "crun version 0.16\ncommit: eb0145e5ad4d8207e84a327248af76663d4e50dd\nspec: 1.0.0\n+SYSTEMD +SELINUX +APPARMOR +CAP +SECCOMP +EBPF +YAJL" }, "os": "linux", "remoteSocket": { - "path": "/run/user/1000/podman/podman.sock", - "exists": false + "path": "/run/user/3267/podman/podman.sock", + "exists": true + }, + "security": { + "apparmorEnabled": false, + "capabilities": "CAP_CHOWN,CAP_DAC_OVERRIDE,CAP_FOWNER,CAP_FSETID,CAP_KILL,CAP_NET_BIND_SERVICE,CAP_SETFCAP,CAP_SETGID,CAP_SETPCAP,CAP_SETUID,CAP_SYS_CHROOT", + "rootless": true, + "seccompEnabled": true, + "selinuxEnabled": true }, - "rootless": true, "slirp4netns": { "executable": "/bin/slirp4netns", - "package": "slirp4netns-1.0.0-1.fc32.x86_64", - "version": "slirp4netns version 1.0.0\ncommit: a3be729152a33e692cd28b52f664defbf2e7810a\nlibslirp: 4.2.0" + "package": "slirp4netns-1.1.4-4.dev.giteecccdb.fc33.x86_64", + "version": "slirp4netns version 1.1.4+dev\ncommit: eecccdb96f587b11d7764556ffacfeaffe4b6e11\nlibslirp: 4.3.1\nSLIRP_CONFIG_VERSION_MAX: 3\nlibseccomp: 2.5.0" }, - "swapFree": 8291610624, - "swapTotal": 8296329216, - "uptime": "52h 27m 39.38s (Approximately 2.17 days)", + "swapFree": 6509203456, + "swapTotal": 12591292416, + "uptime": "264h 13m 12.39s (Approximately 11.00 days)", "linkmode": "dynamic" }, "store": { "configFile": "/home/dwalsh/.config/containers/storage.conf", "containerStore": { - "number": 2, + "number": 3, "paused": 0, "running": 0, - "stopped": 2 + "stopped": 3 }, "graphDriverName": "overlay", "graphOptions": { "overlay.mount_program": { "Executable": "/home/dwalsh/bin/fuse-overlayfs", "Package": "Unknown", - "Version": "fusermount3 version: 3.9.1\nfuse-overlayfs: version 0.7.2\nFUSE library version 3.9.1\nusing FUSE kernel interface version 7.31" + "Version": "fusermount3 version: 3.9.3\nfuse-overlayfs: version 0.7.2\nFUSE library version 3.9.3\nusing FUSE kernel interface version 7.31" } }, "graphRoot": "/home/dwalsh/.local/share/containers/storage", @@ -221,7 +238,7 @@ Run podman info with JSON formatted response: "Using metacopy": "false" }, "imageStore": { - "number": 7 + "number": 77 }, "runRoot": "/run/user/3267/containers", "volumePath": "/home/dwalsh/.local/share/containers/storage/volumes" @@ -235,12 +252,12 @@ Run podman info with JSON formatted response: ] }, "version": { - "APIVersion": 1, - "Version": "2.0.0", - "GoVersion": "go1.14.2", - "GitCommit": "c3678ce3289f4195f3f16802411e795c6a587c9f-dirty", - "BuiltTime": "Tue May 19 10:40:46 2020", - "Built": 1589899246, + "APIVersion": "3.0.0", + "Version": "3.0.0-dev", + "GoVersion": "go1.15.5", + "GitCommit": "d6925182cdaf94225908a386d02eae8fd3e01123-dirty", + "BuiltTime": "Mon Dec 21 10:02:02 2020", + "Built": 1608562922, "OsArch": "linux/amd64" } } diff --git a/docs/source/markdown/podman-kill.1.md b/docs/source/markdown/podman-kill.1.md index 5956c03da..96c01ac09 100644 --- a/docs/source/markdown/podman-kill.1.md +++ b/docs/source/markdown/podman-kill.1.md @@ -16,6 +16,10 @@ The main process inside each container specified will be sent SIGKILL, or any si Signal all running containers. This does not include paused containers. +#### **--cidfile** + +Read container ID from the specified file and remove the container. Can be specified multiple times. + #### **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman @@ -40,6 +44,10 @@ podman kill --latest podman kill --signal KILL -a +podman kill --cidfile /home/user/cidfile-1 + +podman kill --cidfile /home/user/cidfile-1 --cidfile ./cidfile-2 + ## SEE ALSO podman(1), podman-stop(1) diff --git a/docs/source/markdown/podman-play-kube.1.md b/docs/source/markdown/podman-play-kube.1.md index 67584ffcc..2de261f66 100644 --- a/docs/source/markdown/podman-play-kube.1.md +++ b/docs/source/markdown/podman-play-kube.1.md @@ -15,6 +15,8 @@ Ideally the input file would be one created by Podman (see podman-generate-kube( Note: HostPath volume types created by play kube will be given an SELinux private label (Z) +Note: If the `:latest` tag is used, Podman will attempt to pull the image from a registry. If the image was built locally with Podman or Buildah, it will have `localhost` as the domain, in that case, Podman will use the image from the local store even if it has the `:latest` tag. + ## OPTIONS #### **--authfile**=*path* diff --git a/docs/source/markdown/podman-ps.1.md b/docs/source/markdown/podman-ps.1.md index b94964f6c..28212b92c 100644 --- a/docs/source/markdown/podman-ps.1.md +++ b/docs/source/markdown/podman-ps.1.md @@ -57,6 +57,8 @@ Valid filters are listed below: | since | [ID] or [Name] Containers created since this container | | volume | [VolumeName] or [MountpointDestination] Volume mounted in container | | health | [Status] healthy or unhealthy | +| pod | [Pod] name or full or partial ID of pod | + #### **--format**=*format* diff --git a/docs/source/markdown/podman-run.1.md b/docs/source/markdown/podman-run.1.md index 3241cf9f7..674079a9d 100644 --- a/docs/source/markdown/podman-run.1.md +++ b/docs/source/markdown/podman-run.1.md @@ -394,6 +394,13 @@ Run the container in a new user namespace using the supplied mapping. This optio This option can be passed several times to map different ranges. If calling **podman run** as an unprivileged user, the user needs to have the right to use the mapping. See **subuid**(5). The example maps gids **0-1999** in the container to the gids **30000-31999** on the host: **--gidmap=0:30000:2000**. +**Important note:** The new user namespace mapping based on **--gidmap** is based on the initial mapping made in the _/etc/subgid_ file. +Assuming there is a _/etc/subgid_ mapping **groupname:100000:65536**, then **groupname** is initially mapped to a namespace starting with +gid **100000** for **65536** ids. From here the **--gidmap** mapping to the new namespace starts from **0** again, but is based on the initial mapping. +Meaning **groupname** is initially mapped to gid **100000** which is referenced as **0** in the following **--gidmap** mapping. In terms of the example +above: The group **groupname** is mapped to group **100000** of the initial namespace then the +**30000**st id of this namespace (which is gid 130000 in this namespace) is mapped to container namespace group id **0**. (groupname -> 100000 / 30000 -> 0) + #### **--group-add**=*group* Add additional groups to run as @@ -840,10 +847,6 @@ To generate systemd unit files, please see **podman generate systemd**. Automatically remove the container when it exits. The default is **false**. -Note that the container will not be removed when it could not be created or -started successfully. This allows the user to inspect the container after -failure. - #### **--rmi**=*true|false* After exit of the container, remove the image unless another @@ -950,7 +953,7 @@ For the IPC namespace, the following sysctls are allowed: Note: if you use the **--ipc=host** option, the above sysctls will not be allowed. -For the network namespace, the following ysctls areallowed: +For the network namespace, the following sysctls are allowed: - Sysctls beginning with net.\* @@ -1030,6 +1033,15 @@ as an unprivileged user, the user needs to have the right to use the mapping. Se The following example maps uids 0-1999 in the container to the uids 30000-31999 on the host: **--uidmap=0:30000:2000**. +**Important note:** The new user namespace mapping based on **--uidmap** is based on the initial mapping made in the _/etc/subuid_ file. +Assuming there is a _/etc/subuid_ mapping **username:100000:65536**, then **username** is initially mapped to a namespace starting with +uid **100000** for **65536** ids. From here the **--uidmap** mapping to the new namespace starts from **0** again, but is based on the initial mapping. +Meaning **username** is initially mapped to uid **100000** which is referenced as **0** in the following **--uidmap** mapping. In terms of the example +above: The user **username** is mapped to user **100000** of the initial namespace then the +**30000**st id of this namespace (which is uid 130000 in this namespace) is mapped to container namespace user id **0**. (username -> 100000 / 30000 -> 0) + +_Note_: A minimal mapping has to have at least container uid **0** mapped to the parent user namespace. + #### **--ulimit**=*option* Ulimit options. You can use **host** to copy the current configuration from the host. diff --git a/docs/source/markdown/podman-system-prune.1.md b/docs/source/markdown/podman-system-prune.1.md index 431a11267..791503a2c 100644 --- a/docs/source/markdown/podman-system-prune.1.md +++ b/docs/source/markdown/podman-system-prune.1.md @@ -18,6 +18,21 @@ By default, volumes are not removed to prevent important data from being deleted Recursively remove all unused pod, container, image and volume data (Maximum 50 iterations.) +#### **--filter**=*filters* + +Provide filter values. + +The --filter flag format is of “key=value”. If there is more than one filter, then pass multiple flags (e.g., --filter "foo=bar" --filter "bif=baz") + +Supported filters: + +- `until` (_timestamp_) - only remove containers and images created before given timestamp +- `label` (label=_key_, label=_key=value_, label!=_key_, or label!=_key=value_) - only remove containers and images, with (or without, in case label!=... is used) the specified labels. + +The until filter can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m) computed relative to the machine’s time. + +The label filter accepts two formats. One is the label=... (label=_key_ or label=_key=value_), which removes containers and images with the specified labels. The other format is the label!=... (label!=_key_ or label!=_key=value_), which removes containers and images without the specified labels. + #### **--force**, **-f** Do not prompt for confirmation @@ -35,3 +50,4 @@ podman(1), podman-image-prune(1), podman-container-prune(1), podman-pod-prune(1) ## HISTORY February 2019, Originally compiled by Dan Walsh (dwalsh at redhat dot com) +December 2020, converted filter information from docs.docker.com documentation by Dan Walsh (dwalsh at redhat dot com) diff --git a/docs/source/markdown/podman-system-service.1.md b/docs/source/markdown/podman-system-service.1.md index 1fdecfa5c..0905830c5 100644 --- a/docs/source/markdown/podman-system-service.1.md +++ b/docs/source/markdown/podman-system-service.1.md @@ -9,7 +9,7 @@ podman\-system\-service - Run an API service ## DESCRIPTION The **podman system service** command creates a listening service that will answer API calls for Podman. You may optionally provide an endpoint for the API in URI form. For example, *unix://tmp/foobar.sock* or *tcp:localhost:8080*. -If no endpoint is provided, defaults will be used. The default endpoint for a rootfull +If no endpoint is provided, defaults will be used. The default endpoint for a rootful service is *unix:/run/podman/podman.sock* and rootless is *unix:/$XDG_RUNTIME_DIR/podman/podman.sock* (for example *unix:/run/user/1000/podman/podman.sock*) diff --git a/docs/source/markdown/podman-volume-prune.1.md b/docs/source/markdown/podman-volume-prune.1.md index b5f1b7e94..9477cb5d5 100644 --- a/docs/source/markdown/podman-volume-prune.1.md +++ b/docs/source/markdown/podman-volume-prune.1.md @@ -8,7 +8,8 @@ podman\-volume\-prune - Remove all unused volumes ## DESCRIPTION -Removes all unused volumes. You will be prompted to confirm the removal of all the +Removes unused volumes. By default all unused volumes will be removed, the **--filter** flag can +be used to filter specific volumes. You will be prompted to confirm the removal of all the unused volumes. To bypass the confirmation, use the **--force** flag. @@ -18,6 +19,17 @@ unused volumes. To bypass the confirmation, use the **--force** flag. Do not prompt for confirmation. +#### **--filter** + +Filter volumes to be pruned. Volumes can be filtered by the following attributes: + +- dangling +- driver +- label +- name +- opt +- scope + #### **--help** Print usage statement @@ -29,6 +41,8 @@ Print usage statement $ podman volume prune $ podman volume prune --force + +$ podman volume prune --filter label=mylabel=mylabelvalue ``` ## SEE ALSO diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 7da01d389..2688c1720 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -44,7 +44,9 @@ Path of the conmon binary (Default path is configured in `containers.conf`) #### **--events-backend**=*type* -Backend to use for storing events. Allowed values are **file**, **journald**, and **none**. +Backend to use for storing events. Allowed values are **file**, **journald**, and +**none**. When *file* is specified, the events are stored under a subdirectory +of the *tmpdir* location (see **--tmpdir** below). #### **--help**, **-h** @@ -291,7 +293,7 @@ When Podman runs in rootless mode, the file `$HOME/.config/containers/mounts.con Non root users of Podman can create the `$HOME/.config/containers/registries.conf` file to be used instead of the system defaults. -**storage.conf** (`/etc/containers/storage.conf`, `$HOME/.config/contaners/storage.conf`) +**storage.conf** (`/etc/containers/storage.conf`, `$HOME/.config/containers/storage.conf`) storage.conf is the storage configuration file for all tools using containers/storage |