aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown/options/network-alias.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-08-09 19:28:42 +0000
committerGitHub <noreply@github.com>2022-08-09 19:28:42 +0000
commit6d887bdc0188f08cd9b76c4a3d0531b1ab4a85b8 (patch)
tree537464efb647560c81a4f65eb6285427fbd63e85 /docs/source/markdown/options/network-alias.md
parenta2869c327eca50badc04e6f898f562e0560127f5 (diff)
parentd7f134d687459834e1b9c805fe30bf40b2df767a (diff)
downloadpodman-6d887bdc0188f08cd9b76c4a3d0531b1ab4a85b8.tar.gz
podman-6d887bdc0188f08cd9b76c4a3d0531b1ab4a85b8.tar.bz2
podman-6d887bdc0188f08cd9b76c4a3d0531b1ab4a85b8.zip
Merge pull request #15250 from edsantiago/docs_dedup_phase2
Refactor common man page options, phase 2
Diffstat (limited to 'docs/source/markdown/options/network-alias.md')
-rw-r--r--docs/source/markdown/options/network-alias.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/source/markdown/options/network-alias.md b/docs/source/markdown/options/network-alias.md
new file mode 100644
index 000000000..f48a1bb95
--- /dev/null
+++ b/docs/source/markdown/options/network-alias.md
@@ -0,0 +1,8 @@
+#### **--network-alias**=*alias*
+
+Add a network-scoped alias for the <<container|pod>>, setting the alias for all networks that the container joins. To set a
+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
+not exist with netavark/aardvark-dns.