From 32c2cea0f9a7ebc31fe34c678a803cd5acb28c19 Mon Sep 17 00:00:00 2001 From: Daniel J Walsh Date: Sun, 14 May 2023 06:46:11 -0400 Subject: [PATCH] Remove future tense from man pages Remove all will, would, could, should and use present tense. Signed-off-by: Daniel J Walsh --- RELEASE_PROCESS.md | 2 +- docs/source/Introduction.rst | 4 +- docs/source/markdown/options/README.md | 12 +- docs/source/markdown/options/arch.md | 2 +- docs/source/markdown/options/cgroup-parent.md | 4 +- docs/source/markdown/options/cgroups.md | 6 +- docs/source/markdown/options/chrootdirs.md | 6 +- docs/source/markdown/options/cidfile.write.md | 2 +- docs/source/markdown/options/cpu-period.md | 4 +- docs/source/markdown/options/cpu-quota.md | 2 +- .../source/markdown/options/cpu-rt-runtime.md | 2 +- docs/source/markdown/options/cpu-shares.md | 6 +- docs/source/markdown/options/cpuset-mems.md | 2 +- docs/source/markdown/options/creds.md | 2 +- .../source/markdown/options/decryption-key.md | 2 +- docs/source/markdown/options/detach-keys.md | 2 +- docs/source/markdown/options/device.md | 6 +- docs/source/markdown/options/dns.md | 2 +- docs/source/markdown/options/env-merge.md | 2 +- docs/source/markdown/options/env.md | 2 +- docs/source/markdown/options/follow.md | 2 +- docs/source/markdown/options/gidmap.pod.md | 2 +- docs/source/markdown/options/health-cmd.md | 2 +- .../markdown/options/health-startup-cmd.md | 6 +- .../options/health-startup-retries.md | 3 +- .../options/health-startup-success.md | 4 +- .../markdown/options/hostname.container.md | 2 +- docs/source/markdown/options/http-proxy.md | 6 +- docs/source/markdown/options/ignore.md | 2 +- docs/source/markdown/options/image-volume.md | 2 +- docs/source/markdown/options/infra-command.md | 2 +- docs/source/markdown/options/infra-name.md | 2 +- docs/source/markdown/options/init.md | 2 +- docs/source/markdown/options/latest.md | 2 +- docs/source/markdown/options/log-driver.md | 2 +- docs/source/markdown/options/mac-address.md | 2 +- .../markdown/options/memory-reservation.md | 2 +- docs/source/markdown/options/memory-swap.md | 2 +- docs/source/markdown/options/memory.md | 2 +- .../source/markdown/options/name.container.md | 2 +- docs/source/markdown/options/network-alias.md | 2 +- docs/source/markdown/options/network.md | 16 +- docs/source/markdown/options/no-hosts.md | 4 +- docs/source/markdown/options/os.pull.md | 2 +- docs/source/markdown/options/pidfile.md | 4 +- docs/source/markdown/options/platform.md | 2 +- .../markdown/options/pod-id-file.container.md | 2 +- docs/source/markdown/options/pod.run.md | 4 +- docs/source/markdown/options/preserve-fds.md | 2 +- docs/source/markdown/options/publish-all.md | 6 +- docs/source/markdown/options/publish.md | 6 +- docs/source/markdown/options/pull.md | 4 +- docs/source/markdown/options/read-only.md | 5 +- docs/source/markdown/options/requires.md | 2 +- docs/source/markdown/options/restart.md | 4 +- docs/source/markdown/options/rootfs.md | 2 +- docs/source/markdown/options/sdnotify.md | 4 +- .../source/markdown/options/seccomp-policy.md | 2 +- docs/source/markdown/options/secret.md | 14 +- docs/source/markdown/options/security-opt.md | 2 +- docs/source/markdown/options/systemd.md | 2 +- docs/source/markdown/options/timeout.md | 2 +- docs/source/markdown/options/tls-verify.md | 6 +- docs/source/markdown/options/tty.md | 4 +- .../markdown/options/uidmap.container.md | 10 +- .../markdown/options/user-mode-networking.md | 10 +- docs/source/markdown/options/user.md | 4 +- .../markdown/options/userns.container.md | 10 +- docs/source/markdown/options/userns.pod.md | 4 +- docs/source/markdown/options/volume.md | 54 +++-- .../markdown/podman-auto-update.1.md.in | 8 +- docs/source/markdown/podman-build.1.md.in | 194 +++++++++--------- docs/source/markdown/podman-commit.1.md | 6 +- docs/source/markdown/podman-completion.1.md | 2 +- .../markdown/podman-container-checkpoint.1.md | 13 +- .../markdown/podman-container-cleanup.1.md | 7 +- .../markdown/podman-container-clone.1.md.in | 8 +- .../markdown/podman-container-diff.1.md.in | 2 +- .../markdown/podman-container-exists.1.md | 4 +- .../markdown/podman-container-inspect.1.md.in | 4 +- .../markdown/podman-container-restore.1.md | 17 +- .../podman-container-runlabel.1.md.in | 14 +- docs/source/markdown/podman-cp.1.md | 2 +- docs/source/markdown/podman-create.1.md.in | 28 +-- docs/source/markdown/podman-diff.1.md.in | 2 +- docs/source/markdown/podman-events.1.md | 16 +- docs/source/markdown/podman-exec.1.md.in | 2 +- .../source/markdown/podman-generate-spec.1.md | 2 +- .../markdown/podman-generate-systemd.1.md | 26 +-- docs/source/markdown/podman-generate.1.md | 2 +- docs/source/markdown/podman-image-diff.1.md | 2 +- docs/source/markdown/podman-image-exists.1.md | 4 +- .../source/markdown/podman-image-inspect.1.md | 3 +- docs/source/markdown/podman-image-mount.1.md | 2 +- .../source/markdown/podman-image-sign.1.md.in | 12 +- .../markdown/podman-image-trust.1.md.in | 13 +- .../source/markdown/podman-image-unmount.1.md | 5 +- docs/source/markdown/podman-init.1.md.in | 2 +- docs/source/markdown/podman-inspect.1.md.in | 6 +- docs/source/markdown/podman-kill.1.md.in | 2 +- docs/source/markdown/podman-kube-apply.1.md | 6 +- docs/source/markdown/podman-kube-down.1.md | 6 +- .../source/markdown/podman-kube-generate.1.md | 18 +- docs/source/markdown/podman-kube-play.1.md.in | 32 +-- docs/source/markdown/podman-kube.1.md | 4 +- docs/source/markdown/podman-login.1.md.in | 12 +- docs/source/markdown/podman-logout.1.md.in | 2 +- .../markdown/podman-machine-init.1.md.in | 14 +- docs/source/markdown/podman-machine-rm.1.md | 2 +- .../markdown/podman-machine-set.1.md.in | 6 +- docs/source/markdown/podman-machine-ssh.1.md | 2 +- .../source/markdown/podman-machine-start.1.md | 2 +- .../markdown/podman-manifest-add.1.md.in | 8 +- .../markdown/podman-manifest-create.1.md.in | 4 +- .../markdown/podman-manifest-exists.1.md | 5 +- .../markdown/podman-manifest-push.1.md.in | 2 +- docs/source/markdown/podman-manifest.1.md | 5 +- docs/source/markdown/podman-mount.1.md.in | 4 +- .../markdown/podman-network-connect.1.md | 2 +- .../markdown/podman-network-create.1.md | 25 ++- .../markdown/podman-network-disconnect.1.md | 4 +- .../markdown/podman-network-exists.1.md | 4 +- .../source/markdown/podman-network-ls.1.md.in | 2 +- .../source/markdown/podman-network-prune.1.md | 2 +- docs/source/markdown/podman-network-rm.1.md | 4 +- docs/source/markdown/podman-network.1.md | 10 +- docs/source/markdown/podman-pod-clone.1.md.in | 2 +- .../source/markdown/podman-pod-create.1.md.in | 18 +- docs/source/markdown/podman-pod-exists.1.md | 4 +- docs/source/markdown/podman-pod-kill.1.md.in | 2 +- docs/source/markdown/podman-pod-logs.1.md.in | 4 +- docs/source/markdown/podman-pod-restart.1.md | 8 +- docs/source/markdown/podman-pod-rm.1.md.in | 4 +- docs/source/markdown/podman-ps.1.md | 6 +- docs/source/markdown/podman-pull.1.md.in | 10 +- docs/source/markdown/podman-push.1.md.in | 2 +- docs/source/markdown/podman-remote.1.md | 4 +- docs/source/markdown/podman-rename.1.md | 2 +- docs/source/markdown/podman-restart.1.md.in | 3 +- docs/source/markdown/podman-rm.1.md.in | 10 +- docs/source/markdown/podman-rmi.1.md | 4 +- docs/source/markdown/podman-run.1.md.in | 42 ++-- docs/source/markdown/podman-save.1.md.in | 4 +- docs/source/markdown/podman-search.1.md.in | 12 +- .../source/markdown/podman-secret-create.1.md | 4 +- .../source/markdown/podman-secret-exists.1.md | 4 +- .../markdown/podman-secret-inspect.1.md | 2 +- docs/source/markdown/podman-secret-rm.1.md | 6 +- docs/source/markdown/podman-stats.1.md.in | 4 +- .../podman-system-connection-add.1.md | 2 +- .../markdown/podman-system-connection.1.md | 2 +- .../markdown/podman-system-migrate.1.md | 2 +- docs/source/markdown/podman-system-prune.1.md | 4 +- .../markdown/podman-system-renumber.1.md | 2 +- .../markdown/podman-system-service.1.md | 12 +- docs/source/markdown/podman-systemd.unit.5.md | 73 ++++--- docs/source/markdown/podman-tag.1.md | 2 +- docs/source/markdown/podman-top.1.md.in | 4 +- docs/source/markdown/podman-unmount.1.md.in | 5 +- docs/source/markdown/podman-untag.1.md | 2 +- docs/source/markdown/podman-update.1.md.in | 4 +- .../source/markdown/podman-volume-create.1.md | 6 +- .../source/markdown/podman-volume-exists.1.md | 4 +- .../source/markdown/podman-volume-import.1.md | 4 +- docs/source/markdown/podman-volume-mount.1.md | 2 +- docs/source/markdown/podman-volume-prune.1.md | 4 +- docs/source/markdown/podman-volume-rm.1.md | 6 +- docs/source/markdown/podman-wait.1.md.in | 2 +- docs/source/markdown/podman.1.md | 30 +-- 169 files changed, 619 insertions(+), 629 deletions(-) diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md index 500cd437b7..ff74ce8132 100644 --- a/RELEASE_PROCESS.md +++ b/RELEASE_PROCESS.md @@ -22,7 +22,7 @@ development efforts occur on the *main* branch. Branches with a be dedicated to writing release notes. * For a **minor** or **patch** release, you have 2-4 hours of time available (minimum depends largely on the speed/reliability of automated testing) -* You will annouce the release on the proper platforms +* You will announce the release on the proper platforms (i.e. Podman blog, Twitter, Mastodon Podman and Podman-Desktop mailing lists) # Releases diff --git a/docs/source/Introduction.rst b/docs/source/Introduction.rst index 5c8713d27f..833baada67 100644 --- a/docs/source/Introduction.rst +++ b/docs/source/Introduction.rst @@ -30,7 +30,7 @@ You can poke around in the busybox container for a while, but you’ll quickly f There’s an old saying that “nobody runs an operating system just to run an operating system” and the same is true with containers. It’s the workload running on top of an operating system or in a container that’s interesting and valuable. -Sometimes we can find a publicly available container image for the exact workload we’re looking for and it will already be packaged exactly how we want. But, more often than not, there’s something that we want to add, remove, or customize. It could be as simple as a configuration setting for security or performance, or as complex as adding a complex workload. Either way, containers make it fairly easy to make the changes we need. +Sometimes we can find a publicly available container image for the exact workload we’re looking for and it will already be packaged exactly how we want. But, more often than not, there’s something that we want to add, remove, or customize. It can be as simple as a configuration setting for security or performance, or as complex as adding a complex workload. Either way, containers make it fairly easy to make the changes we need. 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 a new container image and can easily be shared with others publicly using tools like GitHub. @@ -49,7 +49,7 @@ Output::

Thank you for using nginx.

... -Building new images is great, but sharing our work with others let’s them review our work, critique how we built them, and offer improved versions. Our newly built Nginx image could be published at quay.io or docker.io to share it with the world. Everything needed to run the Nginx application is provided in the container image. Others could easily pull it down and use it, or make improvements to it. +Building new images is great, but sharing our work with others lets them review our work, critique how we built them, and offer improved versions. Our newly built Nginx image can be published at quay.io or docker.io to share it with the world. Everything needed to run the Nginx application is provided in the container image. Others can easily pull it down and use it, or make improvements to it. Standardizing on container images and `Container Registries`_ enable a new level of collaboration through simple consumption. This simple consumption model is possible because every major Container Engine and Registry Server uses the Open Containers Initiative (OCI_) format. This allows users to find, run, build, share and deploy containers anywhere they want. Podman and other `Container Engines`_ like CRI-O, Docker, or containerd can create and consume container images from docker.io, quay.io, an on premise registry or even one provided by a cloud provider. The OCI image format facilitates this ecosystem through a single standard. diff --git a/docs/source/markdown/options/README.md b/docs/source/markdown/options/README.md index 783f7bcf95..bc3f5bfccb 100644 --- a/docs/source/markdown/options/README.md +++ b/docs/source/markdown/options/README.md @@ -16,12 +16,12 @@ The files here are included in `podman-*.md.in` files using the `@@option` mechanism: ``` -@@option foo ! will include options/foo.md +@@option foo ! includes options/foo.md ``` The tool that does this is `hack/markdown-preprocess`. It is a python script because it needs to run on `readthedocs.io`. From a given `.md.in` -file, this script will create a `.md` file that can then be read by +file, this script creates a `.md` file that can then be read by `go-md2man`, `sphinx`, anything that groks markdown. This runs as part of `make docs`. @@ -32,11 +32,11 @@ Some options are almost identical except for 'pod' vs 'container' differences. For those, use `<>`. Order is immaterial: the important thing is the presence of the string "`pod`" in one half but not the other. The correct string -will be chosen based on the filename: if the file contains `-pod`, +is chosen based on the filename: if the file contains `-pod`, such as `podman-pod-create`, the string with `pod` (case-insensitive) -in it will be chosen. +in it is chosen. -The string `<>` will be replaced with the podman subcommand +The string `<>` is replaced with the podman subcommand as determined from the filename, e.g., `create` for `podman-create.1.md.in`. This allows the shared use of examples in the option file: ``` @@ -54,7 +54,7 @@ back-ticks in the front and the end of the line. For instance: \`\`\`Some man page text\`\`\` -This is currently not allowed and will cause a corruption of the +This is currently not allowed and causes a corruption of the compiled man page. Instead, put the three back-ticks on separate lines like: diff --git a/docs/source/markdown/options/arch.md b/docs/source/markdown/options/arch.md index 535bc87e11..33cee10299 100644 --- a/docs/source/markdown/options/arch.md +++ b/docs/source/markdown/options/arch.md @@ -4,4 +4,4 @@ ####> are applicable to all of those. #### **--arch**=*ARCH* Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. -Unless overridden, subsequent lookups of the same image in the local storage will match this architecture, regardless of the host. +Unless overridden, subsequent lookups of the same image in the local storage matches this architecture, regardless of the host. diff --git a/docs/source/markdown/options/cgroup-parent.md b/docs/source/markdown/options/cgroup-parent.md index b9eecaa98f..ce9f28fdfb 100644 --- a/docs/source/markdown/options/cgroup-parent.md +++ b/docs/source/markdown/options/cgroup-parent.md @@ -4,6 +4,6 @@ ####> are applicable to all of those. #### **--cgroup-parent**=*path* -Path to cgroups under which the cgroup for the <> will be created. If the +Path to cgroups under which the cgroup for the <> is created. If the path is not absolute, the path is considered to be relative to the cgroups path -of the init process. Cgroups will be created if they do not already exist. +of the init process. Cgroups are created if they do not already exist. diff --git a/docs/source/markdown/options/cgroups.md b/docs/source/markdown/options/cgroups.md index 37f1c1a8c7..a5e16e5783 100644 --- a/docs/source/markdown/options/cgroups.md +++ b/docs/source/markdown/options/cgroups.md @@ -4,11 +4,11 @@ ####> are applicable to all of those. #### **--cgroups**=*how* -Determines whether the container will create CGroups. +Determines whether the container creates CGroups. Default is **enabled**. -The **enabled** option will create a new cgroup under the cgroup-parent. -The **disabled** option will force the container to not create CGroups, and thus conflicts with CGroup options (**--cgroupns** and **--cgroup-parent**). +The **enabled** option creates a new cgroup under the cgroup-parent. +The **disabled** option forces the container to not create CGroups, and thus conflicts with CGroup options (**--cgroupns** and **--cgroup-parent**). The **no-conmon** option disables a new CGroup only for the **conmon** process. The **split** option splits the current CGroup in two sub-cgroups: one for conmon and one for the container payload. It is not possible to set **--cgroup-parent** with **split**. diff --git a/docs/source/markdown/options/chrootdirs.md b/docs/source/markdown/options/chrootdirs.md index ef0fbe3033..a1920063c6 100644 --- a/docs/source/markdown/options/chrootdirs.md +++ b/docs/source/markdown/options/chrootdirs.md @@ -4,6 +4,6 @@ ####> are applicable to all of those. #### **--chrootdirs**=*path* -Path to a directory inside the container that should be treated as a `chroot` directory. -Any Podman managed file (e.g., /etc/resolv.conf, /etc/hosts, etc/hostname) that is mounted into the root directory will be mounted into that location as well. -Multiple directories should be separated with a comma. +Path to a directory inside the container that is treated as a `chroot` directory. +Any Podman managed file (e.g., /etc/resolv.conf, /etc/hosts, etc/hostname) that is mounted into the root directory is mounted into that location as well. +Multiple directories are separated with a comma. diff --git a/docs/source/markdown/options/cidfile.write.md b/docs/source/markdown/options/cidfile.write.md index a767d01c73..846f3b0178 100644 --- a/docs/source/markdown/options/cidfile.write.md +++ b/docs/source/markdown/options/cidfile.write.md @@ -4,4 +4,4 @@ ####> are applicable to all of those. #### **--cidfile**=*file* -Write the container ID to *file*. The file will be removed along with the container. +Write the container ID to *file*. The file is removed along with the container. diff --git a/docs/source/markdown/options/cpu-period.md b/docs/source/markdown/options/cpu-period.md index e90577a566..6177adf612 100644 --- a/docs/source/markdown/options/cpu-period.md +++ b/docs/source/markdown/options/cpu-period.md @@ -5,8 +5,8 @@ #### **--cpu-period**=*limit* Set the CPU period for the Completely Fair Scheduler (CFS), which is a -duration in microseconds. Once the container's CPU quota is used up, it will -not be scheduled to run until the current period ends. Defaults to 100000 +duration in microseconds. Once the container's CPU quota is used up, it will not +be scheduled to run until the current period ends. Defaults to 100000 microseconds. On some systems, changing the resource limits may not be allowed for non-root diff --git a/docs/source/markdown/options/cpu-quota.md b/docs/source/markdown/options/cpu-quota.md index 8551d30695..4875f73625 100644 --- a/docs/source/markdown/options/cpu-quota.md +++ b/docs/source/markdown/options/cpu-quota.md @@ -8,7 +8,7 @@ Limit the CPU Completely Fair Scheduler (CFS) quota. Limit the container's CPU usage. By default, containers run with the full CPU resource. The limit is a number in microseconds. If a number is provided, -the container will be allowed to use that much CPU time until the CPU period +the container is allowed to use that much CPU time until the CPU period ends (controllable via **--cpu-period**). On some systems, changing the resource limits may not be allowed for non-root diff --git a/docs/source/markdown/options/cpu-rt-runtime.md b/docs/source/markdown/options/cpu-rt-runtime.md index b40ac351f6..9272785868 100644 --- a/docs/source/markdown/options/cpu-rt-runtime.md +++ b/docs/source/markdown/options/cpu-rt-runtime.md @@ -7,7 +7,7 @@ Limit the CPU real-time runtime in microseconds. Limit the containers Real Time CPU usage. This option tells the kernel to limit the amount of time in a given CPU period Real Time tasks may consume. Ex: -Period of 1,000,000us and Runtime of 950,000us means that this container could consume 95% of available CPU and leave the remaining 5% to normal priority tasks. +Period of 1,000,000us and Runtime of 950,000us means that this container can consume 95% of available CPU and leave the remaining 5% to normal priority tasks. The sum of all runtimes across containers cannot exceed the amount allotted to the parent cgroup. diff --git a/docs/source/markdown/options/cpu-shares.md b/docs/source/markdown/options/cpu-shares.md index bdf0dfc64b..e3bec007ee 100644 --- a/docs/source/markdown/options/cpu-shares.md +++ b/docs/source/markdown/options/cpu-shares.md @@ -11,14 +11,14 @@ proportion can be modified by changing the container's CPU share weighting relative to the combined weight of all the running containers. Default weight is **1024**. -The proportion will only apply when CPU-intensive processes are running. +The proportion only applies when CPU-intensive processes are running. When tasks in one container are idle, other containers can use the -left-over CPU time. The actual amount of CPU time will vary depending on +left-over CPU time. The actual amount of CPU time varies depending on the number of containers running on the system. For example, consider three containers, one has a cpu-share of 1024 and two others have a cpu-share setting of 512. When processes in all three -containers attempt to use 100% of CPU, the first container would receive +containers attempt to use 100% of CPU, the first container receives 50% of the total CPU time. If a fourth container is added with a cpu-share of 1024, the first container only gets 33% of the CPU. The remaining containers receive 16.5%, 16.5% and 33% of the CPU. diff --git a/docs/source/markdown/options/cpuset-mems.md b/docs/source/markdown/options/cpuset-mems.md index 7796341662..751a1a0219 100644 --- a/docs/source/markdown/options/cpuset-mems.md +++ b/docs/source/markdown/options/cpuset-mems.md @@ -8,7 +8,7 @@ Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. If there are four memory nodes on the system (0-3), use **--cpuset-mems=0,1** -then processes in the container will only use memory from the first +then processes in the container only uses memory from the first two memory nodes. On some systems, changing the resource limits may not be allowed for non-root diff --git a/docs/source/markdown/options/creds.md b/docs/source/markdown/options/creds.md index d88cf4a189..313d0e75ff 100644 --- a/docs/source/markdown/options/creds.md +++ b/docs/source/markdown/options/creds.md @@ -5,7 +5,7 @@ #### **--creds**=*[username[:password]]* 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 +If one or both values are not supplied, a command line prompt appears and the value can be entered. The password is entered without echo. Note that the specified credentials are only used to authenticate against diff --git a/docs/source/markdown/options/decryption-key.md b/docs/source/markdown/options/decryption-key.md index b804ba7f7b..0fe8527a87 100644 --- a/docs/source/markdown/options/decryption-key.md +++ b/docs/source/markdown/options/decryption-key.md @@ -4,4 +4,4 @@ ####> are applicable to all of those. #### **--decryption-key**=*key[:passphrase]* -The [key[:passphrase]] to be used for decryption of images. Key can point to keys and/or certificates. Decryption will be tried with all keys. If the key is protected by a passphrase, it is required to be passed in the argument and omitted otherwise. +The [key[:passphrase]] to be used for decryption of images. Key can point to keys and/or certificates. Decryption is tried with all keys. If the key is protected by a passphrase, it is required to be passed in the argument and omitted otherwise. diff --git a/docs/source/markdown/options/detach-keys.md b/docs/source/markdown/options/detach-keys.md index 3f2b0fcc5f..7a4ab91114 100644 --- a/docs/source/markdown/options/detach-keys.md +++ b/docs/source/markdown/options/detach-keys.md @@ -4,6 +4,6 @@ ####> are applicable to all of those. #### **--detach-keys**=*sequence* -Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-` characters where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will disable this feature. The default is *ctrl-p,ctrl-q*. +Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-` characters where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" disables this feature. The default is *ctrl-p,ctrl-q*. This option can also be set in **containers.conf**(5) file. diff --git a/docs/source/markdown/options/device.md b/docs/source/markdown/options/device.md index 4f17997793..3209f3e0ae 100644 --- a/docs/source/markdown/options/device.md +++ b/docs/source/markdown/options/device.md @@ -10,11 +10,11 @@ can be used to specify device permissions by combining Example: **--device=/dev/sdc:/dev/xvdc:rwm**. -Note: if *host-device* is a symbolic link then it will be resolved first. -The <> will only store the major and minor numbers of the host device. +Note: if *host-device* is a symbolic link then it is resolved first. +The <> only stores the major and minor numbers of the host device. Podman may load kernel modules required for using the specified -device. The devices that Podman will load modules for when necessary are: +device. The devices that Podman loads modules for when necessary are: /dev/fuse. In rootless mode, the new device is bind mounted in the container from the host diff --git a/docs/source/markdown/options/dns.md b/docs/source/markdown/options/dns.md index 1da106a115..1d016a3b53 100644 --- a/docs/source/markdown/options/dns.md +++ b/docs/source/markdown/options/dns.md @@ -12,4 +12,4 @@ host DNS configuration is invalid for the container (e.g., **127.0.0.1**). When is the case the **--dns** flag is necessary for every run. The special value **none** can be specified to disable creation of _/etc/resolv.conf_ in the container by Podman. -The _/etc/resolv.conf_ file in the image will be used without changes. +The _/etc/resolv.conf_ file in the image is used without changes. diff --git a/docs/source/markdown/options/env-merge.md b/docs/source/markdown/options/env-merge.md index 2b80233a1a..4bc1c388da 100644 --- a/docs/source/markdown/options/env-merge.md +++ b/docs/source/markdown/options/env-merge.md @@ -6,4 +6,4 @@ Preprocess default environment variables for the containers. For example if image contains environment variable `hello=world` user can preprocess -it using `--env-merge hello=${hello}-some` so new value will be `hello=world-some`. +it using `--env-merge hello=${hello}-some` so new value is `hello=world-some`. diff --git a/docs/source/markdown/options/env.md b/docs/source/markdown/options/env.md index cd95c658e8..19bfc42ae4 100644 --- a/docs/source/markdown/options/env.md +++ b/docs/source/markdown/options/env.md @@ -6,4 +6,4 @@ Set environment variables. -This option allows arbitrary environment variables that are available for the process to be launched inside of the container. If an environment variable is specified without a value, Podman will check the host environment for a value and set the variable only if it is set on the host. As a special case, if an environment variable ending in __*__ is specified without a value, Podman will search the host environment for variables starting with the prefix and will add those variables to the container. +This option allows arbitrary environment variables that are available for the process to be launched inside of the container. If an environment variable is specified without a value, Podman checks the host environment for a value and set the variable only if it is set on the host. As a special case, if an environment variable ending in __*__ is specified without a value, Podman searches the host environment for variables starting with the prefix and adds those variables to the container. diff --git a/docs/source/markdown/options/follow.md b/docs/source/markdown/options/follow.md index 159840d2e5..6fd7c6b865 100644 --- a/docs/source/markdown/options/follow.md +++ b/docs/source/markdown/options/follow.md @@ -8,4 +8,4 @@ Follow log output. Default is false. Note: When following a <> which is removed by `podman <> rm` or removed on exit (`podman run --rm ...`), there is a chance that the log -file will be removed before `podman<< pod|>> logs` reads the final content. +file is removed before `podman<< pod|>> logs` reads the final content. diff --git a/docs/source/markdown/options/gidmap.pod.md b/docs/source/markdown/options/gidmap.pod.md index 9244833c29..3d938e5223 100644 --- a/docs/source/markdown/options/gidmap.pod.md +++ b/docs/source/markdown/options/gidmap.pod.md @@ -4,5 +4,5 @@ ####> are applicable to all of those. #### **--gidmap**=*pod_gid:host_gid:amount* -GID map for the user namespace. Using this flag will run all containers in the pod with user namespace enabled. +GID map for the user namespace. Using this flag runs all containers in the pod with user namespace enabled. It conflicts with the **--userns** and **--subgidname** flags. diff --git a/docs/source/markdown/options/health-cmd.md b/docs/source/markdown/options/health-cmd.md index 01c4ef92b1..a135a2c435 100644 --- a/docs/source/markdown/options/health-cmd.md +++ b/docs/source/markdown/options/health-cmd.md @@ -8,5 +8,5 @@ Set or alter a healthcheck command for a container. The command is a command to container that determines the container health. The command is required for other healthcheck options to be applied. A value of **none** disables existing healthchecks. -Multiple options can be passed in the form of a JSON array; otherwise, the command will be interpreted +Multiple options can be passed in the form of a JSON array; otherwise, the command is interpreted as an argument to **/bin/sh -c**. diff --git a/docs/source/markdown/options/health-startup-cmd.md b/docs/source/markdown/options/health-startup-cmd.md index 84cbb22215..b3792a584f 100644 --- a/docs/source/markdown/options/health-startup-cmd.md +++ b/docs/source/markdown/options/health-startup-cmd.md @@ -4,8 +4,8 @@ ####> are applicable to all of those. #### **--health-startup-cmd**=*"command"* | *'["command", "arg1", ...]'* -Set a startup healthcheck command for a container. This command will be executed inside the container and is used to gate the regular -healthcheck. When the startup command succeeds, the regular healthcheck will begin and the startup healthcheck will cease. Optionally, -if the command fails for a set number of attempts, the container will be restarted. A startup healthcheck can be used to ensure that +Set a startup healthcheck command for a container. This command is executed inside the container and is used to gate the regular +healthcheck. When the startup command succeeds, the regular healthcheck begins and the startup healthcheck ceases. Optionally, +if the command fails for a set number of attempts, the container is restarted. A startup healthcheck can be used to ensure that containers with an extended startup period are not marked as unhealthy until they are fully started. Startup healthchecks can only be used when a regular healthcheck (from the container's image or the **--health-cmd** option) is also set. diff --git a/docs/source/markdown/options/health-startup-retries.md b/docs/source/markdown/options/health-startup-retries.md index dd1b900a36..db213dcf97 100644 --- a/docs/source/markdown/options/health-startup-retries.md +++ b/docs/source/markdown/options/health-startup-retries.md @@ -4,5 +4,4 @@ ####> are applicable to all of those. #### **--health-startup-retries**=*retries* -The number of attempts allowed before the startup healthcheck restarts the container. If set to **0**, the container will never be -restarted. The default is **0**. +The number of attempts allowed before the startup healthcheck restarts the container. If set to **0**, the container is never restarted. The default is **0**. diff --git a/docs/source/markdown/options/health-startup-success.md b/docs/source/markdown/options/health-startup-success.md index 2c1f761e71..c8c85e1bfb 100644 --- a/docs/source/markdown/options/health-startup-success.md +++ b/docs/source/markdown/options/health-startup-success.md @@ -4,5 +4,5 @@ ####> are applicable to all of those. #### **--health-startup-success**=*retries* -The number of successful runs required before the startup healthcheck will succeed and the regular healthcheck will begin. A value -of **0** means that any success will begin the regular healthcheck. The default is **0**. +The number of successful runs required before the startup healthcheck succeeds and the regular healthcheck begins. A value +of **0** means that any success begins the regular healthcheck. The default is **0**. diff --git a/docs/source/markdown/options/hostname.container.md b/docs/source/markdown/options/hostname.container.md index 6b89f1b6a1..4177a41c4b 100644 --- a/docs/source/markdown/options/hostname.container.md +++ b/docs/source/markdown/options/hostname.container.md @@ -6,4 +6,4 @@ Container host name -Sets the container host name that is available inside the container. Can only be used with a private UTS namespace `--uts=private` (default). If `--pod` is specified and the pod shares the UTS namespace (default) the pod's hostname will be used. +Sets the container host name that is available inside the container. Can only be used with a private UTS namespace `--uts=private` (default). If `--pod` is specified and the pod shares the UTS namespace (default) the pod's hostname is used. diff --git a/docs/source/markdown/options/http-proxy.md b/docs/source/markdown/options/http-proxy.md index d45ccbd3b6..8bfbbcdca1 100644 --- a/docs/source/markdown/options/http-proxy.md +++ b/docs/source/markdown/options/http-proxy.md @@ -9,12 +9,12 @@ for the Podman process. This can be disabled by setting the value to **false**. The environment variables passed in include **http_proxy**, **https_proxy**, **ftp_proxy**, **no_proxy**, and also the upper case versions of those. This option is only needed when the host system must use a proxy but -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 +the container does not use any proxy. Proxy environment variables specified +for the container in any other way overrides the values that 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.) -When used with the remote client it will use the proxy environment variables +When used with the remote client it uses the proxy environment variables that are set on the server process. Defaults to **true**. diff --git a/docs/source/markdown/options/ignore.md b/docs/source/markdown/options/ignore.md index c5fa3dfcca..505984233f 100644 --- a/docs/source/markdown/options/ignore.md +++ b/docs/source/markdown/options/ignore.md @@ -5,5 +5,5 @@ #### **--ignore**, **-i** Ignore errors when specified <> are not in the container store. A user -might have decided to manually remove a <> which would lead to a failure +might have decided to manually remove a <> which leads to a failure during the ExecStop directive of a systemd service referencing that <>. diff --git a/docs/source/markdown/options/image-volume.md b/docs/source/markdown/options/image-volume.md index d842199482..878461ac68 100644 --- a/docs/source/markdown/options/image-volume.md +++ b/docs/source/markdown/options/image-volume.md @@ -6,7 +6,7 @@ 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. +- **bind**: An anonymous named volume is 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. diff --git a/docs/source/markdown/options/infra-command.md b/docs/source/markdown/options/infra-command.md index dc9a9546de..fd42557b8f 100644 --- a/docs/source/markdown/options/infra-command.md +++ b/docs/source/markdown/options/infra-command.md @@ -4,4 +4,4 @@ ####> are applicable to all of those. #### **--infra-command**=*command* -The command that will be run to start the infra container. Default: "/pause". +The command that is run to start the infra container. Default: "/pause". diff --git a/docs/source/markdown/options/infra-name.md b/docs/source/markdown/options/infra-name.md index ec389b007c..0a07f658e2 100644 --- a/docs/source/markdown/options/infra-name.md +++ b/docs/source/markdown/options/infra-name.md @@ -4,4 +4,4 @@ ####> are applicable to all of those. #### **--infra-name**=*name* -The name that will be used for the pod's infra container. +The name that is used for the pod's infra container. diff --git a/docs/source/markdown/options/init.md b/docs/source/markdown/options/init.md index bc47ca0f9f..5a9fb2f29e 100644 --- a/docs/source/markdown/options/init.md +++ b/docs/source/markdown/options/init.md @@ -6,4 +6,4 @@ Run an init inside the container that forwards signals and reaps processes. The container-init binary is mounted at `/run/podman-init`. -Mounting over `/run` will hence break container execution. +Mounting over `/run` breaks container execution. diff --git a/docs/source/markdown/options/latest.md b/docs/source/markdown/options/latest.md index 3be6e2f4e0..34ba9072c0 100644 --- a/docs/source/markdown/options/latest.md +++ b/docs/source/markdown/options/latest.md @@ -5,6 +5,6 @@ #### **--latest**, **-l** Instead of providing the <> name or ID, use the last created <>. -Note: the last started <> could be from other users of Podman on the host machine. +Note: the last started <> can be from other users of Podman on the host machine. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) diff --git a/docs/source/markdown/options/log-driver.md b/docs/source/markdown/options/log-driver.md index da697fe0d5..754a97c022 100644 --- a/docs/source/markdown/options/log-driver.md +++ b/docs/source/markdown/options/log-driver.md @@ -6,7 +6,7 @@ Logging driver for the container. Currently available options are **k8s-file**, **journald**, **none** and **passthrough**, with **json-file** aliased to **k8s-file** for scripting compatibility. (Default **journald**). -The podman info command below will display the default log-driver for the system. +The podman info command below displays the default log-driver for the system. ``` $ podman info --format '{{ .Host.LogDriver }}' journald diff --git a/docs/source/markdown/options/mac-address.md b/docs/source/markdown/options/mac-address.md index eb636d2af7..a9f20df0d1 100644 --- a/docs/source/markdown/options/mac-address.md +++ b/docs/source/markdown/options/mac-address.md @@ -9,7 +9,7 @@ This option can only be used if the <> is joined to only a single and if the <> is not joining another container's network namespace via **--network=container:_id_**. 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 +The IPv6 link-local address is based on the device's MAC address according to RFC4862. To specify multiple static MAC addresses per <>, set multiple networks using the **--network** option with a static MAC address specified for each using the `mac` mode for that option. diff --git a/docs/source/markdown/options/memory-reservation.md b/docs/source/markdown/options/memory-reservation.md index b7022807c7..849f9c1d6a 100644 --- a/docs/source/markdown/options/memory-reservation.md +++ b/docs/source/markdown/options/memory-reservation.md @@ -9,7 +9,7 @@ Memory soft limit. A _unit_ can be **b** (bytes), **k** (kibibytes), **m** (mebi After setting memory reservation, when the system detects memory contention or low memory, containers are forced to restrict their consumption to their reservation. So always set the value below **--memory**, otherwise the -hard limit will take precedence. By default, memory reservation will be the same +hard limit takes precedence. By default, memory reservation is the same as memory limit. This option is not supported on cgroups V1 rootless systems. diff --git a/docs/source/markdown/options/memory-swap.md b/docs/source/markdown/options/memory-swap.md index bbaf3b5515..ecfb5c96f8 100644 --- a/docs/source/markdown/options/memory-swap.md +++ b/docs/source/markdown/options/memory-swap.md @@ -8,7 +8,7 @@ A limit value equal to memory plus swap. A _unit_ can be **b** (bytes), **k** (kibibytes), **m** (mebibytes), or **g** (gibibytes). Must be used with the **-m** (**--memory**) flag. -The argument value should always be larger than that of +The argument value must be larger than that of **-m** (**--memory**) By default, it is set to double the value of **--memory**. diff --git a/docs/source/markdown/options/memory.md b/docs/source/markdown/options/memory.md index 06f2da1bc1..3d1a4b7762 100644 --- a/docs/source/markdown/options/memory.md +++ b/docs/source/markdown/options/memory.md @@ -10,6 +10,6 @@ Allows the memory available to a container to be constrained. If the host supports swap memory, then the **-m** memory setting can be larger than physical RAM. If a limit of 0 is specified (not using **-m**), the container's memory is not limited. The actual limit may be rounded up to a multiple of the operating -system's page size (the value would be very large, that's millions of trillions). +system's page size (the value is very large, that's millions of trillions). This option is not supported on cgroups V1 rootless systems. diff --git a/docs/source/markdown/options/name.container.md b/docs/source/markdown/options/name.container.md index 1caa8aaf9c..8f06e8d016 100644 --- a/docs/source/markdown/options/name.container.md +++ b/docs/source/markdown/options/name.container.md @@ -13,6 +13,6 @@ The operator can identify a container in three ways: - Name (“jonah”). Podman generates a UUID for each container, and if a name is not assigned -to the container with **--name** then it will generate a random +to the container with **--name** then it generates a random string name. The name can be useful as a more human-friendly way to identify containers. This works for both background and foreground containers. diff --git a/docs/source/markdown/options/network-alias.md b/docs/source/markdown/options/network-alias.md index 066c6dc927..3c0ed9c9db 100644 --- a/docs/source/markdown/options/network-alias.md +++ b/docs/source/markdown/options/network-alias.md @@ -8,5 +8,5 @@ Add a network-scoped alias for the <>, setting the alias for all name only for a specific network, use the alias option as described under the **--network** option. If the network has DNS enabled (`podman network inspect -f {{.DNSEnabled}} `), these aliases can be used for name resolution on the given network. This option can be specified multiple times. -NOTE: When using CNI a <> will only have access to aliases on the first network that it joins. This limitation does +NOTE: When using CNI a <> only has access to aliases on the first network that it joins. This limitation does not exist with netavark/aardvark-dns. diff --git a/docs/source/markdown/options/network.md b/docs/source/markdown/options/network.md index bc22b41f61..44dd26cc3c 100644 --- a/docs/source/markdown/options/network.md +++ b/docs/source/markdown/options/network.md @@ -20,18 +20,18 @@ Valid _mode_ values are: - \[:OPTIONS,...]: Connect to a user-defined network; this is the network name or ID from a network created by **[podman network create](podman-network-create.1.md)**. Using the network name implies the bridge network mode. It is possible to specify the same options described under the bridge mode above. Use the **--network** option multiple times to specify additional networks. - **none**: Create a network namespace for the container but do not configure network interfaces for it, thus the container has no network connectivity. - **container:**_id_: Reuse another container's network stack. -- **host**: Do not create a network namespace, the container will use the host's network. Note: The host mode gives the container full access to local system services such as D-bus and is therefore considered insecure. +- **host**: Do not create a network namespace, the container uses the host's network. Note: The host mode gives the container full access to local system services such as D-bus and is therefore considered insecure. - **ns:**_path_: Path to a network namespace to join. -- **private**: Create a new namespace for the container. This will use the **bridge** mode for rootful containers and **slirp4netns** for rootless ones. +- **private**: Create a new namespace for the container. This uses the **bridge** mode for rootful containers and **slirp4netns** for rootless ones. - **slirp4netns[:OPTIONS,...]**: use **slirp4netns**(1) to create a user network stack. This is the default for rootless containers. It is possible to specify these additional options, they can also be set with `network_cmd_options` in containers.conf: - **allow_host_loopback=true|false**: Allow slirp4netns to reach the host loopback IP (default is 10.0.2.2 or the second IP from slirp4netns cidr subnet when changed, see the cidr option below). The default is false. - **mtu=MTU**: Specify the MTU to use for this network. (Default is `65520`). - **cidr=CIDR**: Specify ip range to use for this network. (Default is `10.0.2.0/24`). - **enable_ipv6=true|false**: Enable IPv6. Default is true. (Required for `outbound_addr6`). - - **outbound_addr=INTERFACE**: Specify the outbound interface slirp should bind to (ipv4 traffic only). - - **outbound_addr=IPv4**: Specify the outbound ipv4 address slirp should bind to. - - **outbound_addr6=INTERFACE**: Specify the outbound interface slirp should bind to (ipv6 traffic only). - - **outbound_addr6=IPv6**: Specify the outbound ipv6 address slirp should bind to. + - **outbound_addr=INTERFACE**: Specify the outbound interface slirp binds to (ipv4 traffic only). + - **outbound_addr=IPv4**: Specify the outbound ipv4 address slirp binds to. + - **outbound_addr6=INTERFACE**: Specify the outbound interface slirp binds to (ipv6 traffic only). + - **outbound_addr6=IPv6**: Specify the outbound ipv6 address slirp binds to. - **port_handler=rootlesskit**: Use rootlesskit for port forwarding. Default. Note: Rootlesskit changes the source IP address of incoming packets to an IP address in the container network namespace, usually `10.0.2.100`. If the application requires the real source IP address, e.g. web server logs, use the slirp4netns port handler. The rootlesskit port handler is also used for rootless containers when connected to user-defined networks. - **port_handler=slirp4netns**: Use the slirp4netns port forwarding, it is slower than rootlesskit but preserves the correct source IP address. This port handler cannot be used for user-defined networks. @@ -41,7 +41,7 @@ Valid _mode_ values are: This is only supported in rootless mode. \ By default, IPv4 and IPv6 addresses and routes, as well as the pod interface name, are copied from the host. If port forwarding isn't configured, ports - will be forwarded dynamically as services are bound on either side (init + are forwarded dynamically as services are bound on either side (init namespace or container namespace). Port forwarding preserves the original source IP address. Options described in pasta(1) can be specified as comma-separated arguments. \ @@ -75,4 +75,4 @@ Valid _mode_ values are: host, using the loopback interface instead of the tap interface for improved performance - NOTE: For backward compatibility reasons, if there is an existing network named `pasta`, Podman will use it instead of the pasta mode."? + NOTE: For backward compatibility reasons, if there is an existing network named `pasta`, Podman uses it instead of the pasta mode."? diff --git a/docs/source/markdown/options/no-hosts.md b/docs/source/markdown/options/no-hosts.md index 0c2ee34399..68eace9c88 100644 --- a/docs/source/markdown/options/no-hosts.md +++ b/docs/source/markdown/options/no-hosts.md @@ -5,5 +5,5 @@ #### **--no-hosts** Do not create _/etc/hosts_ for the <>. -By default, Podman will manage _/etc/hosts_, adding the container's own IP address and any hosts from **--add-host**. -**--no-hosts** disables this, and the image's _/etc/hosts_ will be preserved unmodified. +By default, Podman manages _/etc/hosts_, adding the container's own IP address and any hosts from **--add-host**. +**--no-hosts** disables this, and the image's _/etc/hosts_ is preserved unmodified. diff --git a/docs/source/markdown/options/os.pull.md b/docs/source/markdown/options/os.pull.md index a81763424e..aeb0bdbe5d 100644 --- a/docs/source/markdown/options/os.pull.md +++ b/docs/source/markdown/options/os.pull.md @@ -5,4 +5,4 @@ #### **--os**=*OS* Override the OS, defaults to hosts, of the image to be pulled. For example, `windows`. -Unless overridden, subsequent lookups of the same image in the local storage will match this OS, regardless of the host. +Unless overridden, subsequent lookups of the same image in the local storage matches this OS, regardless of the host. diff --git a/docs/source/markdown/options/pidfile.md b/docs/source/markdown/options/pidfile.md index e9962d03a5..4e6efaf878 100644 --- a/docs/source/markdown/options/pidfile.md +++ b/docs/source/markdown/options/pidfile.md @@ -4,8 +4,8 @@ ####> are applicable to all of those. #### **--pidfile**=*path* -When the pidfile location is specified, the container process' PID will be written to the pidfile. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) -If the pidfile option is not specified, the container process' PID will be written to /run/containers/storage/${storage-driver}-containers/$CID/userdata/pidfile. +When the pidfile location is specified, the container process' PID is written to the pidfile. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) +If the pidfile option is not specified, the container process' PID is written to /run/containers/storage/${storage-driver}-containers/$CID/userdata/pidfile. After the container is started, the location for the pidfile can be discovered with the following `podman inspect` command: diff --git a/docs/source/markdown/options/platform.md b/docs/source/markdown/options/platform.md index b96f2735af..ff1f86ded0 100644 --- a/docs/source/markdown/options/platform.md +++ b/docs/source/markdown/options/platform.md @@ -6,4 +6,4 @@ 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. -Unless overridden, subsequent lookups of the same image in the local storage will match this platform, regardless of the host. +Unless overridden, subsequent lookups of the same image in the local storage matches this platform, regardless of the host. diff --git a/docs/source/markdown/options/pod-id-file.container.md b/docs/source/markdown/options/pod-id-file.container.md index 402886285a..a5fa1cd09a 100644 --- a/docs/source/markdown/options/pod-id-file.container.md +++ b/docs/source/markdown/options/pod-id-file.container.md @@ -5,4 +5,4 @@ #### **--pod-id-file**=*file* Run container in an existing pod and read the pod's ID from the specified *file*. -If a container is run within a pod, and the pod has an infra-container, the infra-container will be started before the container is. +When a container is run within a pod which has an infra-container, the infra-container starts first. diff --git a/docs/source/markdown/options/pod.run.md b/docs/source/markdown/options/pod.run.md index b3a0214f5a..8165dcf4ba 100644 --- a/docs/source/markdown/options/pod.run.md +++ b/docs/source/markdown/options/pod.run.md @@ -4,6 +4,6 @@ ####> are applicable to all of those. #### **--pod**=*name* -Run container in an existing pod. Podman will make the pod automatically if the pod name is prefixed with **new:**. +Run container in an existing pod. Podman makes the pod automatically if the pod name is prefixed with **new:**. To make a pod with more granular options, use the **podman pod create** command before creating a container. -If a container is run with a pod, and the pod has an infra-container, the infra-container will be started before the container is. +When a container is run with a pod with an infra-container, the infra-container is started first. diff --git a/docs/source/markdown/options/preserve-fds.md b/docs/source/markdown/options/preserve-fds.md index 970d71672a..32cb3b8ba1 100644 --- a/docs/source/markdown/options/preserve-fds.md +++ b/docs/source/markdown/options/preserve-fds.md @@ -5,5 +5,5 @@ #### **--preserve-fds**=*N* Pass down to the process N additional file descriptors (in addition to 0, 1, 2). -The total FDs will be 3+N. +The total FDs are 3+N. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) diff --git a/docs/source/markdown/options/publish-all.md b/docs/source/markdown/options/publish-all.md index ce5195b057..0f2c7ae824 100644 --- a/docs/source/markdown/options/publish-all.md +++ b/docs/source/markdown/options/publish-all.md @@ -7,10 +7,10 @@ Publish all exposed ports to random ports on the host interfaces. The default is **false**. When set to **true**, publish all exposed ports to the host interfaces. -If the operator uses **-P** (or **-p**) then Podman will make the -exposed port accessible on the host and the ports will be available to any +If the operator uses **-P** (or **-p**) then Podman makes the +exposed port accessible on the host and the ports are available to any client that can reach the host. -When using this option, Podman will bind any exposed port to a random port on the host +When using this option, Podman binds any exposed port to a random port on the host within an ephemeral port range defined by */proc/sys/net/ipv4/ip_local_port_range*. To find the mapping between the host ports and the exposed ports, use **podman port**. diff --git a/docs/source/markdown/options/publish.md b/docs/source/markdown/options/publish.md index b0ecdddc69..d9447b558a 100644 --- a/docs/source/markdown/options/publish.md +++ b/docs/source/markdown/options/publish.md @@ -10,14 +10,14 @@ Both *hostPort* and *containerPort* can be specified as a range of ports. When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range. -If host IP is set to 0.0.0.0 or not set at all, the port will be bound on all IPs on the host. +If host IP is set to 0.0.0.0 or not set at all, the port is bound on all IPs on the host. -By default, Podman will publish TCP ports. To publish a UDP port instead, give +By default, Podman publishes TCP ports. To publish a UDP port instead, give `udp` as protocol. To publish both TCP and UDP ports, set `--publish` twice, with `tcp`, and `udp` as protocols respectively. Rootful containers can also publish ports using the `sctp` protocol. Host port does not have to be specified (e.g. `podman run -p 127.0.0.1::80`). -If it is not, the container port will be randomly assigned a port on the host. +If it is not, the container port is randomly assigned a port on the host. Use **podman port** to see the actual mapping: `podman port $CONTAINER $CONTAINERPORT`. diff --git a/docs/source/markdown/options/pull.md b/docs/source/markdown/options/pull.md index c8c45fbf93..e8c2090aba 100644 --- a/docs/source/markdown/options/pull.md +++ b/docs/source/markdown/options/pull.md @@ -7,6 +7,6 @@ Pull image policy. The default is **missing**. - **always**: Always pull the image and throw an error if the pull fails. -- **missing**: Pull the image only if it could not be found in the local containers storage. Throw an error if no image could be found and the pull fails. -- **never**: Never pull the image but use the one from the local containers storage. Throw an error if no image could be found. +- **missing**: Pull the image only when the image is not in the local containers storage. Throw an error if no image is found and the pull fails. +- **never**: Never pull the image but use the one from the local containers storage. Throw an error if no image is found. - **newer**: Pull if the image on the registry is newer than the one in the local containers storage. An image is considered to be newer when the digests are different. Comparing the time stamps is prone to errors. Pull errors are suppressed if a local image was found. diff --git a/docs/source/markdown/options/read-only.md b/docs/source/markdown/options/read-only.md index 1155f9e9c8..3c16f65a39 100644 --- a/docs/source/markdown/options/read-only.md +++ b/docs/source/markdown/options/read-only.md @@ -6,6 +6,5 @@ Mount the container's root filesystem as read-only. -By default a container will have its root filesystem writable allowing processes -to write files anywhere. By specifying the **--read-only** flag, the container will have -its root filesystem mounted as read-only prohibiting any writes. +By default, container root filesystems are writable, allowing processes +to write files anywhere. By specifying the **--read-only** flag, the containers root filesystem are mounted read-only prohibiting any writes. diff --git a/docs/source/markdown/options/requires.md b/docs/source/markdown/options/requires.md index 8c2901239f..1a0b34dfa3 100644 --- a/docs/source/markdown/options/requires.md +++ b/docs/source/markdown/options/requires.md @@ -5,5 +5,5 @@ #### **--requires**=*container* Specify one or more requirements. -A requirement is a dependency container that will be started before this container. +A requirement is a dependency container that is started before this container. Containers can be specified by name or ID, with multiple containers being separated by commas. diff --git a/docs/source/markdown/options/restart.md b/docs/source/markdown/options/restart.md index 7d0219600e..2a7d56a696 100644 --- a/docs/source/markdown/options/restart.md +++ b/docs/source/markdown/options/restart.md @@ -5,7 +5,7 @@ #### **--restart**=*policy* Restart policy to follow when containers exit. -Restart policy will not take effect if a container is stopped via the **podman kill** or **podman stop** commands. +Restart policy does not take effect if a container is stopped via the **podman kill** or **podman stop** commands. Valid _policy_ values are: @@ -17,4 +17,4 @@ Valid _policy_ values are: Podman provides a systemd unit file, podman-restart.service, which restarts containers after a system reboot. -If container will run as a system service, generate a systemd unit file to manage it. See **podman generate systemd**. +If container runs as a system service, generate a systemd unit file to manage it. See **podman generate systemd**. diff --git a/docs/source/markdown/options/rootfs.md b/docs/source/markdown/options/rootfs.md index 6e4fba3388..001294bd01 100644 --- a/docs/source/markdown/options/rootfs.md +++ b/docs/source/markdown/options/rootfs.md @@ -15,7 +15,7 @@ of the container is assumed to be managed externally. storage using the `overlay file system`. The container processes can modify content within the mount point which is stored in the container storage in a separate directory. In overlay terms, the source -directory will be the lower, and the container storage directory will be the +directory is the lower, and the container storage directory is the upper. Modifications to the mount point are destroyed when the container finishes executing, similar to a tmpfs mount point being unmounted. diff --git a/docs/source/markdown/options/sdnotify.md b/docs/source/markdown/options/sdnotify.md index 4faa9d9ae1..c3905007ae 100644 --- a/docs/source/markdown/options/sdnotify.md +++ b/docs/source/markdown/options/sdnotify.md @@ -7,8 +7,8 @@ Determines how to use the NOTIFY_SOCKET, as passed with systemd and Type=notify. Default is **container**, which means allow the OCI runtime to proxy the socket into the -container to receive ready notification. Podman will set the MAINPID to conmon's pid. +container to receive ready notification. Podman sets the MAINPID to conmon's pid. The **conmon** option sets MAINPID to conmon's pid, and sends READY when the container has started. The socket is never passed to the runtime or the container. The **ignore** option removes NOTIFY_SOCKET from the environment for itself and child processes, -for the case where some other process above Podman uses NOTIFY_SOCKET and Podman should not use it. +for the case where some other process above Podman uses NOTIFY_SOCKET and Podman does not use it. diff --git a/docs/source/markdown/options/seccomp-policy.md b/docs/source/markdown/options/seccomp-policy.md index b22f5b2b5c..73202e839c 100644 --- a/docs/source/markdown/options/seccomp-policy.md +++ b/docs/source/markdown/options/seccomp-policy.md @@ -4,6 +4,6 @@ ####> are applicable to all of those. #### **--seccomp-policy**=*policy* -Specify the policy to select the seccomp profile. If set to *image*, Podman will look for a "io.containers.seccomp.profile" label in the container-image config and use its value as a seccomp profile. Otherwise, Podman will follow the *default* policy by applying the default profile unless specified otherwise via *--security-opt seccomp* as described below. +Specify the policy to select the seccomp profile. If set to *image*, Podman looks for a "io.containers.seccomp.profile" label in the container-image config and use its value as a seccomp profile. Otherwise, Podman follows the *default* policy by applying the default profile unless specified otherwise via *--security-opt seccomp* as described below. Note that this feature is experimental and may change in the future. diff --git a/docs/source/markdown/options/secret.md b/docs/source/markdown/options/secret.md index e81abfb679..f91a2ae1da 100644 --- a/docs/source/markdown/options/secret.md +++ b/docs/source/markdown/options/secret.md @@ -7,27 +7,27 @@ Give the container access to a secret. Can be specified multiple times. A secret is a blob of sensitive data which a container needs at runtime but -should not be stored in the image or in source control, such as usernames and passwords, +is not stored in the image or in source control, such as usernames and passwords, TLS certificates and keys, SSH keys or other important generic strings or binary content (up to 500 kb in size). When secrets are specified as type `mount`, the secrets are copied and mounted into the container when a container is created. -When secrets are specified as type `env`, the secret will be set as an environment variable within the container. +When secrets are specified as type `env`, the secret is set as an environment variable within the container. Secrets are written in the container at the time of container creation, and modifying the secret using `podman secret` commands -after the container is created will not affect the secret inside the container. +after the container is created affects the secret inside the container. Secrets and its storage are managed using the `podman secret` command. Secret Options -- `type=mount|env` : How the secret will be exposed to the container. +- `type=mount|env` : How the secret is exposed to the container. `mount` mounts the secret into the container as a file. `env` exposes the secret as a environment variable. Defaults to `mount`. - `target=target` : Target of secret. For mounted secrets, this is the path to the secret inside the container. - If a fully qualified path is provided, the secret will be mounted at that location. - Otherwise, the secret will be mounted to `/run/secrets/target`. - If target is not set, by default the secret will be mounted to `/run/secrets/secretname`. + If a fully qualified path is provided, the secret is mounted at that location. + Otherwise, the secret is mounted to `/run/secrets/target`. + If the target is not set, the secret is mounted to `/run/secrets/secretname` by default. For env secrets, this is the environment variable key. Defaults to `secretname`. - `uid=0` : UID of secret. Defaults to 0. Mount secret type only. - `gid=0` : GID of secret. Defaults to 0. Mount secret type only. diff --git a/docs/source/markdown/options/security-opt.md b/docs/source/markdown/options/security-opt.md index 8ac58b124a..f5a4ea2cf4 100644 --- a/docs/source/markdown/options/security-opt.md +++ b/docs/source/markdown/options/security-opt.md @@ -30,7 +30,7 @@ Note: Labeling can be disabled for all <<|pods/>>containers by setting label=fal - **proc-opts**=_OPTIONS_ : Comma-separated list of options to use for the /proc mount. More details for the possible mount options are specified in the **proc(5)** man page. -- **unmask**=_ALL_ or _/path/1:/path/2_, or shell expanded paths (/proc/*): Paths to unmask separated by a colon. If set to **ALL**, it will unmask all the paths that are masked or made read-only by default. +- **unmask**=_ALL_ or _/path/1:/path/2_, or shell expanded paths (/proc/*): Paths to unmask separated by a colon. If set to **ALL**, it unmasks all the paths that are masked or made read-only by default. The default masked paths are **/proc/acpi, /proc/kcore, /proc/keys, /proc/latency_stats, /proc/sched_debug, /proc/scsi, /proc/timer_list, /proc/timer_stats, /sys/firmware, and /sys/fs/selinux**. The default paths that are read-only are **/proc/asound**, **/proc/bus**, **/proc/fs**, **/proc/irq**, **/proc/sys**, **/proc/sysrq-trigger**, **/sys/fs/cgroup**. Note: Labeling can be disabled for all containers by setting **label=false** in the **containers.conf**(5) file. diff --git a/docs/source/markdown/options/systemd.md b/docs/source/markdown/options/systemd.md index 8d69f9ab79..67aaca4ad1 100644 --- a/docs/source/markdown/options/systemd.md +++ b/docs/source/markdown/options/systemd.md @@ -24,7 +24,7 @@ Running the container in systemd mode causes the following changes: * Podman sets the default stop signal to **SIGRTMIN+3**. * Podman sets **container_uuid** environment variable in the container to the first 32 characters of the container ID. -* Podman will not mount virtual consoles (_/dev/tty\d+_) when running with **--privileged**. +* Podman does not mount virtual consoles (_/dev/tty\d+_) when running with **--privileged**. This allows systemd to run in a confined container without any modifications. diff --git a/docs/source/markdown/options/timeout.md b/docs/source/markdown/options/timeout.md index be959d73ac..03f8069735 100644 --- a/docs/source/markdown/options/timeout.md +++ b/docs/source/markdown/options/timeout.md @@ -5,5 +5,5 @@ #### **--timeout**=*seconds* Maximum time a container is allowed to run before conmon sends it the kill -signal. By default containers will run until they exit or are stopped by +signal. By default containers run until they exit or are stopped by `podman stop`. diff --git a/docs/source/markdown/options/tls-verify.md b/docs/source/markdown/options/tls-verify.md index bf2b7d4d84..d694bab26d 100644 --- a/docs/source/markdown/options/tls-verify.md +++ b/docs/source/markdown/options/tls-verify.md @@ -5,7 +5,7 @@ #### **--tls-verify** Require HTTPS and verify certificates when contacting registries (default: **true**). -If explicitly set to **true**, TLS verification will be used. -If set to **false**, TLS verification will not be used. -If not specified, TLS verification will be used unless the target registry +If explicitly set to **true**, TLS verification is used. +If set to **false**, TLS verification is not used. +If not specified, TLS verification is used unless the target registry is listed as an insecure registry in **[containers-registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md)** diff --git a/docs/source/markdown/options/tty.md b/docs/source/markdown/options/tty.md index 4ca1827a2e..7c5db3cd0e 100644 --- a/docs/source/markdown/options/tty.md +++ b/docs/source/markdown/options/tty.md @@ -6,8 +6,8 @@ Allocate a pseudo-TTY. The default is **false**. -When set to **true**, Podman will allocate a pseudo-tty and attach to the standard +When set to **true**, Podman allocates a pseudo-tty and attach to the standard input of the container. This can be used, for example, to run a throwaway interactive shell. -**NOTE**: The --tty flag prevents redirection of standard output. It combines STDOUT and STDERR, it can insert control characters, and it can hang pipes. This option should only be used when run interactively in a terminal. When feeding input to Podman, use -i only, not -it. +**NOTE**: The --tty flag prevents redirection of standard output. It combines STDOUT and STDERR, it can insert control characters, and it can hang pipes. This option is only used when run interactively in a terminal. When feeding input to Podman, use -i only, not -it. diff --git a/docs/source/markdown/options/uidmap.container.md b/docs/source/markdown/options/uidmap.container.md index 63370f3b57..221302a5f1 100644 --- a/docs/source/markdown/options/uidmap.container.md +++ b/docs/source/markdown/options/uidmap.container.md @@ -18,8 +18,8 @@ works as a direct mapping between host UIDs and container UIDs. host UID -> container UID -The _amount_ specifies the number of consecutive UIDs that will be mapped. -If for example _amount_ is **4** the mapping would look like: +The _amount_ specifies the number of consecutive UIDs that is mapped. +If for example _amount_ is **4** the mapping looks like: | host UID | container UID | | - | - | @@ -55,7 +55,7 @@ subordinate UIDs configured in _/etc/subuid_. See **subuid**(5). The second mapping step is configured with **--uidmap**. -If for example _amount_ is **5** the second mapping step would look like: +If for example _amount_ is **5** the second mapping step looks like: | intermediate UID | container UID | | - | - | @@ -65,7 +65,7 @@ If for example _amount_ is **5** the second mapping step would look like: | _from_uid_ + 3 | _container_uid_ + 3 | | _from_uid_ + 4 | _container_uid_ + 4 | -When running as rootless, Podman will use all the ranges configured in the _/etc/subuid_ file. +When running as rootless, Podman uses all the ranges configured in the _/etc/subuid_ file. The current user ID is mapped to UID=0 in the rootless user namespace. Every additional range is added sequentially afterward: @@ -77,7 +77,7 @@ Every additional range is added sequentially afterward: | 1+$FIRST_RANGE_LENGTH | $SECOND_RANGE_ID | $SECOND_RANGE_LENGTH| Even if a user does not have any subordinate UIDs in _/etc/subuid_, -**--uidmap** could still be used to map the normal UID of the user to a +**--uidmap** can be used to map the normal UID of the user to a container UID by running `podman <> --uidmap $container_uid:0:1 --user $container_uid ...`. Note: the **--uidmap** flag cannot be called in conjunction with the **--pod** flag as a uidmap cannot be set on the container level when in a pod. diff --git a/docs/source/markdown/options/user-mode-networking.md b/docs/source/markdown/options/user-mode-networking.md index dc6129f834..f71ed07030 100644 --- a/docs/source/markdown/options/user-mode-networking.md +++ b/docs/source/markdown/options/user-mode-networking.md @@ -4,18 +4,18 @@ ####> are applicable to all of those. #### **--user-mode-networking** -Whether this machine should relay traffic from the guest through a user-space +Indicates that this machine relays traffic from the guest through a user-space process running on the host. In some VPN configurations the VPN may drop traffic from alternate network interfaces, including VM network devices. By -enabling user-mode networking (a setting of `true`), VPNs will observe all +enabling user-mode networking (a setting of `true`), VPNs observe all podman machine traffic as coming from the host, bypassing the problem. When the qemu backend is used (Linux, Mac), user-mode networking is mandatory and the only allowed value is `true`. In contrast, The Windows/WSL backend defaults to `false`, and follows the standard WSL network setup. -Changing this setting to `true` on Windows/WSL will inform Podman to replace +Changing this setting to `true` on Windows/WSL informs Podman to replace the WSL networking setup on start of this machine instance with a user-mode networking distribution. Since WSL shares the same kernel across -distributions, all other running distributions will reuse this network. +distributions, all other running distributions reuses this network. Likewise, when the last machine instance with a `true` setting stops, the -original networking setup will be restored. +original networking setup is restored. diff --git a/docs/source/markdown/options/user.md b/docs/source/markdown/options/user.md index f81718bc5d..2307fcc9b6 100644 --- a/docs/source/markdown/options/user.md +++ b/docs/source/markdown/options/user.md @@ -6,6 +6,6 @@ Sets the username or UID used and, optionally, the groupname or GID for the specified command. Both *user* and *group* may be symbolic or numeric. -Without this argument, the command will run as the user specified in the container image. Unless overridden by a `USER` command in the Containerfile or by a value passed to this option, this user generally defaults to root. +Without this argument, the command runs as the user specified in the container image. Unless overridden by a `USER` command in the Containerfile or by a value passed to this option, this user generally defaults to root. -When a user namespace is not in use, the UID and GID used within the container and on the host will match. When user namespaces are in use, however, the UID and GID in the container may correspond to another UID and GID on the host. In rootless containers, for example, a user namespace is always used, and root in the container will by default correspond to the UID and GID of the user invoking Podman. +When a user namespace is not in use, the UID and GID used within the container and on the host match. When user namespaces are in use, however, the UID and GID in the container may correspond to another UID and GID on the host. In rootless containers, for example, a user namespace is always used, and root in the container by default corresponds to the UID and GID of the user invoking Podman. diff --git a/docs/source/markdown/options/userns.container.md b/docs/source/markdown/options/userns.container.md index 1c42a194d4..7c0c68f657 100644 --- a/docs/source/markdown/options/userns.container.md +++ b/docs/source/markdown/options/userns.container.md @@ -30,24 +30,24 @@ Podman allocates unique ranges of UIDs and GIDs from the `containers` subordinat The option `--userns=keep-id` uses all the subuids and subgids of the user. The option `--userns=nomap` uses all the subuids and subgids of the user except the user's own ID. -Using `--userns=auto` when starting new containers will consequently not work as long as any containers exist that were started with `--userns=keep-id` or `--userns=nomap`. +Using `--userns=auto` when starting new containers does not work as long as any containers exist that were started with `--userns=keep-id` or `--userns=nomap`. Valid `auto` options: - *gidmapping*=_CONTAINER\_GID:HOST\_GID:SIZE_: to force a GID mapping to be present in the user namespace. - - *size*=_SIZE_: to specify an explicit size for the automatic user namespace. e.g. `--userns=auto:size=8192`. If `size` is not specified, `auto` will estimate a size for the user namespace. + - *size*=_SIZE_: to specify an explicit size for the automatic user namespace. e.g. `--userns=auto:size=8192`. If `size` is not specified, `auto` estimates a size for the user namespace. - *uidmapping*=_CONTAINER\_UID:HOST\_UID:SIZE_: to force a UID mapping to be present in the user namespace. **container:**_id_: join the user namespace of the specified container. -**host**: run in the user namespace of the caller. The processes running in the container will have the same privileges on the host as any other process launched by the calling user (default). +**host**: run in the user namespace of the caller. The processes running in the container have the same privileges on the host as any other process launched by the calling user (default). **keep-id**: creates a user namespace where the current user's UID:GID are mapped to the same values in the container. For containers created by root, the current mapping is created into a new user namespace. Valid `keep-id` options: - - *uid*=UID: override the UID inside the container that will be used to map the current user to. - - *gid*=GID: override the GID inside the container that will be used to map the current user to. + - *uid*=UID: override the UID inside the container that is used to map the current user to. + - *gid*=GID: override the GID inside the container that is used to map the current user to. **nomap**: creates a user namespace where the current rootless user's UID:GID are not mapped into the container. This option is not allowed for containers created by the root user. diff --git a/docs/source/markdown/options/userns.pod.md b/docs/source/markdown/options/userns.pod.md index bf31f7dfb9..3974140c11 100644 --- a/docs/source/markdown/options/userns.pod.md +++ b/docs/source/markdown/options/userns.pod.md @@ -21,11 +21,11 @@ Valid _mode_ values are: - *gidmapping=*_CONTAINER\_GID:HOST\_GID:SIZE_ to force a GID mapping to be present in the user namespace. - - *size=*_SIZE_: to specify an explicit size for the automatic user namespace. e.g. `--userns=auto:size=8192`. If `size` is not specified, `auto` will estimate a size for the user namespace. + - *size=*_SIZE_: to specify an explicit size for the automatic user namespace. e.g. `--userns=auto:size=8192`. If `size` is not specified, `auto` estimates the size for the user namespace. - *uidmapping=*_CONTAINER\_UID:HOST\_UID:SIZE_ to force a UID mapping to be present in the user namespace. - - *host*: run in the user namespace of the caller. The processes running in the container will have the same privileges on the host as any other process launched by the calling user (default). + - *host*: run in the user namespace of the caller. The processes running in the container have the same privileges on the host as any other process launched by the calling user (default). - *keep-id*: creates a user namespace where the current rootless user's UID:GID are mapped to the same values in the container. This option is not allowed for containers created by the root user. diff --git a/docs/source/markdown/options/volume.md b/docs/source/markdown/options/volume.md index eaf33bf9c8..839ea82dbb 100644 --- a/docs/source/markdown/options/volume.md +++ b/docs/source/markdown/options/volume.md @@ -6,14 +6,14 @@ Create a bind mount. If `-v /HOST-DIR:/CONTAINER-DIR` is specified, Podman bind mounts `/HOST-DIR` from the host into `/CONTAINER-DIR` in the Podman -container. Similarly, `-v SOURCE-VOLUME:/CONTAINER-DIR` will mount the named +container. Similarly, `-v SOURCE-VOLUME:/CONTAINER-DIR` mounts the named volume from the host into the container. If no such named volume exists, -Podman will create one. If no source is given, the volume will be created -as an anonymously named volume with a randomly generated name, and will be +Podman creates one. If no source is given, the volume is created +as an anonymously named volume with a randomly generated name, and is removed when the <> is removed via the `--rm` flag or the `podman rm --volumes` command. -(Note when using the remote client, including Mac and Windows (excluding WSL2) machines, the volumes will be mounted from the remote server, not necessarily the client machine.) +(Note when using the remote client, including Mac and Windows (excluding WSL2) machines, the volumes are mounted from the remote server, not necessarily the client machine.) The _OPTIONS_ is a comma-separated list and can be: [[1]](#Footnote1) @@ -30,16 +30,16 @@ The _OPTIONS_ is a comma-separated list and can be: [[1]](#Footnote1) * **idmap**[=**options**] The `CONTAINER-DIR` must be an absolute path such as `/src/docs`. The volume -will be mounted into the container at this directory. +is mounted into the container at this directory. If a volume source is specified, it must be a path on the host or the name of a named volume. Host paths are allowed to be absolute or relative; relative paths are resolved relative to the directory Podman is run in. If the source does not -exist, Podman will return an error. Users must pre-create the source files or +exist, Podman returns an error. Users must pre-create the source files or directories. -Any source that does not begin with a `.` or `/` will be treated as the name of -a named volume. If a volume with that name does not exist, it will be created. +Any source that does not begin with a `.` or `/` is treated as the name of +a named volume. If a volume with that name does not exist, it is created. Volumes created with names are not anonymous, and they are not removed by the `--rm` option and the `podman rm --volumes` command. @@ -63,9 +63,9 @@ The `:U` suffix tells Podman to use the correct host UID and GID based on the UID and GID within the <>, to change recursively the owner and group of the source volume. Chowning walks the file system under the volume and changes the UID/GID on each file, it the volume has thousands of inodes, this -process will take a long time, delaying the start of the <>. +process takes a long time, delaying the start of the <>. -**Warning** use with caution since this will modify the host filesystem. +**Warning** use with caution since this modifies the host filesystem. `Labeling Volume Mounts` @@ -82,7 +82,7 @@ content with a shared content label. Shared volume labels allow all containers to read/write content. The **Z** option tells Podman to label the content with a private unshared label Only the current <> can use a private volume. Relabeling walks the file system under the volume and changes the label -on each file, if the volume has thousands of inodes, this process will take a +on each file, if the volume has thousands of inodes, this process takes a long time, delaying the start of the <>. If the volume was previously relabeled with the `z` option, Podman is optimized to not relabel a second time. If files are moved into the volume, then the labels can be @@ -103,17 +103,17 @@ For example if a user wanted to volume mount their entire home directory into a temporary storage using the `overlay file system`. The <> processes can modify content within the mountpoint which is stored in the container storage in a separate directory. In overlay terms, the source -directory will be the lower, and the container storage directory will be the +directory is the lower, and the container storage directory is the upper. Modifications to the mount point are destroyed when the <> finishes executing, similar to a tmpfs mount point being unmounted. For advanced users, the **overlay** option also supports custom non-volatile **upperdir** and **workdir** for the overlay mount. Custom **upperdir** and -**workdir** can be fully managed by the users themselves, and Podman will not +**workdir** can be fully managed by the users themselves, and Podman does not remove it on lifecycle completion. Example **:O,upperdir=/some/upper,workdir=/some/work** - Subsequent executions of the container will see the original source directory + Subsequent executions of the container sees the original source directory content, any changes from previous <> executions no longer exist. One use case of the overlay mount is sharing the package cache from the @@ -128,19 +128,17 @@ by the <<|pod infra>> container label. Usually containers can read/execute `cont and can read/write `container_file_t`. If unable to change the labels on a source volume, SELinux container separation must be disabled for the <<|pod or infra>> container to work. - - The source directory mounted into the <> with an overlay mount -should not be modified, it can cause unexpected failures. It is recommended -to not modify the directory until the container finishes running. + - Do not modify the source directory mounted into the <> with an overlay mount, it can cause unexpected failures. Only modify the directory after the container finishes running. `Mounts propagation` By default bind mounted volumes are `private`. That means any mounts done -inside the <> will not be visible on host and vice versa. One can change +inside the <> is not visible on host and vice versa. One can change this behavior by specifying a volume mount propagation property. Making a -volume shared mounts done under that volume inside the <> will be +volume shared mounts done under that volume inside the <> is visible on host and vice versa. Making a volume **slave** enables only one way mount propagation and that is mounts done on host under that volume -will be visible inside container but not the other way around. [[1]](#Footnote1) +is visible inside container but not the other way around. [[1]](#Footnote1) To control mount propagation property of a volume one can use the [**r**]**shared**, [**r**]**slave**, [**r**]**private** or the [**r**]**unbindable** propagation flag. @@ -153,7 +151,7 @@ slave volumes, the source mount point has to be either shared or slave. To recursively mount a volume and all of its submounts into a <>, use the **rbind** option. By default the bind option is -used, and submounts of the source directory will not be mounted into the +used, and submounts of the source directory is not mounted into the <>. Mounting the volume with a **copy** option tells podman to copy content from @@ -162,15 +160,15 @@ the underlying destination directory onto newly created internal volumes. The copied up when the volume is subsequently used on different containers. The **copy** option is ignored on bind mounts and has no effect. -Mounting the volume with the **nosuid** options means that SUID applications on -the volume will not be able to change their privilege. By default volumes -are mounted with **nosuid**. +Mounting volumes with the **nosuid** options means that SUID executables on the +volume can not be used by applications to change their privilege. By default +volumes are mounted with **nosuid**. Mounting the volume with the **noexec** option means that no executables on the -volume will be able to be executed within the <>. +volume can be executed within the <>. Mounting the volume with the **nodev** option means that no devices on the volume -will be able to be used by processes within the <>. By default volumes +can be used by processes within the <>. By default volumes are mounted with **nodev**. If the _HOST-DIR_ is a mount point, then **dev**, **suid**, and **exec** options are @@ -187,12 +185,12 @@ is slave, and if nothing is there, the mount is private. [[1]](#Footnote1)< To change propagation properties of a mount point, use **mount**(8) command. For example, if one wants to bind mount source directory _/foo_, one can do **mount --bind /foo /foo** and **mount --make-private --make-shared /foo**. This -will convert /foo into a shared mount point. Alternatively, one can directly +converts /foo into a shared mount point. Alternatively, one can directly change propagation properties of source mount. Say _/_ is source mount for _/foo_, then use **mount --make-shared /** to convert _/_ into a shared mount. Note: if the user only has access rights via a group, accessing the volume -from inside a rootless <> will fail. +from inside a rootless <> fails. `Idmapped mount` diff --git a/docs/source/markdown/podman-auto-update.1.md.in b/docs/source/markdown/podman-auto-update.1.md.in index b351817eba..b44999496b 100644 --- a/docs/source/markdown/podman-auto-update.1.md.in +++ b/docs/source/markdown/podman-auto-update.1.md.in @@ -15,9 +15,9 @@ If an image must be updated, Podman pulls it down and restarts the systemd unit The registry policy requires a fully-qualified image reference (e.g., quay.io/podman/stable:latest) to be used to create the container. 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. +If an image ID was used, Podman does not know which image to check/pull anymore. -Alternatively, if the autoupdate label is set to `local`, Podman will compare the image a container is using to the image with its raw name in local storage. +Alternatively, if the autoupdate label is set to `local`, Podman compares the image a container is using to the image with its raw name in local storage. If an image is updated locally, Podman simply restarts the systemd unit executing the container. If `io.containers.autoupdate.authfile` label is present, Podman reaches out to the corresponding authfile when pulling images. @@ -26,7 +26,7 @@ At container-creation time, Podman looks up the `PODMAN_SYSTEMD_UNIT` environmen This variable is now set by all systemd units generated by **[podman-generate-systemd](podman-generate-systemd.1.md)** 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. -If a container configured for auto updates is part of a pod, the pod's systemd unit will be restarted and hence the entire pod and all containers inside the pod. Container updates are batched, such that a pod gets restarted at most once. +If a container configured for auto updates is part of a pod, the pod's systemd unit is restarted and hence the entire pod and all containers inside the pod. Container updates are batched, such that a pod gets restarted at most once. Note that **podman auto-update** relies on systemd. The systemd units are expected to be generated with **[podman-generate-systemd --new](podman-generate-systemd.1.md#--new)**, or similar units that create new containers in order to run the updated images. Systemd units that start and stop a container cannot run a new image. @@ -75,7 +75,7 @@ Valid placeholders for the Go template are listed below: If restarting a systemd unit after updating the image has failed, rollback to using the previous image and restart the unit another time. Default is true. -Please note that detecting if a systemd unit has failed is best done by the container sending the READY message via SDNOTIFY. This way, restarting the unit will wait until having received the message or a timeout kicked in. Without that, restarting the systemd unit may succeed even if the container has failed shortly after. +Please note that detecting if a systemd unit has failed is best done by the container sending the READY message via SDNOTIFY. This way, restarting the unit waits until having received the message or a timeout kicked in. Without that, restarting the systemd unit may succeed even if the container has failed shortly after. For a container to send the READY message via SDNOTIFY it must be created with the `--sdnotify=container` option (see podman-run(1)). The application running inside the container can then execute `systemd-notify --ready` when ready or use the sdnotify bindings of the specific programming language (e.g., sd_notify(3)). diff --git a/docs/source/markdown/podman-build.1.md.in b/docs/source/markdown/podman-build.1.md.in index 30311ed8b6..7700ed14b9 100644 --- a/docs/source/markdown/podman-build.1.md.in +++ b/docs/source/markdown/podman-build.1.md.in @@ -19,9 +19,9 @@ The build context directory can be specified as the http(s) URL of an archive, git repository or Containerfile. When invoked with `-f` and a path to a Containerfile, with no explicit CONTEXT -directory, Podman will use the Containerfile's parent directory as its build context. +directory, Podman uses the Containerfile's parent directory as its build context. -Containerfiles ending with a ".in" suffix will be preprocessed via CPP(1). This +Containerfiles ending with a ".in" suffix are preprocessed via CPP(1). This can be useful to decompose Containerfiles into several reusable parts that can be used via CPP's **#include** directive. Notice, a Containerfile.in file can still be used by other tools when manually preprocessing them via `cpp -E`. @@ -66,16 +66,16 @@ discarded when writing images in Docker formats. Set the architecture of the image to be built, and that of the base image to be pulled, if the build uses one, to the provided value instead of using the architecture of the build host. Unless overridden, subsequent lookups of the -same image in the local storage will match this architecture, regardless of the +same image in the local storage matches this architecture, regardless of the host. (Examples: arm, arm64, 386, amd64, ppc64le, s390x) @@option authfile #### **--build-arg**=*arg=value* -Specifies a build argument and its value, which will be interpolated in +Specifies a build argument and its value, which is interpolated in instructions read from the Containerfiles in the same way that environment -variables are, but which will not be added to environment variable list in the +variables are, but which are not added to environment variable list in the resulting image's configuration. #### **--build-arg-file**=*path* @@ -84,13 +84,13 @@ Specifies a file containing lines of build arguments of the form `arg=value`. The suggested file name is `argfile.conf`. Comment lines beginning with `#` are ignored, along with blank lines. -All others should be of the `arg=value` format passed to `--build-arg`. +All others must be of the `arg=value` format passed to `--build-arg`. If several arguments are provided via the `--build-arg-file` -and `--build-arg` options, the build arguments will be merged across all +and `--build-arg` options, the build arguments are merged across all of the provided files and command line arguments. -Any file provided in a `--build-arg-file` option will be read before +Any file provided in a `--build-arg-file` option is read before the arguments supplied via the `--build-arg` option. When a given argument name is specified several times, the last instance @@ -103,7 +103,7 @@ Specify an additional build context using its short name and its location. Additional build contexts can be referenced in the same manner as we access different stages in COPY instruction. -Valid values could be: +Valid values are: * Local directory – e.g. --build-context project2=../path/to/project2/src (This option is not available with the remote Podman client. On Podman machine setup (i.e macOS and Winows) path must exists on the machine VM) * HTTP URL to a tarball – e.g. --build-context src=https://example.org/releases/src.tar @@ -126,9 +126,9 @@ The value of [name] is matched with the following priority order: #### **--cache-from** -Repository to utilize as a potential cache source. When specified, Buildah will try to look for -cache images in the specified repository and will attempt to pull cache images instead of actually -executing the build steps locally. Buildah will only attempt to pull previously cached images if they +Repository to utilize as a potential cache source. When specified, Buildah tries to look for +cache images in the specified repository and attempts to pull cache images instead of actually +executing the build steps locally. Buildah only attempts to pull previously cached images if they are considered as valid cache hits. Use the `--cache-to` option to populate a remote repository with cache content. @@ -144,7 +144,7 @@ Note: `--cache-from` option is ignored unless `--layers` is specified. #### **--cache-to** -Set this flag to specify a remote repository that will be used to store cache images. Buildah will attempt to +Set this flag to specify a remote repository that is used to store cache images. Buildah attempts to push newly built cache image to the remote repository. Note: Use the `--cache-from` option in order to use cache content in a remote repository. @@ -161,12 +161,11 @@ Note: `--cache-to` option is ignored unless `--layers` is specified. #### **--cache-ttl** Limit the use of cached images to only consider images with created timestamps less than *duration* ago. -For example if `--cache-ttl=1h` is specified, Buildah will only consider intermediate cache images which are created -under the duration of one hour, and intermediate cache images outside this duration will be ignored. +For example if `--cache-ttl=1h` is specified, Buildah considers intermediate cache images which are created +under the duration of one hour, and intermediate cache images outside this duration is ignored. Note: Setting `--cache-ttl=0` manually is equivalent to using `--no-cache` in the -implementation since this would effectively mean that user is not willing to use -cache at all. +implementation since this means that the user dones not want to use cache at all. #### **--cap-add**=*CAP\_xxx* @@ -185,7 +184,7 @@ CAP\_SETGID, CAP\_SETPCAP, and CAP\_SETUID capabilities are granted by default; this option can be used to remove them. If a capability is specified to both the **--cap-add** and **--cap-drop** -options, it will be dropped, regardless of the order in which the options were +options, it is dropped, regardless of the order in which the options were given. @@option cert-dir @@ -196,8 +195,8 @@ given. Sets the configuration for cgroup namespaces when handling `RUN` instructions. The configured value can be "" (the empty string) or "private" to indicate -that a new cgroup namespace should be created, or it can be "host" to indicate -that the cgroup namespace in which `buildah` itself is being run should be reused. +that a new cgroup namespace is created, or it can be "host" to indicate +that the cgroup namespace in which `buildah` itself is being run is reused. #### **--compress** @@ -207,7 +206,7 @@ Thus, compressing the data before sending it is irrelevant to Podman. (This opti #### **--cpp-flag**=*flags* -Set additional flags to pass to the C Preprocessor cpp(1). Containerfiles ending with a ".in" suffix will be preprocessed via cpp(1). This option can be used to pass additional flags to cpp.Note: You can also set default CPPFLAGS by setting the BUILDAH_CPPFLAGS environment variable (e.g., export BUILDAH_CPPFLAGS="-DDEBUG"). +Set additional flags to pass to the C Preprocessor cpp(1). Containerfiles ending with a ".in" suffix is preprocessed via cpp(1). This option can be used to pass additional flags to cpp.Note: You can also set default CPPFLAGS by setting the BUILDAH_CPPFLAGS environment variable (e.g., export BUILDAH_CPPFLAGS="-DDEBUG"). @@option cpu-period @@ -224,14 +223,14 @@ Set additional flags to pass to the C Preprocessor cpp(1). Containerfiles ending #### **--decryption-key**=*key[:passphrase]* The [key[:passphrase]] to be used for decryption of images. Key can point to -keys and/or certificates. Decryption will be tried with all keys. If the key is +keys and/or certificates. Decryption is tried with all keys. If the key is protected by a passphrase, it is required to be passed in the argument and omitted otherwise. @@option device Note: if the user only has access rights via a group, accessing the device -from inside a rootless container will fail. The **[crun(1)](https://github.com/containers/crun/tree/main/crun.1.md)** runtime offers a +from inside a rootless container fails. The **[crun(1)](https://github.com/containers/crun/tree/main/crun.1.md)** runtime offers a workaround for this by adding the option **--annotation run.oci.keep_original_groups=1**. @@ -240,7 +239,7 @@ workaround for this by adding the option Don't compress filesystem layers when building the image unless it is required by the location where the image is being written. This is the default setting, because image layers are compressed automatically when they are pushed to -registries, and images being written to local storage would only need to be +registries, and images being written to local storage only need to be decompressed again to be stored. Compression can be forced in all cases by specifying **--disable-compression=false**. @@ -265,7 +264,7 @@ Set custom DNS search domains to be used during the build. Add a value (e.g. env=*value*) to the built image. Can be used multiple times. If neither `=` nor a `*value*` are specified, but *env* is set in the current -environment, the value from the current environment will be added to the image. +environment, the value from the current environment is added to the image. To remove an environment variable from the built image, use the `--unsetenv` option. @@ -273,11 +272,11 @@ option. Specifies a Containerfile which contains instructions for building the image, either a local file or an **http** or **https** URL. If more than one -Containerfile is specified, *FROM* instructions will only be accepted from the +Containerfile is specified, *FROM* instructions are only be accepted from the last specified file. If a build context is not specified, and at least one Containerfile is a -local file, the directory in which it resides will be used as the build +local file, the directory in which it resides is used as the build context. Specifying the option `-f -` causes the Containerfile contents to be read from stdin. @@ -301,8 +300,8 @@ environment variable. `export BUILDAH_FORMAT=docker` Overrides the first `FROM` instruction within the Containerfile. If there are multiple FROM instructions in a Containerfile, only the first is changed. -With the remote podman client, not all container transports will work as -expected. For example, oci-archive:/x.tar will reference /x.tar on the remote +With the remote podman client, not all container transports work as +expected. For example, oci-archive:/x.tar references /x.tar on the remote machine instead of on the client. When using podman remote clients it is best to restrict use to *containers-storage*, and *docker:// transports*. @@ -334,7 +333,7 @@ For the annotation conditions, buildah uses any annotations set in the generated For the bind-mount conditions, only mounts explicitly requested by the caller via --volume are considered. Bind mounts that buildah inserts by default (e.g. /dev/shm) are not considered. -If --hooks-dir is unset for root callers, Buildah will currently default to /usr/share/containers/oci/hooks.d and /etc/containers/oci/hooks.d in order of increasing precedence. Using these defaults is deprecated, and callers should migrate to explicitly setting --hooks-dir. +If --hooks-dir is unset for root callers, Buildah currently defaults to /usr/share/containers/oci/hooks.d and /etc/containers/oci/hooks.d in order of increasing precedence. Using these defaults is deprecated. Migrate to explicitly setting --hooks-dir. @@option http-proxy @@ -349,14 +348,14 @@ Path to an alternative .containerignore file. #### **--iidfile**=*ImageIDfile* Write the built image's ID to the file. When `--platform` is specified more -than once, attempting to use this option will trigger an error. +than once, attempting to use this option triggers an error. #### **--ipc**=*how* Sets the configuration for IPC namespaces when handling `RUN` instructions. The configured value can be "" (the empty string) or "container" to indicate -that a new IPC namespace should be created, or it can be "host" to indicate -that the IPC namespace in which `podman` itself is being run should be reused, +that a new IPC namespace is created, or it can be "host" to indicate +that the IPC namespace in which `podman` itself is being run is reused, or it can be the path to an IPC namespace which is already in use by another process. @@ -377,7 +376,7 @@ BUILDAH\_ISOLATION environment variable. `export BUILDAH_ISOLATION=oci` #### **--jobs**=*number* Run up to N concurrent stages in parallel. If the number of jobs is greater -than 1, stdin will be read from /dev/null. If 0 is specified, then there is +than 1, stdin is read from /dev/null. If 0 is specified, then there is no limit in the number of jobs that run in parallel. #### **--label**=*label* @@ -392,8 +391,8 @@ Podman to run the container with just these capabilities. Podman launches the container with just the specified capabilities, as long as this list of capabilities is a subset of the default list. -If the specified capabilities are not in the default set, Podman will -print an error message and will run the container with the default capabilities. +If the specified capabilities are not in the default set, Podman prints an error +message and runs the container with the default capabilities. #### **--layers** @@ -404,7 +403,7 @@ BUILDAH\_LAYERS environment variable. `export BUILDAH_LAYERS=true` #### **--logfile**=*filename* -Log output which would be sent to standard output and standard error to the +Log output which is sent to standard output and standard error to the specified file instead of to standard output and standard error. This option is not supported on the remote client, including Mac and Windows (excluding WSL2) machines. @@ -419,7 +418,7 @@ This option is not supported on the remote client, including Mac and Windows #### **--manifest**=*manifest* -Name of the manifest list to which the image will be added. Creates the manifest list +Name of the manifest list to which the image is added. Creates the manifest list if it does not exist. This option is useful for building multi architecture images. @@option memory @@ -463,21 +462,20 @@ do not include `History` information in their images. Set the OS of the image to be built, and that of the base image to be pulled, if the build uses one, instead of using the current operating system of the build host. Unless overridden, subsequent lookups of the same image in the -local storage will match this OS, regardless of the host. +local storage matches this OS, regardless of the host. #### **--os-feature**=*feature* -Set the name of a required operating system *feature* for the image which will -be built. By default, if the image is not based on *scratch*, the base image's +Set the name of a required operating system *feature* for the image which is built. By default, if the image is not based on *scratch*, the base image's required OS feature list is kept, if the base image specified any. This option is typically only meaningful when the image's OS is Windows. If *feature* has a trailing `-`, then the *feature* is removed from the set of -required features which will be listed in the image. +required features which is listed in the image. #### **--os-version**=*version* -Set the exact required operating system *version* for the image which will be +Set the exact required operating system *version* for the image which is built. By default, if the image is not based on *scratch*, the base image's required OS version is kept, if the base image specified one. This option is typically only meaningful when the image's OS is Windows, and is typically set in @@ -506,8 +504,8 @@ Alternatively, instead of a comma-separated sequence, the value of **--output** Sets the configuration for PID namespaces when handling `RUN` instructions. The configured value can be "" (the empty string) or "container" to indicate -that a new PID namespace should be created, or it can be "host" to indicate -that the PID namespace in which `podman` itself is being run should be reused, +that a new PID namespace is created, or it can be "host" to indicate +that the PID namespace in which `podman` itself is being run is reused, or it can be the path to a PID namespace which is already in use by another process. @@ -516,15 +514,15 @@ process. Set the *os/arch* of the built image (and its base image, when using one) to the provided value instead of using the current operating system and architecture of the host (for example `linux/arm`). Unless overridden, -subsequent lookups of the same image in the local storage will match this +subsequent lookups of the same image in the local storage matches this platform, regardless of the host. If `--platform` is set, then the values of the `--arch`, `--os`, and -`--variant` options will be overridden. +`--variant` options is overridden. The `--platform` option can be specified more than once, or given a comma-separated list of values as its argument. When more than one platform is -specified, the `--manifest` option should be used instead of the `--tag` +specified, the `--manifest` option is used instead of the `--tag` option. Os/arch pairs are those used by the Go Programming Language. In several cases @@ -534,7 +532,7 @@ values for $GOOS and $GOARCH at https://golang.org/doc/install/source#environmen and can also be found by running `go tool dist list`. While `podman build` is happy to use base images and build images for any -platform that exists, `RUN` instructions will not be able to succeed without +platform that exists, `RUN` instructions are able to succeed without the help of emulation provided by packages like `qemu-user-static`. #### **--pull**=*policy* @@ -542,8 +540,8 @@ the help of emulation provided by packages like `qemu-user-static`. Pull image policy. The default is **always**. - **always**, **true**: Always pull the image and throw an error if the pull fails. -- **missing**: Pull the image only if it could not be found in the local containers storage. Throw an error if no image could be found and the pull fails. -- **never**, **false**: Never pull the image but use the one from the local containers storage. Throw an error if no image could be found. +- **missing**: Only pull the image when it does not exist in the local containers storage. Throw an error if no image is found and the pull fails. +- **never**, **false**: Never pull the image but use the one from the local containers storage. Throw an error when no image is found. - **newer**: Pull if the image on the registry is newer than the one in the local containers storage. An image is considered to be newer when the digests are different. Comparing the time stamps is prone to errors. Pull errors are suppressed if a local image was found. #### **--quiet**, **-q** @@ -568,7 +566,7 @@ Remove intermediate containers after a successful build (default true). #### **--runtime**=*path* -The *path* to an alternate OCI-compatible runtime, which will be used to run +The *path* to an alternate OCI-compatible runtime, which is used to run commands specified by the **RUN** instruction. Note: You can also override the default runtime by setting the BUILDAH\_RUNTIME @@ -578,13 +576,13 @@ environment variable. `export BUILDAH_RUNTIME=/usr/local/bin/runc` Adds global flags for the container rutime. To list the supported flags, please consult the manpages of the selected container runtime. -Note: Do not pass the leading -- to the flag. To pass the runc flag --log-format json to buildah build, the option given would be --runtime-flag log-format=json. +Note: Do not pass the leading -- to the flag. To pass the runc flag --log-format json to buildah build, the option given is --runtime-flag log-format=json. #### **--secret**=**id=id,src=path** -Pass secret information to be used in the Containerfile for building images -in a safe way that will not end up stored in the final image, or be seen in other stages. -The secret will be mounted in the container at the default location of `/run/secrets/id`. +Pass secret information used in the Containerfile for building images +in a safe way that are not stored in the final image, or be seen in other stages. +The secret is mounted in the container at the default location of `/run/secrets/id`. To later use the secret, use the --mount option in a `RUN` instruction within a `Containerfile`: @@ -647,16 +645,16 @@ Use --stdin to be able to interact from the terminal during the build. #### **--tag**, **-t**=*imageName* -Specifies the name which will be assigned to the resulting image if the build +Specifies the name which is assigned to the resulting image if the build process completes successfully. If _imageName_ does not include a registry name, the registry name *localhost* -will be prepended to the image name. +is prepended to the image name. #### **--target**=*stageName* Set the target build stage to build. When building a Containerfile with multiple build stages, --target can be used to specify an intermediate build -stage by name as the final stage for the resulting image. Commands after the target stage will be skipped. +stage by name as the final stage for the resulting image. Commands after the target stage is skipped. #### **--timestamp**=*seconds* @@ -666,7 +664,7 @@ and written into the image manifest with every commit, causing the image's sha256 hash to be different even if the sources are exactly the same otherwise. When --timestamp is set, the created timestamp is always set to the time specified and therefore not changed, allowing the image's sha256 hash to remain the -same. All files committed to the layers of the image will be created with the +same. All files committed to the layers of the image is created with the timestamp. If the only instruction in a Containerfile is `FROM`, this flag has no effect. @@ -702,16 +700,16 @@ Unset environment variables from the final image. Sets the configuration for user namespaces when handling `RUN` instructions. The configured value can be "" (the empty string) or "container" to indicate -that a new user namespace should be created, it can be "host" to indicate that -the user namespace in which `podman` itself is being run should be reused, or +that a new user namespace is created, it can be "host" to indicate that +the user namespace in which `podman` itself is being run is reused, or it can be the path to a user namespace which is already in use by another process. #### **--userns-gid-map**=*mapping* -Directly specifies a GID mapping which should be used to set ownership, at the +Directly specifies a GID mapping to be used to set ownership, at the filesystem level, on the working container's contents. -Commands run when handling `RUN` instructions will default to being run in +Commands run when handling `RUN` instructions defaults to being run in their own user namespaces, configured using the UID and GID maps. Entries in this map take the form of one or more triples of a starting @@ -722,32 +720,32 @@ This option overrides the *remap-gids* setting in the *options* section of /etc/containers/storage.conf. If this option is not specified, but a global --userns-gid-map setting is -supplied, settings from the global option will be used. +supplied, settings from the global option is used. If none of --userns-uid-map-user, --userns-gid-map-group, or --userns-gid-map -are specified, but --userns-uid-map is specified, the GID map will be set to +are specified, but --userns-uid-map is specified, the GID map is set to use the same numeric values as the UID map. #### **--userns-gid-map-group**=*group* -Specifies that a GID mapping which should be used to set ownership, at the +Specifies that a GID mapping to be used to set ownership, at the filesystem level, on the working container's contents, can be found in entries in the `/etc/subgid` file which correspond to the specified group. -Commands run when handling `RUN` instructions will default to being run in +Commands run when handling `RUN` instructions defaults to being run in their own user namespaces, configured using the UID and GID maps. If --userns-uid-map-user is specified, but --userns-gid-map-group is not -specified, `podman` will assume that the specified user name is also a +specified, `podman` assumes that the specified user name is also a suitable group name to use as the default setting for this option. **NOTE:** When this option is specified by a rootless user, the specified mappings are relative to the rootless user namespace in the container, rather -than being relative to the host as it would be when run rootful. +than being relative to the host as it is when run rootful. #### **--userns-uid-map**=*mapping* -Directly specifies a UID mapping which should be used to set ownership, at the +Directly specifies a UID mapping to be used to set ownership, at the filesystem level, on the working container's contents. -Commands run when handling `RUN` instructions will default to being run in +Commands run when handling `RUN` instructions default to being run in their own user namespaces, configured using the UID and GID maps. Entries in this map take the form of one or more triples of a starting @@ -758,33 +756,33 @@ This option overrides the *remap-uids* setting in the *options* section of /etc/containers/storage.conf. If this option is not specified, but a global --userns-uid-map setting is -supplied, settings from the global option will be used. +supplied, settings from the global option is used. If none of --userns-uid-map-user, --userns-gid-map-group, or --userns-uid-map -are specified, but --userns-gid-map is specified, the UID map will be set to +are specified, but --userns-gid-map is specified, the UID map is set to use the same numeric values as the GID map. #### **--userns-uid-map-user**=*user* -Specifies that a UID mapping which should be used to set ownership, at the +Specifies that a UID mapping to be used to set ownership, at the filesystem level, on the working container's contents, can be found in entries in the `/etc/subuid` file which correspond to the specified user. -Commands run when handling `RUN` instructions will default to being run in +Commands run when handling `RUN` instructions defaults to being run in their own user namespaces, configured using the UID and GID maps. If --userns-gid-map-group is specified, but --userns-uid-map-user is not -specified, `podman` will assume that the specified group name is also a +specified, `podman` assumes that the specified group name is also a suitable user name to use as the default setting for this option. **NOTE:** When this option is specified by a rootless user, the specified mappings are relative to the rootless user namespace in the container, rather -than being relative to the host as it would be when run rootful. +than being relative to the host as it is when run rootful. #### **--uts**=*how* Sets the configuration for UTS namespaces when handling `RUN` instructions. The configured value can be "" (the empty string) or "container" to indicate -that a new UTS namespace should be created, or it can be "host" to indicate -that the UTS namespace in which `podman` itself is being run should be reused, +that a new UTS namespace to be created, or it can be "host" to indicate +that the UTS namespace in which `podman` itself is being run is reused, or it can be the path to a UTS namespace which is already in use by another process. @@ -830,7 +828,7 @@ The `:U` suffix tells Podman to use the correct host UID and GID based on the UID and GID within the namespace, to change recursively the owner and group of the source volume. -**Warning** use with caution since this will modify the host filesystem. +**Warning** use with caution since this modifies the host filesystem. `Labeling Volume Mounts` @@ -861,7 +859,7 @@ For example, if a user wanted to volume mount their entire home directory into t temporary storage using the Overlay file system. The `RUN` command containers are allowed to modify contents within the mountpoint and are stored in the container storage in a separate directory. In Overlay FS terms the source -directory will be the lower, and the container storage directory will be the +directory is the lower, and the container storage directory is the upper. Modifications to the mount point are destroyed when the `RUN` command finishes executing, similar to a tmpfs mount point. @@ -884,14 +882,14 @@ overlay mount can cause unexpected failures. Do not modify the directory until the container finishes running. By default bind mounted volumes are `private`. That means any mounts done -inside containers will not be visible on the host and vice versa. This behavior +inside containers are not be visible on the host and vice versa. This behavior can be changed by specifying a volume mount propagation property. When the mount propagation policy is set to `shared`, any mounts completed -inside the container on that volume will be visible to both the host and +inside the container on that volume is visible to both the host and container. When the mount propagation policy is set to `slave`, one way mount -propagation is enabled and any mounts completed on the host for that volume will -be visible only inside of the container. To control the mount propagation +propagation is enabled and any mounts completed on the host for that volume is +visible only inside of the container. To control the mount propagation property of volume use the `:[r]shared`, `:[r]slave` or `:[r]private` propagation flag. For mount propagation to work on the source mount point (mount point where source dir is mounted on) has to have the right propagation properties. @@ -910,7 +908,7 @@ and if nothing is there that means the mount is `private`. [[1]](#Footnote1 To change propagation properties of a mount point use the `mount` command. For example, to bind mount the source directory `/foo` do `mount --bind /foo /foo` and `mount --make-private --make-shared /foo`. This -will convert /foo into a `shared` mount point. The propagation properties of +converts /foo into a `shared` mount point. The propagation properties of the source mount can be changed directly. For instance if `/` is the source mount for `/foo`, then use `mount --make-shared /` to convert `/` into a `shared` mount. @@ -987,7 +985,7 @@ context. #### Building an image using a URL to a Containerfile - Podman will download the Containerfile to a temporary location and then use + Podman downloads the Containerfile to a temporary location and then use it as the build context. ``` @@ -996,9 +994,9 @@ $ podman build https://10.10.10.1/podman/Containerfile #### Building an image using a Git repository - Podman will clone the specified GitHub repository to a temporary location and -use it as the context. The Containerfile at the root of the repository will be -used and it only works if the GitHub repository is a dedicated repository. + Podman clones the specified GitHub repository to a temporary location and +use it as the context. The Containerfile at the root of the repository is used +and it only works if the GitHub repository is a dedicated repository. ``` $ podman build https://github.com/scollier/purpletest @@ -1008,9 +1006,9 @@ $ podman build https://github.com/scollier/purpletest #### Building an image using a URL to an archive - Podman will fetch the archive file, decompress it, and use its contents as the + Podman fetches the archive file, decompress it, and use its contents as the build context. The Containerfile at the root of the archive and the rest of the -archive will get used as the context of the build. Passing the +archive are used as the context of the build. Passing the `-f PATH/Containerfile` option as well tells the system to look for that file inside the contents of the archive. @@ -1033,13 +1031,13 @@ directory, when executing COPY and ADD directives in the Containerfile/Dockerfile The .containerignore and .dockerignore files use the same syntax; if both -are in the context directory, podman build will only use .containerignore. +are in the context directory, podman build only uses .containerignore. Users can specify a series of Unix shell globs in a .containerignore file to identify files/directories to exclude. Podman supports a special wildcard string `**` which matches any number of -directories (including zero). For example, **/*.go will exclude all files that +directories (including zero). For example, **/*.go excludes all files that end with .go that are found in all directories. Example .containerignore file: @@ -1079,14 +1077,14 @@ https://github.com/containers/common/blob/main/docs/containerignore.5.md **registries.conf** (`/etc/containers/registries.conf`) registries.conf is the configuration file which specifies which container -registries should be consulted when completing image names which do not include +registries is consulted when completing image names which do not include a registry or domain portion. ## Troubleshooting ### lastlog sparse file -Using a useradd command within a Containerfile with a large UID/GID will create +Using a useradd command within a Containerfile with a large UID/GID creates a large sparse file `/var/log/lastlog`. This can cause the build to hang forever. Go language does not support sparse files correctly, which can lead to some huge files being created in the container image. @@ -1108,7 +1106,7 @@ December 2017, Originally compiled by Tom Sweeney `` ## FOOTNOTES 1: The Podman project is committed to inclusivity, a core value of open source. The `master` and `slave` mount propagation -terminology used here is problematic and divisive, and should be changed. +terminology used here is problematic and divisive, and needs to be changed. However, these terms are currently used within the Linux kernel and must be used as-is at this time. When the kernel maintainers rectify this usage, Podman will follow suit immediately. diff --git a/docs/source/markdown/podman-commit.1.md b/docs/source/markdown/podman-commit.1.md index fd3c3835f7..23e6bac2f0 100644 --- a/docs/source/markdown/podman-commit.1.md +++ b/docs/source/markdown/podman-commit.1.md @@ -9,10 +9,10 @@ podman\-commit - Create new image based on the changed container **podman container commit** [*options*] *container* [*image*] ## DESCRIPTION -**podman commit** creates an image based on a changed *container*. The author of the image can be set using the **--author** OPTION. Various image instructions can be configured with the **--change** OPTION and a commit message can be set using the **--message** OPTION. The *container* and its processes aren't paused while the image is committed. If this is not desired, the **--pause** OPTION can be set to *true*. When the commit is complete, Podman will print out the ID of the new image. +**podman commit** creates an image based on a changed *container*. The author of the image can be set using the **--author** OPTION. Various image instructions can be configured with the **--change** OPTION and a commit message can be set using the **--message** OPTION. The *container* and its processes aren't paused while the image is committed. If this is not desired, the **--pause** OPTION can be set to *true*. When the commit is complete, Podman prints out the ID of the new image. -If `image` does not begin with a registry name component, `localhost` will be added to the name. -If `image` is not provided, the values for the `REPOSITORY` and `TAG` values of the created image will each be set to ``. +If `image` does not begin with a registry name component, `localhost` is added to the name. +If `image` is not provided, the values for the `REPOSITORY` and `TAG` values of the created image is set to ``. ## OPTIONS #### **--author**, **-a**=*author* diff --git a/docs/source/markdown/podman-completion.1.md b/docs/source/markdown/podman-completion.1.md index f603055201..e58b8fe6f6 100644 --- a/docs/source/markdown/podman-completion.1.md +++ b/docs/source/markdown/podman-completion.1.md @@ -42,7 +42,7 @@ Shell completion needs to be already enabled in the environment. The following c To make it available for all zsh sessions run:\ **podman completion -f "${fpath[1]}/_podman" zsh** -Once the shell is reloaded the auto-completion should be working. +Once the shell is reloaded the auto-completion works. ### FISH diff --git a/docs/source/markdown/podman-container-checkpoint.1.md b/docs/source/markdown/podman-container-checkpoint.1.md index b68dffc8a6..254200f8d0 100644 --- a/docs/source/markdown/podman-container-checkpoint.1.md +++ b/docs/source/markdown/podman-container-checkpoint.1.md @@ -36,7 +36,7 @@ all of the checkpoint files. The content of this image layer is in the same form checkpoint created with **--export**. A checkpoint image can be pushed to a standard container registry and pulled on a different system to enable container migration. In addition, the image can be exported with **podman image save** and -inspected with **podman inspect**. Inspecting a checkpoint image would display +inspected with **podman inspect**. Inspecting a checkpoint image displays additional information, stored as annotations, about the host environment used to do the checkpoint: @@ -107,7 +107,7 @@ The default is **false**.\ This OPTION must be used in combination with the **--export, -e** OPTION. When this OPTION is specified, the content of volumes associated with -the *container* will not be included into the checkpoint tar.gz file.\ +the *container* is not included into the checkpoint tar.gz file.\ The default is **false**. #### **--keep**, **-k** @@ -117,8 +117,7 @@ The default is **false**. #### **--latest**, **-l** -Instead of providing the *container ID* or *name*, use the last created *container*. If other methods than Podman are used to run *containers* such as `CRI-O`, the last started *container* could be from either of those methods.\ -The default is **false**.\ +Instead of providing the *container ID* or *name*, use the last created *container*. The default is **false**. *IMPORTANT: This OPTION is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines. This OPTION does not need a container name or ID as input argument.* #### **--leave-running**, **-R** @@ -129,14 +128,14 @@ The default is **false**. #### **--pre-checkpoint**, **-P** Dump the *container's* memory information only, leaving the *container* running. Later -operations will supersede prior dumps. It only works on `runc 1.0-rc3` or `higher`.\ +operations supersedes prior dumps. It only works on `runc 1.0-rc3` or `higher`.\ The default is **false**. The functionality to only checkpoint the memory of the container and in a second checkpoint only write out the memory pages which have changed since the first checkpoint relies on the Linux kernel's soft-dirty bit, which is not available on all systems as it depends on the system architecture and the configuration -of the Linux kernel. Podman will verify if the current system supports this +of the Linux kernel. Podman verifies if the current system supports this functionality and return an error if the current system does not support it. #### **--print-stats** @@ -188,7 +187,7 @@ The default is **false**.\ *IMPORTANT: This OPTION is not available with __--pre-checkpoint__*. This option requires that the option __--pre-checkpoint__ has been used before on the -same container. Without an existing pre-checkpoint, this option will fail. +same container. Without an existing pre-checkpoint, this option fails. Also see __--pre-checkpoint__ for additional information about __--pre-checkpoint__ availability on different systems. diff --git a/docs/source/markdown/podman-container-cleanup.1.md b/docs/source/markdown/podman-container-cleanup.1.md index 744f7b41bd..b6b4db6c6d 100644 --- a/docs/source/markdown/podman-container-cleanup.1.md +++ b/docs/source/markdown/podman-container-cleanup.1.md @@ -7,7 +7,7 @@ podman\-container\-cleanup - Clean up the container's network and mountpoints **podman container cleanup** [*options*] *container* [*container* ...] ## DESCRIPTION -**podman container cleanup** cleans up exited *containers* by removing all mountpoints and network configuration from the host. The *container name* or *ID* can be used. The cleanup command does not remove the *containers*. Running *containers* will not be cleaned up.\ +**podman container cleanup** cleans up exited *containers* by removing all mountpoints and network configurations from the host. The *container name* or *ID* can be used. The cleanup command does not remove the *containers*. Running *containers* are not cleaned up.\ Sometimes container mount points and network stacks can remain if the podman command was killed or the *container* ran in daemon mode. This command is automatically executed when *containers* are run in daemon mode by the `conmon process` when the *container* exits. ## OPTIONS @@ -20,13 +20,12 @@ The default is **false**.\ #### **--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*.\ +It 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 are cleaned up; if it is, the exec session is removed from the *container*.\ *IMPORTANT: Conflicts with **--rmi** as the container is not being cleaned up so the image cannot be removed.* #### **--latest**, **-l** -Instead of providing the *container ID* or *name*, use the last created *container*. If other methods than Podman are used to run *containers* such as `CRI-O`, the last started *container* could be from either of those methods.\ -The default is **false**.\ +Instead of providing the *container ID* or *name*, use the last created *container*. The default is **false**. *IMPORTANT: This OPTION is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines. This OPTION does not need a container name or ID as input argument.* #### **--rm** diff --git a/docs/source/markdown/podman-container-clone.1.md.in b/docs/source/markdown/podman-container-clone.1.md.in index 9902caa0f4..fd26774623 100644 --- a/docs/source/markdown/podman-container-clone.1.md.in +++ b/docs/source/markdown/podman-container-clone.1.md.in @@ -62,16 +62,16 @@ Force removal of the original container that we are cloning. Can only be used in @@option memory -If no memory limits are specified, the original container's will be used. +If no memory limits are specified, the original container's memory limits are used. @@option memory-reservation -If unspecified, memory reservation will be the same as memory limit from the +If unspecified, memory reservation is the same as memory limit from the container being cloned. @@option memory-swap -If unspecified, the container being cloned will be used to derive +If unspecified, the container being cloned is used to derive the swap value. @@option memory-swappiness @@ -83,7 +83,7 @@ Set a custom name for the cloned container. The default if not specified is of t #### **--pod**=*name* Clone the container in an existing pod. It is helpful to move a container to an -existing pod. The container will join the pod shared namespaces, losing its configuration +existing pod. The container joins the pod shared namespaces, losing its configuration that conflicts with the shared namespaces. #### **--run** diff --git a/docs/source/markdown/podman-container-diff.1.md.in b/docs/source/markdown/podman-container-diff.1.md.in index ceaa5e9c15..d66d65644e 100644 --- a/docs/source/markdown/podman-container-diff.1.md.in +++ b/docs/source/markdown/podman-container-diff.1.md.in @@ -7,7 +7,7 @@ podman\-container\-diff - Inspect changes on a container's filesystem **podman container diff** [*options*] *container* [*container*] ## DESCRIPTION -Displays changes on a container's filesystem. The container will be compared to its parent layer or the second argument when given. +Displays changes on a container's filesystem. The container is compared to its parent layer or the second argument when given. The output is prefixed with the following symbols: diff --git a/docs/source/markdown/podman-container-exists.1.md b/docs/source/markdown/podman-container-exists.1.md index 49b74f1ee4..90fab58bb4 100644 --- a/docs/source/markdown/podman-container-exists.1.md +++ b/docs/source/markdown/podman-container-exists.1.md @@ -7,8 +7,8 @@ podman\-container\-exists - Check if a container exists in local storage **podman container exists** [*options*] *container* ## DESCRIPTION -**podman container exists** checks if a container exists in local storage. The *container ID* or *name* is used as input. Podman will return an exit code -of `0` when the container is found. A `1` will be returned otherwise. An exit code of `125` indicates there was an issue accessing the local storage. +**podman container exists** checks if a container exists in local storage. The *container ID* or *name* is used as input. Podman returns an exit code +of `0` when the container is found. A `1` is returned otherwise. An exit code of `125` indicates there was an issue accessing the local storage. ## OPTIONS #### **--external** diff --git a/docs/source/markdown/podman-container-inspect.1.md.in b/docs/source/markdown/podman-container-inspect.1.md.in index b016df8758..a8b1a8bb1c 100644 --- a/docs/source/markdown/podman-container-inspect.1.md.in +++ b/docs/source/markdown/podman-container-inspect.1.md.in @@ -8,8 +8,8 @@ podman\-container\-inspect - Display a container's configuration ## DESCRIPTION -This displays the low-level information on containers identified by name or ID. By default, this will render -all results in a JSON array. If a format is specified, the given template will be executed for each result. +This displays the low-level information on containers identified by name or ID. By default, this renders +all results in a JSON array. If a format is specified, the given template is executed for each result. ## OPTIONS diff --git a/docs/source/markdown/podman-container-restore.1.md b/docs/source/markdown/podman-container-restore.1.md index a5347fa485..35115c1e3e 100644 --- a/docs/source/markdown/podman-container-restore.1.md +++ b/docs/source/markdown/podman-container-restore.1.md @@ -58,7 +58,7 @@ The default is **false**. This option must be used in combination with the **--import, -i** option. When restoring *containers* from a checkpoint tar.gz file with this option, -the content of associated volumes will not be restored.\ +the content of associated volumes are not restored.\ The default is **false**. #### **--import**, **-i**=*file* @@ -67,10 +67,10 @@ Import a checkpoint tar.gz file, which was exported by Podman. This can be used to import a checkpointed *container* from another host.\ *IMPORTANT: This OPTION does not need a container name or ID as input argument.* -During the import of a checkpoint file Podman will select the same container runtime +During the import of a checkpoint file Podman selects the same container runtime which was used during checkpointing. This is especially important if a specific -(non-default) container runtime was specified during container creation. Podman will -also abort the restore if the container runtime specified during restore does +(non-default) container runtime was specified during container creation. Podman +also aborts the restore if the container runtime specified during restore does not much the container runtime used for container creation. #### **--import-previous**=*file* @@ -89,13 +89,12 @@ files for further analysis. This includes the checkpoint directory with all files created during checkpointing. The size required by the checkpoint directory is roughly the same as the amount of memory required by the processes in the checkpointed *container*.\ -Without the **--keep**, **-k** option the checkpoint will be consumed and cannot be used again.\ +Without the **--keep**, **-k** option, the checkpoint is consumed and cannot be used again.\ The default is **false**. #### **--latest**, **-l** -Instead of providing the *container ID* or *name*, use the last created *container*. If other tools than Podman are used to run *containers* such as `CRI-O`, the last started *container* could be from either tool.\ -The default is **false**.\ +Instead of providing the *container ID* or *name*, use the last created *container*. The default is **false**. *IMPORTANT: This OPTION is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines. This OPTION does not need a container name or ID as input argument.* #### **--name**, **-n**=*name* @@ -103,9 +102,9 @@ The default is **false**.\ If a *container* is restored from a checkpoint tar.gz file it is possible to rename it with **--name, -n**. This way it is possible to restore a *container* from a checkpoint multiple times with different names. -If the **--name, -n** option is used, Podman will not attempt to assign the same IP +If the **--name, -n** option is used, Podman does not attempt to assign the same IP address to the *container* it was using before checkpointing as each IP address can only -be used once and the restored *container* will have another IP address. This also means +be used once, and the restored *container* has another IP address. This also means that **--name, -n** cannot be used in combination with **--tcp-established**.\ *IMPORTANT: This OPTION is only available for a checkpoint image or in combination with __--import, -i__.* diff --git a/docs/source/markdown/podman-container-runlabel.1.md.in b/docs/source/markdown/podman-container-runlabel.1.md.in index 9ad0f802a0..6462fb3f00 100644 --- a/docs/source/markdown/podman-container-runlabel.1.md.in +++ b/docs/source/markdown/podman-container-runlabel.1.md.in @@ -7,20 +7,20 @@ podman-container-runlabel - Executes a command as described by a container-image **podman container runlabel** [*options*] *label* *image* [*arg...*] ## DESCRIPTION -**podman container runlabel** reads the specified `label` of the `image` and executes it as command on the host. If the label does not exist, Podman will exit with an error. Additional arguments will be appended to the command. +**podman container runlabel** reads the specified `label` of the `image` and executes it as command on the host. If the label does not exist, Podman exits with an error. Additional arguments are appended to the command. -Historically, container images describe the contents (e.g., layers) and how a container runtime (e.g., crun(1) or runc(1)) should execute the container. For instance, an image may set the environment and the command in its configuration. However, a container image cannot directly specify how a container engine such as Podman should execute it. For instance, an image configuration does not include information about log drivers, namespaces or which capabilities it needs to run correctly. +Historically, container images describe the contents (e.g., layers) and how a container runtime (e.g., crun(1) or runc(1)) executes the container. For instance, an image may set the environment and the command in its configuration. However, a container image cannot directly specify how a container engine such as Podman executes it. For instance, an image configuration does not include information about log drivers, namespaces, or which capabilities it needs to run correctly. -`podman container runlabel` addresses the limitation of container images in a simple yet efficient way. Podman will read the contents of the label and interpret it as a command that will be executed on the host. This way an image can describe exactly how it should be executed by Podman. For instance, a label with the content `/usr/bin/podman run -d --pid=host --privileged \${IMAGE}` instructs the image to be executed in a detached, privileged container that is using the PID namespace of the host. This lifts the self-description of a container image from "what" to "how". +`podman container runlabel` addresses the limitation of container images in a simple yet efficient way. Podman reads the contents of the label and interpret it as a command that is executed on the host. This way an image can describe exactly how it is executed by Podman. For instance, a label with the content `/usr/bin/podman run -d --pid=host --privileged \${IMAGE}` instructs the image to be executed in a detached, privileged container that is using the PID namespace of the host. This lifts the self-description of a container image from "what" to "how". Please note that the `runlabel` command is intended to be run in trusted environments exclusively. Using the command on untrusted images is not recommended. ## VARIABLES -The contents of a label may refer to the following variables which will be substituted while processing the label. +The contents of a label may refer to the following variables which is substituted while processing the label. **IMAGE** -The name of the image. When executing `podman container runlabel label fedora` the `IMAGE` variable will be replaced with `fedora`. Valid formats are `IMAGE`, `$IMAGE`, `${IMAGE}` and `=IMAGE`. +The name of the image. When executing `podman container runlabel label fedora` the `IMAGE` variable is replaced with `fedora`. Valid formats are `IMAGE`, `$IMAGE`, `${IMAGE}` and `=IMAGE`. **NAME** As specified by the `--name` option. The format is identical to the one of the IMAGE attribute. @@ -38,7 +38,7 @@ Will be replaced with the current working directory. #### **--display** -Display the label's value of the image having populated its environment variables. The runlabel command will not execute if --display is specified. +Display the label's value of the image having populated its environment variables. The runlabel command is not executed if --display is specified. #### **--help**, **-h** Print usage statement @@ -53,7 +53,7 @@ Suppress output information when pulling images #### **--replace** -If a container exists of the default or given name, as needed it will be stopped, deleted and a new container will be created from this image. +If a container exists with the current name, it is stopped, deleted and a new container is created from this image. @@option tls-verify diff --git a/docs/source/markdown/podman-cp.1.md b/docs/source/markdown/podman-cp.1.md index c87e8b42b4..eaf996593c 100644 --- a/docs/source/markdown/podman-cp.1.md +++ b/docs/source/markdown/podman-cp.1.md @@ -59,7 +59,7 @@ Further note that `podman cp` does not support globbing (e.g., `cp dir/*.txt`). #### **--archive**, **-a** Archive mode (copy all UID/GID information). -When set to true, files copied to a container will have changed ownership to the primary UID/GID of the container. +When set to true, files copied to a container have changed ownership to the primary UID/GID of the container. When set to false, maintain UID/GID from archive sources instead of changing them to the primary UID/GID of the destination container. The default is **true**. diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in index 41057f18cb..0f50b57d74 100644 --- a/docs/source/markdown/podman-create.1.md.in +++ b/docs/source/markdown/podman-create.1.md.in @@ -24,7 +24,7 @@ man pages. ## IMAGE The image is specified using transport:path format. If no transport is specified, the `docker` (container registry) -transport will be used by default. For remote Podman, including Mac and Windows (excluding WSL2) machines, `docker` is the only allowed transport. +transport is used by default. For remote Podman, including Mac and Windows (excluding WSL2) machines, `docker` is the only allowed transport. **dir:**_path_ An existing local directory _path_ storing the manifest, layer tarballs and signatures as individual files. This @@ -36,9 +36,9 @@ is a non-standardized format, primarily useful for debugging or noninvasive cont **docker://**_docker-reference_ (Default) An image reference stored in a remote container image registry. Example: "quay.io/podman/stable:latest". The reference can include a path to a specific registry; if it does not, the -registries listed in registries.conf will be queried to find a matching image. +registries listed in registries.conf is queried to find a matching image. By default, credentials from `podman login` (stored at -$XDG_RUNTIME_DIR/containers/auth.json by default) will be used to authenticate; +$XDG_RUNTIME_DIR/containers/auth.json by default) is used to authenticate; otherwise it falls back to using credentials in $HOME/.docker/config.json. $ podman create registry.fedoraproject.org/fedora:latest echo hello @@ -118,7 +118,7 @@ and specified with a _tag_. @@option device Note: if the user only has access rights via a group, accessing the device -from inside a rootless container will fail. Use the `--group-add keep-groups` +from inside a rootless container fails. Use the `--group-add keep-groups` flag to pass the user's supplementary group access into the container. @@option device-cgroup-rule @@ -207,11 +207,11 @@ but before regular pod containers are started. Init containers are useful for r setup operations for the pod's applications. Valid values for `init-ctr` type are *always* or *once*. The *always* value -means the container will run with each and every `pod start`, whereas the *once* -value means the container will only run once when the pod is started and then the container is removed. +means the container runs with each and every `pod start`, whereas the *once* +value means the container only runs once when the pod is started and then the container is removed. -Init containers are only run on pod `start`. Restarting a pod will not execute any init -containers should they be present. Furthermore, init containers can only be created in a +Init containers are only run on pod `start`. Restarting a pod does not execute +any init containers. Furthermore, init containers can only be created in a pod when that pod is not running. @@option init-path @@ -252,7 +252,7 @@ pod when that pod is not running. Invalid if using **--dns**, **--dns-option**, or **--dns-search** with **--network** set to **none** or **container:**_id_. -If used together with **--pod**, the container will not join the pod's network namespace. +If used together with **--pod**, the container does not join the pod's network namespace. @@option network-alias @@ -288,7 +288,7 @@ This option conflicts with **--add-host**. @@option publish -**Note:** If a container will be run within a pod, it is not necessary to publish the port for +**Note:** If a container runs within a pod, it is not necessary to publish the port for the containers in the pod. The port must only be published by the pod itself. Pod network stacks act like the network stack on the host - when there are a variety of containers in the pod, and programs in the container, all sharing a single interface and IP address, and @@ -426,7 +426,7 @@ $ podman create --tz=US/Eastern alpine date ### Adding dependency containers -Podman will make sure the first container, container1, is running before the second container (container2) is started. +Podman makes sure the first container, container1, is running before the second container (container2) is started. ``` $ podman create --name container1 -t -i fedora bash @@ -489,10 +489,10 @@ Environment variables within containers can be set using multiple different opti Precedence order (later entries override earlier entries): - **--env-host** : Host environment of the process executing Podman is added. -- **--http-proxy**: By default, several environment variables will be passed in from the host, such as **http_proxy** and **no_proxy**. See **--http-proxy** for details. +- **--http-proxy**: By default, several environment variables are passed in from the host, such as **http_proxy** and **no_proxy**. See **--http-proxy** for details. - Container image : Any environment variables specified in the container image. - **--env-file** : Any environment variables specified via env-files. If multiple files specified, then they override each other in order of entry. -- **--env** : Any environment variables specified will override previous settings. +- **--env** : Any environment variables specified overrides previous settings. Create containers and set the environment ending with a __*__. The trailing __*__ glob functionality is only active when no value is specified: @@ -541,4 +541,4 @@ September 2014, updated by Sven Dowideit `` August 2014, updated by Sven Dowideit `` ## FOOTNOTES -1: The Podman project is committed to inclusivity, a core value of open source. The `master` and `slave` mount propagation terminology used here is problematic and divisive, and should be changed. However, these terms are currently used within the Linux kernel and must be used as-is at this time. When the kernel maintainers rectify this usage, Podman will follow suit immediately. +1: The Podman project is committed to inclusivity, a core value of open source. The `master` and `slave` mount propagation terminology used here is problematic and divisive, and needs to be changed. However, these terms are currently used within the Linux kernel and must be used as-is at this time. When the kernel maintainers rectify this usage, Podman will follow suit immediately. diff --git a/docs/source/markdown/podman-diff.1.md.in b/docs/source/markdown/podman-diff.1.md.in index 1e2bd21d1a..70de724bce 100644 --- a/docs/source/markdown/podman-diff.1.md.in +++ b/docs/source/markdown/podman-diff.1.md.in @@ -7,7 +7,7 @@ podman\-diff - Inspect changes on a container or image's filesystem **podman diff** [*options*] *container|image* [*container|image*] ## DESCRIPTION -Displays changes on a container or image's filesystem. The container or image will be compared to its parent layer or the second argument when given. +Displays changes on a container or image's filesystem. The container or image is compared to its parent layer or the second argument when given. The output is prefixed with the following symbols: diff --git a/docs/source/markdown/podman-events.1.md b/docs/source/markdown/podman-events.1.md index 5de46724b3..b23b6c430b 100644 --- a/docs/source/markdown/podman-events.1.md +++ b/docs/source/markdown/podman-events.1.md @@ -10,16 +10,16 @@ podman\-events - Monitor Podman events ## DESCRIPTION -Monitor and print events that occur in Podman. Each event will include a timestamp, +Monitor and print events that occur in Podman. Each event includes a timestamp, a type, a status, name (if applicable), and image (if applicable). The default logging mechanism is *journald*. This can be changed in containers.conf by changing the `events_logger` value to `file`. Only `file` and `journald` are accepted. A `none` logger is also -available but this logging mechanism completely disables events; nothing will be reported by +available, but this logging mechanism completely disables events; nothing is reported by `podman events`. By default, streaming mode is used, printing new events as they occur. Previous events can be listed via `--since` and `--until`. -The *container* event type will report the follow statuses: +The *container* event type reports the follow statuses: * attach * checkpoint * cleanup @@ -48,7 +48,7 @@ The *container* event type will report the follow statuses: * unmount * unpause -The *pod* event type will report the follow statuses: +The *pod* event type reports the follow statuses: * create * kill * pause @@ -57,7 +57,7 @@ The *pod* event type will report the follow statuses: * stop * unpause -The *image* event type will report the following statuses: +The *image* event type reports the following statuses: * loadFromArchive, * mount * pull @@ -68,11 +68,11 @@ The *image* event type will report the following statuses: * unmount * untag -The *system* type will report the following statuses: +The *system* type reports the following statuses: * refresh * renumber -The *volume* type will report the following statuses: +The *volume* type reports the following statuses: * create * prune * remove @@ -137,7 +137,7 @@ Stream events and do not exit after reading the last known event (default *true* Show all events created until the given timestamp The *since* and *until* values can be RFC3339Nano time stamps or a Go duration string such as 10m, 5h. If no -*since* or *until* values are provided, only new events will be shown. +*since* or *until* values are provided, only new events are shown. ## JOURNALD IDENTIFIERS diff --git a/docs/source/markdown/podman-exec.1.md.in b/docs/source/markdown/podman-exec.1.md.in index 089a4723d8..cf54d2d225 100644 --- a/docs/source/markdown/podman-exec.1.md.in +++ b/docs/source/markdown/podman-exec.1.md.in @@ -15,7 +15,7 @@ podman\-exec - Execute a command in a running container #### **--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. +Start the exec session, but do not attach to it. The command runs in the background, and the exec session is automatically removed when it completes. The **podman exec** command prints the ID of the exec session and exits immediately after it starts. @@option detach-keys diff --git a/docs/source/markdown/podman-generate-spec.1.md b/docs/source/markdown/podman-generate-spec.1.md index 73924df6cd..b209253a53 100644 --- a/docs/source/markdown/podman-generate-spec.1.md +++ b/docs/source/markdown/podman-generate-spec.1.md @@ -7,7 +7,7 @@ podman\-generate\-spec - Generate Specgen JSON based on containers or pods **podman generate spec** [*options*] *container | *pod* ## DESCRIPTION -**podman generate spec** will generate Specgen JSON from Podman Containers and Pods. This JSON can either be printed to a file, directly to the command line, or both. +**podman generate spec** generates SpecGen JSON from Podman Containers and Pods. This JSON can be printed to a file, directly to the command line, or both. This JSON can then be used as input for the Podman API, specifically for Podman container and pod creation. Specgen is Podman's internal structure for formulating new container-related entities. diff --git a/docs/source/markdown/podman-generate-systemd.1.md b/docs/source/markdown/podman-generate-systemd.1.md index ccccf0c022..1e2035b2af 100644 --- a/docs/source/markdown/podman-generate-systemd.1.md +++ b/docs/source/markdown/podman-generate-systemd.1.md @@ -7,8 +7,8 @@ podman\-generate\-systemd - Generate systemd unit file(s) for a container or pod **podman generate systemd** [*options*] *container|pod* ## DESCRIPTION -**podman generate systemd** will create a systemd unit file that can be used to control a container or pod. -By default, the command will print the content of the unit files to stdout. +**podman generate systemd** creates a systemd unit file that can be used to control a container or pod. +By default, the command prints the content of the unit files to stdout. Generating unit files for a pod requires the pod to be created with an infra container (see `--infra=true`). An infra container runs across the entire lifespan of a pod and is hence required for systemd to manage the life cycle of the pod's main unit. @@ -17,7 +17,7 @@ Generating unit files for a pod requires the pod to be created with an infra con - Note: The generated `podman run` command contains an `--sdnotify` option with the value taken from the container. If the container does not have any explicitly set value or the value is set to __ignore__, the value __conmon__ is used. The reason for overriding the default value __container__ is that almost no container workloads send notify messages. -Systemd would wait for a ready message that never comes, if the value __container__ is used for a container +Systemd waits for a ready message that never comes, if the value __container__ is used for a container that does not send notify messages. The use of the default value might have been unintentional by the user, therefore the overridden default value._ @@ -38,7 +38,7 @@ active Add the systemd unit after (`After=`) option, that ordering dependencies between the list of dependencies and this service. This option may be specified more than once. -User-defined dependencies will be appended to the generated unit file, but any existing options such as needed or defined by default (e.g. `online.target`) will **not** be removed or overridden. +User-defined dependencies are appended to the generated unit file, but any existing options needed or defined by default (e.g., `online.target`) are **not** removed or overridden. #### **--container-prefix**=*prefix* @@ -48,17 +48,17 @@ Set the systemd unit name prefix for containers. The default is *container*. Set environment variables to the systemd unit files. -If an environment variable is specified without a value, Podman will check the host environment for a value and set the variable only if it is set on the host. As a special case, if an environment variable ending in __*__ is specified without a value, Podman will search the host environment for variables starting with the prefix and will add those variables to the systemd unit files. +If an environment variable is specified without a value, Podman checks the host environment for a value and sets the variable only if it is set on the host. As a special case, if an environment variable ending in __*__ is specified without a value, Podman searches the host environment for variables starting with the prefix and adds those variables to the systemd unit files. #### **--files**, **-f** -Generate files instead of printing to stdout. The generated files are named {container,pod}-{ID,name}.service and will be placed in the current working directory. +Generate files instead of printing to stdout. The generated files are named {container,pod}-{ID,name}.service and are placed in the current working directory. -Note: On a system with SELinux enabled, the generated files will inherit contexts from the current working directory. Depending on the SELinux setup, changes to the generated files using `restorecon`, `chcon`, or `semanage` may be required to allow systemd to access these files. Alternatively, use the `-Z` option when running `mv` or `cp`. +Note: On a system with SELinux enabled, the generated files inherits contexts from the current working directory. Depending on the SELinux setup, changes to the generated files using `restorecon`, `chcon`, or `semanage` may be required to allow systemd to access these files. Alternatively, use the `-Z` option when running `mv` or `cp`. #### **--format**=*format* -Print the created units in specified format (json). If `--files` is specified the paths to the created files will be printed instead of the unit content. +Print the created units in the specified format (json). If `--files` is specified, the paths to the created files are printed instead of the unit content. #### **--name**, **-n** @@ -66,7 +66,7 @@ Use the name of the container for the start, stop, and description in the unit f #### **--new** -Using this flag will yield unit files that do not expect containers and pods to exist. Instead, new containers and pods are created based on their configuration files. The unit files are created best effort and may need to be further edited; please review the generated files carefully before using them in production. +This option yields unit files that do not expect containers and pods to exist. Instead, new containers and pods are created based on their configuration files. The unit files are created best effort and may need further editing; please review the generated files carefully before using them in production. Note that `--new` only works on containers and pods created directly via Podman (i.e., `podman [container] {create,run}` or `podman pod create`). It does not work on containers or pods created via the REST API or via `podman kube play`. For `podman kube play`, please use the `podman-kube@.service` systemd template instead. @@ -87,7 +87,7 @@ Set the systemd unit requires (`Requires=`) option. Similar to wants, but declar 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* unless the container was created with a custom restart policy. -Note that generating a unit without `--new` on a container with a custom restart policy can lead to issues on shutdown; systemd will attempt to stop the unit while Podman tries to restart it. It is recommended to to create the container without `--restart` and use the `--restart-policy` option instead when generating the unit file. +Note that generating a unit without `--new` on a container with a custom restart policy can lead to issues on shutdown; systemd attempts to stop the unit while Podman tries to restart it. Creating the container without `--restart` and using the `--restart-policy` option when generating the unit file is recommended. #### **--restart-sec**=*time* @@ -110,13 +110,13 @@ Override the default stop timeout for the container with the given value in seco Add template specifiers to run multiple services from the systemd unit file. -Note that if `--new` was not set to true, it is set to true by default. However, if `--new` is set to `false` explicitly the command will fail. +Note that if `--new` was not set to true, it is set to true by default. However, the command fails if `--new` is set to `false` explicitly. #### **--wants**=*dependency_name* Add the systemd unit wants (`Wants=`) option, that this service is (weak) dependent on. This option may be specified more than once. This option does not influence the order in which services are started or stopped. -User-defined dependencies will be appended to the generated unit file, but any existing options such as needed or defined by default (e.g. `online.target`) will **not** be removed or overridden. +User-defined dependencies are appended to the generated unit file, but any existing options needed or defined by default (e.g., `online.target`) are **not** removed or overridden. ## EXAMPLES @@ -195,7 +195,7 @@ WantedBy=default.target ### Generate systemd unit files for a pod with two simple alpine containers -Note `systemctl` should only be used on the pod unit and one should not start or stop containers individually via `systemctl`, as they are managed by the pod service along with the internal infra-container. +Note `systemctl` must only be used on the pod unit and not used to start or stop containers individually. The containers are managed by the pod service along with the internal infra-container. Use `systemctl status` or `journalctl` to examine container or pod unit files. ``` diff --git a/docs/source/markdown/podman-generate.1.md b/docs/source/markdown/podman-generate.1.md index dab9a866bf..e18c1260e2 100644 --- a/docs/source/markdown/podman-generate.1.md +++ b/docs/source/markdown/podman-generate.1.md @@ -7,7 +7,7 @@ podman\-generate - Generate structured data based on containers, pods or volumes **podman generate** *subcommand* ## DESCRIPTION -The generate command will create structured output (like YAML) based on a container, pod or volume. +The generate command creates structured output (like YAML) based on a container, pod or volume. ## COMMANDS diff --git a/docs/source/markdown/podman-image-diff.1.md b/docs/source/markdown/podman-image-diff.1.md index 0e6747ee0c..d63db98fda 100644 --- a/docs/source/markdown/podman-image-diff.1.md +++ b/docs/source/markdown/podman-image-diff.1.md @@ -7,7 +7,7 @@ podman-image-diff - Inspect changes on an image's filesystem **podman image diff** [*options*] *image* [*image*] ## DESCRIPTION -Displays changes on an image's filesystem. The image will be compared to its parent layer or the second argument when given. +Displays changes on an image's filesystem. The image is compared to its parent layer or the second argument when given. The output is prefixed with the following symbols: diff --git a/docs/source/markdown/podman-image-exists.1.md b/docs/source/markdown/podman-image-exists.1.md index 7c08205bfb..71134149d6 100644 --- a/docs/source/markdown/podman-image-exists.1.md +++ b/docs/source/markdown/podman-image-exists.1.md @@ -8,8 +8,8 @@ podman-image-exists - Check if an image exists in local storage ## DESCRIPTION **podman image exists** checks if an image exists in local storage. The **ID** or **Name** -of the image may be used as input. Podman will return an exit code -of `0` when the image is found. A `1` will be returned otherwise. An exit code of `125` indicates there +of the image may be used as input. Podman returns an exit code +of `0` when the image is found. A `1` is returned otherwise. An exit code of `125` indicates there was an issue accessing the local storage. ## OPTIONS diff --git a/docs/source/markdown/podman-image-inspect.1.md b/docs/source/markdown/podman-image-inspect.1.md index 0e34817deb..b5981778f0 100644 --- a/docs/source/markdown/podman-image-inspect.1.md +++ b/docs/source/markdown/podman-image-inspect.1.md @@ -8,8 +8,7 @@ podman\-image\-inspect - Display an image's configuration ## DESCRIPTION -This displays the low-level information on images identified by name or ID. By default, this will render -all results in a JSON array. If a format is specified, the given template will be executed for each result. +This displays the low-level information on images identified by name or ID. By default, this renders all results in a JSON array. If a format is specified, the given template is executed for each result. ## OPTIONS diff --git a/docs/source/markdown/podman-image-mount.1.md b/docs/source/markdown/podman-image-mount.1.md index 301f701048..da56bd25e6 100644 --- a/docs/source/markdown/podman-image-mount.1.md +++ b/docs/source/markdown/podman-image-mount.1.md @@ -14,7 +14,7 @@ The `podman image mount` command without any arguments lists all of the currently mounted images. Rootless mode only supports mounting VFS driver, unless podman is run in a user namespace. -Use the `podman unshare` command to enter the user namespace. All other storage drivers will fail to mount. +Use the `podman unshare` command to enter the user namespace. All other storage drivers fail to mount. ## RETURN VALUE The location of the mounted file system. On error an empty string and errno is diff --git a/docs/source/markdown/podman-image-sign.1.md.in b/docs/source/markdown/podman-image-sign.1.md.in index 718b60a367..2a49976741 100644 --- a/docs/source/markdown/podman-image-sign.1.md.in +++ b/docs/source/markdown/podman-image-sign.1.md.in @@ -7,11 +7,11 @@ podman-image-sign - Create a signature for an image **podman image sign** [*options*] *image* [*image* ...] ## DESCRIPTION -**podman image sign** will create a local signature for one or more local images that have -been pulled from a registry. The signature will be written to a directory +**podman image sign** creates a local signature for one or more local images that have +been pulled from a registry. The signature is written to a directory derived from the registry configuration files in `$HOME/.config/containers/registries.d` if it exists, otherwise `/etc/containers/registries.d` (unless overridden at compile-time), see **containers-registries.d(5)** for more information. -By default, the signature will be written into `/var/lib/containers/sigstore` for root and `$HOME/.local/share/containers/sigstore` for non-root users +By default, the signature is written into `/var/lib/containers/sigstore` for root and `$HOME/.local/share/containers/sigstore` for non-root users ## OPTIONS @@ -47,7 +47,7 @@ Sign the busybox image with the identity of foo@bar.com with a user's keyring an The write (and read) location for signatures is defined in YAML-based configuration files in /etc/containers/registries.d/ for root, or $HOME/.config/containers/registries.d for non-root users. When signing -an image, Podman will use those configuration files to determine +an image, Podman uses those configuration files to determine where to write the signature based on the name of the originating registry or a default storage value unless overridden with the --directory option. For example, consider the following configuration file. @@ -57,9 +57,9 @@ docker: sigstore: file:///var/lib/containers/sigstore When signing an image preceded with the registry name 'privateregistry.example.com', -the signature will be written into sub-directories of +the signature is written into sub-directories of /var/lib/containers/sigstore/privateregistry.example.com. The use of 'sigstore' also means -the signature will be 'read' from that same location on a pull-related function. +the signature is 'read' from that same location on a pull-related function. ## SEE ALSO **[containers-certs.d(5)](https://github.com/containers/image/blob/main/docs/containers-certs.d.5.md)**, **[containers-registries.d(5)](https://github.com/containers/image/blob/main/docs/containers-registries.d.5.md)** diff --git a/docs/source/markdown/podman-image-trust.1.md.in b/docs/source/markdown/podman-image-trust.1.md.in index 5fcbeb4b3c..72a9cff7a1 100644 --- a/docs/source/markdown/podman-image-trust.1.md.in +++ b/docs/source/markdown/podman-image-trust.1.md.in @@ -17,13 +17,20 @@ as an example, `docker` is the transport and `docker.io` is the registry host. Trust is defined in **/etc/containers/policy.json** and is enforced when a user attempts to pull a remote image from a registry. The trust policy in policy.json describes a registry scope (registry and/or repository) for the trust. This trust can use public keys for signed images. -The scope of the trust is evaluated from most specific to the least specific. In other words, a policy may be defined for an entire registry. Or it could be defined for a particular repository in that registry. Or it could be defined down to a specific signed image inside of the registry. +The scope of the trust is evaluated from most specific to the least specific. In other words, a policy may be: -For example, the following list includes valid scope values that could be used in policy.json from most specific to the least specific: + * Defined to an entire registry. + * Defined to a particular repository in that registry. + * Defined to a specific signed image inside of the registry. + +The following list are examples of valid scope values used in policy.json from most specific to the least specific: docker.io/library/busybox:notlatest + docker.io/library/busybox + docker.io/library + docker.io If no configuration is found for any of these scopes, the default value (specified by using "default" instead of REGISTRY[/REPOSITORY]) is used. @@ -45,7 +52,7 @@ Trust may be updated using the command **podman image trust set** for an existin #### **--pubkeysfile**, **-f**=*KEY1* A path to an exported public key on the local system. Key paths - will be referenced in policy.json. Any path to a file may be used but locating the file in **/etc/pki/containers** is recommended. Options may be used multiple times to + are referenced in policy.json. Any path to a file may be used but locating the file in **/etc/pki/containers** is recommended. Options may be used multiple times to require an image be signed by multiple keys. The **--pubkeysfile** option is required for the **signedBy** and **sigstoreSigned** types. #### **--type**, **-t**=*value* diff --git a/docs/source/markdown/podman-image-unmount.1.md b/docs/source/markdown/podman-image-unmount.1.md index 7000b9e1c9..9aa6138309 100644 --- a/docs/source/markdown/podman-image-unmount.1.md +++ b/docs/source/markdown/podman-image-unmount.1.md @@ -21,15 +21,14 @@ An unmount can be forced with the --force flag. ## OPTIONS #### **--all**, **-a** -All of the currently mounted images will be unmounted. +All of the currently mounted images are unmounted. #### **--force**, **-f** Force the unmounting of specified images' root file system, even if other processes have mounted it. -Note: This could cause other processes that are using the file system to fail, -as the mount point could be removed without their knowledge. +Note: Other processes using the file system can fail if the mount point is removed without their knowledge. ## EXAMPLE diff --git a/docs/source/markdown/podman-init.1.md.in b/docs/source/markdown/podman-init.1.md.in index 5546d82326..9f5e516f1d 100644 --- a/docs/source/markdown/podman-init.1.md.in +++ b/docs/source/markdown/podman-init.1.md.in @@ -12,7 +12,7 @@ podman\-init - Initialize one or more containers Initialize one or more containers. You may use container IDs or names as input. Initializing a container performs all tasks necessary for starting the container (mounting filesystems, creating an OCI spec, initializing the container network) but does not start the container. -If a container is not initialized, the `podman start` and `podman run` commands will do so automatically prior to starting it. +If a container is not initialized, the `podman start` and `podman run` commands initialize it automatically prior to starting it. This command is intended to be used for inspecting or modifying the container's filesystem or OCI spec prior to starting it. This can be used to inspect the container before it runs, or debug why a container is failing to run. diff --git a/docs/source/markdown/podman-inspect.1.md.in b/docs/source/markdown/podman-inspect.1.md.in index 0b916be01f..9a5dcf2aae 100644 --- a/docs/source/markdown/podman-inspect.1.md.in +++ b/docs/source/markdown/podman-inspect.1.md.in @@ -8,10 +8,10 @@ podman\-inspect - Display a container, image, volume, network, or pod's configur ## DESCRIPTION -This displays the low-level information on containers and images identified by name or ID. By default, this will render +This displays the low-level information on containers and images identified by name or ID. By default, this renders all results in a JSON array. If the inspect type is all, the order of inspection is: containers, images, volumes, network, pods. - So, if a container has the same name as an image, then the container JSON will be returned, and so on. - If a format is specified, the given template will be executed for each result. + If a container has the same name as an image, then the container JSON is returned, and so on. + If a format is specified, the given template is executed for each result. For more inspection options, see also [podman-container-inspect(1)](podman-container-inspect.1.md), diff --git a/docs/source/markdown/podman-kill.1.md.in b/docs/source/markdown/podman-kill.1.md.in index 503e09e5f1..722d37bbb8 100644 --- a/docs/source/markdown/podman-kill.1.md.in +++ b/docs/source/markdown/podman-kill.1.md.in @@ -9,7 +9,7 @@ podman\-kill - Kill the main process in one or more containers **podman container kill** [*options*] [*container* ...] ## DESCRIPTION -The main process inside each container specified will be sent SIGKILL, or any signal specified with option --signal. +The main process inside each container specified is sent SIGKILL or any signal specified with the `--signal` option. ## OPTIONS #### **--all**, **-a** diff --git a/docs/source/markdown/podman-kube-apply.1.md b/docs/source/markdown/podman-kube-apply.1.md index c71e6dc42c..b46548ba4c 100644 --- a/docs/source/markdown/podman-kube-apply.1.md +++ b/docs/source/markdown/podman-kube-apply.1.md @@ -6,7 +6,7 @@ podman-kube-apply - Apply Kubernetes YAML based on containers, pods, or volumes **podman kube apply** [*options*] [*container...* | *pod...* | *volume...*] ## DESCRIPTION -**podman kube apply** will deploy a podman container, pod, or volume to a Kubernetes cluster. Use the `--file` flag to deploy a Kubernetes YAML (v1 specification) to a kubernetes cluster as well. +**podman kube apply** deploys a podman container, pod, or volume to a Kubernetes cluster. Use the `--file` option to deploy a Kubernetes YAML (v1 specification) to a Kubernetes cluster as well. Note that the Kubernetes YAML file can be used to run the deployment in Podman via podman-play-kube(1). @@ -23,7 +23,7 @@ Path to the kubernetes yaml file to deploy onto the kubernetes cluster. This fil #### **--kubeconfig**, **-k**=*kubeconfig filepath* Path to the kubeconfig file to be used when deploying the generated kube yaml to the Kubernetes cluster. The environment variable `KUBECONFIG` can be used to set the path for the kubeconfig file as well. -Note: A kubeconfig can have multiple cluster configurations, but `kube generate` will always only pick the first cluster configuration in the given kubeconfig. +Note: A kubeconfig can have multiple cluster configurations, but `kube generate` always picks the first cluster configuration in the given kubeconfig. #### **--ns**=*namespace* @@ -31,7 +31,7 @@ The namespace or project to deploy the workloads of the generated kube yaml to i #### **--service**, **-s** -Used to create a service for the corresponding container or pod being deployed to the cluster. In particular, if the container or pod has portmap bindings, the service specification will include a NodePort declaration to expose the service. A random port is assigned by Podman in the service specification that is deployed to the cluster. +Used to create a service for the corresponding container or pod being deployed to the cluster. In particular, if the container or pod has portmap bindings, the service specification includes a NodePort declaration to expose the service. A random port is assigned by Podman in the service specification that is deployed to the cluster. ## EXAMPLES diff --git a/docs/source/markdown/podman-kube-down.1.md b/docs/source/markdown/podman-kube-down.1.md index 9982340bc5..14411e1a12 100644 --- a/docs/source/markdown/podman-kube-down.1.md +++ b/docs/source/markdown/podman-kube-down.1.md @@ -10,8 +10,8 @@ podman-kube-down - Remove containers and pods based on Kubernetes YAML **podman kube down** reads a specified Kubernetes YAML file, tearing down pods that were created by the `podman kube play` command via the same Kubernetes YAML file. Any volumes that were created by the previous `podman kube play` command remain intact unless the `--force` options is used. If the YAML file is specified as `-`, `podman kube down` reads the YAML from stdin. The input can also be a URL that points to a YAML file such as https://podman.io/demo.yml. -`podman kube down` will then teardown the pods and containers created by `podman kube play` via the same Kubernetes YAML from the URL. However, -`podman kube down` will not work with a URL if the YAML file the URL points to has been changed or altered since the creation of the pods and containers using +`podman kube down` tears down the pods and containers created by `podman kube play` via the same Kubernetes YAML from the URL. However, +`podman kube down` does not work with a URL if the YAML file the URL points to has been changed or altered since the creation of the pods and containers using `podman kube play`. ## OPTIONS @@ -64,7 +64,7 @@ Pods stopped: Pods removed: 52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6 ``` -`podman kube down` will not work with a URL if the YAML file the URL points to has been changed +`podman kube down` does not work with a URL if the YAML file the URL points to has been changed or altered since it was used to create the pods and containers. ## SEE ALSO diff --git a/docs/source/markdown/podman-kube-generate.1.md b/docs/source/markdown/podman-kube-generate.1.md index 114497767a..a35a15776e 100644 --- a/docs/source/markdown/podman-kube-generate.1.md +++ b/docs/source/markdown/podman-kube-generate.1.md @@ -6,25 +6,25 @@ podman-kube-generate - Generate Kubernetes YAML based on containers, pods or vol **podman kube generate** [*options*] *container...* | *pod...* | *volume...* ## DESCRIPTION -**podman kube generate** will generate Kubernetes YAML (v1 specification) from Podman containers, pods or volumes. Regardless of whether -the input is for containers or pods, Podman will generate the specification as a Pod by default. The input may be in the form +**podman kube generate** generates Kubernetes YAML (v1 specification) from Podman containers, pods or volumes. Regardless of whether +the input is for containers or pods, Podman generates the specification as a Pod by default. The input may be in the form of one or more containers, pods or volumes names or IDs. `Podman Containers or Pods` -Volumes appear in the generated YAML according to two different volume types. Bind-mounted volumes become *hostPath* volume types and named volumes become *persistentVolumeClaim* volume types. Generated *hostPath* volume types will be one of three subtypes depending on the state of the host path: *DirectoryOrCreate* when no file or directory exists at the host, *Directory* when host path is a directory, or *File* when host path is a file. The value for *claimName* for a *persistentVolumeClaim* is the name of the named volume registered in Podman. +Volumes appear in the generated YAML according to two different volume types. Bind-mounted volumes become *hostPath* volume types and named volumes become *persistentVolumeClaim* volume types. Generated *hostPath* volume types are one of three subtypes depending on the state of the host path: *DirectoryOrCreate* when no file or directory exists at the host, *Directory* when host path is a directory, or *File* when host path is a file. The value for *claimName* for a *persistentVolumeClaim* is the name of the named volume registered in Podman. Potential name conflicts between volumes are avoided by using a standard naming scheme for each volume type. The *hostPath* volume types are named according to the path on the host machine, replacing forward slashes with hyphens less any leading and trailing forward slashes. The special case of the filesystem root, `/`, translates to the name `root`. Additionally, the name is suffixed with `-host` to avoid naming conflicts with *persistentVolumeClaim* volumes. Each *persistentVolumeClaim* volume type uses the name of its associated named volume suffixed with `-pvc`. -Note that if an init container is created with type `once` and the pod has been started, the init container will not show up in the generated kube YAML as `once` type init containers are deleted after they are run. If the pod has only been created and not started, it will be in the generated kube YAML. -Init containers created with type `always` will always be generated in the kube YAML as they are never deleted, even after running to completion. +Note that if an init container is created with type `once` and the pod has been started, it does not show up in the generated kube YAML as `once` type init containers are deleted after they are run. If the pod has only been created and not started, it is in the generated kube YAML. +Init containers created with type `always` are always generated in the kube YAML as they are never deleted, even after running to completion. *Note*: When using volumes and generating a Kubernetes YAML for an unprivileged and rootless podman container on an **SELinux enabled system**, one of the following options must be completed: * Add the "privileged: true" option to the pod spec * Add `type: spc_t` under the `securityContext` `seLinuxOptions` in the pod spec * Relabel the volume via the CLI command `chcon -t container_file_t -R ` -Once completed, the correct permissions will be in place to access the volume when the pod/container is created in a Kubernetes cluster. +Once completed, the correct permissions are in place to access the volume when the pod/container is created in a Kubernetes cluster. Note that the generated Kubernetes YAML file can be used to re-run the deployment via podman-play-kube(1). @@ -32,7 +32,7 @@ Note that the generated Kubernetes YAML file can be used to re-run the deploymen #### **--filename**, **-f**=*filename* -Output to the given file, instead of STDOUT. If the file already exists, `kube generate` will refuse to replace it and return an error. +Output to the given file instead of STDOUT. If the file already exists, `kube generate` refuses to replace it and returns an error. #### **--replicas**, **-r**=*replica count* @@ -41,11 +41,11 @@ Note: this can only be set with the option `--type=deployment`. #### **--service**, **-s** -Generate a Kubernetes service object in addition to the Pods. Used to generate a Service specification for the corresponding Pod output. In particular, if the object has portmap bindings, the service specification will include a NodePort declaration to expose the service. A random port is assigned by Podman in the specification. +Generate a Kubernetes service object in addition to the Pods. Used to generate a Service specification for the corresponding Pod output. In particular, if the object has portmap bindings, the service specification includes a NodePort declaration to expose the service. A random port is assigned by Podman in the specification. #### **--type**, **-t**=*pod | deployment* -The Kubernetes kind to generate in the YAML file. Currently, the only supported Kubernetes specifications are `Pod` and `Deployment`. By default, the `Pod` specification will be generated. +The Kubernetes kind to generate in the YAML file. Currently, the only supported Kubernetes specifications are `Pod` and `Deployment`. By default, the `Pod` specification is generated. ## EXAMPLES diff --git a/docs/source/markdown/podman-kube-play.1.md.in b/docs/source/markdown/podman-kube-play.1.md.in index 9dd37172e9..0f2d2ff401 100644 --- a/docs/source/markdown/podman-kube-play.1.md.in +++ b/docs/source/markdown/podman-kube-play.1.md.in @@ -7,14 +7,14 @@ podman-kube-play - Create containers, pods and volumes based on Kubernetes YAML **podman kube play** [*options*] *file.yml|-|https://website.io/file.yml* ## DESCRIPTION -**podman kube play** will read in a structured file of Kubernetes YAML. It will then recreate the containers, pods or volumes described in the YAML. Containers within a pod are then started and the ID of the new Pod or the name of the new Volume is output. If the yaml file is specified as "-" then `podman kube play` will read the YAML file from stdin. -The input can also be a URL that points to a YAML file such as https://podman.io/demo.yml. `podman kube play` will read the YAML from the URL and create pods and containers from it. +**podman kube play** reads in a structured file of Kubernetes YAML. It recreates the containers, pods, or volumes described in the YAML. Containers within a pod are then started, and the ID of the new Pod or the name of the new Volume is output. If the YAML file is specified as "-", then `podman kube play` reads the YAML file from stdin. +The input can also be a URL that points to a YAML file such as https://podman.io/demo.yml. `podman kube play` reads the YAML from the URL and create pods and containers from it. Using the `--down` command line option, it is also capable of tearing down the pods created by a previous run of `podman kube play`. -Using the `--replace` command line option, it will tear down the pods(if any) created by a previous run of `podman kube play` and recreate the pods with the Kubernetes YAML file. +Using the `--replace` command line option, it tears down the pods(if any) created by a previous run of `podman kube play` and recreate the pods with the Kubernetes YAML file. -Ideally the input file would be one created by Podman (see podman-kube-generate(1)). This would guarantee a smooth import and expected results. +Ideally the input file is created by Podman (see podman-kube-generate(1)). This guarantees a smooth import and expected results. Currently, the supported Kubernetes kinds are: @@ -34,13 +34,13 @@ Only three volume types are supported by kube play, the *hostPath*, *emptyDir*, Note: The default restart policy for containers is `always`. You can change the default by setting the `restartPolicy` field in the spec. -Note: When playing a kube YAML with init containers, the init container will be created with init type value `once`. To change the default type, use the `io.podman.annotations.init.container.type` annotation to set the type to `always`. +Note: When playing a kube YAML with init containers, the init container is created with init type value `once`. To change the default type, use the `io.podman.annotations.init.container.type` annotation to set the type to `always`. -Note: *hostPath* volume types created by kube play will be given an SELinux shared label (z), bind mounts are not relabeled (use `chcon -t container_file_t -R `). +Note: *hostPath* volume types created by kube play is given an SELinux shared label (z), bind mounts are not relabeled (use `chcon -t container_file_t -R `). -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. +Note: If the `:latest` tag is used, Podman attempts to pull the image from a registry. If the image was built locally with Podman or Buildah, it has `localhost` as the domain, in that case, Podman uses the image from the local store even if it has the `:latest` tag. -Note: The command `podman play kube` is an alias of `podman kube play`, and will perform the same function. +Note: The command `podman play kube` is an alias of `podman kube play`, and performs the same function. Note: The command `podman kube down` can be used to stop and remove pods or containers based on the same Kubernetes YAML used by `podman kube play` to create them. @@ -77,7 +77,7 @@ spec: ``` If there is a directory named `foobar` in the current working directory with a file named `Containerfile` or `Dockerfile`, -Podman kube play will build that image and name it `foobar`. An example directory structure for this example would look +Podman kube play builds that image and name it `foobar`. An example directory structure for this example looks like: ``` |- mykubefiles @@ -86,14 +86,14 @@ like: |- Containerfile ``` -The build will consider `foobar` to be the context directory for the build. If there is an image in local storage -called `foobar`, the image will not be built unless the `--build` flag is used. Use `--build=false` to completely +The build considers `foobar` to be the context directory for the build. If there is an image in local storage +called `foobar`, the image is not built unless the `--build` flag is used. Use `--build=false` to completely disable builds. `Kubernetes ConfigMap` Kubernetes ConfigMap can be referred as a source of environment variables or volumes in Pods or Deployments. -ConfigMaps aren't a standalone object in Podman; instead, when a container uses a ConfigMap, Podman will create environment variables or volumes as needed. +ConfigMaps aren't a standalone object in Podman; instead, when a container uses a ConfigMap, Podman creates environment variables or volumes as needed. For example, the following YAML document defines a ConfigMap and then uses it in a Pod: @@ -121,7 +121,7 @@ spec: optional: false ``` -and as a result environment variable `FOO` will be set to `bar` for container `container-1`. +and as a result environment variable `FOO` is set to `bar` for container `container-1`. `Kubernetes Secret` @@ -155,7 +155,7 @@ spec: key: foo ``` -and as a result environment variable `FOO` will be set to `bar` for container `container-1`. +and as a result environment variable `FOO` is set to `bar` for container `container-1`. ## OPTIONS @@ -251,7 +251,7 @@ the running pods and containers. When attached in the tty mode, you can kill the pods and containers by pressing Ctrl-C or receiving any other interrupt signals. -All pods, containers, and volumes created with `podman kube play` will be removed +All pods, containers, and volumes created with `podman kube play` is removed upon exit. ## EXAMPLES @@ -304,7 +304,7 @@ Pods stopped: Pods removed: 52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6 ``` -`podman kube play --down` will not work with a URL if the YAML file the URL points to +`podman kube play --down` does not work with a URL if the YAML file the URL points to has been changed or altered. @@include ../../kubernetes_support.md diff --git a/docs/source/markdown/podman-kube.1.md b/docs/source/markdown/podman-kube.1.md index 76762df2dd..3a776ef892 100644 --- a/docs/source/markdown/podman-kube.1.md +++ b/docs/source/markdown/podman-kube.1.md @@ -7,8 +7,8 @@ podman\-kube - Play containers, pods or volumes based on a structured input file **podman kube** *subcommand* ## DESCRIPTION -The kube command will recreate containers, pods or volumes based on the input from a structured (like YAML) -file input. Containers will be automatically started. +The kube command recreates containers, pods or volumes based on the input from a structured (like YAML) +file input. Containers are automatically started. ## COMMANDS diff --git a/docs/source/markdown/podman-login.1.md.in b/docs/source/markdown/podman-login.1.md.in index 63798ed990..fba90d431a 100644 --- a/docs/source/markdown/podman-login.1.md.in +++ b/docs/source/markdown/podman-login.1.md.in @@ -9,15 +9,15 @@ podman\-login - Login to a container registry ## DESCRIPTION **podman login** logs into a specified registry server with the correct username and password. If the registry is not specified, the first registry under [registries.search] -from registries.conf will be used. **podman login** reads in the username and password from STDIN. +from registries.conf is used. **podman login** reads in the username and password from STDIN. The username and password can also be set using the **username** and **password** flags. The path of the authentication file can be specified by the user by setting the **authfile** flag. The default path for reading and writing credentials is **${XDG\_RUNTIME\_DIR}/containers/auth.json**. -Podman will use existing credentials if the user does not pass in a username. -Podman will first search for the username and password in the **${XDG\_RUNTIME\_DIR}/containers/auth.json**, if they are not valid, -Podman will then use any existing credentials found in **$HOME/.docker/config.json**. -If those credentials are not present, Podman will create **${XDG\_RUNTIME\_DIR}/containers/auth.json** (if the file does not exist) and -will then store the username and password from STDIN as a base64 encoded string in it. +Podman uses existing credentials if the user does not pass in a username. +Podman first searches for the username and password in the **${XDG\_RUNTIME\_DIR}/containers/auth.json**, if they are not valid, +Podman then uses any existing credentials found in **$HOME/.docker/config.json**. +If those credentials are not present, Podman creates **${XDG\_RUNTIME\_DIR}/containers/auth.json** (if the file does not exist) and +then stores the username and password from STDIN as a base64 encoded string in it. For more details about format and configurations of the auth.json file, please refer to containers-auth.json(5) **podman [GLOBAL OPTIONS]** diff --git a/docs/source/markdown/podman-logout.1.md.in b/docs/source/markdown/podman-logout.1.md.in index 0f41804163..da0387f812 100644 --- a/docs/source/markdown/podman-logout.1.md.in +++ b/docs/source/markdown/podman-logout.1.md.in @@ -9,7 +9,7 @@ podman\-logout - Logout of a container registry ## DESCRIPTION **podman logout** logs out of a specified registry server by deleting the cached credentials stored in the **auth.json** file. If the registry is not specified, the first registry under [registries.search] -from registries.conf will be used. The path of the authentication file can be overridden by the user by setting the **authfile** flag. +from registries.conf is used. The path of the authentication file can be overridden by the user by setting the **authfile** flag. The default path used is **${XDG\_RUNTIME\_DIR}/containers/auth.json**. For more details about format and configurations of the auth,json file, please refer to containers-auth.json(5) All the cached credentials can be removed by setting the **all** flag. diff --git a/docs/source/markdown/podman-machine-init.1.md.in b/docs/source/markdown/podman-machine-init.1.md.in index 0fc9c1632e..4dfd1aa95d 100644 --- a/docs/source/markdown/podman-machine-init.1.md.in +++ b/docs/source/markdown/podman-machine-init.1.md.in @@ -25,7 +25,7 @@ SSH keys are automatically generated to access the VM, and system connections to and a user account inside the VM are added. By default, the VM distribution is [Fedora CoreOS](https://getfedora.org/en/coreos?stream=testing). -Fedora CoreOS upgrades come out every 14 days and are detected and installed automatically. The VM will be rebooted during the upgrade. +Fedora CoreOS upgrades come out every 14 days and are detected and installed automatically. The VM is rebooted during the upgrade. For more information on updates and advanced configuration, please see the FCOS update docs [here](https://docs.fedoraproject.org/en-US/fedora-coreos/auto-updates/) and [here](https://coreos.github.io/zincati/usage/updates-strategy/). ## OPTIONS @@ -47,9 +47,7 @@ Print usage statement. Fully qualified path of the ignition file. If an ignition file is provided, the file -will be copied into the user's CONF_DIR and renamed. Additionally, no SSH keys will -be generated nor will a system connection be made. It is assumed that the user will -do these things manually or handle otherwise. +is copied into the user's CONF_DIR and renamed. Additionally, no SSH keys are generated, nor are any system connections made. It is assumed that the user does these things manually or handled otherwise. #### **--image-path** @@ -67,11 +65,11 @@ Start the virtual machine immediately after it has been initialized. #### **--rootful** -Whether this machine should prefer rootful (`true`) or rootless (`false`) -container execution. This option will also determine the remote connection default +Whether this machine prefers rootful (`true`) or rootless (`false`) +container execution. This option determines the remote connection default if there is no existing remote connection configurations. -API forwarding, if available, will follow this setting. +API forwarding, if available, follows this setting. #### **--timezone** @@ -112,7 +110,7 @@ attributes as extended attributes on the host. This is suitable when the host and the guest do not need to interoperate on the shared filesystem, but has caveats for actual shared access; notably, symlinks on the host are not usable on the guest and vice versa. If interoperability is required, then choose -*none* instead, but keep in mind that the guest will not be able to do things +*none* instead, but keep in mind that the guest is not able to do things that the user running the virtual machine cannot do, e.g. create files owned by another user. Using *none* is almost certainly the best choice for read-only volumes. diff --git a/docs/source/markdown/podman-machine-rm.1.md b/docs/source/markdown/podman-machine-rm.1.md index 9f2c812bbc..1224adbe1d 100644 --- a/docs/source/markdown/podman-machine-rm.1.md +++ b/docs/source/markdown/podman-machine-rm.1.md @@ -13,7 +13,7 @@ depends on the virtual machine type. For all virtual machines, the generated SSH keys and the podman system connection are deleted. The ignition files generated for that VM are also removed as is its image file on the filesystem. -Users get a display of what will be deleted and are required to confirm unless the option `--force` +Users get a display of what is deleted and are required to confirm unless the option `--force` is used. The default machine name is `podman-machine-default`. If a machine name is not specified as an argument, diff --git a/docs/source/markdown/podman-machine-set.1.md.in b/docs/source/markdown/podman-machine-set.1.md.in index e622f22c9d..414e59b90e 100644 --- a/docs/source/markdown/podman-machine-set.1.md.in +++ b/docs/source/markdown/podman-machine-set.1.md.in @@ -38,15 +38,15 @@ Only supported for QEMU machines. #### **--rootful** -Whether this machine should prefer rootful (`true`) or rootless (`false`) -container execution. This option will also update the current podman +Whether this machine prefers rootful (`true`) or rootless (`false`) +container execution. This option updates the current podman remote connection default if it is currently pointing at the specified machine name (or `podman-machine-default` if no name is specified). @@option user-mode-networking Unlike [**podman system connection default**](podman-system-connection-default.1.md) -this option will also make the API socket, if available, forward to the rootful/rootless +this option makes the API socket, if available, forward to the rootful/rootless socket in the VM. ## EXAMPLES diff --git a/docs/source/markdown/podman-machine-ssh.1.md b/docs/source/markdown/podman-machine-ssh.1.md index 808ab771c8..eda566d0db 100644 --- a/docs/source/markdown/podman-machine-ssh.1.md +++ b/docs/source/markdown/podman-machine-ssh.1.md @@ -14,7 +14,7 @@ first argument must be the virtual machine name. The optional command to execute can then follow. If no command is provided, an interactive session with the virtual machine is established. -The exit code from ssh command will be forwarded to the podman machine ssh caller, see [Exit Codes](#Exit-Codes). +The exit code from ssh command is forwarded to the podman machine ssh caller, see [Exit Codes](#Exit-Codes). The default machine name is `podman-machine-default`. If a machine name is not specified as an argument, then `podman-machine-default` will be SSH'd into. diff --git a/docs/source/markdown/podman-machine-start.1.md b/docs/source/markdown/podman-machine-start.1.md index 56412358e6..c3ba5bbfba 100644 --- a/docs/source/markdown/podman-machine-start.1.md +++ b/docs/source/markdown/podman-machine-start.1.md @@ -21,7 +21,7 @@ The default machine name is `podman-machine-default`. If a machine name is not s then `podman-machine-default` will be started. Only one Podman managed VM can be active at a time. If a VM is already running, -`podman machine start` will return an error. +`podman machine start` returns an error. **podman machine start** starts a Linux virtual machine where containers are run. diff --git a/docs/source/markdown/podman-manifest-add.1.md.in b/docs/source/markdown/podman-manifest-add.1.md.in index 815739a414..e4fa89ab3f 100644 --- a/docs/source/markdown/podman-manifest-add.1.md.in +++ b/docs/source/markdown/podman-manifest-add.1.md.in @@ -17,9 +17,9 @@ The list image's ID. #### **--all** -If the image which should be added to the list or index is itself a list or +If the image which is added to the list or index is itself a list or index, add all of the contents to the local list. By default, only one image -from such a list or index will be added to the list or index. Combining +from such a list or index is added to the list or index. Combining *--all* with any of the other options described below is NOT recommended. @@option annotation.manifest @@ -28,7 +28,7 @@ from such a list or index will be added to the list or index. Combining Override the architecture which the list or index records as a requirement for the image. If *imageName* refers to a manifest list or image index, the -architecture information will be retrieved from it. Otherwise, it will be +architecture information is retrieved from it. Otherwise, it is retrieved from the image's configuration information. @@option authfile @@ -43,7 +43,7 @@ retrieved from the image's configuration information. Override the OS which the list or index records as a requirement for the image. If *imagename* refers to a manifest list or image index, the OS information -will be retrieved from it. Otherwise, it will be retrieved from the image's +is retrieved from it. Otherwise, it is retrieved from the image's configuration information. @@option os-version diff --git a/docs/source/markdown/podman-manifest-create.1.md.in b/docs/source/markdown/podman-manifest-create.1.md.in index 6ebf8a055c..1405940813 100644 --- a/docs/source/markdown/podman-manifest-create.1.md.in +++ b/docs/source/markdown/podman-manifest-create.1.md.in @@ -18,9 +18,9 @@ index. #### **--all** -If any of the images which should be added to the new list or index are +If any of the images added to the new list or index are themselves lists or indexes, add all of their contents. By default, only one -image from such a list will be added to the newly-created list or index. +image from such a list is added to the newly-created list or index. #### **--amend**, **-a** diff --git a/docs/source/markdown/podman-manifest-exists.1.md b/docs/source/markdown/podman-manifest-exists.1.md index b87559f8b5..a3e6d721ca 100644 --- a/docs/source/markdown/podman-manifest-exists.1.md +++ b/docs/source/markdown/podman-manifest-exists.1.md @@ -7,8 +7,9 @@ podman\-manifest\-exists - Check if the given manifest list exists in local stor **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. +**podman manifest exists** checks if a manifest list exists on local storage. +Podman returns an exit code of `0` when the manifest is found. A `1` is +returned otherwise. An exit code of `125` indicates there was another issue. diff --git a/docs/source/markdown/podman-manifest-push.1.md.in b/docs/source/markdown/podman-manifest-push.1.md.in index cd937dcda3..2077d45f5f 100644 --- a/docs/source/markdown/podman-manifest-push.1.md.in +++ b/docs/source/markdown/podman-manifest-push.1.md.in @@ -66,7 +66,7 @@ Sign the pushed images with a sigstore signature using a private key at the spec The DESTINATION is a location to store container images The Image "DESTINATION" uses a "transport":"details" format. - If a transport is not given, podman push will attempt to push + If a transport is not given, `podman push` attempts to push to a registry. Multiple transports are supported: diff --git a/docs/source/markdown/podman-manifest.1.md b/docs/source/markdown/podman-manifest.1.md index 74c59b6579..26248a4c4f 100644 --- a/docs/source/markdown/podman-manifest.1.md +++ b/docs/source/markdown/podman-manifest.1.md @@ -36,8 +36,7 @@ the scope of this example. Building a multi-arch manifest list $ platarch=linux/amd64,linux/ppc64le,linux/arm64,linux/s390x $ podman build --jobs=4 --platform=$platarch --manifest shazam . -**Note:** The `--jobs` argument is optional, and the `-t` or `--tag` -option should *not* be used. +**Note:** The `--jobs` argument is optional. Do not use the `podman build` command's `--tag` (or `-t`) option when building a multi-arch manifest list. ### Assembling a multi-arch manifest from separately built images @@ -60,7 +59,7 @@ pushed, not just the native platform/arch. Special care is needed when removing and pushing manifest lists, as opposed to the contents. You almost always want to use the `manifest rm` and -`manifest push --all` subcommands. For example, a rename and push could +`manifest push --all` subcommands. For example, a rename and push can be performed like this: $ podman tag localhost/shazam example.com/example/shazam diff --git a/docs/source/markdown/podman-mount.1.md.in b/docs/source/markdown/podman-mount.1.md.in index cf9daf311e..cd535311f1 100644 --- a/docs/source/markdown/podman-mount.1.md.in +++ b/docs/source/markdown/podman-mount.1.md.in @@ -17,7 +17,7 @@ without any arguments. External containers are containers in container/storage b For example Buildah and CRI-O. Rootless mode only supports mounting VFS driver, unless Podman is run within the user namespace -via the `podman unshare` command. All other storage drivers will fail to mount. +via the `podman unshare` command. All other storage drivers fails to mount. ## RETURN VALUE The location of the mounted file system. On error an empty string and errno is @@ -27,7 +27,7 @@ returned. #### **--all**, **-a** -Mount all podman containers. (External containers will not be mounted) +Mount all podman containers. (External containers are not mounted) #### **--format**=*format* diff --git a/docs/source/markdown/podman-network-connect.1.md b/docs/source/markdown/podman-network-connect.1.md index dc238fced1..b60639c7b1 100644 --- a/docs/source/markdown/podman-network-connect.1.md +++ b/docs/source/markdown/podman-network-connect.1.md @@ -14,7 +14,7 @@ Once connected, the container can communicate with other containers in the same #### **--alias**=*name* Add network-scoped alias for the container. If the network has DNS enabled (`podman network inspect -f {{.DNSEnabled}} `), these aliases can be used for name resolution on the given network. Multiple *--alias* options may be specified as input. -NOTE: When using CNI a container will only have access to aliases on the first network that it joins. This limitation does +NOTE: When using CNI, a container only has access to aliases on the first network that it joins. This limitation does not exist with netavark/aardvark-dns. #### **--ip**=*address* diff --git a/docs/source/markdown/podman-network-create.1.md b/docs/source/markdown/podman-network-create.1.md index a7550ed3e4..b68b50a50c 100644 --- a/docs/source/markdown/podman-network-create.1.md +++ b/docs/source/markdown/podman-network-create.1.md @@ -11,22 +11,22 @@ Create a network configuration for use with Podman. By default, Podman creates a A *Macvlan* connection can be created with the *-d macvlan* option. A parent device for macvlan or ipvlan can be designated with the *-o parent=``* or *--network-interface=``* option. -If no options are provided, Podman will assign a free subnet and name for the network. +If no options are provided, Podman assigns a free subnet and name for the network. -Upon completion of creating the network, Podman will display the name of the newly added network. +Upon completion of creating the network, Podman displays the name of the newly added network. -NOTE: The support for the network name pasta is deprecated and will be removed in the next major +NOTE: The support for the network name "pasta" is deprecated and will be removed in the next major release because it is used as a special network mode in **podman run/create --network**. ## OPTIONS #### **--disable-dns** Disables the DNS plugin for this network which if enabled, can perform container to container name -resolution. It is only supported with the `bridge` driver, for other drivers it will be always disabled. +resolution. It is only supported with the `bridge` driver, for other drivers it is always disabled. #### **--dns**=*ip* -Set network-scoped DNS resolver/nameserver for containers in this network. If not set, the host servers from `/etc/resolv.conf` will be used. It can be overwritten on the container level with the `podman run/create --dns` option. This option can be specified multiple times to set more than one IP. +Set network-scoped DNS resolver/nameserver for containers in this network. If not set, the host servers from `/etc/resolv.conf` is used. It can be overwritten on the container level with the `podman run/create --dns` option. This option can be specified multiple times to set more than one IP. #### **--driver**, **-d**=*driver* @@ -52,18 +52,17 @@ The argument order of the **--subnet**, **--gateway** and **--ip-range** options #### **--ignore** Ignore the create request if a network with the same name already exists instead of failing. -Note, trying to create a network with an existing name and different parameters, will not change the configuration of the existing one +Note, trying to create a network with an existing name and different parameters does not change the configuration of the existing one. #### **--interface-name**=*name* This option maps the the *network_interface* option in the network config, see **podman network inspect**. -Depending on the driver this can have different effects, for `bridge` it will be the bridge interface name. -For `macvlan` and `ipvlan` this will be the parent device on the host. It is the same as `--opt parent=...`. +Depending on the driver, this can have different effects; for `bridge`, it uses the bridge interface name. +For `macvlan` and `ipvlan`, it is the parent device on the host. It is the same as `--opt parent=...`. #### **--internal** -Restrict external access of this network. Note when using this option, the dnsname plugin will be -automatically disabled. +Restrict external access of this network. Note when using this option, the dnsname plugin is automatically disabled. #### **--ip-range**=*range* @@ -73,7 +72,7 @@ The argument order of the **--subnet**, **--gateway** and **--ip-range** options #### **--ipam-driver**=*driver* -Set the ipam driver (IP Address Management Driver) for the network. When unset podman will choose an +Set the ipam driver (IP Address Management Driver) for the network. When unset podman chooses an ipam driver automatically based on the network driver. Valid values are: @@ -86,7 +85,7 @@ View the driver in the **podman network inspect** output under the `ipam_options #### **--ipv6** -Enable IPv6 (Dual Stack) networking. If no subnets are given it will allocate an ipv4 and an ipv6 subnet. +Enable IPv6 (Dual Stack) networking. If no subnets are given, it allocates an ipv4 and an ipv6 subnet. #### **--label**=*label* @@ -110,7 +109,7 @@ Additionally the `bridge` driver supports the following options: The `macvlan` and `ipvlan` driver support the following options: -- `parent`: The host device which should be used for the macvlan interface. Defaults to the default route interface. +- `parent`: The host device which is used for the macvlan interface. Defaults to the default route interface. - `mode`: This option sets the specified ip/macvlan mode on the interface. - Supported values for `macvlan` are `bridge`, `private`, `vepa`, `passthru`. Defaults to `bridge`. - Supported values for `ipvlan` are `l2`, `l3`, `l3s`. Defaults to `l2`. diff --git a/docs/source/markdown/podman-network-disconnect.1.md b/docs/source/markdown/podman-network-disconnect.1.md index 9685cf400e..0f2936969d 100644 --- a/docs/source/markdown/podman-network-disconnect.1.md +++ b/docs/source/markdown/podman-network-disconnect.1.md @@ -8,8 +8,8 @@ podman\-network\-disconnect - Disconnect a container from a network ## DESCRIPTION Disconnects a container from a network. A container can be disconnected from a network by name or by ID. -If all networks are disconnected from the container, it will behave like a container created with `--network=none` -and it will longer have network connectivity until a network is connected again. +If all networks are disconnected from the container, it behaves like a container created with `--network=none` +and it does not have network connectivity until a network is connected again. ## OPTIONS diff --git a/docs/source/markdown/podman-network-exists.1.md b/docs/source/markdown/podman-network-exists.1.md index f014b14ef3..702c98ee32 100644 --- a/docs/source/markdown/podman-network-exists.1.md +++ b/docs/source/markdown/podman-network-exists.1.md @@ -8,8 +8,8 @@ podman\-network\-exists - Check if the given network exists ## DESCRIPTION **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 +of the network may be used as input. Podman returns an exit code +of `0` when the network is found. A `1` is returned otherwise. An exit code of `125` indicates there was another issue. diff --git a/docs/source/markdown/podman-network-ls.1.md.in b/docs/source/markdown/podman-network-ls.1.md.in index 709555a0f8..8a60ee0770 100644 --- a/docs/source/markdown/podman-network-ls.1.md.in +++ b/docs/source/markdown/podman-network-ls.1.md.in @@ -66,7 +66,7 @@ Do not truncate the network ID. #### **--quiet**, **-q** -The `quiet` option will restrict the output to only the network names. +The `quiet` option restricts the output to only the network names. ## EXAMPLE diff --git a/docs/source/markdown/podman-network-prune.1.md b/docs/source/markdown/podman-network-prune.1.md index 806f5c8a1f..10667e8ab9 100644 --- a/docs/source/markdown/podman-network-prune.1.md +++ b/docs/source/markdown/podman-network-prune.1.md @@ -8,7 +8,7 @@ podman\-network\-prune - Remove all unused networks ## DESCRIPTION Remove all unused networks. An unused network is defined by a network which -has no containers connected or configured to connect to it. It will not remove +has no containers connected or configured to connect to it. It does not remove the so-called default network which goes by the name of *podman*. ## OPTIONS diff --git a/docs/source/markdown/podman-network-rm.1.md b/docs/source/markdown/podman-network-rm.1.md index 714fea8fbc..a4d6693b64 100644 --- a/docs/source/markdown/podman-network-rm.1.md +++ b/docs/source/markdown/podman-network-rm.1.md @@ -12,8 +12,8 @@ Delete one or more Podman networks. ## OPTIONS #### **--force**, **-f** -The `force` option will remove all containers that use the named network. If the container is -running, the container will be stopped and removed. +The `force` option removes all containers that use the named network. If the container is +running, the container is stopped and removed. #### **--time**, **-t**=*seconds* diff --git a/docs/source/markdown/podman-network.1.md b/docs/source/markdown/podman-network.1.md index b4ff9504a0..1cf7daa760 100644 --- a/docs/source/markdown/podman-network.1.md +++ b/docs/source/markdown/podman-network.1.md @@ -10,11 +10,11 @@ podman\-network - Manage Podman networks The network command manages networks for Podman. Podman supports two network backends [Netavark](https://github.com/containers/netavark) -and [CNI](https://www.cni.dev/). Netavark is the default network backend and was added in Podman v4.0. CNI will be -deprecated in the future in preference of Netavark. To configure +and [CNI](https://www.cni.dev/). Netavark is the default network backend and was added in Podman v4.0. CNI will be deprecated in the future in preference of +Netavark. To configure the network backend use the `network_backend`key under the `[Network]` in **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**. -New systems should use netavark by default, to check what backed is used run +New systems use netavark by default, to check what backend is used run `podman info --format {{.Host.NetworkBackend}}`. All network commands work for both backends but CNI and Netavark use different config files @@ -39,7 +39,7 @@ so networks have to be created again after a backend change. Podman requires specific default IPs and, thus, network subnets. The default values used by Podman can be modified in the **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)** file. ### Podman network -The default bridge network (called `podman`) uses 10.88.0.0/16 as a subnet. When Podman runs as root, the `podman` network is used as default. It is the same as adding the option `--network bridge` or `--network podman`. This subnet can be changed in **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)** under the [network] section. Set the `default_subnet` to any subnet that is free in the environment. The name of the default network can also be changed from `podman` to another name using the default network key. Note that this should only be done when no containers are running. +The default bridge network (called `podman`) uses 10.88.0.0/16 as a subnet. When Podman runs as root, the `podman` network is used as default. It is the same as adding the option `--network bridge` or `--network podman`. This subnet can be changed in **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)** under the [network] section. Set the `default_subnet` to any subnet that is free in the environment. The name of the default network can also be changed from `podman` to another name using the default network key. Note that this is only done when no containers are running. ### Slirp4netns When Podman is run as rootless, the internet connectivity is provided with slirp4netns by default. Slirp4nents uses 10.0.2.0/24 for its default network. This can also be changed in **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)** but under the `[engine]` section. Use the `network_cmd_options` key and add `["cidr=X.X.X.X/24"]` as a value. Note that slirp4netns needs a network prefix size between 1 and 25. This option accepts an array, so more options can be added in a comma-separated string as described on the **[podman-network-create(1)](podman-network-create.1.md)** man page. To change the CIDR for just one container, specify it on the cli using the `--network` option like this: `--network slirp4netns:cidr=192.168.1.0/24`. @@ -47,7 +47,7 @@ When Podman is run as rootless, the internet connectivity is provided with slirp When using the default network as rootless, i.e. --network podman/bridge, then it also uses the same subnet as described above in addition to the slirp4netns subnet. ### Podman network create -When a new network is created with a `podman network create` command, and no subnet is given with the --subnet option, Podman will start picking a free subnet from 10.89.0.0/24 to 10.255.255.0/24. Use the `default_subnet_pools` option under the `[network]` section in **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)** to change the range and/or size that is assigned by default. +When a new network is created with a `podman network create` command, and no subnet is given with the --subnet option, Podman starts picking a free subnet from 10.89.0.0/24 to 10.255.255.0/24. Use the `default_subnet_pools` option under the `[network]` section in **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)** to change the range and/or size that is assigned by default. ## SEE ALSO **[podman(1)](podman.1.md)**, **[podman-network-create(1)](podman-network-create.1.md)**, **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)** diff --git a/docs/source/markdown/podman-pod-clone.1.md.in b/docs/source/markdown/podman-pod-clone.1.md.in index a442be80c9..f68b510f4b 100644 --- a/docs/source/markdown/podman-pod-clone.1.md.in +++ b/docs/source/markdown/podman-pod-clone.1.md.in @@ -126,4 +126,4 @@ d0cf1f782e2ed67e8c0050ff92df865a039186237a4df24d7acba5b1fa8cc6e7 May 2022, Originally written by Charlie Doern ## FOOTNOTES -1: The Podman project is committed to inclusivity, a core value of open source. The `master` and `slave` mount propagation terminology used here is problematic and divisive, and should be changed. However, these terms are currently used within the Linux kernel and must be used as-is at this time. When the kernel maintainers rectify this usage, Podman will follow suit immediately. +1: The Podman project is committed to inclusivity, a core value of open source. The `master` and `slave` mount propagation terminology used here is problematic and divisive, and needs to be changed. However, these terms are currently used within the Linux kernel and must be used as-is at this time. When the kernel maintainers rectify this usage, Podman will follow suit immediately. diff --git a/docs/source/markdown/podman-pod-create.1.md.in b/docs/source/markdown/podman-pod-create.1.md.in index 28ce755316..46f52d3966 100644 --- a/docs/source/markdown/podman-pod-create.1.md.in +++ b/docs/source/markdown/podman-pod-create.1.md.in @@ -20,7 +20,7 @@ UUID short identifier (“f78375b1c487”) Name (“jonah”) podman generates a UUID for each pod, and if a name is not assigned -to the container with **--name** then a random string name will be generated +to the container with **--name** then a random string name is generated for it. This name is useful to identify a pod. Note: resource limit related flags work by setting the limits explicitly in the pod's cgroup parent @@ -59,15 +59,15 @@ Note: the pod implements devices by storing the initial configuration passed by #### **--dns**=*ipaddr* -Set custom DNS servers in the /etc/resolv.conf file that will be shared between all containers in the pod. A special option, "none" is allowed which disables creation of /etc/resolv.conf for the pod. +Set custom DNS servers in the /etc/resolv.conf file that is shared between all containers in the pod. A special option, "none" is allowed which disables creation of /etc/resolv.conf for the pod. #### **--dns-option**=*option* -Set custom DNS options in the /etc/resolv.conf file that will be shared between all containers in the pod. +Set custom DNS options in the /etc/resolv.conf file that is shared between all containers in the pod. #### **--dns-search**=*domain* -Set custom DNS search domains in the /etc/resolv.conf file that will be shared between all containers in the pod. +Set custom DNS search domains in the /etc/resolv.conf file that is shared between all containers in the pod. #### **--exit-policy**=**continue** | *stop* @@ -96,7 +96,7 @@ Create an infra container and associate it with the pod. An infra container is a #### **--infra-image**=*image* -The custom image that will be used for the infra container. Unless specified, Podman builds a custom local image which does not require pulling down an image. +The custom image that is used for the infra container. Unless specified, Podman builds a custom local image which does not require pulling down an image. @@option infra-name @@ -151,13 +151,13 @@ Default restart policy for all the containers in a pod. #### **--share**=*namespace* -A comma-separated list of kernel namespaces to share. If none or "" is specified, no namespaces will be shared and the infra container will not be created unless expiclity specified via **--infra=true**. The namespaces to choose from are cgroup, ipc, net, pid, uts. If the option is prefixed with a "+" then the namespace is appended to the default list, otherwise it replaces the default list. Defaults matches Kubernetes default (ipc, net, uts) +A comma-separated list of kernel namespaces to share. If none or "" is specified, no namespaces are shared, and the infra container is not created unless explicitly specified via **--infra=true**. The namespaces to choose from are cgroup, ipc, net, pid, uts. If the option is prefixed with a "+", the namespace is appended to the default list. Otherwise, it replaces the default list. Defaults match Kubernetes default (ipc, net, uts) #### **--share-parent** -This boolean determines whether or not all containers entering the pod will use the pod as their cgroup parent. The default value of this flag is true. Use the **--share** option to share the cgroup namespace rather than a cgroup parent in a pod. +This boolean determines whether or not all containers entering the pod use the pod as their cgroup parent. The default value of this option is true. Use the **--share** option to share the cgroup namespace rather than a cgroup parent in a pod. -Note: This options conflict with **--share=cgroup** since that would set the pod as the cgroup parent but enter the container into the same cgroupNS as the infra container. +Note: This option conflicts with the **--share=cgroup** option since that option sets the pod as the cgroup parent but enters the container into the same cgroupNS as the infra container. @@option shm-size @@ -209,4 +209,4 @@ $ podman pod create --network net1:ip=10.89.1.5 --network net2:ip=10.89.10.10 July 2018, Originally compiled by Peter Hunt ## FOOTNOTES -1: The Podman project is committed to inclusivity, a core value of open source. The `master` and `slave` mount propagation terminology used here is problematic and divisive, and should be changed. However, these terms are currently used within the Linux kernel and must be used as-is at this time. When the kernel maintainers rectify this usage, Podman will follow suit immediately. +1: The Podman project is committed to inclusivity, a core value of open source. The `master` and `slave` mount propagation terminology used here is problematic and divisive, and needs to be changed. However, these terms are currently used within the Linux kernel and must be used as-is at this time. When the kernel maintainers rectify this usage, Podman will follow suit immediately. diff --git a/docs/source/markdown/podman-pod-exists.1.md b/docs/source/markdown/podman-pod-exists.1.md index eea4633d7b..6923aadb2c 100644 --- a/docs/source/markdown/podman-pod-exists.1.md +++ b/docs/source/markdown/podman-pod-exists.1.md @@ -8,8 +8,8 @@ podman-pod-exists - Check if a pod exists in local storage ## DESCRIPTION **podman pod exists** checks if a pod exists in local storage. The **ID** or **Name** -of the pod may be used as input. Podman will return an exit code -of `0` when the pod is found. A `1` will be returned otherwise. An exit code of `125` indicates there +of the pod may be used as input. Podman returns an exit code +of `0` when the pod is found. A `1` is returned otherwise. An exit code of `125` indicates there was an issue accessing the local storage. ## EXAMPLES diff --git a/docs/source/markdown/podman-pod-kill.1.md.in b/docs/source/markdown/podman-pod-kill.1.md.in index b7eb003652..69a34210ce 100644 --- a/docs/source/markdown/podman-pod-kill.1.md.in +++ b/docs/source/markdown/podman-pod-kill.1.md.in @@ -7,7 +7,7 @@ podman\-pod\-kill - Kill the main process of each container in one or more pods **podman pod kill** [*options*] *pod* ... ## DESCRIPTION -The main process of each container inside the pods specified will be sent SIGKILL, or any signal specified with option --signal. +The main process of each container inside the pods specified is sent SIGKILL, or any signal specified with option --signal. ## OPTIONS #### **--all**, **-a** diff --git a/docs/source/markdown/podman-pod-logs.1.md.in b/docs/source/markdown/podman-pod-logs.1.md.in index 5d0764ca0f..fc0efe963d 100644 --- a/docs/source/markdown/podman-pod-logs.1.md.in +++ b/docs/source/markdown/podman-pod-logs.1.md.in @@ -9,7 +9,7 @@ podman\-pod\-logs - Displays logs for pod with one or more containers ## DESCRIPTION The podman pod logs command batch-retrieves whatever logs are present with all the containers of a pod. Pod logs can be filtered by container name or ID using flag **-c** or **--container** if needed. -Note: Long running command of `podman pod log` with a `-f` or `--follow` needs to be reinvoked if new container is added to the pod dynamically otherwise logs of newly added containers would not be visible in log stream. +Note: A long-running `podman pod log` command with a `-f` or `--follow` option needs to be reinvoked if a new container is added to the pod dynamically; otherwise, logs of newly added containers are not visible in the log stream. ## OPTIONS @@ -17,7 +17,7 @@ Note: Long running command of `podman pod log` with a `-f` or `--follow` needs t #### **--container**, **-c** -By default `podman pod logs` retrieves logs for all the containers available within the pod differentiate by field `container`. However there are use-cases where user would want to limit the log stream only to a particular container of a pod for such cases `-c` can be used like `podman pod logs -c ctrNameorID podname`. +By default, `podman pod logs` retrieves logs for all the containers available within the pod, differentiated by the field `container`. However, there are use cases where the user wants to limit the log stream only to a particular container of a pod. For such cases, `-c` can be used like `podman pod logs -c ctrNameorID podname`. @@option follow diff --git a/docs/source/markdown/podman-pod-restart.1.md b/docs/source/markdown/podman-pod-restart.1.md index 1e309be9f6..63a74d135e 100644 --- a/docs/source/markdown/podman-pod-restart.1.md +++ b/docs/source/markdown/podman-pod-restart.1.md @@ -7,10 +7,10 @@ podman\-pod\-restart - Restart one or more pods **podman pod restart** [*options*] *pod* ... ## DESCRIPTION -Restart containers in one or more pods. Containers will be stopped if running and then restarted. -Stopped containers will only be started. You may use pod IDs or names as input. -The pod ID will be printed upon successful restart. -When restarting multiple pods, an error from restarting one pod will not effect restarting other pods. +Restart containers in one or more pods. Running containers are stopped an restarted. +Stopped containers are started. You may use pod IDs or names as input. +The pod ID is printed upon successful restart. +When restarting multiple pods, an error from restarting one pod does not effect restarting other pods. ## OPTIONS diff --git a/docs/source/markdown/podman-pod-rm.1.md.in b/docs/source/markdown/podman-pod-rm.1.md.in index aa5dff226e..99fc2b0a37 100644 --- a/docs/source/markdown/podman-pod-rm.1.md.in +++ b/docs/source/markdown/podman-pod-rm.1.md.in @@ -7,7 +7,7 @@ podman\-pod\-rm - Remove one or more stopped pods and containers **podman pod rm** [*options*] *pod* ## DESCRIPTION -**podman pod rm** will remove one or more stopped pods and their containers from the host. The pod name or ID can be used. The \-f option stops all containers and then removes them before removing the pod. If all containers added by the user are in an exited state, the pod will be removed. +**podman pod rm** removes one or more stopped pods and their containers from the host. The pod name or ID can be used. The \-f option stops all containers and then removes them before removing the pod. If all containers added by the user are in an exited state, the pod is removed. ## OPTIONS @@ -24,7 +24,7 @@ Stop running containers and delete all stopped containers before removal of pod. @@option latest @@option pod-id-file.pod -If specified, the pod-id-file will be removed along with the pod. +If specified, the pod-id-file is removed along with the pod. @@option time diff --git a/docs/source/markdown/podman-ps.1.md b/docs/source/markdown/podman-ps.1.md index efe7a15c27..e5de35df00 100644 --- a/docs/source/markdown/podman-ps.1.md +++ b/docs/source/markdown/podman-ps.1.md @@ -69,7 +69,7 @@ Valid placeholders for the Go template are listed below: | **Placeholder** | **Description** | |--------------------|----------------------------------------------| -| .AutoRemove | If true, container will be removed on exit | +| .AutoRemove | If true, containers are removed on exit | | .Command | Quoted command used | | .Created | Creation time for container, Y-M-D H:M:S | | .CreatedAt | Creation time for container (same as above) | @@ -135,13 +135,13 @@ Display the total file size #### **--sort**=*created* Sort by command, created, id, image, names, runningfor, size, or status", -Note: Choosing size will sort by size of rootFs, not alphabetically like the rest of the options +Note: Choosing size sorts by size of rootFs, not alphabetically like the rest of the options #### **--sync** Force a sync of container state with the OCI runtime. In some cases, a container's state in the runtime can become out of sync with Podman's state. -This will update Podman's state based on what the OCI runtime reports. +This updates Podman's state based on what the OCI runtime reports. Forcibly syncing is much slower, but can resolve inconsistent state issues. #### **--watch**, **-w** diff --git a/docs/source/markdown/podman-pull.1.md.in b/docs/source/markdown/podman-pull.1.md.in index 43a89244f3..0081e00e6a 100644 --- a/docs/source/markdown/podman-pull.1.md.in +++ b/docs/source/markdown/podman-pull.1.md.in @@ -13,7 +13,7 @@ podman\-pull - Pull an image from a registry **podman image pull** [*options*] [*transport*]*name*[:*tag*|@*digest*] ## DESCRIPTION -podman pull copies an image from a registry onto the local machine. The command can pull one or more images. If the image reference in the command line argument does not contain a registry, it is referred to as a`short-name` reference. If the image is a 'short-name' reference, Podman will prompt the user for the specific container registry to pull the image from, if an alias for the short-name has not been specified in the `short-name-aliases.conf`. If an image tag is not specified, **podman pull** defaults to the image with the **latest** tag (if it exists) and pulls it. After the image is pulled, podman will print the full image ID. **podman pull** can also pull images using a digest **podman pull** *image*@*digest* and can also be used to pull images from archives and local storage using different transports. +podman pull copies an image from a registry onto the local machine. The command can pull one or more images. If the image reference in the command line argument does not contain a registry, it is referred to as a`short-name` reference. If the image is a 'short-name' reference, Podman prompts the user for the specific container registry to pull the image from, if an alias for the short-name has not been specified in the `short-name-aliases.conf`. If an image tag is not specified, **podman pull** defaults to the image with the **latest** tag (if it exists) and pulls it. After the image is pulled, podman prints the full image ID. **podman pull** can also pull images using a digest **podman pull** *image*@*digest* and can also be used to pull images from archives and local storage using different transports. *IMPORTANT: Images are stored in local image storage.* ## SOURCE @@ -45,9 +45,9 @@ $ podman pull oci-archive:/tmp/myimage ## OPTIONS #### **--all-tags**, **-a** -All tagged images in the repository will be pulled. +All tagged images in the repository are pulled. -*IMPORTANT: When using the all-tags flag, Podman will not iterate over the search registries in the **[containers-registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md)** but will always use docker.io for unqualified image names.* +*IMPORTANT: When using the all-tags flag, Podman does not iterate over the search registries in the **[containers-registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md)** but always uses docker.io for unqualified image names.* @@option arch @@ -88,14 +88,14 @@ Using short names is subject to the risk of hitting squatted registry namespaces While it is highly recommended to always use fully-qualified image references, existing deployments using short names may not be easily changed. To circumvent the aforementioned ambiguity, so called short-name aliases can be configured that point to a fully-qualified image reference. Distributions often ship a default shortnames.conf expansion file in /etc/containers/registries.conf.d/ directory. Administrators can use this directory to add their own local short-name expansion files. -When pulling an image, if the user does not specify the complete registry, container engines attempt to expand the short-name into a full name. If the command is executed with a tty, the user will be prompted to select a registry from the +When pulling an image, if the user does not specify the complete registry, container engines attempt to expand the short-name into a full name. If the command is executed with a tty, the user is prompted to select a registry from the default list unqualified registries defined in registries.conf. The user's selection is then stored in a cache file to be used in all future short-name expansions. Rootful short-names are stored in /var/cache/containers/short-name-aliases.conf. Rootless short-names are stored in the $HOME/.cache/containers/short-name-aliases.conf file. For more information on short-names, see `containers-registries.conf(5)` **registries.conf** (`/etc/containers/registries.conf`) -registries.conf is the configuration file which specifies which container registries should be consulted when completing image names which do not include a registry or domain portion. +registries.conf is the configuration file which specifies which container registries is consulted when completing image names which do not include a registry or domain portion. NOTE: Use the environment variable `TMPDIR` to change the temporary storage location of downloaded container images. Podman defaults to use `/var/tmp`. diff --git a/docs/source/markdown/podman-push.1.md.in b/docs/source/markdown/podman-push.1.md.in index 3dddbbe8e2..30a057f57c 100644 --- a/docs/source/markdown/podman-push.1.md.in +++ b/docs/source/markdown/podman-push.1.md.in @@ -65,7 +65,7 @@ Note: This flag can only be set when using the **dir** transport #### **--encrypt-layer**=*layer(s)* -Layer(s) to encrypt: 0-indexed layer indices with support for negative indexing (e.g. 0 is the first layer, -1 is the last layer). If not defined, will encrypt all layers if encryption-key flag is specified. +Layer(s) to encrypt: 0-indexed layer indices with support for negative indexing (e.g. 0 is the first layer, -1 is the last layer). If not defined, encrypts all layers if encryption-key flag is specified. #### **--encryption-key**=*key* diff --git a/docs/source/markdown/podman-remote.1.md b/docs/source/markdown/podman-remote.1.md index c5d728ab8d..29b093969c 100644 --- a/docs/source/markdown/podman-remote.1.md +++ b/docs/source/markdown/podman-remote.1.md @@ -19,7 +19,7 @@ created by the other. Podman-remote provides a local client interacting with a Podman backend node through a RESTful API tunneled through a ssh connection. In this context, a Podman node is a Linux system with Podman installed on it and the API service activated. Credentials for this session can be passed in using flags, environment variables, or in `containers.conf`. -The `containers.conf` file should be placed under `$HOME/.config/containers/containers.conf` on Linux and Mac and `%APPDATA%\containers\containers.conf` on Windows. +The `containers.conf` file is placed under `$HOME/.config/containers/containers.conf` on Linux and Mac and `%APPDATA%\containers\containers.conf` on Windows. **podman [GLOBAL OPTIONS]** @@ -62,7 +62,7 @@ Details: * `ssh` (default): a local unix(7) socket on the named `host` and `port`, reachable via SSH * `tcp`: an unencrypted, unauthenticated TCP connection to the named `host` and `port`, can work with proxy if `CONTAINER_PROXY` is set * `unix`: a local unix(7) socket at the specified `path`, or the default for the user - - `user` will default to either `root` or the current running user (`ssh` only) + - `user` defaults to either `root` or the current running user (`ssh` only) - `password` has no default (`ssh` only) - `host` must be provided and is either the IP or name of the machine hosting the Podman service (`ssh` and `tcp`) - `port` defaults to 22 (`ssh` and `tcp`) diff --git a/docs/source/markdown/podman-rename.1.md b/docs/source/markdown/podman-rename.1.md index a91ac26665..1c25ef0d8f 100644 --- a/docs/source/markdown/podman-rename.1.md +++ b/docs/source/markdown/podman-rename.1.md @@ -10,7 +10,7 @@ podman\-rename - Rename an existing container ## DESCRIPTION Rename changes the name of an existing container. -The old name will be freed, and will be available for use. +The old name is freed, and is available for use. This command can be run on containers in any state. However, running containers may not fully receive the effects until they are restarted - for example, a running container may still use the old name in its logs. At present, only containers are supported; pods and volumes cannot be renamed. diff --git a/docs/source/markdown/podman-restart.1.md.in b/docs/source/markdown/podman-restart.1.md.in index 4a4838f97c..dc57e12175 100644 --- a/docs/source/markdown/podman-restart.1.md.in +++ b/docs/source/markdown/podman-restart.1.md.in @@ -10,8 +10,7 @@ podman\-restart - Restart one or more containers ## DESCRIPTION The restart command allows containers to be restarted using their ID or name. -Containers will be stopped if they are running and then restarted. Stopped -containers will not be stopped and will only be started. +Running containers are stopped and restarted. Stopped containers are started. ## OPTIONS diff --git a/docs/source/markdown/podman-rm.1.md.in b/docs/source/markdown/podman-rm.1.md.in index e8ac184848..b42c2ee5f8 100644 --- a/docs/source/markdown/podman-rm.1.md.in +++ b/docs/source/markdown/podman-rm.1.md.in @@ -9,8 +9,8 @@ podman\-rm - Remove one or more containers **podman container rm** [*options*] *container* ## DESCRIPTION -**podman rm** will remove one or more containers from the host. The container name or ID can be used. This does not remove images. -Running or unusable containers will not be removed without the **-f** option. +**podman rm** removes one or more containers from the host. The container name or ID can be used. This does not remove images. +Running or unusable containers are not removed without the **-f** option. ## OPTIONS @@ -51,8 +51,8 @@ Valid filters are listed below: #### **--force**, **-f** Force the removal of running and paused containers. Forcing a container removal also -removes containers from container storage even if the container is not known to podman. -Containers could have been created by a different container engine. +removes containers from container storage even if the container is not known to Podman. +For example, containers that are created by different container engines like Buildah. In addition, forcing can be used to remove unusable containers, e.g. containers whose OCI runtime has become unavailable. @@ -117,7 +117,7 @@ $ podman rm -f --latest **125** The command fails for any other reason ## SEE ALSO -**[podman(1)](podman.1.md)**, **[crio(8)](https://github.com/cri-o/cri-o/blob/main/docs/crio.8.md)** +**[podman(1)](podman.1.md)** ## HISTORY August 2017, Originally compiled by Ryan Cole diff --git a/docs/source/markdown/podman-rmi.1.md b/docs/source/markdown/podman-rmi.1.md index 08e6742c93..a07c3f02e6 100644 --- a/docs/source/markdown/podman-rmi.1.md +++ b/docs/source/markdown/podman-rmi.1.md @@ -22,7 +22,7 @@ Remove all images in the local storage. #### **--force**, **-f** -This option will cause podman to remove all containers that are using the image before removing the image from the system. +This option causes Podman to remove all containers that are using the image before removing the image from the system. #### **--ignore**, **-i** @@ -30,7 +30,7 @@ If a specified image does not exist in the local storage, ignore it and do not t #### **--no-prune** -This options will not remove dangling parents of specified image +This option does not remove dangling parents of the specified image. Remove an image by its short ID ``` diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in index fa291ee58d..c894019c5b 100644 --- a/docs/source/markdown/podman-run.1.md.in +++ b/docs/source/markdown/podman-run.1.md.in @@ -43,7 +43,7 @@ pages. ## IMAGE The image is specified using transport:path format. If no transport is specified, the `docker` (container registry) -transport will be used by default. For remote Podman, including Mac and Windows (excluding WSL2) machines, `docker` is the only allowed transport. +transport is used by default. For remote Podman, including Mac and Windows (excluding WSL2) machines, `docker` is the only allowed transport. **dir:**_path_ An existing local directory _path_ storing the manifest, layer tarballs and signatures as individual files. This @@ -55,9 +55,9 @@ is a non-standardized format, primarily useful for debugging or noninvasive cont **docker://**_docker-reference_ (Default) An image reference stored in a remote container image registry. Example: "quay.io/podman/stable:latest". The reference can include a path to a specific registry; if it does not, the -registries listed in registries.conf will be queried to find a matching image. +registries listed in registries.conf are queried to find a matching image. By default, credentials from `podman login` (stored at -$XDG_RUNTIME_DIR/containers/auth.json by default) will be used to authenticate; +$XDG_RUNTIME_DIR/containers/auth.json by default) are used to authenticate; otherwise it falls back to using credentials in $HOME/.docker/config.json. $ podman run registry.fedoraproject.org/fedora:latest echo hello @@ -151,7 +151,7 @@ it in the **containers.conf** file: see **containers.conf(5)** for more informat @@option device Note: if the user only has access rights via a group, accessing the device -from inside a rootless container will fail. Use the `--group-add keep-groups` +from inside a rootless container fails. Use the `--group-add keep-groups` flag to pass the user's supplementary group access into the container. @@option device-cgroup-rule @@ -270,7 +270,7 @@ Print usage statement Invalid if using **--dns**, **--dns-option**, or **--dns-search** with **--network** set to **none** or **container:**_id_. -If used together with **--pod**, the container will not join the pod's network namespace. +If used together with **--pod**, the container joins the pod's network namespace. @@option network-alias @@ -313,7 +313,7 @@ This is used to override the Podman provided user setup in favor of entrypoint c @@option publish -**Note:** If a container will be run within a pod, it is not necessary to publish the port for +**Note:** If a container runs within a pod, it is not necessary to publish the port for the containers in the pod. The port must only be published by the pod itself. Pod network stacks act like the network stack on the host - meaning a variety of containers in the pod and programs in the container all share a single interface, IP address, and @@ -459,7 +459,7 @@ to volumes if they need to write to file systems at all. Applications can be made more secure by running them in read-only mode using the **--read-only** switch. This protects the container's image from modification. By default read-only containers can write to temporary data. Podman mounts a tmpfs on _/run_ and -_/tmp_ within the container. If the container should not write to any file +_/tmp_ within the container. If the container does not write to any file system within the container, including tmpfs, set --read-only-tmpfs=false. ``` @@ -491,11 +491,11 @@ Then exit and check the journal. $ journalctl -b | grep Hello ``` -This should list the message sent to logger. +This lists the message sent to the logger. ### Attaching to one or more from STDIN, STDOUT, STDERR -Without specifying the **-a** option, Podman will attach everything (stdin, stdout, stderr). +Without specifying the **-a** option, Podman attaches everything (stdin, stdout, stderr). Override the default by specifying -a (stdin, stdout, stderr), as in: ``` @@ -582,8 +582,8 @@ $ podman run -p 8080:80 -d -i -t fedora/httpd To mount a host directory as a container volume, specify the absolute path to the directory and the absolute path for the container directory separated by a colon. If the source is a named volume maintained by Podman, it is recommended to -use its name rather than the path to the volume. Otherwise the volume will be -considered as an orphan and wiped by the **podman volume prune** command: +use its name rather than the path to the volume. Otherwise the volume is +considered an orphan and wiped by the **podman volume prune** command: ``` $ podman run -v /var/db:/data1 -i -t fedora bash @@ -619,7 +619,7 @@ $ podman run --mount type=bind,src=volume-name,target=/data1 busybox sh When using SELinux, be aware that the host has no knowledge of container SELinux policy. Therefore, in the above example, if SELinux policy is enforced, the _/var/db_ directory is not writable to the container. A "Permission Denied" -message will occur and an **avc:** message in the host's syslog. +message occurs, and an **avc:** message is added to the host's syslog. To work around this, at time of writing this man page, the following command needs to be run in order for the proper SELinux policy type label to be attached @@ -629,8 +629,8 @@ to the host directory: $ chcon -Rt svirt_sandbox_file_t /var/db ``` -Now, writing to the _/data1_ volume in the container will be allowed and the -changes will also be reflected on the host in _/var/db_. +Now, writing to the _/data1_ volume in the container is allowed and the +changes are reflected on the host in _/var/db_. ### Using alternative security labeling @@ -665,7 +665,7 @@ command: $ podman run --security-opt label=type:svirt_apache_t -i -t centos bash ``` -Note an SELinux policy defining a **svirt_apache_t** type would need to be written. +Note that an SELinux policy defining a **svirt_apache_t** type must be written. To mask additional specific paths in the container, specify the paths separated by a colon using the **mask** option with the **--security-opt** @@ -763,8 +763,8 @@ $ podman run --tz=US/Eastern alpine date ### Adding dependency containers -The first container, container1, is not started initially, but must be running before container2 will start. -The `podman run` command will start the container automatically before starting container2. +The first container, container1, is not started initially, but must be running before container2 starts. +The `podman run` command starts the container automatically before starting container2. ``` $ podman create --name container1 -t -i fedora bash @@ -801,7 +801,7 @@ $ podman run --name container1 --rootfs /path/to/rootfs:O bash In order to use a timezone other than UTC when running a Java application within a container, the `TZ` environment variable must be -set within the container. Java applications will ignore the value set with the +set within the container. Java applications ignores the value set with the `--tz` option. ``` @@ -843,10 +843,10 @@ Environment variables within containers can be set using multiple different opti in the following order of precedence (later entries override earlier entries): - Container image: Any environment variables specified in the container image. -- **--http-proxy**: By default, several environment variables will be passed in from the host, such as **http_proxy** and **no_proxy**. See **--http-proxy** for details. +- **--http-proxy**: By default, several environment variables are passed in from the host, such as **http_proxy** and **no_proxy**. See **--http-proxy** for details. - **--env-host**: Host environment of the process executing Podman is added. - **--env-file**: Any environment variables specified via env-files. If multiple files are specified, then they override each other in order of entry. -- **--env**: Any environment variables specified will override previous settings. +- **--env**: Any environment variables specified overrides previous settings. Run containers and set the environment ending with a __*__. The trailing __*__ glob functionality is only active when no value is specified: @@ -896,4 +896,4 @@ June 2014, updated by Sven Dowideit `` April 2014, Originally compiled by William Henry `` based on docker.com source material and internal work. ## FOOTNOTES -1: The Podman project is committed to inclusivity, a core value of open source. The `master` and `slave` mount propagation terminology used here is problematic and divisive, and should be changed. However, these terms are currently used within the Linux kernel and must be used as-is at this time. When the kernel maintainers rectify this usage, Podman will follow suit immediately. +1: The Podman project is committed to inclusivity, a core value of open source. The `master` and `slave` mount propagation terminology used here is problematic and divisive, and needs to be changed. However, these terms are currently used within the Linux kernel and must be used as-is at this time. When the kernel maintainers rectify this usage, Podman will follow suit immediately. diff --git a/docs/source/markdown/podman-save.1.md.in b/docs/source/markdown/podman-save.1.md.in index cf5354ef84..f9719868d1 100644 --- a/docs/source/markdown/podman-save.1.md.in +++ b/docs/source/markdown/podman-save.1.md.in @@ -12,7 +12,7 @@ podman\-save - Save image(s) to an archive **podman save** saves an image to a local file or directory. **podman save** writes to STDOUT by default and can be redirected to a file using the **output** flag. The **quiet** flag suppresses the output when set. -**podman save** will save parent layers of the image(s) and the image(s) can be loaded using **podman load**. +**podman save** saves parent layers of the image(s) and the image(s) can be loaded using **podman load**. To export the containers, use the **podman export**. Note: `:` is a restricted character and cannot be part of the file name. @@ -45,7 +45,7 @@ Print usage statement #### **--multi-image-archive**, **-m** -Allow for creating archives with more than one image. Additional names will be interpreted as images instead of tags. Only supported for **--format=docker-archive**. +Allow for creating archives with more than one image. Additional names are interpreted as images instead of tags. Only supported for **--format=docker-archive**. The default for this option can be modified via the `multi_image_archive="true"|"false"` flag in containers.conf. #### **--output**, **-o**=*file* diff --git a/docs/source/markdown/podman-search.1.md.in b/docs/source/markdown/podman-search.1.md.in index 8fcc8239ed..9bd0be6e8b 100644 --- a/docs/source/markdown/podman-search.1.md.in +++ b/docs/source/markdown/podman-search.1.md.in @@ -13,14 +13,14 @@ The user can specify which registry to search by prefixing the registry in the s unqualified-search registries in `containers-registries.conf(5)` are used. The default number of results is 25. The number of results can be limited using the **--limit** flag. -If more than one registry is being searched, the limit will be applied to each registry. The output can be filtered +If more than one registry is being searched, the limit is applied to each registry. The output can be filtered using the **--filter** flag. To get all available images in a registry without a specific search term, the user can just enter the registry name with a trailing "/" (example **registry.fedoraproject.org/**). Note that **podman search** is not a reliable way to determine the presence or existence of an image. The search behavior of the v1 and v2 Docker distribution API is specific to the implementation of each registry. Some registries may not support searching at all. -Further note that searching without a search term will only work for registries that implement the v2 API. +Further note that searching without a search term only works for registries that implement the v2 API. **podman [GLOBAL OPTIONS]** @@ -76,9 +76,9 @@ Print usage statement #### **--limit**=*limit* Limit the number of results (default 25). -Note: The results from each registry will be limited to this value. +Note: The results from each registry is 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). +number of results is 20, 10 from each (if there are at least 10 matches in each). The order of the search results is the order in which the API endpoint returns the results. #### **--list-tags** @@ -129,13 +129,13 @@ registry.access.redhat.com/ubi8 8.4-199 registry.access.redhat.com/ubi8 8.4-211-source ``` -Note: This works only with registries that implement the v2 API. If tried with a v1 registry an error will be returned. +Note: This works only with registries that implement the v2 API. If tried with a v1 registry an error is returned. ## FILES **registries.conf** (`/etc/containers/registries.conf`) -registries.conf is the configuration file which specifies which container registries should be consulted when completing image names which do not include a registry or domain portion. +registries.conf is the configuration file which specifies which container registries is consulted when completing image names which do not include a registry or domain portion. ## SEE ALSO **[podman(1)](podman.1.md)**, **[containers-registries(5)](https://github.com/containers/image/blob/main/docs/containers-registries.5.md)** diff --git a/docs/source/markdown/podman-secret-create.1.md b/docs/source/markdown/podman-secret-create.1.md index fc6d72efb6..1024a35fdd 100644 --- a/docs/source/markdown/podman-secret-create.1.md +++ b/docs/source/markdown/podman-secret-create.1.md @@ -13,10 +13,10 @@ Creates a secret using standard input or from a file for the secret content. Create accepts a path to a file, or `-`, which tells podman to read the secret from stdin A secret is a blob of sensitive data which a container needs at runtime but -should not be stored in the image or in source control, such as usernames and passwords, +is not stored in the image or in source control, such as usernames and passwords, TLS certificates and keys, SSH keys or other important generic strings or binary content (up to 500 kb in size). -Secrets will not be committed to an image with `podman commit`, and will not be in the archive created by a `podman export` +Secrets are not committed to an image with `podman commit`, and does not get committed in the archive created by a `podman export` command. ## OPTIONS diff --git a/docs/source/markdown/podman-secret-exists.1.md b/docs/source/markdown/podman-secret-exists.1.md index e240646319..9dd68db9a4 100644 --- a/docs/source/markdown/podman-secret-exists.1.md +++ b/docs/source/markdown/podman-secret-exists.1.md @@ -7,8 +7,8 @@ podman\-secret\-exists - Check if the given secret exists **podman secret exists** *secret* ## DESCRIPTION -**podman secret exists** checks if a secret exists. Podman will return an exit code -of `0` when the secret is found. A `1` will be returned otherwise. An exit code of +**podman secret exists** checks if a secret exists. Podman returns an exit code +of `0` when the secret is found. A `1` is returned otherwise. An exit code of `125` indicates there was another issue. diff --git a/docs/source/markdown/podman-secret-inspect.1.md b/docs/source/markdown/podman-secret-inspect.1.md index a1de6f42dc..1d03dc8293 100644 --- a/docs/source/markdown/podman-secret-inspect.1.md +++ b/docs/source/markdown/podman-secret-inspect.1.md @@ -10,7 +10,7 @@ podman\-secret\-inspect - Display detailed information on one or more secrets Inspects the specified secret. -By default, this renders all results in a JSON array. If a format is specified, the given template will be executed for each result. +By default, this renders all results in a JSON array. If a format is specified, the given template is executed for each result. Secrets can be queried individually by providing their full name or a unique partial name. ## OPTIONS diff --git a/docs/source/markdown/podman-secret-rm.1.md b/docs/source/markdown/podman-secret-rm.1.md index 820c8515cd..5f439987a2 100644 --- a/docs/source/markdown/podman-secret-rm.1.md +++ b/docs/source/markdown/podman-secret-rm.1.md @@ -11,10 +11,10 @@ podman\-secret\-rm - Remove one or more secrets Removes one or more secrets. `podman secret rm` is safe to use on secrets that are in use by a container. -The created container will still have access to the secret data because secrets are +The created container has access to the secret data because secrets are copied and mounted into the container when a container is created. If a secret is deleted and -another secret is created with the same name, the secret inside the container will not change; -the old secret value will still remain. +another secret is created with the same name, the secret inside the container does not change; +the old secret value still remains. ## OPTIONS diff --git a/docs/source/markdown/podman-stats.1.md.in b/docs/source/markdown/podman-stats.1.md.in index 2be6b376a9..710a191334 100644 --- a/docs/source/markdown/podman-stats.1.md.in +++ b/docs/source/markdown/podman-stats.1.md.in @@ -11,7 +11,7 @@ podman\-stats - Display a live stream of one or more container's resource usage ## DESCRIPTION Display a live stream of one or more containers' resource usage statistics -Note: Podman stats will not work in rootless environments that use CGroups V1. +Note: Podman stats does not work in rootless environments that use CGroups V1. Podman stats relies on CGroup information for statistics, and CGroup v1 is not supported for rootless use cases. @@ -122,7 +122,7 @@ ID NAME MEM USAGE / LIMIT ``` Note: When using a slirp4netns network with the rootlesskit port -handler, the traffic send via the port forwarding will be accounted to +handler, the traffic sent via the port forwarding is accounted to the `lo` device. Traffic accounted to `lo` is not accounted in the stats output. diff --git a/docs/source/markdown/podman-system-connection-add.1.md b/docs/source/markdown/podman-system-connection-add.1.md index f06cd27805..967c8d1d90 100644 --- a/docs/source/markdown/podman-system-connection-add.1.md +++ b/docs/source/markdown/podman-system-connection-add.1.md @@ -13,7 +13,7 @@ Record ssh destination for remote podman service(s). The ssh destination is give - unix://path - tcp://hostname:port -The user will be prompted for the remote ssh login password or key file pass phrase as required. The `ssh-agent` is supported if it is running. +The user is prompted for the remote ssh login password or key file pass phrase as required. The `ssh-agent` is supported if it is running. ## OPTIONS diff --git a/docs/source/markdown/podman-system-connection.1.md b/docs/source/markdown/podman-system-connection.1.md index 007fb0d223..bcc37ff363 100644 --- a/docs/source/markdown/podman-system-connection.1.md +++ b/docs/source/markdown/podman-system-connection.1.md @@ -9,7 +9,7 @@ podman\-system\-connection - Manage the destination(s) for Podman service(s) ## DESCRIPTION Manage the destination(s) for Podman service(s). -The user will be prompted for the ssh login password or key file pass phrase as required. The `ssh-agent` is supported if it is running. +The user is prompted for the ssh login password or key file pass phrase as required. The `ssh-agent` is supported if it is running. ## COMMANDS diff --git a/docs/source/markdown/podman-system-migrate.1.md b/docs/source/markdown/podman-system-migrate.1.md index 2e9cf02e32..14b5e137b9 100644 --- a/docs/source/markdown/podman-system-migrate.1.md +++ b/docs/source/markdown/podman-system-migrate.1.md @@ -30,7 +30,7 @@ newly configured mappings. Set a new OCI runtime for all containers. This can be used after a system upgrade which changes the default OCI runtime to move all containers to the new runtime. -There are no guarantees that the containers will continue to work under the new runtime, as some runtimes support differing options and configurations. +There are no guarantees that the containers continue to work under the new runtime, as some runtimes support differing options and configurations. ## SEE ALSO **[podman(1)](podman.1.md)**, **[podman-system(1)](podman-system.1.md)**, **usermod(8)** diff --git a/docs/source/markdown/podman-system-prune.1.md b/docs/source/markdown/podman-system-prune.1.md index 0b9482605e..fece09f69f 100644 --- a/docs/source/markdown/podman-system-prune.1.md +++ b/docs/source/markdown/podman-system-prune.1.md @@ -20,9 +20,9 @@ Recursively remove all unused pods, containers, images, networks, and volume dat #### **--external** -Removes all leftover container storage files from local storage that are not managed by podman. In normal circumstances no such data should exist, but in case of an unclean shutdown the podman database may be corrupted and cause his. +Removes all leftover container storage files from local storage not managed by Podman. In normal circumstances, no such data exists, but in case of an unclean shutdown, the Podman database may be corrupted and cause this. -However, when using transient storage mode, the Podman database does not persist. This means containers will leave the writable layers on disk after a reboot. When using a transient store, it is recommended that the **podman system prune --external** command is run during boot. +However, when using transient storage mode, the Podman database does not persist. This means containers leave the writable layers on disk after a reboot. When using a transient store, it is recommended that the **podman system prune --external** command is run during boot. This option is incompatible with **--all** and **--filter** and drops the default behaviour of removing unused resources. diff --git a/docs/source/markdown/podman-system-renumber.1.md b/docs/source/markdown/podman-system-renumber.1.md index 845fc2c533..a7059d302a 100644 --- a/docs/source/markdown/podman-system-renumber.1.md +++ b/docs/source/markdown/podman-system-renumber.1.md @@ -13,7 +13,7 @@ Each Podman container and pod is allocated a lock at creation time, up to a maxi When all available locks are exhausted, no further containers and pods can be created until some existing containers and pods are removed. This can be avoided by increasing the number of locks available via modifying **containers.conf** and subsequently running **podman system renumber** to prepare the new locks (and reallocate lock numbers to fit the new struct). -**podman system renumber** must be called after any changes to **num_locks** - failure to do so will result in errors starting Podman as the number of locks available conflicts with the configured number of locks. +**podman system renumber** must be called after any changes to **num_locks** - failure to do so results in errors starting Podman as the number of locks available conflicts with the configured number of locks. **podman system renumber** can also be used to migrate 1.0 and earlier versions of Podman, which used a different locking scheme, to the new locking model. It is not strictly required to do this, but it is highly recommended to do so as deadlocks can occur otherwise. diff --git a/docs/source/markdown/podman-system-service.1.md b/docs/source/markdown/podman-system-service.1.md index 13aa3d60c4..ddf96a6eeb 100644 --- a/docs/source/markdown/podman-system-service.1.md +++ b/docs/source/markdown/podman-system-service.1.md @@ -7,9 +7,9 @@ podman\-system\-service - Run an API service **podman system service** [*options*] ## DESCRIPTION -The **podman system service** command creates a listening service that will answer API calls for Podman. You may +The **podman system service** command creates a listening service that answers 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 rootful +If no endpoint is provided, defaults is 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*) @@ -19,10 +19,10 @@ To access the API service inside a container: The REST API provided by **podman system service** is split into two parts: a compatibility layer offering support for the Docker v1.40 API, and a Podman-native Libpod layer. Documentation for the latter is available at *https://docs.podman.io/en/latest/_static/api.html*. -Both APIs are versioned, but the server will not reject requests with an unsupported version set. +Both APIs are versioned, but the server does not reject requests with an unsupported version set. -Please note that the API grants full access to Podman's capabilities, and as such should be treated as allowing arbitrary code execution as the user running the API. -As such, we strongly recommend against making the API socket available via the network. +Please note that the API grants full access to Podman's capabilities, and allows arbitrary code execution as the user running the API. +We strongly recommend against making the API socket available via the network. The default configuration (a Unix socket with permissions set to only allow the user running Podman) is the most secure way of running the API. Note: The default systemd unit files (system and user) change the log-level option to *info* from *error*. This change provides additional information on each API call. @@ -40,7 +40,7 @@ Print usage statement. #### **--time**, **-t** The time until the session expires in _seconds_. The default is 5 -seconds. A value of `0` means no timeout, therefore the session will not expire. +seconds. A value of `0` means no timeout, therefore the session does not expire. The default timeout can be changed via the `service_timeout=VALUE` field in containers.conf. See **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)** for more information. diff --git a/docs/source/markdown/podman-systemd.unit.5.md b/docs/source/markdown/podman-systemd.unit.5.md index 1c5a8d185d..9cc69512d2 100644 --- a/docs/source/markdown/podman-systemd.unit.5.md +++ b/docs/source/markdown/podman-systemd.unit.5.md @@ -36,14 +36,14 @@ Files with the `.network` extension are only read if they are mentioned in a `.c The Podman files use the same format as [regular systemd unit files](https://www.freedesktop.org/software/systemd/man/systemd.syntax.html). Each file type has a custom section (for example, `[Container]`) that is handled by Podman, and all -other sections will be passed on untouched, allowing the use of any normal systemd configuration options +other sections are passed on untouched, allowing the use of any normal systemd configuration options like dependencies or cgroup limits. For rootless containers, when administrators place Quadlet files in the -/etc/containers/systemd/users directory, all users' sessions will execute the +/etc/containers/systemd/users directory, all users' sessions execute the Quadlet when the login session begins. If the administrator places a Quadlet file in the /etc/containers/systemd/user/${UID}/ directory, then only the -user with the matching UID will execute the Quadlet when the login +user with the matching UID execute the Quadlet when the login session gets started. @@ -54,7 +54,7 @@ persistence rules as regular units. In particular, it is not possible to "system in order for them to become automatically enabled on the next boot. To compensate for this, the generator manually applies the `[Install]` section of the container definition -unit files during generation, in the same way `systemctl enable` would do when run later. +unit files during generation, in the same way `systemctl enable` does when run later. For example, to start a container on boot, add something like this to the file: @@ -72,15 +72,15 @@ true for other kinds of dependencies, too, like `After=other.service`. ## Container units [Container] Container units are named with a `.container` extension and contain a `[Container]` section describing -the container that should be run as a service. The resulting service file will contain a line like +the container that is run as a service. The resulting service file contains a line like `ExecStart=podman run … image-name`, and most of the keys in this section control the command-line options passed to Podman. However, some options also affect the details of how systemd is set up to run and interact with the container. -By default, the Podman container will have the same name as the unit, but with a `systemd-` prefix. -I.e. a `$name.container` file will create a `$name.service` unit and a `systemd-$name` Podman container. +By default, the Podman container has the same name as the unit, but with a `systemd-` prefix. +I.e. a `$name.container` file creates a `$name.service` unit and a `systemd-$name` Podman container. -There is only one required key, `Image`, which defines the container image the service should run. +There is only one required key, `Image`, which defines the container image the service runs. Valid options for `[Container]` are listed below: @@ -170,7 +170,7 @@ This key can be listed multiple times. ### `ContainerName=` The (optional) name of the Podman container. If this is not specified, the default value -of `systemd-%N` will be used, which is the same as the service name but with a `systemd-` +of `systemd-%N` is used, which is the same as the service name but with a `systemd-` prefix to avoid conflicts with user-managed containers. ### `DropCapability=` (defaults to `all`) @@ -232,7 +232,7 @@ Equivalent to the Podman `--health-interval` option. Action to take once the container transitions to an unhealthy state. The "kill" action in combination integrates best with systemd. Once -the container turns unhealthy, it gets killed and systemd will restart +the container turns unhealthy, it gets killed, and systemd restarts the service. Equivalent to the Podman `--health-on-failure` option. @@ -263,7 +263,7 @@ Equivalent to the Podman `--health-startup-retries` option. ### `HealthStartupSuccess=` -The number of successful runs required before the startup healthcheck will succeed and the regular healthcheck will begin. +The number of successful runs required before the startup healthcheck succeeds and the regular healthcheck begins. Equivalent to the Podman `--health-startup-success` option. ### `HealthStartupTimeout=` @@ -284,7 +284,7 @@ Equivalent to the Podman `--hostname` option. ### `Image=` The image to run in the container. This image must be locally installed for the service to work -when it is activated, because the generated service file will never try to download images. +when it is activated, because the generated service file never tries to download images. It is recommended to use a fully qualified image name rather than a short name, both for performance and robustness reasons. @@ -310,7 +310,7 @@ This key can be listed multiple times. ### `LogDriver=` -Set the log-driver Podman should use when running the container. +Set the log-driver used by Podman when running the container. Equivalent to the Podman `--log-driver` option. ### `Mount=` @@ -320,7 +320,7 @@ This is equivalent to the Podman `--mount` option, and generally has the form `type=TYPE,TYPE-SPECIFIC-OPTION[,...]`. As a special case, for `type=volume` if `source` ends with `.volume`, a Podman named volume called -`systemd-$name` will be used as the source, and the generated systemd service will contain +`systemd-$name` is used as the source, and the generated systemd service contains a dependency on the `$name-volume.service`. Such a volume can be automatically be lazily created by using a `$name.volume` Quadlet file. @@ -333,7 +333,7 @@ to `podman run`. For example, use `host` to use the host network in the containe not set up networking in the container. As a special case, if the `name` of the network ends with `.network`, a Podman network called -`systemd-$name` will be used, and the generated systemd service will contain +`systemd-$name` is used, and the generated systemd service contains a dependency on the `$name-network.service`. Such a network can be automatically created by using a `$name.network` Quadlet file. @@ -358,7 +358,7 @@ By default, Podman is run in such a way that the systemd startup notify command the container runtime. In other words, the service is deemed started when the container runtime starts the child in the container. However, if the container application supports [sd_notify](https://www.freedesktop.org/software/systemd/man/sd_notify.html), then setting -`Notify`to true will pass the notification details to the container allowing it to notify +`Notify`to true passes the notification details to the container allowing it to notify of startup on its own. ### `PodmanArgs=` @@ -381,10 +381,10 @@ the form `ip:hostPort:containerPort`, `ip::containerPort`, `hostPort:containerPo `containerPort`, where the number of host and container ports must be the same (in the case of a range). -If the IP is set to 0.0.0.0 or not set at all, the port will be bound on all IPv4 addresses on +If the IP is set to 0.0.0.0 or not set at all, the port is bound on all IPv4 addresses on the host; use [::] for IPv6. -Note that not listing a host port means that Podman will automatically select one, and it +Note that not listing a host port means that Podman automatically selects one, and it may be different for each invocation of service. This makes that a less useful option. The allocated port can be found with the `podman port` command. @@ -394,11 +394,11 @@ This key can be listed multiple times. If enabled, makes image read-only, with /var/tmp, /tmp and /run a tmpfs (unless disabled by `VolatileTmp=no`).r -**NOTE:** Podman will automatically copy any content from the image onto the tmpfs +**NOTE:** Podman automatically copies any content from the image onto the tmpfs ### `RunInit=` (default to `no`) -If enabled, the container will have a minimal init process inside the +If enabled, the container has a minimal init process inside the container that forwards signals and reaps processes. ### `SeccompProfile=` @@ -450,19 +450,19 @@ generally has the form `MODE[:OPTIONS,...]`. ### `VolatileTmp=` (default to `no`, or `yes` if `ReadOnly` enabled) -If enabled, the container will have a fresh tmpfs mounted on `/tmp`. +If enabled, the container has a fresh tmpfs mounted on `/tmp`. -**NOTE:** Podman will automatically copy any content from the image onto the tmpfs +**NOTE:** Podman automatically copies any content from the image onto the tmpfs ### `Volume=` Mount a volume in the container. This is equivalent to the Podman `--volume` option, and generally has the form `[[SOURCE-VOLUME|HOST-DIR:]CONTAINER-DIR[:OPTIONS]]`. -If `SOURCE-VOLUME` starts with `.`, Quadlet will resolve the path relative to the location of the unit file. +If `SOURCE-VOLUME` starts with `.`, Quadlet resolves the path relative to the location of the unit file. As a special case, if `SOURCE-VOLUME` ends with `.volume`, a Podman named volume called -`systemd-$name` will be used as the source, and the generated systemd service will contain +`systemd-$name` is used as the source, and the generated systemd service contains a dependency on the `$name-volume.service`. Such a volume can be automatically be lazily created by using a `$name.volume` Quadlet file. @@ -471,7 +471,7 @@ This key can be listed multiple times. ## Kube units [Kube] Kube units are named with a `.kube` extension and contain a `[Kube]` section describing -how `podman kube play` should be run as a service. The resulting service file will contain a line like +how `podman kube play` runs as a service. The resulting service file contains a line like `ExecStart=podman kube play … file.yml`, and most of the keys in this section control the command-line options passed to Podman. However, some options also affect the details of how systemd is set up to run and interact with the container. @@ -501,7 +501,7 @@ This key may be used multiple times ### `LogDriver=` -Set the log-driver Podman should use when running the container. +Set the log-driver Podman uses when running the container. Equivalent to the Podman `--log-driver` option. ### `Network=` @@ -511,7 +511,7 @@ to `podman kube play`. For example, use `host` to use the host network in the co not set up networking in the container. As a special case, if the `name` of the network ends with `.network`, a Podman network called -`systemd-$name` will be used, and the generated systemd service will contain +`systemd-$name` is used, and the generated systemd service contains a dependency on the `$name-network.service`. Such a network can be automatically created by using a `$name.network` Quadlet file. @@ -525,12 +525,12 @@ the form `ip:hostPort:containerPort`, `ip::containerPort`, `hostPort:containerPo `containerPort`, where the number of host and container ports must be the same (in the case of a range). -If the IP is set to 0.0.0.0 or not set at all, the port will be bound on all IPv4 addresses on +If the IP is set to 0.0.0.0 or not set at all, the port is bound on all IPv4 addresses on the host; use [::] for IPv6. -The list of published ports specified in the unit file will be merged with the list of ports specified +The list of published ports specified in the unit file is merged with the list of ports specified in the Kubernetes YAML file. If the same container port and protocol is specified in both, the -entry from the unit file will take precedence +entry from the unit file takes precedence This key can be listed multiple times. @@ -549,12 +549,11 @@ Network files are named with a `.network` extension and contain a section `[Netw named Podman network. The generated service is a one-time command that ensures that the network exists on the host, creating it if needed. -For a network file named `$NAME.network`, the generated Podman network will be called `systemd-$NAME`, +For a network file named `$NAME.network`, the generated Podman network is called `systemd-$NAME`, and the generated service file `$NAME-network.service`. Using network units allows containers to depend on networks being automatically pre-created. This is -particularly interesting when using special options to control network creation, as Podman will -otherwise create networks with the default options. +particularly interesting when using special options to control network creation, as Podman otherwise creates networks with the default options. Valid options for `[Network]` are listed below: @@ -646,12 +645,12 @@ Volume files are named with a `.volume` extension and contain a section `[Volume named Podman volume. The generated service is a one-time command that ensures that the volume exists on the host, creating it if needed. -For a volume file named `$NAME.volume`, the generated Podman volume will be called `systemd-$NAME`, +For a volume file named `$NAME.volume`, the generated Podman volume is called `systemd-$NAME`, and the generated service file `$NAME-volume.service`. Using volume units allows containers to depend on volumes being automatically pre-created. This is -particularly interesting when using special options to control volume creation, as Podman will -otherwise create volumes with the default options. +particularly interesting when using special options to control volume creation, +as Podman otherwise creates volumes with the default options. Valid options for `[Volume]` are listed below: @@ -672,7 +671,7 @@ volume on the first run. ### `Device=` -The path of a device which should be mounted for the volume. +The path of a device which is mounted for the volume. ### `Group=` diff --git a/docs/source/markdown/podman-tag.1.md b/docs/source/markdown/podman-tag.1.md index 38ccfaec8f..9f99e4c050 100644 --- a/docs/source/markdown/podman-tag.1.md +++ b/docs/source/markdown/podman-tag.1.md @@ -11,7 +11,7 @@ podman\-tag - Add an additional name to a local image ## DESCRIPTION Assigns a new image name to an existing image. A full name refers to the entire image name, including the optional *tag* after the `:`. If there is no *tag* -provided, then podman will default to `latest` for both the *image* and the +provided, then Podman defaults to `latest` for both the *image* and the *target-name*. ## OPTIONS diff --git a/docs/source/markdown/podman-top.1.md.in b/docs/source/markdown/podman-top.1.md.in index 191cf53b1c..82d3ecc8cd 100644 --- a/docs/source/markdown/podman-top.1.md.in +++ b/docs/source/markdown/podman-top.1.md.in @@ -9,7 +9,7 @@ podman\-top - Display the running processes of a container **podman container top** [*options*] *container* [*format-descriptors*] ## DESCRIPTION -Display the running processes of the container. The *format-descriptors* are ps (1) compatible AIX format descriptors but extended to print additional information, such as the seccomp mode or the effective capabilities of a given process. The descriptors can either be passed as separated arguments or as a single comma-separated argument. Note that options and or flags of ps(1) can also be specified; in this case, Podman will fallback to executing ps with the specified arguments and flags in the container. Please use the "h*" descriptors to extract host-related information. For instance, `podman top $name hpid huser` to display the PID and user of the processes in the host context. +Display the running processes of the container. The *format-descriptors* are ps (1) compatible AIX format descriptors but extended to print additional information, such as the seccomp mode or the effective capabilities of a given process. The descriptors can either be passed as separated arguments or as a single comma-separated argument. Note that options and or flags of ps(1) can also be specified; in this case, Podman falls back to executing ps with the specified arguments and flags in the container. Please use the "h*" descriptors to extract host-related information. For instance, `podman top $name hpid huser` to display the PID and user of the processes in the host context. ## OPTIONS @@ -90,7 +90,7 @@ PID SECCOMP COMMAND %CPU 8 filter vi /etc/ 0.000 ``` -Podman will fallback to executing ps(1) in the container if an unknown descriptor is specified. +Podman falls back to executing ps(1) in the container if an unknown descriptor is specified. ``` $ podman top -l -- aux diff --git a/docs/source/markdown/podman-unmount.1.md.in b/docs/source/markdown/podman-unmount.1.md.in index ccd7fd44ba..8e09d6f58f 100644 --- a/docs/source/markdown/podman-unmount.1.md.in +++ b/docs/source/markdown/podman-unmount.1.md.in @@ -29,15 +29,14 @@ Buildah and CRI-O. ## OPTIONS #### **--all**, **-a** -All of the currently mounted containers will be unmounted. +All of the currently mounted containers are unmounted. #### **--force**, **-f** Force the unmounting of specified containers' root file system, even if other processes have mounted it. -Note: This could cause other processes that are using the file system to fail, -as the mount point could be removed without their knowledge. +Note: Other processes can fail if the mount point they are using is removed without their knowledge. @@option latest diff --git a/docs/source/markdown/podman-untag.1.md b/docs/source/markdown/podman-untag.1.md index f9ea2b6440..029a291866 100644 --- a/docs/source/markdown/podman-untag.1.md +++ b/docs/source/markdown/podman-untag.1.md @@ -9,7 +9,7 @@ podman\-untag - Removes one or more names from a locally-stored image **podman image untag** *image* [*name*[:*tag*]...] ## DESCRIPTION -Remove one or more names from an image in the local storage. The image can be referred to by ID or reference. If no name is specified, all names are removed from the image. If a specified name is a short name and does not include a registry, `localhost/` will be prefixed (e.g., `fedora` -> `localhost/fedora`). If a specified name does not include a tag, `:latest` will be appended (e.g., `localhost/fedora` -> `localhost/fedora:latest`). +Remove one or more names from an image in the local storage. The image can be referred to by ID or reference. If no name is specified, all names are removed from the image. If a specified name is a short name and does not include a registry, `localhost/` is prefixed (e.g., `fedora` -> `localhost/fedora`). If a specified name does not include a tag, `:latest` is appended (e.g., `localhost/fedora` -> `localhost/fedora:latest`). ## OPTIONS diff --git a/docs/source/markdown/podman-update.1.md.in b/docs/source/markdown/podman-update.1.md.in index bcdd6ebc1c..487220fe6f 100644 --- a/docs/source/markdown/podman-update.1.md.in +++ b/docs/source/markdown/podman-update.1.md.in @@ -11,8 +11,8 @@ podman\-update - Updates the cgroup configuration of a given container ## DESCRIPTION Updates the cgroup configuration of an already existing container. The currently supported options are a subset of the -podman create/run resource limits options. These new options are non-persistent and only last for the current execution of the container; the configuration will be honored on its next run. -This means that this command can only be executed on an already running container and the changes made will be erased the next time the container is stopped and restarted, this is to ensure immutability. +podman create/run resource limits options. These new options are non-persistent and only last for the current execution of the container; the configuration is honored on its next run. +This means that this command can only be executed on an already running container and the changes made is erased the next time the container is stopped and restarted, this is to ensure immutability. This command takes one argument, a container name or ID, alongside the resource flags to modify the cgroup. ## OPTIONS diff --git a/docs/source/markdown/podman-volume-create.1.md b/docs/source/markdown/podman-volume-create.1.md index 2253551f0e..683f1931b6 100644 --- a/docs/source/markdown/podman-volume-create.1.md +++ b/docs/source/markdown/podman-volume-create.1.md @@ -23,9 +23,9 @@ There are two drivers supported by Podman itself: **local** and **image**. The **local** driver uses a directory on disk as the backend by default, but can also use the **mount(8)** command to mount a filesystem as the volume if **--opt** is specified. The **image** driver uses an image as the backing store of for the volume. -An overlay filesystem will be created, which allows changes to the volume to be committed as a new layer on top of the image. +An overlay filesystem is created, which allows changes to the volume to be committed as a new layer on top of the image. -Using a value other than **local** or **image**, Podman will attempt to create the volume using a volume plugin with the given name. +Using a value other than **local** or **image**, Podman attempts to create the volume using a volume plugin with the given name. Such plugins must be defined in the **volume_plugins** section of the **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)** configuration file. #### **--help** @@ -106,7 +106,7 @@ xfs_quota -x -c 'project -s storage volumes' / In the example above we are configuring the overlay storage driver for newly created containers as well as volumes to use project IDs with a **start offset**. -All containers will be assigned larger project IDs (e.g. >= 100000). +All containers are assigned larger project IDs (e.g. >= 100000). All volume assigned project IDs larger project IDs starting with 200000. This prevents xfs_quota management conflicts with containers/storage. diff --git a/docs/source/markdown/podman-volume-exists.1.md b/docs/source/markdown/podman-volume-exists.1.md index 37aa2b61aa..8e1580db6d 100644 --- a/docs/source/markdown/podman-volume-exists.1.md +++ b/docs/source/markdown/podman-volume-exists.1.md @@ -7,8 +7,8 @@ podman\-volume\-exists - Check if the given volume exists **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 +**podman volume exists** checks if a volume exists. Podman returns an exit code +of `0` when the volume is found. A `1` is returned otherwise. An exit code of `125` indicates there was another issue. diff --git a/docs/source/markdown/podman-volume-import.1.md b/docs/source/markdown/podman-volume-import.1.md index a69ac991b1..84c402d5c5 100644 --- a/docs/source/markdown/podman-volume-import.1.md +++ b/docs/source/markdown/podman-volume-import.1.md @@ -9,10 +9,10 @@ podman\-volume\-import - Import tarball contents into an existing podman volume ## DESCRIPTION **podman volume import** imports the contents of a tarball into the podman volume's mount point. -The contents of the volume will be merged with the content of the tarball with the latter taking precedence. +The contents of the volume is merged with the content of the tarball with the latter taking precedence. **podman volume import** can consume piped input when using `-` as source path. -The given volume must already exist and will not be created by podman volume import. +The given volume must already exist and is not created by podman volume import. Note: Following command is not supported by podman-remote. diff --git a/docs/source/markdown/podman-volume-mount.1.md b/docs/source/markdown/podman-volume-mount.1.md index 9890341ac6..96268515cf 100644 --- a/docs/source/markdown/podman-volume-mount.1.md +++ b/docs/source/markdown/podman-volume-mount.1.md @@ -11,7 +11,7 @@ Mounts the specified volumes' file system in a location which can be accessed from the host, and returns its location. Rootless mode only supports mounting file volumes unless Podman is run within the user namespace -via the `podman unshare` command. All other volume types will fail to mount. +via the `podman unshare` command. All other volume types fail to mount. ## RETURN VALUE The location of the mounted file system. On error an empty string and errno is diff --git a/docs/source/markdown/podman-volume-prune.1.md b/docs/source/markdown/podman-volume-prune.1.md index ab0479b84f..a30ad3496f 100644 --- a/docs/source/markdown/podman-volume-prune.1.md +++ b/docs/source/markdown/podman-volume-prune.1.md @@ -8,8 +8,8 @@ podman\-volume\-prune - Remove all unused volumes ## DESCRIPTION -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 +Removes unused volumes. By default all unused volumes are removed, the **--filter** flag can +be used to filter specific volumes. Users are prompted to confirm the removal of all the unused volumes. To bypass the confirmation, use the **--force** flag. diff --git a/docs/source/markdown/podman-volume-rm.1.md b/docs/source/markdown/podman-volume-rm.1.md index 744b322b11..b9241d13e4 100644 --- a/docs/source/markdown/podman-volume-rm.1.md +++ b/docs/source/markdown/podman-volume-rm.1.md @@ -8,8 +8,8 @@ podman\-volume\-rm - Remove one or more volumes ## DESCRIPTION -Removes one or more volumes. Only volumes that are not being used will be removed. -If a volume is being used by a container, an error will be returned unless the **--force** +Removes one or more volumes. Only volumes that are not being used are removed. +If a volume is being used by a container, an error is returned unless the **--force** flag is being used. To remove all volumes, use the **--all** flag. Volumes can be removed individually by providing their full name or a unique partial name. @@ -22,7 +22,7 @@ Remove all volumes. #### **--force**, **-f** Remove a volume by force. -If it is being used by containers, the containers will be removed first. +If it is being used by containers, the containers are removed first. #### **--help** diff --git a/docs/source/markdown/podman-wait.1.md.in b/docs/source/markdown/podman-wait.1.md.in index 79d86c4fd0..db3ce0d54f 100644 --- a/docs/source/markdown/podman-wait.1.md.in +++ b/docs/source/markdown/podman-wait.1.md.in @@ -10,7 +10,7 @@ podman\-wait - Wait on one or more containers to stop and print their exit codes ## DESCRIPTION Waits on one or more containers to stop. The container can be referred to by its -name or ID. In the case of multiple containers, Podman will wait on each consecutively. +name or ID. In the case of multiple containers, Podman waits on each consecutively. After all specified containers are stopped, the containers' return codes are printed separated by newline in the same order as they were given to the command. diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index d34a4e68d2..7f9412c305 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -37,7 +37,7 @@ Path of the conmon binary (Default path is configured in `containers.conf`) #### **--connection**, **-c** Connection to use for remote podman, including Mac and Windows (excluding WSL2) machines, (Default connection is configured in `containers.conf`) -Setting this option will switch the **--remote** option to true. +Setting this option switches the **--remote** option to true. Remote connections use local containers.conf for default. #### **--events-backend**=*type* @@ -60,7 +60,7 @@ For the annotation conditions, libpod uses any annotations set in the generated For the bind-mount conditions, only mounts explicitly requested by the caller via `--volume` are considered. Bind mounts that libpod inserts by default (e.g. `/dev/shm`) are not considered. -If `--hooks-dir` is unset for root callers, Podman and libpod will currently default to `/usr/share/containers/oci/hooks.d` and `/etc/containers/oci/hooks.d` in order of increasing precedence. Using these defaults is deprecated, and callers should migrate to explicitly setting `--hooks-dir`. +If `--hooks-dir` is unset for root callers, Podman and libpod currently default to `/usr/share/containers/oci/hooks.d` and `/etc/containers/oci/hooks.d` in order of increasing precedence. Using these defaults is deprecated. Migrate to explicitly setting `--hooks-dir`. Podman and libpod currently support an additional `precreate` state which is called before the runtime's `create` operation. Unlike the other stages, which receive the container state on their standard input, `precreate` hooks receive the proposed runtime configuration on their standard input. They may alter that configuration as they see fit, and write the altered form to their standard output. @@ -91,14 +91,14 @@ Path to the directory where network configuration files are located. For the netavark backend "/etc/containers/networks" is used as root and "$graphroot/networks" as rootless. For the CNI backend the default is "/etc/cni/net.d" as root -and "$HOME/.config/cni/net.d" as rootless. CNI will be deprecated from Podman in the future for netavark. +and "$HOME/.config/cni/net.d" as rootless. CNI is deprecated from Podman in the future, use netavark. #### **--noout** -Redirect stdout to /dev/null. This command will prevent all stdout from the Podman command. The **--noout** option will not block stderr or stdout from containers. +Redirect stdout to /dev/null. This command prevents all stdout from the Podman command. The **--noout** option is not block stderr or stdout from containers. #### **--remote**, **-r** -When true, access to the Podman service will be remote. Defaults to false. +When true, access to the Podman service is remote. Defaults to false. Settings can be modified in the containers.conf file. If the CONTAINER_HOST environment variable is set, the **--remote** option defaults to true. @@ -107,7 +107,7 @@ environment variable is set, the **--remote** option defaults to true. 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). Default root dir configured in `containers-storage.conf(5)`. -Overriding this option will cause the *storage-opt* settings in `containers-storage.conf(5)` to be ignored. The user must specify additional options via the `--storage-opt` flag. +Overriding this option causes the *storage-opt* settings in `containers-storage.conf(5)` to be ignored. The user must specify additional options via the `--storage-opt` flag. #### **--runroot**=*value* @@ -126,7 +126,7 @@ runtime, the manpage to consult is `runc(8)`. When the machine is configured for cgroup V2, the default runtime is `crun`, the manpage to consult is `crun(8)`.). Note: Do not pass the leading `--` to the flag. To pass the runc flag `--log-format json` -to podman build, the option given would be `--runtime-flag log-format=json`. +to podman build, the option given can be `--runtime-flag log-format=json`. #### **--ssh**=*value* @@ -138,12 +138,12 @@ to use the installed ssh binary and config file declared in containers.conf. Storage driver. The default storage driver for UID 0 is configured in `containers-storage.conf(5)` in rootless mode), and is *vfs* for non-root users when *fuse-overlayfs* is not available. The `STORAGE_DRIVER` environment variable overrides the default. The --storage-driver specified driver overrides all. -Overriding this option will cause the *storage-opt* settings in `containers-storage.conf(5)` to be ignored. The user must +Overriding this option causes the *storage-opt* settings in `containers-storage.conf(5)` to be ignored. The user must specify additional options via the `--storage-opt` flag. #### **--storage-opt**=*value* -Specify a storage driver option. Default storage driver options are configured in `containers-storage.conf(5)`. The `STORAGE_OPTS` environment variable overrides the default. The --storage-opt specified options override all. Specify --storage-opt="" so no storage options will be used. +Specify a storage driver option. Default storage driver options are configured in `containers-storage.conf(5)`. The `STORAGE_OPTS` environment variable overrides the default. The --storage-opt specified options override all. Specify --storage-opt="" so no storage options is used. #### **--syslog** @@ -167,7 +167,7 @@ Default value for this is configured in `containers-storage.conf(5)`. #### **--url**=*value* URL to access Podman service (default from `containers.conf`, rootless `unix://run/user/$UID/podman/podman.sock` or as root `unix://run/podman/podman.sock`). -Setting this option will switch the **--remote** option to true. +Setting this option switches the **--remote** option to true. - `CONTAINER_HOST` is of the format `://[]@][:][]` @@ -176,7 +176,7 @@ Details: * `ssh` (default): a local unix(7) socket on the named `host` and `port`, reachable via SSH * `tcp`: an unencrypted, unauthenticated TCP connection to the named `host` and `port` * `unix`: a local unix(7) socket at the specified `path`, or the default for the user - - `user` will default to either `root` or the current running user (`ssh` only) + - `user` defaults to either `root` or the current running user (`ssh` only) - `password` has no default (`ssh` only) - `host` must be provided and is either the IP or name of the machine hosting the Podman service (`ssh` and `tcp`) - `port` defaults to 22 (`ssh` and `tcp`) @@ -379,7 +379,7 @@ If the **CONTAINERS_CONF** environment variable is set, then its value is used f The mounts.conf file specifies volume mount directories that are automatically mounted inside containers when executing the `podman run` or `podman start` commands. Administrators can override the defaults file by creating `/etc/containers/mounts.conf`. -When Podman runs in rootless mode, the file `$HOME/.config/containers/mounts.conf` will override the default if it exists. Please refer to containers-mounts.conf(5) for further details. +When Podman runs in rootless mode, the file `$HOME/.config/containers/mounts.conf` overrides the default if it exists. Please refer to containers-mounts.conf(5) for further details. **policy.json** (`/etc/containers/policy.json`) @@ -387,7 +387,7 @@ Signature verification policy files are used to specify policy, e.g. trusted key **registries.conf** (`/etc/containers/registries.conf`, `$HOME/.config/containers/registries.conf`) -registries.conf is the configuration file which specifies which container registries should be consulted when completing image names which do not include a registry or domain portion. +registries.conf is the configuration file which specifies which container registries is consulted when completing image names which do not include a registry or domain portion. Non root users of Podman can create the `$HOME/.config/containers/registries.conf` file to be used instead of the system defaults. @@ -428,11 +428,11 @@ Currently slirp4netns or pasta is required to be installed to create a network device, otherwise rootless containers need to run in the network namespace of the host. -In certain environments like HPC (High Performance Computing), users cannot take advantage of the additional UIDs and GIDs from the /etc/subuid and /etc/subgid systems. However, in this environment, rootless Podman can operate with a single UID. To make this work, set the `ignore_chown_errors` option in the `containers-storage.conf(5)` file. This option tells Podman when pulling an image to ignore chown errors when attempting to change a file in a container image to match the non-root UID in the image. This means all files get saved as the user's UID. Note this could cause issues when running the container. +In certain environments like HPC (High Performance Computing), users cannot take advantage of the additional UIDs and GIDs from the /etc/subuid and /etc/subgid systems. However, in this environment, rootless Podman can operate with a single UID. To make this work, set the `ignore_chown_errors` option in the `containers-storage.conf(5)` file. This option tells Podman when pulling an image to ignore chown errors when attempting to change a file in a container image to match the non-root UID in the image. This means all files get saved as the user's UID. Note this can cause issues when running the container. ### **NOTE:** Unsupported file systems in rootless mode -The Overlay file system (OverlayFS) is not supported with kernels prior to 5.12.9 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-overlayfs 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 Overlay file system (OverlayFS) is not supported with kernels prior to 5.12.9 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 automatically uses the fuse-overlayfs 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.