diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/podman-pod-create.1.md | 71 | ||||
| -rw-r--r-- | docs/podman-pod-rm.1.md | 39 | ||||
| -rw-r--r-- | docs/podman-pod.1.md | 32 |
3 files changed, 142 insertions, 0 deletions
diff --git a/docs/podman-pod-create.1.md b/docs/podman-pod-create.1.md new file mode 100644 index 000000000..66d74a774 --- /dev/null +++ b/docs/podman-pod-create.1.md @@ -0,0 +1,71 @@ +% 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 + +**-a**, **--attach**=[] + +Not yet implemented. + +**--cgroup-to-ctr**="" +Tells containers in this pod to use the cgroup created for the pod + +**--cgroup-parent**=*true*|*false* + +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. + +**--podidfile**="" + +Write the pod ID to the file + +**--help** + +Print usage statement + +**-l**, **--label**=[] + +Add metadata to a pod (e.g., --label com.example.key=value) + +**--label-file**=[] + +Read in a line delimited file of labels + +**-n**, **--name**="" + +Assign a name to the pod + +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 the daemon will also generate a random +string name. The name is useful any place you need to identify a pod. + +## EXAMPLES + + +# podman pod create --name test + +## SEE ALSO +podman-pod(1) + +## HISTORY +August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +September 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +November 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +October 2017, converted from Docker documentation to podman by Dan Walsh for podman <dwalsh@redhat.com> +July 2018, adapted from create man page by Peter Hunt <pehunt@redhat.com> diff --git a/docs/podman-pod-rm.1.md b/docs/podman-pod-rm.1.md new file mode 100644 index 000000000..725702714 --- /dev/null +++ b/docs/podman-pod-rm.1.md @@ -0,0 +1,39 @@ +% podman-pod-rm "1" + +## NAME +podman\-pod\-rm - Remove one or more pods + +## SYNOPSIS +**podman rm** [*options*] *container* + +## DESCRIPTION +**podman pod rm** will remove one or more pods from the host. The pod name or ID can be used. The -f option stops all containers then removes them before removing the pod. Without the -f option, a pod cannot be removed if it has attached containers. + +## OPTIONS + +**--force, f** + +Stop running containers and delete all stopped containers before removal of pod. + +**--all, a** + +Remove all pods. Can be used in conjunction with -f and -r as well. + +## EXAMPLE + +podman pod rm mywebserverpod + +podman pod rm mywebserverpod myflaskserverpod 860a4b23 + +podman pod rm -f 860a4b23 + +podman pod rm -f -a + +podman pod rm -fa + +## SEE ALSO +podman-pod(1) + +## HISTORY +August 2017, Originally compiled by Ryan Cole <rycole@redhat.com> +July 2018, Adapted from podman rm man page by Peter Hunt <pehunt@redhat.com> diff --git a/docs/podman-pod.1.md b/docs/podman-pod.1.md new file mode 100644 index 000000000..9b8afaeb0 --- /dev/null +++ b/docs/podman-pod.1.md @@ -0,0 +1,32 @@ +% podman-pod "1" + +## NAME +podman\-pod - Simple management tool for groups of containers, called pods. + +## SYNOPSIS +**podman pod** *subcommand* + +# DESCRIPTION +podman pod is a set of subcommands that manage pods, or groups of containers. + +## SUBCOMMANDS + +| Subcommand | Description | +| ------------------------------------------------- | ------------------------------------------------------------------------------ | +| [podman-pod-create(1)](podman-pod-create.1.md) | Create a new pod. | +| [podman-pod-inspect(1)](podman-pod-inspect.1.md) | Display a pod's configuration. | +| [podman-pod-kill(1)](podman-pod-kill.1.md) | Kill the main process in one or more pods. | +| [podman-pod-pause(1)](podman-pod-pause.1.md) | Pause one or more pods. | +| [podman-pod-ps(1)](podman-pod-ps.1.md) | Prints out information about pods. | +| [podman-pod-restart(1)](podman-pod-restart.1.md) | Restart one or more pods. | +| [podman-pod-rm(1)](podman-pod-rm.1.md) | Remove one or more pods. | +| [podman-pod-start(1)](podman-pod-start.1.md) | Starts one or more pods. | +| [podman-pod-stats(1)](podman-pod-stats.1.md) | Display a live stream of one or more pod's resource usage statistics. | +| [podman-pod-stop(1)](podman-pod-stop.1.md) | Stop one or more running pods. | +| [podman-pod-top(1)](podman-pod-top.1.md) | Display the running processes of a pod. | +| [podman-pod-unpause(1)](podman-pod-unpause.1.md) | Unpause one or more pods. | +| [podman-pod-wait(1)](podman-pod-wait.1.md) | Wait on one or more pods to stop and print their exit codes. | + +## HISTORY +Dec 2016, Originally compiled by Dan Walsh <dwalsh@redhat.com> +July 2018, Adapted from podman man page by Peter Hunt <pehunt@redhat.com> |