diff options
Diffstat (limited to 'docs/source/markdown')
30 files changed, 556 insertions, 161 deletions
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-create.1.md b/docs/source/markdown/podman-create.1.md index f0494ca7d..3a6077832 100644 --- a/docs/source/markdown/podman-create.1.md +++ b/docs/source/markdown/podman-create.1.md @@ -278,7 +278,7 @@ See [**Environment**](#environment) note below for precedence and examples. **--env-host**=*true|false* -Use host environment inside of the container. See **Environment** note below for precedence. +Use host environment inside of the container. See **Environment** note below for precedence. (Not available for remote commands) **--env-file**=*file* @@ -347,7 +347,7 @@ the container should not use any proxy. Proxy environment variables specified for the container in any other way will override the values that would have been passed through from the host. (Other ways to specify the proxy for the container include passing the values with the `--env` flag, or hard coding the -proxy environment at container build time.) +proxy environment at container build time.) (Not available for remote commands) For example, to disable passing these environment variables from host to container: @@ -358,12 +358,12 @@ Defaults to `true` **--image-volume**, **builtin-volume**=*bind|tmpfs|ignore* -Tells Podman how to handle the builtin image volumes. The options are: 'bind', 'tmpfs', or 'ignore' (default 'bind'). -bind: A directory is created inside the container state directory and bind mounted into -the container for the volumes. -tmpfs: The volume is mounted onto the container as a tmpfs, which allows the users to create +Tells Podman how to handle the builtin image volumes. Default is **bind**. + +- **bind**: An anonymous named volume will be created and mounted into the container. +- **tmpfs**: The volume is mounted onto the container as a tmpfs, which allows the users to create content that disappears when the container is stopped. -ignore: All volumes are just ignored and no action is taken. +- **ignore**: All volumes are just ignored and no action is taken. **--init** @@ -445,8 +445,6 @@ Remember that the MAC address in an Ethernet network must be unique. The IPv6 link-local address will be based on the device's MAC address according to RFC4862. -Not currently supported - **--memory**, **-m**=*limit* Memory limit (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) @@ -504,7 +502,7 @@ Current supported mount TYPES are `bind`, `volume`, and `tmpfs`. · dst, destination, target: mount destination spec. - · ro, read-only: true or false (default). + · ro, readonly: true or false (default). Options specific to bind: 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..f44a3d3d9 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**, **-d** + +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-generate-systemd.1.md b/docs/source/markdown/podman-generate-systemd.1.md index fa04f81f9..72031b19b 100644 --- a/docs/source/markdown/podman-generate-systemd.1.md +++ b/docs/source/markdown/podman-generate-systemd.1.md @@ -40,6 +40,18 @@ Override the default stop timeout for the container with the given value. Set the systemd restart policy. The restart-policy must be one of: "no", "on-success", "on-failure", "on-abnormal", "on-watchdog", "on-abort", or "always". The default policy is *on-failure*. +**--container-prefix**=*prefix* + +Set the systemd unit name prefix for containers. The default is *container*. + +**--pod-prefix**=*prefix* + +Set the systemd unit name prefix for pods. The default is *pod*. + +**--separator**=*separator* + +Set the systemd unit name seperator between the name/id of a container/pod and the prefix. The default is *-*. + ## Examples ### Generate and print a systemd unit file for a container diff --git a/docs/source/markdown/podman-history.1.md b/docs/source/markdown/podman-history.1.md index 1a8f8906c..26b213af9 100644 --- a/docs/source/markdown/podman-history.1.md +++ b/docs/source/markdown/podman-history.1.md @@ -37,10 +37,13 @@ Display sizes and dates in human readable format (default *true*). Do not truncate the output (default *false*). +**--notruncate** + +Do not truncate the output + **--quiet**, **-q**=*true|false* Print the numeric IDs only (default *false*). - **--format**=*format* Alter the output for a format like 'json' or a Go template. diff --git a/docs/source/markdown/podman-image-diff.1.md b/docs/source/markdown/podman-image-diff.1.md new file mode 100644 index 000000000..1e7397cd8 --- /dev/null +++ b/docs/source/markdown/podman-image-diff.1.md @@ -0,0 +1,46 @@ +% podman-image-diff(1) + +## NAME +podman-image-diff - Inspect changes on an image's filesystem + +## SYNOPSIS +**podman image diff** [*options*] *name* + +## DESCRIPTION +Displays changes on a container or image's filesystem. The container or image will be compared to its parent layer + +## OPTIONS + +**--format** + +Alter the output into a different format. The only valid format for diff is `json`. + +## EXAMPLE + +``` +# podman diff redis:old redis:alpine +C /usr +C /usr/local +C /usr/local/bin +A /usr/local/bin/docker-entrypoint.sh +``` + +``` +# podman diff --format json redis:old redis:alpine +{ + "changed": [ + "/usr", + "/usr/local", + "/usr/local/bin" + ], + "added": [ + "/usr/local/bin/docker-entrypoint.sh" + ] +} +``` + +## SEE ALSO +podman(1) + +## HISTORY +August 2017, Originally compiled by Ryan Cole <rycole@redhat.com> diff --git a/docs/source/markdown/podman-image.1.md b/docs/source/markdown/podman-image.1.md index 1552098ac..dfff57b31 100644 --- a/docs/source/markdown/podman-image.1.md +++ b/docs/source/markdown/podman-image.1.md @@ -14,6 +14,7 @@ The image command allows you to manage images | Command | Man Page | Description | | -------- | ----------------------------------------------- | --------------------------------------------------------------------------- | | build | [podman-build(1)](podman-build.1.md) | Build a container using a Dockerfile. | +| diff | [podman-image-diff(1)](podman-image-diff.1.md) | Inspect changes on an image's filesystem. | | exists | [podman-image-exists(1)](podman-image-exists.1.md) | Check if an image exists in local storage. | | history | [podman-history(1)](podman-history.1.md) | Show the history of an image. | | import | [podman-import(1)](podman-import.1.md) | Import a tarball and save it as a filesystem image. | @@ -25,6 +26,7 @@ The image command allows you to manage images | push | [podman-push(1)](podman-push.1.md) | Push an image from local storage to elsewhere. | | rm | [podman-rmi(1)](podman-rmi.1.md) | Removes one or more locally stored images. | | save | [podman-save(1)](podman-save.1.md) | Save an image to docker-archive or oci. | +| search | [podman-search(1)](podman-search.1.md) | Search a registry for an image. | | sign | [podman-image-sign(1)](podman-image-sign.1.md) | Create a signature for an image. | | tag | [podman-tag(1)](podman-tag.1.md) | Add an additional name to a local image. | | untag | [podman-untag(1)](podman-untag.1.md) | Removes one or more names from a locally-stored image. | 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-manifest-add.1.md b/docs/source/markdown/podman-manifest-add.1.md index 857a98e12..82f2071b9 100644 --- a/docs/source/markdown/podman-manifest-add.1.md +++ b/docs/source/markdown/podman-manifest-add.1.md @@ -73,4 +73,4 @@ podman manifest add --arch arm64 --variant v8 mylist:v1.11 docker://71c201d10fff ``` ## SEE ALSO -podman(1), podman-manifest(1), podman-manifest-create(1), podman-manifest-inspect(1), podman-rmi(1) +podman(1), podman-manifest(1), podman-manifest-create(1), podman-manifest-inspect(1), podman-manifest-push(1), podman-manifest-remove(1), podman-rmi(1) diff --git a/docs/source/markdown/podman-manifest-annotate.1.md b/docs/source/markdown/podman-manifest-annotate.1.md new file mode 100644 index 000000000..4450de7fd --- /dev/null +++ b/docs/source/markdown/podman-manifest-annotate.1.md @@ -0,0 +1,61 @@ +% podman-manifest-annotate(1) + +## NAME +podman\-manifest\-annotate - Add or update information about an entry in a manifest list or image index + +## SYNOPSIS +**podman manifest annotate** [options...] *listnameorindexname* *imagemanifestdigest* + +## DESCRIPTION + +Adds or updates information about an image included in a manifest list or image index. + +## OPTIONS + +**--annotation** *annotation=value* + +Set an annotation on the entry for the specified image. + +**--arch** + +Override the architecture which the list or index records as a requirement for +the image. This is usually automatically retrieved from the image's +configuration information, so it is rarely necessary to use this option. + + +**--features** + +Specify the features list which the list or index records as requirements for +the image. This option is rarely used. + +**--os** + +Override the OS which the list or index records as a requirement for the image. +This is usually automatically retrieved from the image's configuration +information, so it is rarely necessary to use this option. + +**--os-features** + +Specify the OS features list which the list or index records as requirements +for the image. This option is rarely used. + +**--os-version** + +Specify the OS version which the list or index records as a requirement for the +image. This option is rarely used. + +**--variant** + +Specify the variant which the list or index records for the image. This option +is typically used to distinguish between multiple entries which share the same +architecture value, but which expect different versions of its instruction set. + +## EXAMPLE + +``` +podman manifest annotate --arch arm64 --variant v8 mylist:v1.11 sha256:59eec8837a4d942cc19a52b8c09ea75121acc38114a2c68b98983ce9356b8610 +07ec8dc22b5dba3a33c60b68bce28bbd2b905e383fdb32a90708fa5eeac13a07: sha256:59eec8837a4d942cc19a52b8c09ea75121acc38114a2c68b98983ce9356b8610 +``` + +## SEE ALSO +podman(1), podman-manifest(1), podman-manifest-add(1), podman-manifest-create(1), podman-manifest-inspect(1), podman-rmi(1) diff --git a/docs/source/markdown/podman-manifest-create.1.md b/docs/source/markdown/podman-manifest-create.1.md index 941e70c32..537a641f2 100644 --- a/docs/source/markdown/podman-manifest-create.1.md +++ b/docs/source/markdown/podman-manifest-create.1.md @@ -40,4 +40,4 @@ podman manifest create --all mylist:v1.11 docker://fedora ``` ## SEE ALSO -podman(1), podman-manifest(1), podman-manifest-add(1), podman-manifest-inspect(1), podman-rmi(1) +podman(1), podman-manifest(1), podman-manifest-add(1), podman-manifest-inspect(1), podman-manifest-push(1), podman-manifest-remove(1), podman-rmi(1) diff --git a/docs/source/markdown/podman-manifest-inspect.1.md b/docs/source/markdown/podman-manifest-inspect.1.md index efde02643..a4c58bd13 100644 --- a/docs/source/markdown/podman-manifest-inspect.1.md +++ b/docs/source/markdown/podman-manifest-inspect.1.md @@ -21,4 +21,4 @@ podman manifest inspect mylist:v1.11 ``` ## SEE ALSO -podman(1), podman-manifest(1), podman-manifest-create(1), podman-manifest-add(1), podman-rmi(1) +podman(1), podman-manifest(1), podman-manifest-create(1), podman-manifest-add(1), podman-manifest-push(1), podman-manifest-remove(1), podman-rmi(1) diff --git a/docs/source/markdown/podman-manifest-push.1.md b/docs/source/markdown/podman-manifest-push.1.md new file mode 100644 index 000000000..ab3287a7c --- /dev/null +++ b/docs/source/markdown/podman-manifest-push.1.md @@ -0,0 +1,76 @@ +% podman-manifest-push(1) + +## NAME +podman\-manifest\-push - Push a manifest list or image index to a registry + +## SYNOPSIS +**podman manifest push** [options...] *listnameorindexname* *transport:details* + +## DESCRIPTION +Pushes a manifest list or image index to a registry. + +## RETURN VALUE +The list image's ID and the digest of the image's manifest. + +## OPTIONS + +**--all** + +Push the images mentioned in the manifest list or image index, in addition to +the list or index itself. + +**--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` + +**--cert-dir**=*path* + +Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. +Default certificates directory is _/etc/containers/certs.d_. (Not available for remote commands) + +**--creds**=*creds* + +The [username[:password]] to use to authenticate with the registry if required. +If one or both values are not supplied, a command line prompt will appear and the +value can be entered. The password is entered without echo. + +**--digestfile**=*Digestfile* + +After copying the image, write the digest of the resulting image to the file. + +**--format**, **-f**=*format* + +Manifest list type (oci or v2s2) to use when pushing the list (default is oci). + +**--purge** + +Delete the manifest list or image index from local storage if pushing succeeds. + +**--quiet**, **-q** + +When writing the manifest, suppress progress output + +**--remove-signatures** + +Don't copy signatures when pushing images. + +**--sign-by**=*fingerprint* + +Sign the pushed images using the GPG key that matches the specified fingerprint. + +**--tls-verify** + +Require HTTPS and verify certificates when talking to container registries (defaults to true) (Not available for remote commands) + +## EXAMPLE + +``` +podman manifest push mylist:v1.11 docker://registry.example.org/mylist:v1.11 +``` + +## SEE ALSO +podman(1), podman-manifest(1), podman-manifest-add(1), podman-manifest-create(1), podman-manifest-inspect(1), podman-manifest-remove(1), podman-rmi(1) diff --git a/docs/source/markdown/podman-manifest-remove.1.md b/docs/source/markdown/podman-manifest-remove.1.md new file mode 100644 index 000000000..c13714195 --- /dev/null +++ b/docs/source/markdown/podman-manifest-remove.1.md @@ -0,0 +1,23 @@ +% podman-manifest-remove(1) + +## NAME +podman\-manifest\-remove - Remove an image from a manifest list or image index + +## SYNOPSIS +**podman manifest remove** *listnameorindexname* *transport:details* + +## DESCRIPTION +Removes the image with the specified digest from the specified manifest list or image index. + +## RETURN VALUE +The list image's ID and the digest of the removed image's manifest. + +## EXAMPLE + +``` +podman manifest remove mylist:v1.11 sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221 +e604eabaaee4858232761b4fef84e2316ed8f93e15eceafce845966ee3400036 :sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221 +``` + +## SEE ALSO +podman(1), podman-manifest(1), podman-manifest-add(1), podman-manifest-create(1), podman-manifest-inspect(1), podman-manifest-push(1), podman-rmi(1) diff --git a/docs/source/markdown/podman-manifest.1.md b/docs/source/markdown/podman-manifest.1.md index 70d695883..3353979ac 100644 --- a/docs/source/markdown/podman-manifest.1.md +++ b/docs/source/markdown/podman-manifest.1.md @@ -13,11 +13,14 @@ The `podman manifest` command provides subcommands which can be used to: ## SUBCOMMANDS -| Command | Man Page | Description | -| ------- | ---------------------------------------------------------- | --------------------------------------------------------------------------- | -| add | [podman-manifest-add(1)](podman-manifest-add.1.md) | Add an image to a manifest list or image index. | -| create | [podman-manifest-create(1)](podman-manifest-create.1.md) | Create a manifest list or image index. | -| inspect | [podman-manifest-inspect(1)](podman-manifest-inspect.1.md) | Display a manifest list or image index. | +| Command | Man Page | Description | +| -------- | ------------------------------------------------------------ | --------------------------------------------------------------------------- | +| add | [podman-manifest-add(1)](podman-manifest-add.1.md) | Add an image to a manifest list or image index. | +| annotate | [podman-manifest-annotate(1)](podman-manifest-annotate.1.md) | Add or update information about an entry in a manifest list or image index. | +| create | [podman-manifest-create(1)](podman-manifest-create.1.md) | Create a manifest list or image index. | +| inspect | [podman-manifest-inspect(1)](podman-manifest-inspect.1.md) | Display a manifest list or image index. | +| push | [podman-manifest-push(1)](podman-manifest-push.1.md) | Push a manifest list or image index to a registry. | +| remove | [podman-manifest-remove(1)](podman-manifest-remove.1.md) | Remove an image from a manifest list or image index. | ## SEE ALSO -podman(1), podman-manifest-add(1), podman-manifest-create(1), podman-manifest-inspect(1) +podman(1), podman-manifest-add(1), podman-manifest-annotate(1), podman-manifest-create(1), podman-manifest-inspect(1), podman-manifest-push(1), podman-manifest-remove(1) diff --git a/docs/source/markdown/podman-network-create.1.md b/docs/source/markdown/podman-network-create.1.md index cbdfee4d0..45d9d9b0b 100644 --- a/docs/source/markdown/podman-network-create.1.md +++ b/docs/source/markdown/podman-network-create.1.md @@ -24,7 +24,7 @@ resolution. **-d**, **--driver** -Driver to manage the network (default "bridge"). Currently on `bridge` is supported. +Driver to manage the network (default "bridge"). Currently only `bridge` is supported. **--gateway** diff --git a/docs/source/markdown/podman-network-inspect.1.md b/docs/source/markdown/podman-network-inspect.1.md index dfa7e4b0c..86fa2552e 100644 --- a/docs/source/markdown/podman-network-inspect.1.md +++ b/docs/source/markdown/podman-network-inspect.1.md @@ -9,6 +9,11 @@ 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 +**--format**, **-f** + +Pretty-print networks to JSON or using a Go template. + ## EXAMPLE Inspect the default podman network @@ -43,6 +48,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-pod-inspect.1.md b/docs/source/markdown/podman-pod-inspect.1.md index 831d28259..bc04b2b32 100644 --- a/docs/source/markdown/podman-pod-inspect.1.md +++ b/docs/source/markdown/podman-pod-inspect.1.md @@ -18,21 +18,50 @@ to run pods such as CRI-O, the last started pod could be from either of those me The latest option is not supported on the remote client. +**-f**, **--format**=*format* + +Change the default output format. This can be of a supported type like 'json' +or a Go template. +Valid placeholders for the Go template are listed below: + +| **Placeholder** | **Description** | +| ----------------- | ----------------------------------------------------------------------------- | +| .ID | Pod ID | +| .Name | Pod name | +| .State | Pod state | +| .Hostname | Pod hostname | +| .Labels | Pod labels | +| .Created | Time when the pod was created | +| .CreateCgroup | Whether cgroup was created | +| .CgroupParent | Pod cgroup parent | +| .CgroupPath | Pod cgroup path | +| .CreateInfra | Whether infrastructure created | +| .InfraContainerID | Pod infrastructure ID | +| .SharedNamespaces | Pod shared namespaces | +| .NumContainers | Number of containers in the pod | +| .Containers | Pod containers | + ## EXAMPLE ``` # podman pod inspect foobar { - "Config": { - "id": "3513ca70583dd7ef2bac83331350f6b6c47d7b4e526c908e49d89ebf720e4693", - "name": "foobar", - "labels": {}, - "cgroupParent": "/libpod_parent", - "UsePodCgroup": true, - "created": "2018-08-08T11:15:18.823115347-05:00" - }, - "State": { - "CgroupPath": "" - }, + + "Id": "3513ca70583dd7ef2bac83331350f6b6c47d7b4e526c908e49d89ebf720e4693", + "Name": "foobar", + "Labels": {}, + "CgroupParent": "/libpod_parent", + "CreateCgroup": true, + "Created": "2018-08-08T11:15:18.823115347-05:00" + "State": "created", + "Hostname": "", + "SharedNamespaces": [ + "uts", + "ipc", + "net" + ] + "CreateInfra": false, + "InfraContainerID": "1020dd70583dd7ff2bac83331350f6b6e007de0d026c908e49d89ebf891d4699" + "CgroupPath": "" "Containers": [ { "id": "d53f8bf1e9730281264aac6e6586e327429f62c704abea4b6afb5d8a2b2c9f2c", diff --git a/docs/source/markdown/podman-pull.1.md b/docs/source/markdown/podman-pull.1.md index aa558526a..5d941219a 100644 --- a/docs/source/markdown/podman-pull.1.md +++ b/docs/source/markdown/podman-pull.1.md @@ -73,7 +73,10 @@ The [username[:password]] to use to authenticate with the registry if required. If one or both values are not supplied, a command line prompt will appear and the value can be entered. The password is entered without echo. -**--override-arch**=ARCH +**--override-os**=*OS* +Use OS instead of the running OS for choosing images + +**--override-arch**=*ARCH* Override the machine's default architecture of the image to be pulled. For example, `arm`. diff --git a/docs/source/markdown/podman-run.1.md b/docs/source/markdown/podman-run.1.md index b21eb9da9..1e05b8999 100644 --- a/docs/source/markdown/podman-run.1.md +++ b/docs/source/markdown/podman-run.1.md @@ -294,7 +294,7 @@ See [**Environment**](#environment) note below for precedence and examples. **--env-host**=**true**|**false** -Use host environment inside of the container. See **Environment** note below for precedence. +Use host environment inside of the container. See **Environment** note below for precedence. (Not available for remote commands) **--env-file**=*file* @@ -363,7 +363,7 @@ the container should not use any proxy. Proxy environment variables specified for the container in any other way will override the values that would have been passed through from the host. (Other ways to specify the proxy for the container include passing the values with the **--env** flag, or hard coding the -proxy environment at container build time.) +proxy environment at container build time.) (Not available for remote commands) Defaults to **true**. @@ -371,8 +371,7 @@ Defaults to **true**. Tells Podman how to handle the builtin image volumes. Default is **bind**. -- **bind**: A directory is created inside the container state directory and bind mounted into -the container for the volumes. +- **bind**: An anonymous named volume will be created and mounted into the container. - **tmpfs**: The volume is mounted onto the container as a tmpfs, which allows the users to create content that disappears when the container is stopped. - **ignore**: All volumes are just ignored and no action is taken. @@ -454,8 +453,6 @@ Remember that the MAC address in an Ethernet network must be unique. The IPv6 link-local address will be based on the device's MAC address according to RFC4862. -Not currently supported - **--memory**, **-m**=_number_[_unit_] Memory limit. A _unit_ can be **b** (bytes), **k** (kilobytes), **m** (megabytes), or **g** (gigabytes). @@ -514,7 +511,7 @@ Current supported mount TYPEs are **bind**, **volume**, and **tmpfs**. · dst, destination, target: mount destination spec. - · ro, read-only: true or false (default). + · ro, readonly: true or false (default). Options specific to bind: diff --git a/docs/source/markdown/podman-search.1.md b/docs/source/markdown/podman-search.1.md index 31de6f839..75bfeb058 100644 --- a/docs/source/markdown/podman-search.1.md +++ b/docs/source/markdown/podman-search.1.md @@ -59,7 +59,7 @@ Valid placeholders for the Go template are listed below: **--limit**=*limit* -Limit the number of results +Limit the number of results. This value can be in the range between 1 and 100. The default number of results is 25. Note: The results from each registry will be limited to this value. Example if limit is 10 and two registries are being searched, the total number of results will be 20, 10 from each (if there are at least 10 matches in each). diff --git a/docs/source/markdown/podman-system-service.1.md b/docs/source/markdown/podman-system-service.1.md index a2fefe4dd..48e595641 100644 --- a/docs/source/markdown/podman-system-service.1.md +++ b/docs/source/markdown/podman-system-service.1.md @@ -15,15 +15,11 @@ example *unix:/run/user/1000/podman/podman.sock*) ## OPTIONS -**--timeout**, **-t** +**--time**, **-t** The time until the session expires in _milliseconds_. The default is 1 second. A value of `0` means no timeout and the session will not expire. -**--varlink** - -Use the varlink protocol instead of the REST-based protocol. This option will be deprecated in the future. - **--help**, **-h** Print usage statement. diff --git a/docs/source/markdown/podman-varlink.1.md b/docs/source/markdown/podman-varlink.1.md index 0d2ab1668..0b04d5ba3 100644 --- a/docs/source/markdown/podman-varlink.1.md +++ b/docs/source/markdown/podman-varlink.1.md @@ -19,7 +19,7 @@ The varlink service should generally be done with systemd. See _Configuration_ Print usage statement -**--timeout**, **-t** +**--time**, **-t** The time until the varlink session expires in _milliseconds_. The default is 1 second. A value of `0` means no timeout and the session will not expire. 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 diff --git a/docs/source/markdown/podman-wait.1.md b/docs/source/markdown/podman-wait.1.md index ce1c70a5f..886bbc55b 100644 --- a/docs/source/markdown/podman-wait.1.md +++ b/docs/source/markdown/podman-wait.1.md @@ -15,6 +15,9 @@ After the container stops, the container's return code is printed. ## OPTIONS +**--condition**=*state* +Condition to wait on (default "stopped") + **--help**, **-h** Print usage statement diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 6bac0cc9d..02f23e6cc 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -58,6 +58,9 @@ Podman and libpod currently support an additional `precreate` state which is cal **WARNING**: the `precreate` hook lets you do powerful things, such as adding additional mounts to the runtime configuration. That power also makes it easy to break things. Before reporting libpod errors, try running your container with `precreate` hooks disabled to see if the problem is due to one of your hooks. +**--identity**=*path* +Path to SSH identity file + **--log-level**=*level* Log messages above specified level: debug, info, warn, error (default), fatal or panic (default: "error") @@ -70,6 +73,9 @@ When namespace is set, created containers and pods will join the given namespace **--network-cmd-path**=*path* Path to the command binary to use for setting up a network. It is currently only used for setting up a slirp4netns network. If "" is used then the binary is looked up using the $PATH environment variable. +**--remote**, **-r**=*url* +URL to access Podman service (default "unix:/run/user/3267/podman/podman.sock") + **--root**=*value* Storage root dir in which data, including images, is stored (default: "/var/lib/containers/storage" for UID 0, "$HOME/.local/share/containers/storage" for other users). |