summaryrefslogtreecommitdiff
path: root/docs/api.md
diff options
context:
space:
mode:
authorJoffrey F <joffrey@docker.com>2014-12-17 11:29:30 -0800
committerJoffrey F <joffrey@docker.com>2014-12-17 11:48:39 -0800
commit5711ac4cf376cfa287703b8f1f0f870428243514 (patch)
treed9644418032cd6400885b38342e7960b67f2bdb6 /docs/api.md
parent2b5516afabb4ab2afe9b36b074abbc0e1928c6a2 (diff)
downloaddocker-py-host_config.tar.gz
Updated documentation with HostConfig informationhost_config
Diffstat (limited to 'docs/api.md')
-rw-r--r--docs/api.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/docs/api.md b/docs/api.md
index f5b883a..64d9b3d 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -172,8 +172,9 @@ character, bytes are assumed as an intended unit.
`volumes_from` and `dns` arguments raise [TypeError](
https://docs.python.org/3.4/library/exceptions.html#TypeError) exception if
-they are used against v1.10 of the Docker remote API. Those arguments should be
-passed to `start()` instead.
+they are used against v1.10 and above of the Docker remote API. Those
+arguments should be passed to `start()` instead, or as part of the `host_config`
+dictionary.
**Params**:
@@ -200,7 +201,8 @@ from. Optionally a single string joining container id's with commas
* cpu_shares (int or float): CPU shares (relative weight)
* working_dir (str): Path to the working directory
* domainname (str or list): Set custom DNS search domains
-* memswap_limit:
+* memswap_limit (int):
+* host_config (dict): A [HostConfig](hostconfig.md) dictionary
**Returns** (dict): A dictionary with an image 'Id' key and a 'Warnings' key.
@@ -563,9 +565,13 @@ Similar to the `docker start` command, but doesn't support attach options. Use
`.logs()` to recover `stdout`/`stderr`.
`binds` allows to bind a directory in the host to the container. See [Using
-volumes](volumes.md) for more information. `port_bindings` exposes container
-ports to the host. See [Port bindings](port-bindings.md) for more information.
+volumes](volumes.md) for more information.
+
+`port_bindings` exposes container ports to the host.
+See [Port bindings](port-bindings.md) for more information.
+
`lxc_conf` allows to pass LXC configuration options using a dictionary.
+
`privileged` starts the container in privileged mode.
[Links](http://docs.docker.io/en/latest/use/working_with_links_names/) can be