[CI:DOCS] podman-generate-systemd.1.md: document --sdnotify

* Document why the default value for --sdnotify is overridden. Some was included text from containers#15029 (comment) * Document that --sdnotify=ignore is overridden. Fixes containers#15029 Co-authored-by: Valentin Rothberg <[email protected]> Co-authored-by: Tom Sweeney <[email protected]> Signed-off-by: Erik Sjölund <[email protected]>
mheon · Jul 26, 2022 · 990ef3c · 990ef3c
1 parent c85722e
commit 990ef3c
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/source/markdown/podman-generate-systemd.1.md b/docs/source/markdown/podman-generate-systemd.1.md
@@ -14,6 +14,13 @@ 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)`._
 
+_Note: The generated `podman run` command contains an `--sdnotify` option with the value taken from the container.
+If the container does not have any explicitly set value or the value is set to __ignore__, the value __conmon__ is used.
+The reason for overriding the default value __container__ is that almost no container workloads send notify messages.
+Systemd would wait for a ready message that never comes, if the value __container__ is used for a container
+that does not send notify messages. The use of the default value might have been unintentional by the user,
+therefore the overridden default value._
+
 ### Kubernetes Integration
 
 A Kubernetes YAML can be executed in systemd via the `[email protected]` 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: