Skip to content

Commit 36089d5

Browse files
committed
Update docs for StopTimeOut
Signed-off-by: ByoungUk Lee <[email protected]>
1 parent d1c43e3 commit 36089d5

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1021,7 +1021,7 @@ a `$name.pod` file creates a `$name-pod.service` unit and a `systemd-$name` Podm
10211021

10221022
Valid options for `[Pod]` are listed below:
10231023

1024-
| **[Pod] options** | **podman pod create equivalent** |
1024+
| **[Pod] options** | **podman pod create equivalent** |
10251025
|-------------------------------------|----------------------------------------|
10261026
| AddHost=example\.com:192.168.10.11 | --add-host example.com:192.168.10.11 |
10271027
| ContainersConfModule=/etc/nvd\.conf | --module=/etc/nvd\.conf |
@@ -1042,6 +1042,7 @@ Valid options for `[Pod]` are listed below:
10421042
| PublishPort=8080:80 | --publish 8080:80 |
10431043
| ServiceName=name | Name the systemd unit `name.service` |
10441044
| ShmSize=100m | --shm-size=100m |
1045+
| StopTimeout=20 | --time=20 |
10451046
| SubGIDMap=gtest | --subgidname=gtest |
10461047
| SubUIDMap=utest | --subuidname=utest |
10471048
| UIDMap=0:10000:10 | --uidmap=0:10000:10 |
@@ -1210,6 +1211,12 @@ Size of /dev/shm.
12101211

12111212
This is equivalent to the Podman `--shm-size` option and generally has the form `number[unit]`
12121213

1214+
### `StopTimeout=`
1215+
1216+
Sets the time in seconds to wait for the pod to gracefully stop.
1217+
This value is equivalent to the `--time` argument in the podman `pod stop` command when the service is stopped.
1218+
After this period expires, any running containers in the pod are forcibly killed.
1219+
12131220
### `SubGIDMap=`
12141221

12151222
Create the pod in a new user namespace using the map with name in the /etc/subgid file.

0 commit comments

Comments
 (0)