Skip to content

Commit 90a03ca

Browse files
authored
Merge pull request #27584 from salim-b/patch-1
docs: improve note about Quadlet TimeoutStartSec
2 parents 7958d91 + 7b30d9c commit 90a03ca

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

docs/source/markdown/podman-systemd.unit.5.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,13 @@ or [DynamicUser](https://www.freedesktop.org/software/systemd/man/latest/systemd
8585
systemd options. If you want to run a rootless Quadlet, you will need to create the user
8686
and add the unit file to one of the above rootless unit search paths.
8787

88-
Note: When a Quadlet is starting, Podman often pulls or builds one more container images which may take a considerable amount of time.
89-
Systemd defaults service start time to 90 seconds, or fails the service. Pre-pulling the image or extending
90-
the systemd timeout time for the service using the *TimeoutStartSec* Service option can fix the problem.
91-
A word of caution: *TimeoutStartSec* is not available for `Type=oneshot` units. Refer to `systemd.service(5)`
92-
for more information on how to handle long startup times for units which do not need to stay active
93-
once their main process has finished.
88+
When a Quadlet unit starts, Podman may need to pull or build container images, which can take significantly longer
89+
than systemd's default 90-second service startup limit. If this causes the unit to fail, you can either pre-pull the
90+
required images or increase the service's startup timeout using the *TimeoutStartSec* option. Keep in mind, however,
91+
that *TimeoutStartSec* cannot be used with units that specify `Type=oneshot` (their startup timeout is disabled by
92+
default). For further details on *TimeoutStartSec*, see `systemd.service(5)`.
9493

95-
Adding the following snippet to a Quadlet file extends the systemd timeout to 15 minutes.
94+
Adding the following snippet to a Quadlet file extends the startup timeout to 15 minutes.
9695

9796
```
9897
[Service]
@@ -2373,7 +2372,7 @@ Image=quay.io/example/my-app:latest
23732372
Mount=type=artifact,source=my-artifact.artifact,destination=/etc/config
23742373
```
23752374

2376-
Example for Container in a Pod:
2375+
Example for a container in a Pod:
23772376

23782377
`test.pod`
23792378
```
@@ -2389,7 +2388,7 @@ Exec=sh -c "sleep inf"
23892388
Pod=test.pod
23902389
```
23912390

2392-
Example for a Pod with a oneshot Startup Task:
2391+
Example for a Pod with a one-shot startup task:
23932392

23942393
`test.pod`
23952394
```

0 commit comments

Comments
 (0)