Skip to content

Commit 3bea0d8

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

File tree

1 file changed

+33
-26
lines changed

1 file changed

+33
-26
lines changed

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

Lines changed: 33 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1021,32 +1021,33 @@ 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** |
1025-
|-------------------------------------|----------------------------------------|
1026-
| AddHost=example\.com:192.168.10.11 | --add-host example.com:192.168.10.11 |
1027-
| ContainersConfModule=/etc/nvd\.conf | --module=/etc/nvd\.conf |
1028-
| DNS=192.168.55.1 | --dns=192.168.55.1 |
1029-
| DNSOption=ndots:1 | --dns-option=ndots:1 |
1030-
| DNSSearch=example.com | --dns-search example.com |
1031-
| ExitPolicy=stop | --exit-policy stop |
1032-
| GIDMap=0:10000:10 | --gidmap=0:10000:10 |
1033-
| GlobalArgs=--log-level=debug | --log-level=debug |
1034-
| HostName=name | --hostname=name |
1035-
| IP=192.5.0.1 | --ip 192.5.0.1 |
1036-
| IP6=2001:db8::1 | --ip6 2001:db8::1 |
1037-
| Label="XYZ" | --label "XYZ" |
1038-
| Network=host | --network host |
1039-
| NetworkAlias=name | --network-alias name |
1040-
| PodmanArgs=\-\-cpus=2 | --cpus=2 |
1041-
| PodName=name | --name=name |
1042-
| PublishPort=8080:80 | --publish 8080:80 |
1043-
| ServiceName=name | Name the systemd unit `name.service` |
1044-
| ShmSize=100m | --shm-size=100m |
1045-
| SubGIDMap=gtest | --subgidname=gtest |
1046-
| SubUIDMap=utest | --subuidname=utest |
1047-
| UIDMap=0:10000:10 | --uidmap=0:10000:10 |
1048-
| UserNS=keep-id:uid=200,gid=210 | --userns keep-id:uid=200,gid=210 |
1049-
| Volume=/source:/dest | --volume /source:/dest |
1024+
| **[Pod] options** | **podman pod create equivalent** |
1025+
|-------------------------------------|---------------------------------------|
1026+
| AddHost=example\.com:192.168.10.11 | --add-host example.com:192.168.10.11 |
1027+
| ContainersConfModule=/etc/nvd\.conf | --module=/etc/nvd\.conf |
1028+
| DNS=192.168.55.1 | --dns=192.168.55.1 |
1029+
| DNSOption=ndots:1 | --dns-option=ndots:1 |
1030+
| DNSSearch=example.com | --dns-search example.com |
1031+
| ExitPolicy=stop | --exit-policy stop |
1032+
| GIDMap=0:10000:10 | --gidmap=0:10000:10 |
1033+
| GlobalArgs=--log-level=debug | --log-level=debug |
1034+
| HostName=name | --hostname=name |
1035+
| IP=192.5.0.1 | --ip 192.5.0.1 |
1036+
| IP6=2001:db8::1 | --ip6 2001:db8::1 |
1037+
| Label="XYZ" | --label "XYZ" |
1038+
| Network=host | --network host |
1039+
| NetworkAlias=name | --network-alias name |
1040+
| PodmanArgs=\-\-cpus=2 | --cpus=2 |
1041+
| PodName=name | --name=name |
1042+
| PublishPort=8080:80 | --publish 8080:80 |
1043+
| ServiceName=name | Name the systemd unit `name.service` |
1044+
| ShmSize=100m | --shm-size=100m |
1045+
| StopTimeout=20 | --time=20 |
1046+
| SubGIDMap=gtest | --subgidname=gtest |
1047+
| SubUIDMap=utest | --subuidname=utest |
1048+
| UIDMap=0:10000:10 | --uidmap=0:10000:10 |
1049+
| UserNS=keep-id:uid=200,gid=210 | --userns keep-id:uid=200,gid=210 |
1050+
| Volume=/source:/dest | --volume /source:/dest |
10501051

10511052
Supported keys in the `[Pod]` section are:
10521053

@@ -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)