Skip to content

Commit 5803896

Browse files
committed
Add documentation for mem_limit and memswap_limit
`create_host_config` has 2 additional parameters that were previously undocumented.
1 parent 07a99ea commit 5803896

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/hostconfig.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ for example:
9191
* ulimits (list): A list of dicts or `docker.utils.Ulimit` objects. A list
9292
of ulimits to be set in the container.
9393
* log_config (`docker.utils.LogConfig` or dict): Logging configuration to container
94+
* mem_limit (str or num): Maximum amount of memory container is allowed to consume. (e.g. `'1g'`)
95+
* memswap_limit (str or num): Maximum amount of memory + swap a container is allowed to consume.
9496

9597
**Returns** (dict) HostConfig dictionary
9698

0 commit comments

Comments
 (0)