diff options
| author | Valentin Rothberg <vrothberg@redhat.com> | 2022-06-30 16:45:41 +0200 |
|---|---|---|
| committer | Valentin Rothberg <vrothberg@redhat.com> | 2022-06-30 17:09:53 +0200 |
| commit | 9c658f49071a31cb776eade600b092868345da97 (patch) | |
| tree | 730f0f738fe92a3183890be57476d9fd9fcddeef | |
| parent | c6fb533ca6e9cbf00f9d9d1feba0bb7331484f88 (diff) | |
| download | podman-9c658f49071a31cb776eade600b092868345da97.tar.gz podman-9c658f49071a31cb776eade600b092868345da97.tar.bz2 podman-9c658f49071a31cb776eade600b092868345da97.zip | |
docs: mention the podman-kube template
Mention the template in the docs for play-kube and generate-systemd.
Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
| -rw-r--r-- | docs/source/markdown/podman-generate-systemd.1.md | 11 | ||||
| -rw-r--r-- | docs/source/markdown/podman-play-kube.1.md | 13 |
2 files changed, 24 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-generate-systemd.1.md b/docs/source/markdown/podman-generate-systemd.1.md index 8c3c32d04..56ad4e446 100644 --- a/docs/source/markdown/podman-generate-systemd.1.md +++ b/docs/source/markdown/podman-generate-systemd.1.md @@ -14,6 +14,17 @@ Generating unit files for a pod requires the pod to be created with an infra con _Note: If you use this command with the remote client, including Mac and Windows (excluding WSL2) machines, you would still have to place the generated units on the remote system. Moreover, please make sure that the XDG_RUNTIME_DIR environment variable is set. If unset, you may set it via `export XDG_RUNTIME_DIR=/run/user/$(id -u)`._ +### Kubernetes Integration + +A Kubernetes YAML can be executed in systemd via the `podman-kube@.service` systemd template. The template's argument is the path to the YAML file. Given a `workload.yaml` file in the home directory, it can be executed as follows: + +``` +$ escaped=$(systemd-escape ~/sysadmin.yaml) +$ systemctl --user start podman-kube@$escaped.service +$ systemctl --user is-active podman-kube@$escaped.service +active +``` + ## OPTIONS #### **--after**=*dependency_name* diff --git a/docs/source/markdown/podman-play-kube.1.md b/docs/source/markdown/podman-play-kube.1.md index 1c7fc99a2..92cb694b0 100644 --- a/docs/source/markdown/podman-play-kube.1.md +++ b/docs/source/markdown/podman-play-kube.1.md @@ -103,6 +103,19 @@ spec: and as a result environment variable `FOO` will be set to `bar` for container `container-1`. +### Systemd Integration + +A Kubernetes YAML can be executed in systemd via the `podman-kube@.service` systemd template. The template's argument is the path to the YAML file. Given a `workload.yaml` file in the home directory, it can be executed as follows: + +``` +$ escaped=$(systemd-escape ~/sysadmin.yaml) +$ systemctl --user start podman-kube@$escaped.service +$ systemctl --user is-active podman-kube@$escaped.service +active +``` + +Note that the path to the YAML file must be escaped via `systemd-escape`. + ## OPTIONS #### **--annotation**=*key=value* |