diff options
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/markdown/links/podman-image-diff.1 | 1 | ||||
| -rw-r--r-- | docs/source/markdown/links/podman-image-search.1 | 1 | ||||
| -rw-r--r-- | docs/source/markdown/podman-auto-update.1.md | 16 | ||||
| -rw-r--r-- | docs/source/markdown/podman-container-cleanup.1.md | 7 | ||||
| -rw-r--r-- | docs/source/markdown/podman-events.1.md | 2 | ||||
| -rw-r--r-- | docs/source/markdown/podman-exec.1.md | 4 | ||||
| -rw-r--r-- | docs/source/markdown/podman-info.1.md | 294 | ||||
| -rw-r--r-- | docs/source/markdown/podman-network-inspect.1.md | 14 | ||||
| -rw-r--r-- | docs/source/markdown/podman-network-ls.1.md | 18 | ||||
| -rw-r--r-- | docs/source/markdown/podman-version.1.md | 13 |
10 files changed, 256 insertions, 114 deletions
diff --git a/docs/source/markdown/links/podman-image-diff.1 b/docs/source/markdown/links/podman-image-diff.1 new file mode 100644 index 000000000..ac4881f98 --- /dev/null +++ b/docs/source/markdown/links/podman-image-diff.1 @@ -0,0 +1 @@ +.so man1/podman-diff.1 diff --git a/docs/source/markdown/links/podman-image-search.1 b/docs/source/markdown/links/podman-image-search.1 new file mode 100644 index 000000000..73e70d3e3 --- /dev/null +++ b/docs/source/markdown/links/podman-image-search.1 @@ -0,0 +1 @@ +.so man1/podman-search.1 diff --git a/docs/source/markdown/podman-auto-update.1.md b/docs/source/markdown/podman-auto-update.1.md index 93ad22f76..435a767c1 100644 --- a/docs/source/markdown/podman-auto-update.1.md +++ b/docs/source/markdown/podman-auto-update.1.md @@ -13,6 +13,8 @@ If the label is present and set to "image", Podman reaches out to the correspond An image is considered updated if the digest in the local storage is different than the one of the remote image. If an image must be updated, Podman pulls it down and restarts the systemd unit executing the container. +If "io.containers.autoupdate.authfile" label is present, Podman reaches out to corresponding authfile when pulling images. + At container-creation time, Podman looks up the "PODMAN_SYSTEMD_UNIT" environment variables and stores it verbatim in the container's label. This variable is now set by all systemd units generated by `podman-generate-systemd` and is set to `%n` (i.e., the name of systemd unit starting the container). This data is then being used in the auto-update sequence to instruct systemd (via DBUS) to restart the unit and hence to restart the container. @@ -21,11 +23,23 @@ Note that `podman auto-update` relies on systemd and requires a fully-qualified This enforcement is necessary to know which image to actually check and pull. If an image ID was used, Podman would not know which image to check/pull anymore. +## OPTIONS + +**--authfile**=*path* + +Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`. +If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`. (Not available for remote commands) + +Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE +environment variable. `export REGISTRY_AUTH_FILE=path` + ## EXAMPLES ``` # Start a container -$ podman run -d busybox:latest top +$ podman run --label "io.containers.autoupdate=image" \ + --label "io.containers.autoupdate.autfile=/some/authfile.json" \ + -d busybox:latest top bc219740a210455fa27deacc96d50a9e20516492f1417507c13ce1533dbdcd9d # Generate a systemd unit for this container diff --git a/docs/source/markdown/podman-container-cleanup.1.md b/docs/source/markdown/podman-container-cleanup.1.md index 66a6cff62..a200c2c36 100644 --- a/docs/source/markdown/podman-container-cleanup.1.md +++ b/docs/source/markdown/podman-container-cleanup.1.md @@ -16,6 +16,13 @@ Sometimes container's mount points and network stacks can remain if the podman c Cleanup all containers. +**--exec**=_session_ + +Clean up an exec session for a single container. +Can only be specified if a single container is being cleaned up (conflicts with **--all** as such). +If **--rm** is not specified, temporary files for the exec session will be cleaned up; if it is, the exec session will be removed from the container. +Conflicts with **--rmi** as the container is not being cleaned up so the image cannot be removed. + **--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. diff --git a/docs/source/markdown/podman-events.1.md b/docs/source/markdown/podman-events.1.md index bb1923574..a05047684 100644 --- a/docs/source/markdown/podman-events.1.md +++ b/docs/source/markdown/podman-events.1.md @@ -142,7 +142,7 @@ $ sudo podman events --since 5m Show Podman events in JSON Lines format ``` -events --format json +$ podman events --format json {"ID":"683b0909d556a9c02fa8cd2b61c3531a965db42158627622d1a67b391964d519","Image":"localhost/myshdemo:latest","Name":"agitated_diffie","Status":"cleanup","Time":"2019-04-27T22:47:00.849932843-04:00","Type":"container"} {"ID":"a0f8ab051bfd43f9c5141a8a2502139707e4b38d98ac0872e57c5315381e88ad","Image":"docker.io/library/alpine:latest","Name":"friendly_tereshkova","Status":"unmount","Time":"2019-04-28T13:43:38.063017276-04:00","Type":"container"} ``` diff --git a/docs/source/markdown/podman-exec.1.md b/docs/source/markdown/podman-exec.1.md index 1bd10f9ba..b24a1f8aa 100644 --- a/docs/source/markdown/podman-exec.1.md +++ b/docs/source/markdown/podman-exec.1.md @@ -13,6 +13,10 @@ podman\-exec - Execute a command in a running container ## OPTIONS +**--detach** + +Start the exec session, but do not attach to it. The command will run in the background and the exec session will be automatically removed when it completes. The **podman exec** command will print the ID of the exec session and exit immediately after it starts. + **--detach-keys**=*sequence* Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-<value>` characters where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will disable this feature. The default is *ctrl-p,ctrl-q*. diff --git a/docs/source/markdown/podman-info.1.md b/docs/source/markdown/podman-info.1.md index d9da4c3f8..24ab97c91 100644 --- a/docs/source/markdown/podman-info.1.md +++ b/docs/source/markdown/podman-info.1.md @@ -30,128 +30,212 @@ Run podman info with plain text response: ``` $ podman info host: - BuildahVersion: 1.4-dev - Conmon: - package: Unknown - path: /usr/libexec/podman/conmon - version: 'conmon version 1.12.0-dev, commit: d724f3d54ad2d95b6de741085d4990190ebfd7ff' - Distribution: - distribution: fedora - version: "28" - MemFree: 1271083008 - MemTotal: 33074233344 - OCIRuntime: - package: runc-1.0.0-51.dev.gitfdd8055.fc28.x86_64 - path: /usr/bin/runc - version: 'runc version spec: 1.0.0' - SwapFree: 34309664768 - SwapTotal: 34359734272 arch: amd64 + buildahVersion: 1.15.0 + cgroupVersion: v1 + conmon: + package: conmon-2.0.16-2.fc32.x86_64 + path: /usr/bin/conmon + version: 'conmon version 2.0.16, commit: 1044176f7dd177c100779d1c63931d6022e419bd' cpus: 8 + distribution: + distribution: fedora + version: "32" + eventLogger: file hostname: localhost.localdomain - kernel: 4.18.7-200.fc28.x86_64 + idMappings: + gidmap: + - container_id: 0 + host_id: 3267 + size: 1 + - container_id: 1 + host_id: 100000 + size: 65536 + uidmap: + - container_id: 0 + host_id: 3267 + size: 1 + - container_id: 1 + host_id: 100000 + size: 65536 + kernel: 5.6.11-300.fc32.x86_64 + linkmode: dynamic + memFree: 1401929728 + memTotal: 16416161792 + 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 + commit: 3e425f80a8c931f88e6d94a8c831b9d5aa481657 + spec: 1.0.1-dev os: linux - uptime: 218h 49m 33.66s (Approximately 9.08 days) + rootless: true + slirp4netns: + executable: /bin/slirp4netns + package: slirp4netns-1.0.0-1.fc32.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) registries: - docker.io: - Blocked: true - Insecure: true - Location: docker.io - MirrorByDigestOnly: false - Mirrors: - - Insecure: true - Location: example2.io/example/ubi8-minimal - Prefix: docker.io - redhat.com: - Blocked: false - Insecure: false - Location: registry.access.redhat.com/ubi8 - MirrorByDigestOnly: true - Mirrors: - - Insecure: false - Location: example.io/example/ubi8-minimal - - Insecure: true - Location: example3.io/example/ubi8-minimal - Prefix: redhat.com + search: + - registry.fedoraproject.org + - registry.access.redhat.com + - registry.centos.org + - docker.io store: - ConfigFile: /etc/containers/storage.conf - ContainerStore: - number: 37 - GraphDriverName: overlay - GraphOptions: - - overlay.mountopt=nodev - - overlay.override_kernel_check=true - GraphRoot: /var/lib/containers/storage - GraphStatus: + configFile: /home/dwalsh/.config/containers/storage.conf + containerStore: + number: 2 + paused: 0 + running: 0 + stopped: 2 + graphDriverName: overlay + graphOptions: + overlay.mount_program: + Executable: /home/dwalsh/bin/fuse-overlayfs + Package: Unknown + Version: |- + fusermount3 version: 3.9.1 + fuse-overlayfs: version 0.7.2 + FUSE library version 3.9.1 + using FUSE kernel interface version 7.31 + graphRoot: /home/dwalsh/.local/share/containers/storage + graphStatus: Backing Filesystem: extfs - Native Overlay Diff: "true" + Native Overlay Diff: "false" Supports d_type: "true" - ImageStore: - number: 17 - RunRoot: /var/run/containers/storage - + Using metacopy: "false" + imageStore: + number: 7 + 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 + OsArch: linux/amd64 + APIVersion: 1 + Version: 2.0.0 ``` Run podman info with JSON formatted response: ``` { - "host": { - "BuildahVersion": "1.4-dev", - "Conmon": { - "package": "Unknown", - "path": "/usr/libexec/podman/conmon", - "version": "conmon version 1.12.0-dev, commit: d724f3d54ad2d95b6de741085d4990190ebfd7ff" - }, - "Distribution": { - "distribution": "fedora", - "version": "28" + "host": { + "arch": "amd64", + "buildahVersion": "1.15.0", + "cgroupVersion": "v1", + "conmon": { + "package": "conmon-2.0.16-2.fc32.x86_64", + "path": "/usr/bin/conmon", + "version": "conmon version 2.0.16, commit: 1044176f7dd177c100779d1c63931d6022e419bd" + }, + "cpus": 8, + "distribution": { + "distribution": "fedora", + "version": "32" + }, + "eventLogger": "file", + "hostname": "localhost.localdomain", + "idMappings": { + "gidmap": [ + { + "container_id": 0, + "host_id": 3267, + "size": 1 }, - "MemFree": 1204109312, - "MemTotal": 33074233344, - "OCIRuntime": { - "package": "runc-1.0.0-51.dev.gitfdd8055.fc28.x86_64", - "path": "/usr/bin/runc", - "version": "runc version spec: 1.0.0" + { + "container_id": 1, + "host_id": 100000, + "size": 65536 + } + ], + "uidmap": [ + { + "container_id": 0, + "host_id": 3267, + "size": 1 }, - "SwapFree": 34309664768, - "SwapTotal": 34359734272, - "arch": "amd64", - "cpus": 8, - "hostname": "localhost.localdomain", - "kernel": "4.18.7-200.fc28.x86_64", - "os": "linux", - "uptime": "218h 50m 35.02s (Approximately 9.08 days)" + { + "container_id": 1, + "host_id": 100000, + "size": 65536 + } + ] }, - "insecure registries": { - "registries": [] + "kernel": "5.6.11-300.fc32.x86_64", + "memFree": 1380356096, + "memTotal": 16416161792, + "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" }, - "registries": { - "registries": [ - "quay.io", - "registry.fedoraproject.org", - "docker.io", - "registry.access.redhat.com" - ] + "os": "linux", + "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" }, - "store": { - "ContainerStore": { - "number": 37 - }, - "GraphDriverName": "overlay", - "GraphOptions": [ - "overlay.mountopt=nodev", - "overlay.override_kernel_check=true" - ], - "GraphRoot": "/var/lib/containers/storage", - "GraphStatus": { - "Backing Filesystem": "extfs", - "Native Overlay Diff": "true", - "Supports d_type": "true" - }, - "ImageStore": { - "number": 17 - }, - "RunRoot": "/var/run/containers/storage" - } + "swapFree": 8291610624, + "swapTotal": 8296329216, + "uptime": "52h 27m 39.38s (Approximately 2.17 days)", + "linkmode": "dynamic" + }, + "store": { + "configFile": "/home/dwalsh/.config/containers/storage.conf", + "containerStore": { + "number": 2, + "paused": 0, + "running": 0, + "stopped": 2 + }, + "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" +} + }, + "graphRoot": "/home/dwalsh/.local/share/containers/storage", + "graphStatus": { + "Backing Filesystem": "extfs", + "Native Overlay Diff": "false", + "Supports d_type": "true", + "Using metacopy": "false" + }, + "imageStore": { + "number": 7 + }, + "runRoot": "/run/user/3267/containers", + "volumePath": "/home/dwalsh/.local/share/containers/storage/volumes" + }, + "registries": { + "search": [ + "registry.fedoraproject.org", + "registry.access.redhat.com", + "registry.centos.org", + "docker.io" +] + }, + "version": { + "APIVersion": 1, + "Version": "2.0.0", + "GoVersion": "go1.14.2", + "GitCommit": "c3678ce3289f4195f3f16802411e795c6a587c9f-dirty", + "BuiltTime": "Tue May 19 10:40:46 2020", + "Built": 1589899246, + "OsArch": "linux/amd64" + } } ``` Run podman info and only get the registries information. diff --git a/docs/source/markdown/podman-network-inspect.1.md b/docs/source/markdown/podman-network-inspect.1.md index dfa7e4b0c..ca6875d18 100644 --- a/docs/source/markdown/podman-network-inspect.1.md +++ b/docs/source/markdown/podman-network-inspect.1.md @@ -9,6 +9,15 @@ podman\-network\-inspect - Displays the raw CNI network configuration for one or ## DESCRIPTION Display the raw (JSON format) network configuration. This command is not available for rootless users. +## OPTIONS +**--quiet**, **-q** + +The `quiet` option will restrict the output to only the network names. + +**--format**, **-f** + +Pretty-print networks to JSON or using a Go template. + ## EXAMPLE Inspect the default podman network @@ -43,6 +52,11 @@ Inspect the default podman network ] ``` +``` +# podman network inspect podman --format '{{(index .plugins 0).ipam.ranges}}' +[[map[gateway:10.88.0.1 subnet:10.88.0.0/16]]] +``` + ## SEE ALSO podman(1), podman-network(1), podman-network-ls(1) diff --git a/docs/source/markdown/podman-network-ls.1.md b/docs/source/markdown/podman-network-ls.1.md index 46e424593..7b20cf5e0 100644 --- a/docs/source/markdown/podman-network-ls.1.md +++ b/docs/source/markdown/podman-network-ls.1.md @@ -12,7 +12,15 @@ Displays a list of existing podman networks. This command is not available for r ## OPTIONS **--quiet**, **-q** -The `quiet` option will restrict the output to only the network names +The `quiet` option will restrict the output to only the network names. + +**--format**, **-f** + +Pretty-print networks to JSON or using a Go template. + +**--filter** + +Provide filter values (e.g. 'name=podman'). ## EXAMPLE @@ -36,6 +44,14 @@ outside podman9 ``` +Display name of network which support bridge plugin +``` +# podman network ls --filter plugin=portmap --format {{.Name}} +podman +podman2 +podman9 +``` + ## SEE ALSO podman(1), podman-network(1), podman-network-inspect(1) diff --git a/docs/source/markdown/podman-version.1.md b/docs/source/markdown/podman-version.1.md index 86c270e02..185e8e296 100644 --- a/docs/source/markdown/podman-version.1.md +++ b/docs/source/markdown/podman-version.1.md @@ -25,17 +25,18 @@ Change output format to "json" or a Go template. A sample output of the `version` command: ``` $ podman version -Version: 0.11.1 -Go Version: go1.11 -Git Commit: "8967a1d691ed44896b81ad48c863033f23c65eb0-dirty" -Built: Thu Nov 8 22:35:40 2018 -OS/Arch: linux/amd64 +Version: 2.0.0 +API Version: 1 +Go Version: go1.14.2 +Git Commit: 4520664f63c3a7f9a80227715359e20069d95542 +Built: Tue May 19 10:48:59 2020 +OS/Arch: linux/amd64 ``` Filtering out only the version: ``` $ podman version --format '{{.Client.Version}}' -1.6.3 +2.0.0 ``` ## SEE ALSO |