diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/Introduction.rst | 4 | ||||
| -rw-r--r-- | docs/source/manifest.rst | 2 | ||||
| -rw-r--r-- | docs/source/markdown/podman-auto-update.1.md | 5 | ||||
| -rw-r--r-- | docs/source/markdown/podman-create.1.md | 16 | ||||
| -rw-r--r-- | docs/source/markdown/podman-generate-systemd.1.md | 2 | ||||
| -rw-r--r-- | docs/source/markdown/podman-manifest-exists.1.md | 43 | ||||
| -rw-r--r-- | docs/source/markdown/podman-manifest.1.md | 1 | ||||
| -rw-r--r-- | docs/source/markdown/podman-network-create.1.md | 3 | ||||
| -rw-r--r-- | docs/source/markdown/podman-network-exists.1.md | 4 | ||||
| -rw-r--r-- | docs/source/markdown/podman-pull.1.md | 22 | ||||
| -rw-r--r-- | docs/source/markdown/podman-run.1.md | 16 | ||||
| -rw-r--r-- | docs/source/markdown/podman-volume-exists.1.md | 43 | ||||
| -rw-r--r-- | docs/source/markdown/podman-volume.1.md | 1 | ||||
| -rw-r--r-- | docs/source/markdown/podman.1.md | 2 | ||||
| -rw-r--r-- | docs/source/volume.rst | 2 |
15 files changed, 133 insertions, 33 deletions
diff --git a/docs/source/Introduction.rst b/docs/source/Introduction.rst index 9dcae8a83..9fdce6962 100644 --- a/docs/source/Introduction.rst +++ b/docs/source/Introduction.rst @@ -34,7 +34,7 @@ Sometimes we can find a publicly available container image for the exact workloa Container Images aren’t actually images, they’re repositories often made up of multiple layers. These layers can easily be added, saved, and shared with others by using a Containerfile (Dockerfile). This single file often contains all the instructions needed to build the new and can easily be shared with others publicly using tools like GitHub. -Here's an example of how to build an Nginx web server on top of a Debian base image using the Dockerfile maintained by Nginx and published in GitHub:: +Here's an example of how to build a Nginx web server on top of a Debian base image using the Dockerfile maintained by Nginx and published in GitHub:: podman build -t nginx https://git.io/Jf8ol @@ -62,7 +62,7 @@ Input:: Password: ******** Login Succeeded! -Nex, tag the image so that we can push it into our user account:: +Next, tag the image so that we can push it into our user account:: podman tag localhost/nginx quay.io/USERNAME/nginx diff --git a/docs/source/manifest.rst b/docs/source/manifest.rst index c63c28502..b35deaad7 100644 --- a/docs/source/manifest.rst +++ b/docs/source/manifest.rst @@ -7,6 +7,8 @@ Create and manipulate manifest lists and image indexes :doc:`create <markdown/podman-manifest-create.1>` Create a manifest list or image index +:doc:`exists <markdown/podman-manifest-exists.1>` Check if the given manifest list exists in local storage + :doc:`inspect <markdown/podman-manifest-inspect.1>` Display a manifest list or image index :doc:`push <markdown/podman-manifest-push.1>` Push a manifest list or image index to a registry diff --git a/docs/source/markdown/podman-auto-update.1.md b/docs/source/markdown/podman-auto-update.1.md index 219ac03b7..ad1e425aa 100644 --- a/docs/source/markdown/podman-auto-update.1.md +++ b/docs/source/markdown/podman-auto-update.1.md @@ -58,6 +58,11 @@ $ podman generate systemd --new --files bc219740a210455fa27deacc96d50a9e20516492 # Load the new systemd unit and start it $ mv ./container-bc219740a210455fa27deacc96d50a9e20516492f1417507c13ce1533dbdcd9d.service ~/.config/systemd/user $ systemctl --user daemon-reload + +# If the previously created containers or pods are using shared resources, such as ports, make sure to remove them before starting the generated systemd units. +$ podman stop bc219740a210455fa27deacc96d50a9e20516492f1417507c13ce1533dbdcd9d +$ podman rm bc219740a210455fa27deacc96d50a9e20516492f1417507c13ce1533dbdcd9d + $ systemctl --user start container-bc219740a210455fa27deacc96d50a9e20516492f1417507c13ce1533dbdcd9d.service # Auto-update the container diff --git a/docs/source/markdown/podman-create.1.md b/docs/source/markdown/podman-create.1.md index 35d8474a6..b3ac8b6ee 100644 --- a/docs/source/markdown/podman-create.1.md +++ b/docs/source/markdown/podman-create.1.md @@ -77,6 +77,9 @@ option can be set multiple times. Add an annotation to the container. The format is key=value. The **--annotation** option can be set multiple times. +#### **--arch**=*ARCH* +Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. + #### **--attach**, **-a**=*location* Attach to STDIN, STDOUT or STDERR. @@ -667,15 +670,9 @@ Whether to disable OOM Killer for the container or not. Tune the host's OOM preferences for containers (accepts -1000 to 1000) -#### **--override-arch**=*ARCH* -Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. - -#### **--override-os**=*OS* +#### **--os**=*OS* Override the OS, defaults to hosts, of the image to be pulled. For example, `windows`. -#### **--override-variant**=*VARIANT* -Use _VARIANT_ instead of the default architecture variant of the container image. Some images can use multiple variants of the arm architectures, such as arm/v5 and arm/v7. - #### **--pid**=*pid* Set the PID mode for the container @@ -691,7 +688,7 @@ Tune the container's pids limit. Set `0` to have unlimited pids for the containe #### **--platform**=*OS/ARCH* -Specify the platform for selecting the image. (Conflicts with override-arch and override-os) +Specify the platform for selecting the image. (Conflicts with --arch and --os) The `--platform` option can be used to override the current architecture and operating system. #### **--pod**=*name* @@ -1007,6 +1004,9 @@ Set the UTS namespace mode for the container. The following values are supported - **ns:[path]**: run the container in the given existing UTS namespace. - **container:[container]**: join the UTS namespace of the specified container. +#### **--variant**=*VARIANT* +Use _VARIANT_ instead of the default architecture variant of the container image. Some images can use multiple variants of the arm architectures, such as arm/v5 and arm/v7. + #### **--volume**, **-v**[=*[[SOURCE-VOLUME|HOST-DIR:]CONTAINER-DIR[:OPTIONS]]*] Create a bind mount. If you specify, ` -v /HOST-DIR:/CONTAINER-DIR`, Podman diff --git a/docs/source/markdown/podman-generate-systemd.1.md b/docs/source/markdown/podman-generate-systemd.1.md index 032158c56..a59dbc7f0 100644 --- a/docs/source/markdown/podman-generate-systemd.1.md +++ b/docs/source/markdown/podman-generate-systemd.1.md @@ -189,6 +189,8 @@ Create and enable systemd unit files for a pod using the above examples as refer Since systemctl defaults to using the root user, all the changes using the systemctl can be seen by appending sudo to the podman cli commands. To perform `systemctl` actions as a non-root user use the `--user` flag when interacting with `systemctl`. +Note: If the previously created containers or pods are using shared resources, such as ports, make sure to remove them before starting the generated systemd units. + ``` $ systemctl --user start pod-systemd-pod.service $ podman pod ps diff --git a/docs/source/markdown/podman-manifest-exists.1.md b/docs/source/markdown/podman-manifest-exists.1.md new file mode 100644 index 000000000..e15110126 --- /dev/null +++ b/docs/source/markdown/podman-manifest-exists.1.md @@ -0,0 +1,43 @@ +% podman-manifest-exists(1) + +## NAME +podman\-manifest\-exists - Check if the given manifest list exists in local storage + +## SYNOPSIS +**podman manifest exists** *manifest* + +## DESCRIPTION +**podman manifest exists** checks if a manifest list exists on local storage. Podman will +return an exit code of `0` when the manifest is found. A `1` will be returned otherwise. +An exit code of `125` indicates there was another issue. + + +## OPTIONS + +#### **--help**, **-h** + +Print usage statement. + +## EXAMPLE + +Check if a manifest list called `list1` exists (the manifest list does actually exist). +``` +$ podman manifest exists list1 +$ echo $? +0 +$ +``` + +Check if an manifest called `mylist` exists (the manifest list does not actually exist). +``` +$ podman manifest exists mylist +$ echo $? +1 +$ +``` + +## SEE ALSO +podman(1), podman-manifest-create(1), podman-manifest-remove(1) + +## HISTORY +January 2021, Originally compiled by Paul Holzinger `<paul.holzinger@web.de>` diff --git a/docs/source/markdown/podman-manifest.1.md b/docs/source/markdown/podman-manifest.1.md index 3353979ac..30ccdc56a 100644 --- a/docs/source/markdown/podman-manifest.1.md +++ b/docs/source/markdown/podman-manifest.1.md @@ -18,6 +18,7 @@ The `podman manifest` command provides subcommands which can be used to: | 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. | +| exists | [podman-manifest-exists(1)](podman-manifest-exists.1.md) | Check if the given manifest list exists in local storage | | 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. | diff --git a/docs/source/markdown/podman-network-create.1.md b/docs/source/markdown/podman-network-create.1.md index 16e4e3bdb..2fafd1e31 100644 --- a/docs/source/markdown/podman-network-create.1.md +++ b/docs/source/markdown/podman-network-create.1.md @@ -41,7 +41,8 @@ Define a gateway for the subnet. If you want to provide a gateway address, you m #### **--internal** -Restrict external access of this network +Restrict external access of this network. Note when using this option, the dnsname plugin will be +automatically disabled. #### **--ip-range** diff --git a/docs/source/markdown/podman-network-exists.1.md b/docs/source/markdown/podman-network-exists.1.md index c7edc2ac7..3ad3ccedb 100644 --- a/docs/source/markdown/podman-network-exists.1.md +++ b/docs/source/markdown/podman-network-exists.1.md @@ -10,7 +10,7 @@ podman\-network\-exists - Check if the given network exists **podman network exists** checks if a network exists. The **Name** or **ID** of the network may be used as input. Podman will return an exit code of `0` when the network is found. A `1` will be returned otherwise. An exit code of -`125` indicates there was an other issue. +`125` indicates there was another issue. ## OPTIONS @@ -41,4 +41,4 @@ $ podman(1), podman-network-create(1), podman-network-rm(1) ## HISTORY -January 2021, Originally compiled by Paul Holzinger <paul.holzinger@web.de> +January 2021, Originally compiled by Paul Holzinger `<paul.holzinger@web.de>` diff --git a/docs/source/markdown/podman-pull.1.md b/docs/source/markdown/podman-pull.1.md index 44a7e83b6..af91a59e9 100644 --- a/docs/source/markdown/podman-pull.1.md +++ b/docs/source/markdown/podman-pull.1.md @@ -71,6 +71,9 @@ All tagged images in the repository will be pulled. Note: When using the all-tags flag, Podman will not iterate over the search registries in the containers-registries.conf(5) but will always use docker.io for unqualified image names. +#### **--arch**=*ARCH* +Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. + #### **--authfile**=*path* Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`. @@ -96,19 +99,16 @@ This is a Docker specific option to disable image verification to a Docker registry and is not supported by Podman. This flag is a NOOP and provided solely for scripting compatibility. -#### **--override-arch**=*ARCH* -Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. - -#### **--override-os**=*OS* -Override the OS, defaults to hosts, of the image to be pulled. For example, `windows`. +#### **--help**, **-h** -#### **--override-variant**=*VARIANT* +Print usage statement -Use _VARIANT_ instead of the default architecture variant of the container image. Some images can use multiple variants of the arm architectures, such as arm/v5 and arm/v7. +#### **--os**=*OS* +Override the OS, defaults to hosts, of the image to be pulled. For example, `windows`. #### **--platform**=*OS/ARCH* -Specify the platform for selecting the image. (Conflicts with override-arch and override-os) +Specify the platform for selecting the image. (Conflicts with --arch and --os) The `--platform` option can be used to override the current architecture and operating system. #### **--quiet**, **-q** @@ -121,9 +121,9 @@ Require HTTPS and verify certificates when contacting registries (default: true) then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf. -#### **--help**, **-h** +#### **--variant**=*VARIANT* -Print usage statement +Use _VARIANT_ instead of the default architecture variant of the container image. Some images can use multiple variants of the arm architectures, such as arm/v5 and arm/v7. ## EXAMPLES @@ -189,7 +189,7 @@ Storing signatures ``` ``` -$ podman pull --override-arch=arm arm32v7/debian:stretch +$ podman pull --arch=arm arm32v7/debian:stretch Trying to pull docker.io/arm32v7/debian:stretch... Getting image source signatures Copying blob b531ae4a3925 done diff --git a/docs/source/markdown/podman-run.1.md b/docs/source/markdown/podman-run.1.md index 89f05c308..e606c456f 100644 --- a/docs/source/markdown/podman-run.1.md +++ b/docs/source/markdown/podman-run.1.md @@ -93,6 +93,9 @@ This option can be set multiple times. Add an annotation to the container. This option can be set multiple times. +#### **--arch**=*ARCH* +Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. + #### **--attach**, **-a**=**stdin**|**stdout**|**stderr** Attach to STDIN, STDOUT or STDERR. @@ -704,15 +707,9 @@ Whether to disable OOM Killer for the container or not. Tune the host's OOM preferences for containers (accepts values from **-1000** to **1000**). -#### **--override-arch**=*ARCH* -Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. - -#### **--override-os**=*OS* +#### **--os**=*OS* Override the OS, defaults to hosts, of the image to be pulled. For example, `windows`. -#### **--override-variant**=*VARIANT* -Use _VARIANT_ instead of the default architecture variant of the container image. Some images can use multiple variants of the arm architectures, such as arm/v5 and arm/v7. - #### **--pid**=*mode* Set the PID namespace mode for the container. @@ -729,7 +726,7 @@ Tune the container's pids limit. Set to **0** to have unlimited pids for the con #### **--platform**=*OS/ARCH* -Specify the platform for selecting the image. (Conflicts with override-arch and override-os) +Specify the platform for selecting the image. (Conflicts with --arch and --os) The `--platform` option can be used to override the current architecture and operating system. #### **--pod**=*name* @@ -1082,6 +1079,9 @@ Set the UTS namespace mode for the container. The following values are supported - **ns:[path]**: run the container in the given existing UTS namespace. - **container:[container]**: join the UTS namespace of the specified container. +#### **--variant**=*VARIANT* +Use _VARIANT_ instead of the default architecture variant of the container image. Some images can use multiple variants of the arm architectures, such as arm/v5 and arm/v7. + #### **--volume**, **-v**[=*[[SOURCE-VOLUME|HOST-DIR:]CONTAINER-DIR[:OPTIONS]]*] Create a bind mount. If you specify _/HOST-DIR_:_/CONTAINER-DIR_, Podman diff --git a/docs/source/markdown/podman-volume-exists.1.md b/docs/source/markdown/podman-volume-exists.1.md new file mode 100644 index 000000000..ead806bd9 --- /dev/null +++ b/docs/source/markdown/podman-volume-exists.1.md @@ -0,0 +1,43 @@ +% podman-volume-exists(1) + +## NAME +podman\-volume\-exists - Check if the given volume exists + +## SYNOPSIS +**podman volume exists** *volume* + +## DESCRIPTION +**podman volume exists** checks if a volume exists. Podman will return an exit code +of `0` when the volume is found. A `1` will be returned otherwise. An exit code of +`125` indicates there was another issue. + + +## OPTIONS + +#### **--help**, **-h** + +Print usage statement + +## EXAMPLE + +Check if a volume called `myvol` exists (the volume does actually exist). +``` +$ podman volume exists myvol +$ echo $? +0 +$ +``` + +Check if an volume called `mysql` exists (the volume does not actually exist). +``` +$ podman volume exists mysql +$ echo $? +1 +$ +``` + +## SEE ALSO +podman(1), podman-volume-create(1), podman-volume-rm(1) + +## HISTORY +January 2021, Originally compiled by Paul Holzinger `<paul.holzinger@web.de>` diff --git a/docs/source/markdown/podman-volume.1.md b/docs/source/markdown/podman-volume.1.md index 288e57b82..5af5eb50e 100644 --- a/docs/source/markdown/podman-volume.1.md +++ b/docs/source/markdown/podman-volume.1.md @@ -14,6 +14,7 @@ podman volume is a set of subcommands that manage volumes. | Command | Man Page | Description | | ------- | ------------------------------------------------------ | ------------------------------------------------------------------------------ | | create | [podman-volume-create(1)](podman-volume-create.1.md) | Create a new volume. | +| exists | [podman-volume-exists(1)](podman-volume-exists.1.md) | Check if the given volume exists. | | inspect | [podman-volume-inspect(1)](podman-volume-inspect.1.md) | Get detailed information on one or more volumes. | | ls | [podman-volume-ls(1)](podman-volume-ls.1.md) | List all the available volumes. | | prune | [podman-volume-prune(1)](podman-volume-prune.1.md) | Remove all unused volumes. | diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 733fadc30..0bb8e387b 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -328,7 +328,7 @@ Currently the slirp4netns package is required to be installed to create a networ ### **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 `$HOME/.config/containers/storage.conf` file. +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. In rootless mode Podman will automatically use the fuse-overlafs program as the mount_program if installed, as long as the $HOME/.config/containers/storage.conf file was not previously created. If storage.conf exists in the homedir, add `mount_program = "/usr/bin/fuse-overlayfs"` under `[storage.options.overlay]` to enable this feature. 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 `$HOME/.config/containers/storage.conf` to have the `graphroot` option point to a directory stored on local (Non NFS) storage. diff --git a/docs/source/volume.rst b/docs/source/volume.rst index a966feafd..ce9ea2cbd 100644 --- a/docs/source/volume.rst +++ b/docs/source/volume.rst @@ -2,6 +2,8 @@ Volume ====== :doc:`create <markdown/podman-volume-create.1>` Create a new volume +:doc:`exists <markdown/podman-volume-exists.1>` Check if the given volume exists + :doc:`inspect <markdown/podman-volume-inspect.1>` Display detailed information on one or more volumes :doc:`ls <markdown/podman-volume-ls.1>` List volumes |