summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorTomSweeneyRedHat <tsweeney@redhat.com>2021-09-17 18:24:36 -0400
committerTomSweeneyRedHat <tsweeney@redhat.com>2021-09-21 18:15:54 -0400
commit738f2b36e33e25f87edb5f6b60fa993e1fe6176b (patch)
tree1c79a8a8700573e3c4ba033f1eb9f79120f3fd33 /docs/source
parent79816798c2b98e42f0a5590c250c0fb3b2bf2521 (diff)
downloadpodman-738f2b36e33e25f87edb5f6b60fa993e1fe6176b.tar.gz
podman-738f2b36e33e25f87edb5f6b60fa993e1fe6176b.tar.bz2
podman-738f2b36e33e25f87edb5f6b60fa993e1fe6176b.zip
[CI:DOCS] Add network alias note in man pages
Adds a note about the limitation of network aliases to the man pages This should satisfy https://issues.redhat.com/browse/RUN-1189 Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/markdown/podman-create.1.md2
-rw-r--r--docs/source/markdown/podman-network-connect.1.md2
-rw-r--r--docs/source/markdown/podman-pod-create.1.md2
-rw-r--r--docs/source/markdown/podman-run.1.md2
4 files changed, 5 insertions, 3 deletions
diff --git a/docs/source/markdown/podman-create.1.md b/docs/source/markdown/podman-create.1.md
index 0c48f105e..c3e2bbfca 100644
--- a/docs/source/markdown/podman-create.1.md
+++ b/docs/source/markdown/podman-create.1.md
@@ -682,7 +682,7 @@ Valid _mode_ values are:
#### **--network-alias**=*alias*
-Add network-scoped alias for the container
+Add network-scoped alias for the container. NOTE: A container will only have access to aliases on the first network that it joins. This is a limitation that will be removed in a later release.
#### **--no-healthcheck**
diff --git a/docs/source/markdown/podman-network-connect.1.md b/docs/source/markdown/podman-network-connect.1.md
index 47a54bd33..39893c676 100644
--- a/docs/source/markdown/podman-network-connect.1.md
+++ b/docs/source/markdown/podman-network-connect.1.md
@@ -14,6 +14,8 @@ Once connected, the container can communicate with other containers in the same
#### **--alias**
Add network-scoped alias for the container. If the network is using the `dnsname` CNI plugin, these aliases
can be used for name resolution on the given network. Multiple *--alias* options may be specified as input.
+NOTE: A container will only have access to aliases on the first network that it joins. This is a limitation
+that will be removed in a later release.
## EXAMPLE
diff --git a/docs/source/markdown/podman-pod-create.1.md b/docs/source/markdown/podman-pod-create.1.md
index a1540672c..fcb8ddeb9 100644
--- a/docs/source/markdown/podman-pod-create.1.md
+++ b/docs/source/markdown/podman-pod-create.1.md
@@ -157,7 +157,7 @@ Set network mode for the pod. Supported values are:
#### **--network-alias**=strings
-Add a DNS alias for the container. When the container is joined to a CNI network with support for the dnsname plugin, the container will be accessible through this name from other containers in the network.
+Add a DNS alias for the pod. When the pod is joined to a CNI network with support for the dnsname plugin, the containers inside the pod will be accessible through this name from other containers in the network.
#### **--no-hosts**
diff --git a/docs/source/markdown/podman-run.1.md b/docs/source/markdown/podman-run.1.md
index 7b6a56fc6..a369ce5ea 100644
--- a/docs/source/markdown/podman-run.1.md
+++ b/docs/source/markdown/podman-run.1.md
@@ -702,7 +702,7 @@ Valid _mode_ values are:
#### **--network-alias**=*alias*
-Add network-scoped alias for the container
+Add network-scoped alias for the container. NOTE: A container will only have access to aliases on the first network that it joins. This is a limitation that will be removed in a later release.
#### **--no-healthcheck**