Add documentation for mem_limit and memswap_limit

`create_host_config` has 2 additional parameters that were previously undocumented.
This commit is contained in:
Brennan Saeta 2015-08-01 12:35:38 -07:00
parent 07a99ea5c7
commit 5803896e7c
1 changed files with 2 additions and 0 deletions

View File

@ -91,6 +91,8 @@ for example:
* ulimits (list): A list of dicts or `docker.utils.Ulimit` objects. A list
of ulimits to be set in the container.
* log_config (`docker.utils.LogConfig` or dict): Logging configuration to container
* mem_limit (str or num): Maximum amount of memory container is allowed to consume. (e.g. `'1g'`)
* memswap_limit (str or num): Maximum amount of memory + swap a container is allowed to consume.
**Returns** (dict) HostConfig dictionary