containers
/
podman
mirror of https://github.com/containers/podman.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Man pages: Refactor common options: --dns 

Only between podman-build, create, and run. podman-pod-create
is too different.

As usual I went with the podman-run version. This means
keeping the word "flag" (which should be "option"), for
ease of review. I will fix in my in-progress cleanup PR.

For podman-build, I removed "during the build" and changed
it to a note for that man page only.

Signed-off-by: Ed Santiago <santiago@redhat.com>
This commit is contained in:
Ed Santiago 2022-09-14 13:50:37 -06:00
parent 50c538b3cc
commit 62d1c487d9
4 changed files with 19 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/source/markdown/options/dns.md Normal file
View File

@ -0,0 +1,11 @@
#### **--dns**=*ipaddr*
Set custom DNS servers.
This option can be used to override the DNS
configuration passed to the container. Typically this is necessary when the
host DNS configuration is invalid for the container (e.g., **127.0.0.1**). When this
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.

14
docs/source/markdown/podman-build.1.md.in
View File

@ -223,18 +223,12 @@ specifying **--disable-compression=false**.
@@option disable-content-trust
#### **--dns**=*dns*
@@option dns
Set custom DNS servers to be used during the build.
This option cannot be combined with **--network** that is set to **none**.
This option can be used to override the DNS configuration passed to the
container. Typically this is necessary when the host DNS configuration is
invalid for the container (e.g., 127.0.0.1). When this is the case the `--dns`
option 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.
Note: this option takes effect only during *RUN* instructions in the build.
It does not affect _/etc/resolv.conf_ in the final image.
#### **--dns-option**=*option*

12
docs/source/markdown/podman-create.1.md.in
View File

@ -141,17 +141,9 @@ flag to pass the user's supplementary group access into the container.
@@option disable-content-trust
#### **--dns**=*dns*
@@option dns
Set custom DNS servers. Invalid if using **--dns** and **--network** that is set to 'none' or `container:<name|id>`.
This option can be used to override the DNS
configuration passed to the container. Typically this is necessary when the
host DNS configuration is invalid for the container (e.g., 127.0.0.1). When this
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.
This option cannot be combined with **--network** that is set to **none** or **container:**_id_.
@@option dns-opt.container

12
docs/source/markdown/podman-run.1.md.in
View File

@ -177,17 +177,9 @@ flag to pass the user's supplementary group access into the container.
@@option disable-content-trust
#### **--dns**=*ipaddr*
@@option dns
Set custom DNS servers. Invalid if using **--dns** with **--network** that is set to **none** or **container:**_id_.
This option can be used to override the DNS
configuration passed to the container. Typically this is necessary when the
host DNS configuration is invalid for the container (e.g., **127.0.0.1**). When this
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.
This option cannot be combined with **--network** that is set to **none** or **container:**_id_.
@@option dns-opt.container