mirror of https://github.com/containers/podman
Remove future tense from man pages
Remove all will, would, could, should and use present tense. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>pull/18559/head
Daniel J Walsh
parent
3c8d120caa
commit
32c2cea0f9
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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::
|
|||
<p><em>Thank you for using nginx.</em></p>
|
||||
...
|
||||
|
||||
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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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 `<<text for pods|text for containers>>`.
|
||||
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 `<<subcommand>>` will be replaced with the podman subcommand
|
||||
The string `<<subcommand>>` 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:
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -4,6 +4,6 @@
|
|||
####> are applicable to all of those.
|
||||
#### **--cgroup-parent**=*path*
|
||||
|
||||
Path to cgroups under which the cgroup for the <<container|pod>> will be created. If the
|
||||
Path to cgroups under which the cgroup for the <<container|pod>> 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.
|
||||
|
|
|
|||
|
|
@ -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**.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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-<value>` characters where `<value>` 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-<value>` characters where `<value>` 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.
|
||||
|
|
|
|||
|
|
@ -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 <<container|pod>> 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 <<container|pod>> 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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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`.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ Follow log output. Default is false.
|
|||
|
||||
Note: When following a <<container|pod>> which is removed by `podman <<container|pod>> 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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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**.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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**.
|
||||
|
|
|
|||
|
|
@ -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**.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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**.
|
||||
|
|
|
|||
|
|
@ -5,5 +5,5 @@
|
|||
#### **--ignore**, **-i**
|
||||
|
||||
Ignore errors when specified <<containers|pods>> are not in the container store. A user
|
||||
might have decided to manually remove a <<container|pod>> which would lead to a failure
|
||||
might have decided to manually remove a <<container|pod>> which leads to a failure
|
||||
during the ExecStop directive of a systemd service referencing that <<container|pod>>.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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".
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -5,6 +5,6 @@
|
|||
#### **--latest**, **-l**
|
||||
|
||||
Instead of providing the <<container|pod>> name or ID, use the last created <<container|pod>>.
|
||||
Note: the last started <<container|pod>> could be from other users of Podman on the host machine.
|
||||
Note: the last started <<container|pod>> 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)
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ This option can only be used if the <<container|pod>> is joined to only a single
|
|||
and if the <<container|pod>> 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 <<container|pod>>, set multiple networks using the **--network** option with a static MAC address specified for each using the `mac` mode for that option.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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**.
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -8,5 +8,5 @@ Add a network-scoped alias for the <<container|pod>>, 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}} <name>`),
|
||||
these aliases can be used for name resolution on the given network. This option can be specified multiple times.
|
||||
NOTE: When using CNI a <<container|pod>> will only have access to aliases on the first network that it joins. This limitation does
|
||||
NOTE: When using CNI a <<container|pod>> only has access to aliases on the first network that it joins. This limitation does
|
||||
not exist with netavark/aardvark-dns.
|
||||
|
|
|
|||
|
|
@ -20,18 +20,18 @@ Valid _mode_ values are:
|
|||
- \<network name or ID\>[: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."?
|
||||
|
|
|
|||
|
|
@ -5,5 +5,5 @@
|
|||
#### **--no-hosts**
|
||||
|
||||
Do not create _/etc/hosts_ for the <<container|pod>>.
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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**.
|
||||
|
|
|
|||
|
|
@ -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`.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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**.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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`.
|
||||
|
|
|
|||
|
|
@ -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)**
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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 <<subcommand>> --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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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 <<container|pod>> 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: <sup>[[1]](#Footnote1)</sup>
|
||||
|
||||
|
|
@ -30,16 +30,16 @@ The _OPTIONS_ is a comma-separated list and can be: <sup>[[1]](#Footnote1)</sup>
|
|||
* **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 <<container|pod>>, 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 <<container|pod>>.
|
||||
process takes a long time, delaying the start of the <<container|pod>>.
|
||||
|
||||
**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 <<container|pod>> 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 <<container|pod>>. 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 <<container|pod>> 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 <<container|pod>>
|
||||
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 <<container|pod>> 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 <<container|pod>> 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 <<container|pod>> 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 <<container|pod>> will not be visible on host and vice versa. One can change
|
||||
inside the <<container|pod>> 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 <<container|pod>> will be
|
||||
volume shared mounts done under that volume inside the <<container|pod>> 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. <sup>[[1]](#Footnote1)</sup>
|
||||
is visible inside container but not the other way around. <sup>[[1]](#Footnote1)</sup>
|
||||
|
||||
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
|
||||
<<container|pod>>, 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
|
||||
<<container|pod>>.
|
||||
|
||||
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 <<container|pod>>.
|
||||
volume can be executed within the <<container|pod>>.
|
||||
|
||||
Mounting the volume with the **nodev** option means that no devices on the volume
|
||||
will be able to be used by processes within the <<container|pod>>. By default volumes
|
||||
can be used by processes within the <<container|pod>>. 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. <sup>[[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 <<container|pod>> will fail.
|
||||
from inside a rootless <<container|pod>> fails.
|
||||
|
||||
`Idmapped mount`
|
||||
|
||||
|
|
|
|||
|
|
@ -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)).
|
||||
|
||||
|
|
|
|||
|
|
@ -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`. <sup>[[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 `<tsweeney@redhat.com>`
|
|||
## FOOTNOTES
|
||||
<a name="Footnote1">1</a>: 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.
|
||||
|
|
|
|||
|
|
@ -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 `<none>`.
|
||||
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 `<none>`.
|
||||
|
||||
## OPTIONS
|
||||
#### **--author**, **-a**=*author*
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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**
|
||||
|
|
|
|||
|
|
@ -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**
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
||||
|
|
|
|||
|
|
@ -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**
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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__.*
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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**.
|
||||
|
||||
|
|
|
|||
|
|
@ -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 `<SvenDowideit@home.org.au>`
|
|||
August 2014, updated by Sven Dowideit `<SvenDowideit@home.org.au>`
|
||||
|
||||
## FOOTNOTES
|
||||
<a name="Footnote1">1</a>: 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.
|
||||
<a name="Footnote1">1</a>: 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.
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
```
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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)**
|
||||
|
|
|
|||
|
|
@ -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*
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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),
|
||||
|
|
|
|||
|
|
@ -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**
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue