summaryrefslogtreecommitdiff
path: root/docs/podman-play-kube.1.md
diff options
context:
space:
mode:
authorAshley Cui <ashleycui16@gmail.com>2019-05-31 15:21:47 -0400
committerAshley Cui <ashleycui16@gmail.com>2019-06-10 11:48:02 -0400
commit19e0928037e2d9c6fb0941e2ac40b8cea731e22d (patch)
tree1b5b10718e2c27c690ae789392fe1d46535a4401 /docs/podman-play-kube.1.md
parent7b0d6fcf0e3ce59f842273f670d742aaf597bf2f (diff)
downloadpodman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.tar.gz
podman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.tar.bz2
podman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.zip
standardize documentation formatting
Signed-off-by: Ashley Cui <ashleycui16@gmail.com>
Diffstat (limited to 'docs/podman-play-kube.1.md')
-rw-r--r--docs/podman-play-kube.1.md36
1 files changed, 14 insertions, 22 deletions
diff --git a/docs/podman-play-kube.1.md b/docs/podman-play-kube.1.md
index a3a6abbe7..f9a867b44 100644
--- a/docs/podman-play-kube.1.md
+++ b/docs/podman-play-kube.1.md
@@ -1,20 +1,12 @@
-% podman-play-kube Podman Man Pages
-% Brent Baude
-% December 2018
-# NAME
+% podman-play-kube(1)
+
+## NAME
podman-play-kube - Create pods and containers based on Kubernetes YAML
-# SYNOPSIS
-**podman play kube**
-[**-h**|**--help**]
-[**--authfile**]
-[**--cert-dir**]
-[**--creds**]
-[***-q** | **--quiet**]
-[**--tls-verify**]
-kubernetes_input.yml
-
-# DESCRIPTION
+## SYNOPSIS
+**podman play kube** [*options*] *file***.yml**
+
+## DESCRIPTION
**podman play kube** will read in a structured file of Kubernetes YAML. It will then recreate
the pod and containers described in the YAML. The containers within the pod are then started and
the ID of the new Pod is output.
@@ -23,9 +15,9 @@ Ideally the input file would be one created by Podman (see podman-generate-kube(
Note: HostPath volume types created by play kube will be given an SELinux private label (Z)
-# OPTIONS:
+## OPTIONS:
-**--authfile**
+**--authfile**=*path*
Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`. (Not available for remote commands)
@@ -33,7 +25,7 @@ If the authorization state is not found there, $HOME/.docker/config.json is chec
Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE
environment variable. `export REGISTRY_AUTH_FILE=path`
-**--cert-dir** *path*
+**--cert-dir**=*path*
Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry.
Default certificates directory is _/etc/containers/certs.d_. (Not available for remote commands)
@@ -44,11 +36,11 @@ 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.
-**--quiet, -q**
+**--quiet**, **-q**
Suppress output information when pulling images
-**--tls-verify**
+**--tls-verify**=*true|false*
Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true,
then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified,
@@ -58,7 +50,7 @@ TLS verification will be used unless the target registry is listed as an insecur
Print usage statement
-## Examples ##
+## Examples
Recreate the pod and containers as described in a file called `demo.yml`
```
@@ -69,5 +61,5 @@ $ podman play kube demo.yml
## SEE ALSO
podman(1), podman-container(1), podman-pod(1), podman-generate-kube(1), podman-play(1)
-# HISTORY
+## HISTORY
Decemeber 2018, Originally compiled by Brent Baude (bbaude at redhat dot com)