[CI:DOCS] Add network alias note in man pages #11641
Conversation
openshift-ci
bot
added
the
approved
| @@ -141,7 +141,8 @@ 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 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. 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. | |||
There was a problem hiding this comment.
Does this line break effect man page generation?
There was a problem hiding this comment.
No, it just ignores the line break, just verified.
|
LGTM |
| @@ -141,7 +141,8 @@ 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 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. NOTE: A container will only have access to aliases on the first network that it joins. This is a limitation | |||
There was a problem hiding this comment.
This is the podman pod create man page, so the sentence is not entirely correct. This sentence must be added to the podman create/run man page.
For podman pod create you should rewrite so something like this:
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.
There was a problem hiding this comment.
Good catch, reverted and updated elsewhere, TYVM!
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 <[email protected]>
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: rhatdan, TomSweeneyRedHat The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
github-actions
bot
added
the
locked - please file new issue/PR
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 [email protected]