diff options
author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2018-12-20 05:41:38 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-12-20 05:41:38 -0800 |
commit | 2de6cadd6f81b69f33485e4d4601606afbefd748 (patch) | |
tree | d2b9e118ecd2c43bd18c90ac7f4730018a559d51 /docs | |
parent | 2e9952c4240319d8aeeefad10c07d842e7b01765 (diff) | |
parent | 9b03cacc87c4d59fc301c21ef73ddc301ec753fb (diff) | |
download | podman-2de6cadd6f81b69f33485e4d4601606afbefd748.tar.gz podman-2de6cadd6f81b69f33485e4d4601606afbefd748.tar.bz2 podman-2de6cadd6f81b69f33485e4d4601606afbefd748.zip |
Merge pull request #1967 from baude/kubereplay
Add Play
Diffstat (limited to 'docs')
-rw-r--r-- | docs/podman-generate-kube.1.md | 2 | ||||
-rw-r--r-- | docs/podman-play-kube.1.md | 78 | ||||
-rw-r--r-- | docs/podman-play.1.md | 20 |
3 files changed, 99 insertions, 1 deletions
diff --git a/docs/podman-generate-kube.1.md b/docs/podman-generate-kube.1.md index 396f69615..5236f23fe 100644 --- a/docs/podman-generate-kube.1.md +++ b/docs/podman-generate-kube.1.md @@ -145,7 +145,7 @@ status: ``` ## SEE ALSO -podman(1), podman-container, podman-pod +podman(1), podman-container, podman-pod, podman-play # HISTORY Decemeber 2018, Originally compiled by Brent Baude (bbaude at redhat dot com) diff --git a/docs/podman-play-kube.1.md b/docs/podman-play-kube.1.md new file mode 100644 index 000000000..3fd9746a5 --- /dev/null +++ b/docs/podman-play-kube.1.md @@ -0,0 +1,78 @@ +% podman-play-kube Podman Man Pages +% Brent Baude +% December 2018 +# NAME +podman-play-kube - Create pods and containers based on Kubernetes YAML + +# SYNOPSIS +**podman play kube ** +[**-h**|**--help**] +[**--authfile**] +[**--cert-dir**] +[**--creds**] +[***-q** | **--quiet**] +[**--signature-policy**] +[**--tls-verify**] +kubernetes_input.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. + +Ideally the input file would be one created by Podman. This would guarantee a smooth import and expected results. + +# OPTIONS: + +**--authfile** + +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`. + +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* + +Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. +Default certificates directory is _/etc/containers/certs.d_. + +**--creds** + +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** + +Suppress output information when pulling images + +**--signature-policy="PATHNAME"** + +Pathname of a signature policy file to use. It is not recommended that this +option be used, as the default behavior of using the system-wide default policy +(frequently */etc/containers/policy.json*) is most often preferred. + +**--tls-verify** + +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, +TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf. + +**--help**, **-h** + +Print usage statement + +## Examples ## + +Recreate the pod and containers as described in a file called `demo.yml` +``` +$ podman play kube demo.yml +52182811df2b1e73f36476003a66ec872101ea59034ac0d4d3a7b40903b955a6 +``` + +## SEE ALSO +podman(1), podman-container(1), podman-pod(1), podman-generate(1), podman-play(1) + +# HISTORY +Decemeber 2018, Originally compiled by Brent Baude (bbaude at redhat dot com) diff --git a/docs/podman-play.1.md b/docs/podman-play.1.md new file mode 100644 index 000000000..c703c1455 --- /dev/null +++ b/docs/podman-play.1.md @@ -0,0 +1,20 @@ +% podman-play(1) + +## NAME +podman\-container - play pods and containers based on a structured input file + +## SYNOPSIS +**podman play** *subcommand* + +## DESCRIPTION +The play command will recreate pods and containers based on the input from a structured (like YAML) +file input. Containers will be automatically started. + +## COMMANDS + +| Command | Man Page | Description | +| ------- | --------------------------------------------------- | ---------------------------------------------------------------------------- | +| kube | [podman-play-kube(1)](podman-play-kube.1.md) | Recreate pods and containers based on Kubernetes YAML. + +## SEE ALSO +podman, podman-pod(1), podman-container(1), podman-generate(1), podman-play(1), podman-play-kube(1) |