summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorValentin Rothberg <vrothberg@redhat.com>2022-02-24 10:56:47 +0100
committerValentin Rothberg <vrothberg@redhat.com>2022-02-24 10:58:18 +0100
commite1b2981665e46efde56d1323061081af549a783b (patch)
treea492f12cb756455c6d5e2063a25fcf005657182a /docs/source
parent0d2bd53f3714f76228cd07cbc1141c374594de45 (diff)
downloadpodman-e1b2981665e46efde56d1323061081af549a783b.tar.gz
podman-e1b2981665e46efde56d1323061081af549a783b.tar.bz2
podman-e1b2981665e46efde56d1323061081af549a783b.zip
docs: generate-systemd: pod requires an infra container
Generating unit files for a pod requires the pod to be created with an infra container (see `--infra=true`). An infra container runs across the entire lifespan of a pod and is hence required for systemd to manage the life cycle of the pod's main unit. This issue came up on the mailing list. Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/markdown/podman-generate-systemd.1.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-generate-systemd.1.md b/docs/source/markdown/podman-generate-systemd.1.md
index fdc9c21a5..b2b5ee2ca 100644
--- a/docs/source/markdown/podman-generate-systemd.1.md
+++ b/docs/source/markdown/podman-generate-systemd.1.md
@@ -10,6 +10,8 @@ podman\-generate\-systemd - Generate systemd unit file(s) for a container or pod
**podman generate systemd** will create a systemd unit file that can be used to control a container or pod.
By default, the command will print the content of the unit files to stdout.
+Generating unit files for a pod requires the pod to be created with an infra container (see `--infra=true`). An infra container runs across the entire lifespan of a pod and is hence required for systemd to manage the life cycle of the pod's main unit.
+
_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)`._
## OPTIONS