From 5803896e7c35dbdd4c842cfb7ee4a216b540f51e Mon Sep 17 00:00:00 2001 From: Brennan Saeta Date: Sat, 1 Aug 2015 12:35:38 -0700 Subject: [PATCH] Add documentation for mem_limit and memswap_limit `create_host_config` has 2 additional parameters that were previously undocumented. --- docs/hostconfig.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/hostconfig.md b/docs/hostconfig.md index 001be172..c2a4edae 100644 --- a/docs/hostconfig.md +++ b/docs/hostconfig.md @@ -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