diff options
author | Brennan Saeta <brennan.saeta@gmail.com> | 2015-08-01 12:35:38 -0700 |
---|---|---|
committer | Brennan Saeta <brennan.saeta@gmail.com> | 2015-08-01 12:35:38 -0700 |
commit | 5803896e7c35dbdd4c842cfb7ee4a216b540f51e (patch) | |
tree | d4296dbdb06a264a45755b9aec82761b6877aeca /docs | |
parent | 07a99ea5c794962984a1e4def50361fe0914d4df (diff) | |
download | docker-py-5803896e7c35dbdd4c842cfb7ee4a216b540f51e.tar.gz |
Add documentation for mem_limit and memswap_limit
`create_host_config` has 2 additional parameters that were previously undocumented.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/hostconfig.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/hostconfig.md b/docs/hostconfig.md index 001be17..c2a4eda 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 |