summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2019-02-26 15:27:11 +0100
committerGitHub <noreply@github.com>2019-02-26 15:27:11 +0100
commit8a5e1038766b34f8cb4fbe53829ebb0dc8c0ca0a (patch)
treebb5be7ecb3826769e8ebc529243e4a08a86c5cda
parent02988f17f6664204fbd5ec711f82de2811678b80 (diff)
parent7fea0d7077cbcbcec1958e31b361009b87e77398 (diff)
downloadpodman-8a5e1038766b34f8cb4fbe53829ebb0dc8c0ca0a.tar.gz
podman-8a5e1038766b34f8cb4fbe53829ebb0dc8c0ca0a.tar.bz2
podman-8a5e1038766b34f8cb4fbe53829ebb0dc8c0ca0a.zip
Merge pull request #2438 from vrothberg/scope-v2
[skip ci] readme/docs update
-rw-r--r--README.md12
-rw-r--r--docs/podman-generate-kube.1.md4
-rw-r--r--docs/podman-play-kube.1.md4
3 files changed, 13 insertions, 7 deletions
diff --git a/README.md b/README.md
index 4ea63d5b9..97c548ddd 100644
--- a/README.md
+++ b/README.md
@@ -36,10 +36,14 @@ This project tests all builds against each supported version of Fedora, the late
* Container runtimes daemons for working with the Kubernetes CRI interface.
[CRI-O](https://github.com/kubernetes-sigs/cri-o) specializes in that.
* Supporting `docker-compose`. We believe that Kubernetes is the defacto
- standard for container orchestration. Hence, Podman allows the creation of
- Pods from a Kubernetes YAML file. See
- [podman-play-kube](https://github.com/containers/libpod/blob/master/docs/podman-play-kube.1.md)
- for more details.
+ standard for composing Pods and for orchestrating containers, making
+ Kubernetes YAML a defacto standard file format. Hence, Podman allows the
+ creation and execution of Pods from a Kubernetes YAML file (see
+ [podman-play-kube](https://github.com/containers/libpod/blob/master/docs/podman-play-kube.1.md)).
+ Podman can also generate Kubernetes YAML based on a container or Pod (see
+ [podman-generate-kube](https://github.com/containers/libpod/blob/master/docs/podman-generate-kube.1.md)),
+ which allows for an easy transition from a local development environment
+ to a production Kubernetes cluster.
## OCI Projects Plans
diff --git a/docs/podman-generate-kube.1.md b/docs/podman-generate-kube.1.md
index 5236f23fe..d4bed8ab1 100644
--- a/docs/podman-generate-kube.1.md
+++ b/docs/podman-generate-kube.1.md
@@ -19,6 +19,8 @@ The **service** option can be used to generate a Service specification for the c
if the object has portmap bindings, the service specification will include a NodePort declaration to expose the service. A
random port is assigned by Podman in the specification.
+Note that the generated Kubernetes YAML file can be used to re-run the deployment via podman-play-kube(1).
+
# OPTIONS:
**s** **--service**
@@ -145,7 +147,7 @@ status:
```
## SEE ALSO
-podman(1), podman-container, podman-pod, podman-play
+podman(1), podman-container(1), podman-pod(1), podman-play-kube(1)
# 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
index 3fd9746a5..2264f7a88 100644
--- a/docs/podman-play-kube.1.md
+++ b/docs/podman-play-kube.1.md
@@ -20,7 +20,7 @@ kubernetes_input.yml
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.
+Ideally the input file would be one created by Podman (see podman-generate-kube(1)). This would guarantee a smooth import and expected results.
# OPTIONS:
@@ -72,7 +72,7 @@ $ podman play kube demo.yml
```
## SEE ALSO
-podman(1), podman-container(1), podman-pod(1), podman-generate(1), podman-play(1)
+podman(1), podman-container(1), podman-pod(1), podman-generate-kube(1), podman-play(1)
# HISTORY
Decemeber 2018, Originally compiled by Brent Baude (bbaude at redhat dot com)