summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-play-kube.1.md
diff options
context:
space:
mode:
authorBrent Baude <bbaude@redhat.com>2021-08-10 08:10:56 -0500
committerBrent Baude <bbaude@redhat.com>2021-08-18 09:55:24 -0500
commitcd40c875ac51b32f7b4e5479d02faee14e0ab12d (patch)
tree403914c909beea71186002553e09006e08ae2953 /docs/source/markdown/podman-play-kube.1.md
parenta3d8b48fd56a722642f7cbcad52b2fa88f12b656 (diff)
downloadpodman-cd40c875ac51b32f7b4e5479d02faee14e0ab12d.tar.gz
podman-cd40c875ac51b32f7b4e5479d02faee14e0ab12d.tar.bz2
podman-cd40c875ac51b32f7b4e5479d02faee14e0ab12d.zip
Add ability to build images in play kube
When playing a kube YAML file, it can be desirable to be able to build an image on the fly. This is good for development of an image and YAML files and somewhat mocks what compose does. Signed-off-by: Brent Baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-play-kube.1.md')
-rw-r--r--docs/source/markdown/podman-play-kube.1.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-play-kube.1.md b/docs/source/markdown/podman-play-kube.1.md
index ad5ae7e4c..268e4bbcb 100644
--- a/docs/source/markdown/podman-play-kube.1.md
+++ b/docs/source/markdown/podman-play-kube.1.md
@@ -35,6 +35,36 @@ A Kubernetes PersistentVolumeClaim represents a Podman named volume. Only the Pe
- volume.podman.io/gid
- volume.podman.io/mount-options
+Play kube is capable of building images on the fly given the correct directory layout and Containerfiles. This
+option is not available for remote clients yet. Consider the following excerpt from a YAML file:
+```
+apiVersion: v1
+kind: Pod
+metadata:
+...
+spec:
+ containers:
+ - command:
+ - top
+ - name: container
+ value: podman
+ image: foobar
+...
+```
+
+If there is a directory named `foobar` in the current working directory with a file named `Containerfile` or `Dockerfile`,
+Podman play kube will build that image and name it `foobar`. An example directory structure for this example would look
+like:
+```
+|- mykubefiles
+ |- myplayfile.yaml
+ |- foobar
+ |- Containerfile
+```
+
+The build will consider `foobar` to be the context directory for the build. If there is an image in local storage
+called `foobar`, the image will not be built unless the `--build` flag is used.
+
## OPTIONS
#### **--authfile**=*path*
@@ -45,6 +75,10 @@ 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`
+#### **--build**
+
+Build images even if they are found in the local storage.
+
#### **--cert-dir**=*path*
Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry.