summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-pod-create.1.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2020-11-10 12:57:53 -0700
committerEd Santiago <santiago@redhat.com>2020-11-11 08:31:30 -0700
commitb0601cb34ada6b0d4f29bf33221d1e8584ee50ad (patch)
tree4edfdd9f3937c6f52cede254a5860c429c842eba /docs/source/markdown/podman-pod-create.1.md
parent1952420e88bad3f602ab78ea140db9872acdba2b (diff)
downloadpodman-b0601cb34ada6b0d4f29bf33221d1e8584ee50ad.tar.gz
podman-b0601cb34ada6b0d4f29bf33221d1e8584ee50ad.tar.bz2
podman-b0601cb34ada6b0d4f29bf33221d1e8584ee50ad.zip
[CI:DOCS] Restore man page cross-checker
Somewhere in the CIv2 migration we lost the man page vs --help cross-checker. Add it back, by adding it into the man-page-check Makefile target; this is part of 'make validate', which is run in CI even on CI:DOCS PRs. As happens when CI doesn't run, things broke. Man pages got out of sync with --help. This PR: 1) Fixes hack/xref-helpmsgs-manpages to deal with the new "Options" (instead of "Flags") form of podman help. #8034 did part of that, but one of my review comments was accidentally left out. 2) Fixes hack/xref-helpmsgs-manpages to deal with the new option syntax in man pages, post- #8292, in which each option is preceded by four hashes so as to make them HTML <h4> elements with named anchors. 3) Fixes man pages that #8292 accidentally missed. 4) Adds man page entries for two flags that got added to podman but not documented (pod create --network-alias, play kube --log-driver) Fixes: #8296 Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-pod-create.1.md')
-rw-r--r--docs/source/markdown/podman-pod-create.1.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/source/markdown/podman-pod-create.1.md b/docs/source/markdown/podman-pod-create.1.md
index 1e1724aeb..6fd42f800 100644
--- a/docs/source/markdown/podman-pod-create.1.md
+++ b/docs/source/markdown/podman-pod-create.1.md
@@ -63,7 +63,7 @@ The image that will be created for the infra container. Default: "k8s.gcr.io/pau
Set a static IP for the pod's shared network.
-**-l**, **--label**=*label*
+#### **-l**, **--label**=*label*
Add metadata to a pod (e.g., --label com.example.key=value).
@@ -75,7 +75,7 @@ Read in a line delimited file of labels.
Set a static MAC address for the pod's shared network.
-**-n**, **--name**=*name*
+#### **-n**, **--name**=*name*
Assign a name to the pod.
@@ -96,6 +96,10 @@ Set network mode for the pod. Supported values are
- **port_handler=rootlesskit**: Use rootlesskit for port forwarding. Default.
- **port_handler=slirp4netns**: Use the slirp4netns port forwarding.
+#### **--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.
+
#### **--no-hosts**=**true**|**false**
Disable creation of /etc/hosts for the pod.
@@ -104,7 +108,7 @@ Disable creation of /etc/hosts for the pod.
Write the pod ID to the file.
-**-p**, **--publish**=*port*
+#### **-p**, **--publish**=*port*
Publish a port or range of ports from the pod to the host.