Skip to content

Commit

Permalink
[CI:DOCS] elaborate on image lookups of foreign platforms
Browse files Browse the repository at this point in the history
After pulling/creating an image of a foreign platform, Podman will
happily use it when looking it up in the local storage and will not
pull down the image matching the host platform.

As discussed in containers#12682, the reasoning for it is Docker compatibility and
the fact that user already rely on the behavior.  While Podman is now
emitting a warning when an image is in use not matching the local
platform, the documentation was lacking that information.

Fixes: containers#15300
Signed-off-by: Valentin Rothberg <[email protected]>
  • Loading branch information
vrothberg committed Aug 22, 2022
1 parent 351028b commit fbe2bd8
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/source/markdown/options/arch.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
#### **--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.
1 change: 1 addition & 0 deletions docs/source/markdown/options/platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,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.
17 changes: 11 additions & 6 deletions docs/source/markdown/podman-build.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,9 @@ 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. (Examples: arm, arm64, 386, amd64, ppc64le,
s390x)
architecture of the build host. Unless overridden, subsequent lookups of the
same image in the local storage will match this architecture, regardless of the
host. (Examples: arm, arm64, 386, amd64, ppc64le, s390x)

@@option authfile

Expand Down Expand Up @@ -454,7 +455,8 @@ 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.
build host. Unless overridden, subsequent lookups of the same image in the
local storage will match this OS, regardless of the host.

#### **--os-feature**=*feature*

Expand Down Expand Up @@ -506,9 +508,12 @@ process.

Set the *os/arch* of the built image (and its base image, if your build uses one)
to the provided value instead of using the current operating system and
architecture of the host (for example `linux/arm`). If `--platform` is set,
then the values of the `--arch`, `--os`, and `--variant` options will be
overridden.
architecture of the host (for example `linux/arm`). Unless overridden,
subsequent lookups of the same image in the local storage will match this
platform, regardless of the host.

If `--platform` is set, then the values of the `--arch`, `--os`, and
`--variant` options will be 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
Expand Down
1 change: 1 addition & 0 deletions docs/source/markdown/podman-create.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,7 @@ This option conflicts with **--add-host**.

#### **--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.

@@option passwd-entry

Expand Down
1 change: 1 addition & 0 deletions docs/source/markdown/podman-pull.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ Print the usage statement.
#### **--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.

@@option platform

Expand Down
1 change: 1 addition & 0 deletions docs/source/markdown/podman-run.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,7 @@ This option conflicts with **--add-host**.

#### **--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.

#### **--passwd**

Expand Down

0 comments on commit fbe2bd8

Please sign in to comment.