aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-kube-play.1.md
diff options
context:
space:
mode:
authoropenshift-ci[bot] <75433959+openshift-ci[bot]@users.noreply.github.com>2022-08-03 07:56:13 +0000
committerGitHub <noreply@github.com>2022-08-03 07:56:13 +0000
commit1139cd9b8142aa4f4efb0f930a398453d521c1d9 (patch)
tree1a69e285813ea6d26c7da06d4e12230826ddb19e /docs/source/markdown/podman-kube-play.1.md
parentc09457e34a429622475e27fe68e17effe47fe0c3 (diff)
parent1249cbb75f50182f19e5976fa149386672451f2a (diff)
downloadpodman-1139cd9b8142aa4f4efb0f930a398453d521c1d9.tar.gz
podman-1139cd9b8142aa4f4efb0f930a398453d521c1d9.tar.bz2
podman-1139cd9b8142aa4f4efb0f930a398453d521c1d9.zip
Merge pull request #14974 from nicrowe00/kubedown1
add "podman kube down" command
Diffstat (limited to 'docs/source/markdown/podman-kube-play.1.md')
-rw-r--r--docs/source/markdown/podman-kube-play.1.md12
1 files changed, 5 insertions, 7 deletions
diff --git a/docs/source/markdown/podman-kube-play.1.md b/docs/source/markdown/podman-kube-play.1.md
index 25248ce99..b3c385fe9 100644
--- a/docs/source/markdown/podman-kube-play.1.md
+++ b/docs/source/markdown/podman-kube-play.1.md
@@ -1,7 +1,7 @@
% podman-kube-play(1)
## NAME
-podman-kube-play - Create containers, pods or volumes based on Kubernetes YAML
+podman-kube-play - Create containers, pods and volumes based on Kubernetes YAML
## SYNOPSIS
**podman kube play** [*options*] *file.yml|-*
@@ -30,6 +30,9 @@ Note: If the `:latest` tag is used, Podman will attempt to pull the image from a
Note: The command `podman play kube` is an alias of `podman kube play`, and will perform the same function.
+Note: The command `podman kube down` can be used to stop and remove pods or containers based on the same Kubernetes YAML used
+by `podman kube play` to create them.
+
`Kubernetes PersistentVolumeClaims`
A Kubernetes PersistentVolumeClaim represents a Podman named volume. Only the PersistentVolumeClaim name is required by Podman to create a volume. Kubernetes annotations can be used to make use of the available options for Podman volumes.
@@ -145,11 +148,6 @@ The [username[:password]] to use to authenticate with the registry if required.
If one or both values are not supplied, a command line prompt will appear and the
value can be entered. The password is entered without echo.
-#### **--down**
-
-Tears down the pods that were created by a previous run of `kube play`. The pods are stopped and then
-removed. Any volumes created are left intact.
-
#### **--help**, **-h**
Print usage statement
@@ -325,7 +323,7 @@ $ podman kube play demo.yml --network net1:ip=10.89.1.5 --network net2:ip=10.89.
Please take into account that networks must be created first using podman-network-create(1).
## SEE ALSO
-**[podman(1)](podman.1.md)**, **[podman-kube(1)](podman-kube.1.md)**, **[podman-network-create(1)](podman-network-create.1.md)**, **[podman-generate-kube(1)](podman-generate-kube.1.md)**, **[containers-certs.d(5)](https://github.com/containers/image/blob/main/docs/containers-certs.d.5.md)**
+**[podman(1)](podman.1.md)**, **[podman-kube(1)](podman-kube.1.md)**, **[podman-kube-down(1)](podman-kube-down.1.md)**, **[podman-network-create(1)](podman-network-create.1.md)**, **[podman-generate-kube(1)](podman-generate-kube.1.md)**, **[containers-certs.d(5)](https://github.com/containers/image/blob/main/docs/containers-certs.d.5.md)**
## HISTORY
December 2018, Originally compiled by Brent Baude (bbaude at redhat dot com)