diff options
author | Joffrey F <joffrey@docker.com> | 2015-08-24 16:28:26 -0700 |
---|---|---|
committer | Joffrey F <joffrey@docker.com> | 2015-08-24 16:28:26 -0700 |
commit | 75e3b8bb71253bfa5212415f52417d2e80e0ef49 (patch) | |
tree | 9d1199a598da8d027bdd7cd76ca53401db20a5aa | |
parent | 595965ebc4badc08ba6ed2e0effd22896c243681 (diff) | |
download | docker-py-75e3b8bb71253bfa5212415f52417d2e80e0ef49.tar.gz |
Update HostConfig docs
-rw-r--r-- | docs/api.md | 2 | ||||
-rw-r--r-- | docs/hostconfig.md | 7 |
2 files changed, 5 insertions, 4 deletions
diff --git a/docs/api.md b/docs/api.md index b9b29c5..90acd4a 100644 --- a/docs/api.md +++ b/docs/api.md @@ -234,7 +234,7 @@ from. Optionally a single string joining container id's with commas 'Warnings': None} ``` -### parse_env_file +### docker.utils.parse_env_file A utility for parsing an environment file. diff --git a/docs/hostconfig.md b/docs/hostconfig.md index c2a4eda..e21148b 100644 --- a/docs/hostconfig.md +++ b/docs/hostconfig.md @@ -6,7 +6,7 @@ The Docker Remote API introduced [support for HostConfig in version 1.15](http:/ ## HostConfig helper -### docker.utils.create_host_config +### Client.create_host_config Creates a HostConfig dictionary to be used with `Client.create_container`. @@ -97,7 +97,8 @@ for example: **Returns** (dict) HostConfig dictionary ```python ->>> from docker.utils import create_host_config ->>> create_host_config(privileged=True, cap_drop=['MKNOD'], volumes_from=['nostalgic_newton']) +>>> from docker import Client +>>> c = Client() +>>> c.create_host_config(privileged=True, cap_drop=['MKNOD'], volumes_from=['nostalgic_newton']) {'CapDrop': ['MKNOD'], 'LxcConf': None, 'Privileged': True, 'VolumesFrom': ['nostalgic_newton'], 'PublishAllPorts': False} ``` |