Merge pull request #4354 from baude/newdocsstruct

Restructure documentation dir

1 files changed, 94 insertions, 0 deletions

diff --git a/docs/source/markdown/podman-pod-create.1.md b/docs/source/markdown/podman-pod-create.1.md
new file mode 100644
index 000000000..cd1de6401
--- /dev/null
+++ b/docs/source/markdown/podman-pod-create.1.md
@@ -0,0 +1,94 @@
+% podman-pod-create(1)
+
+## NAME
+podman\-pod\-create - Create a new pod
+
+## SYNOPSIS
+**podman pod create** [*options*]
+
+## DESCRIPTION
+
+Creates an empty pod, or unit of multiple containers, and prepares it to have
+containers added to it. The pod id is printed to STDOUT. You can then use
+**podman create --pod \<pod_id|pod_name\> ...** to add containers to the pod, and
+**podman pod start \<pod_id|pod_name\>** to start the pod.
+
+## OPTIONS
+
+**--cgroup-parent**=*path*
+
+Path to cgroups under which the cgroup for the pod will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.
+
+**--help**
+
+Print usage statement
+
+**--infra**
+
+Create an infra container and associate it with the pod. An infra container is a lightweight container used to coordinate the shared kernel namespace of a pod. Default: true
+
+**--infra-command**=*command*
+
+The command that will be run to start the infra container. Default: "/pause"
+
+**--infra-image**=*image*
+
+The image that will be created for the infra container. Default: "k8s.gcr.io/pause:3.1"
+
+**-l**, **--label**=*label*
+
+Add metadata to a pod (e.g., --label com.example.key=value)
+
+**--label-file**=*label*
+
+Read in a line delimited file of labels
+
+**-n**, **--name**=*name*
+
+Assign a name to the pod
+
+**--podidfile**=*podid*
+
+Write the pod ID to the file
+
+**-p**, **--publish**=*port*
+
+Publish a port or range of ports from the pod to the host
+
+Format: `ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort`
+Both hostPort and containerPort can be specified as a range of ports.
+When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range.
+Use `podman port` to see the actual mapping: `podman port CONTAINER $CONTAINERPORT`
+
+NOTE: This cannot be modified once the pod is created.
+
+**--share**=*namespace*
+
+A comma delimited list of kernel namespaces to share. If none or "" is specified, no namespaces will be shared. The namespaces to choose from are ipc, net, pid, user, uts.
+
+The operator can identify a pod in three ways:
+UUID long identifier (“f78375b1c487e03c9438c729345e54db9d20cfa2ac1fc3494b6eb60872e74778”)
+UUID short identifier (“f78375b1c487”)
+Name (“jonah”)
+
+podman generates a UUID for each pod, and if a name is not assigned
+to the container with **--name** then a random string name will be generated
+for it. The name is useful any place you need to identify a pod.
+
+## EXAMPLES
+
+```
+$ podman pod create --name test
+
+$ podman pod create --infra=false
+
+$ podman pod create --infra-command /top
+
+$ podman pod create --publish 8443:443
+```
+
+## SEE ALSO
+podman-pod(1)
+
+## HISTORY
+July 2018, Originally compiled by Peter Hunt <pehunt@redhat.com>