summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/podman-pod-kill.1.md43
-rw-r--r--docs/podman-pod-restart.1.md50
-rw-r--r--docs/podman-pod.1.md1
3 files changed, 94 insertions, 0 deletions
diff --git a/docs/podman-pod-kill.1.md b/docs/podman-pod-kill.1.md
new file mode 100644
index 000000000..2f4d37f92
--- /dev/null
+++ b/docs/podman-pod-kill.1.md
@@ -0,0 +1,43 @@
+% podman-pod-kill "1"
+
+## NAME
+podman\-pod\-kill - Kills all containers in one or more pods with a signal
+
+## SYNOPSIS
+**podman pod kill** [*options*] *pod* ...
+
+## DESCRIPTION
+The main process of each container inside the pods specified will be sent SIGKILL, or any signal specified with option --signal.
+
+## OPTIONS
+**--all, -a**
+
+Sends signal to all containers associated with a pod.
+
+**--latest, -l**
+
+Instead of providing the pod name or ID, use the last created pod. If you use methods other than Podman
+to run pods such as CRI-O, the last started pod could be from either of those methods.
+
+**--signal, s**
+
+Signal to send to the containers in the pod. For more information on Linux signals, refer to *man signal(7)*.
+
+
+## EXAMPLE
+
+podman pod kill mywebserver
+
+podman pod kill 860a4b23
+
+podman pod kill --signal TERM 860a4b23
+
+podman pod kill --latest
+
+podman pod kill --all
+
+## SEE ALSO
+podman-pod(1), podman-pod-stop(1)
+
+## HISTORY
+July 2018, Originally compiled by Peter Hunt <pehunt@redhat.com>
diff --git a/docs/podman-pod-restart.1.md b/docs/podman-pod-restart.1.md
new file mode 100644
index 000000000..0990cf840
--- /dev/null
+++ b/docs/podman-pod-restart.1.md
@@ -0,0 +1,50 @@
+% podman-pod-restart "1"
+
+## NAME
+podman\-pod\-restart - Restart one or more pods
+
+## SYNOPSIS
+**podman pod restart** [*options*] *pod* ...
+
+## DESCRIPTION
+Restart containers in one or more pods. Containers will be stopped if running and then restarted.
+Stopped containers will only be started. You may use pod IDs or names as input.
+The pod ID will be printed upon successful restart.
+When restarting multiple pods, an error from restarting one pod will not effect restarting other pods.
+
+## OPTIONS
+
+**--all, -a**
+
+Restarts all pods
+
+**--latest, -l**
+
+Instead of providing the pod name or ID, restart the last created pod.
+
+## EXAMPLE
+
+podman pod restart mywebserverpod
+cc8f0bea67b1a1a11aec1ecd38102a1be4b145577f21fc843c7c83b77fc28907
+
+podman pod restart 490eb 3557fb
+490eb241aaf704d4dd2629904410fe4aa31965d9310a735f8755267f4ded1de5
+3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab
+
+3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab
+
+podman pod restart --latest
+3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab
+
+podman pod restart --all
+19456b4cd557eaf9629825113a552681a6013f8c8cad258e36ab825ef536e818
+3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab
+490eb241aaf704d4dd2629904410fe4aa31965d9310a735f8755267f4ded1de5
+70c358daecf71ef9be8f62404f926080ca0133277ef7ce4f6aa2d5af6bb2d3e9
+cc8f0bea67b1a1a11aec1ecd38102a1be4b145577f21fc843c7c83b77fc28907
+
+## SEE ALSO
+podman-pod(1), podman-pod-start(1), podman-restart(1)
+
+## HISTORY
+July 2018, Originally compiled by Peter Hunt <pehunt@redhat.com>
diff --git a/docs/podman-pod.1.md b/docs/podman-pod.1.md
index 9aee75e81..74b6d75b5 100644
--- a/docs/podman-pod.1.md
+++ b/docs/podman-pod.1.md
@@ -14,6 +14,7 @@ podman pod is a set of subcommands that manage pods, or groups of containers.
| Subcommand | Description |
| ------------------------------------------------- | ------------------------------------------------------------------------------ |
| [podman-pod-create(1)](podman-pod-create.1.md) | Create a new pod. |
+| [podman-pod-kill(1)](podman-pod-kill.1.md) | Kill the main process of each container in pod. |
| [podman-pod-ps(1)](podman-pod-ps.1.md) | Prints out information about pods. |
| [podman-pod-rm(1)](podman-pod-rm.1.md) | Remove one or more pods. |
| [podman-pod-start(1)](podman-pod-start.1.md) | Start one or more pods. |