docker
/
docker-py
mirror of https://github.com/docker/docker-py.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated documentation

This commit is contained in:
Joffrey F 2014-12-18 11:19:46 -08:00
parent 29c67c3a05
commit 0ec70a2b08
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/api.md
View File

@ -54,7 +54,7 @@ correct value (e.g `gzip`).
* nocache (bool): Don't use the cache when set to `True` * nocache (bool): Don't use the cache when set to `True`
* rm (bool): Remove intermediate containers * rm (bool): Remove intermediate containers
* stream (bool): Return a blocking generator you can iterate over to retrieve * stream (bool): Return a blocking generator you can iterate over to retrieve
build output as it happens build output as it happens
* timeout (int): HTTP timeout * timeout (int): HTTP timeout
* custom_context (bool): Optional if using `fileobj` * custom_context (bool): Optional if using `fileobj`
* encoding (str): The encoding for a stream. Set to `gzip` for compressing * encoding (str): The encoding for a stream. Set to `gzip` for compressing
@ -385,6 +385,8 @@ Nearly identical to the `docker login` command, but non-interactive.
* email (str): The email for the registry account * email (str): The email for the registry account
* registry (str): URL to the registry. Ex:`https://index.docker.io/v1/` * registry (str): URL to the registry. Ex:`https://index.docker.io/v1/`
* reauth (bool): Whether refresh existing authentication on the docker server. * reauth (bool): Whether refresh existing authentication on the docker server.
* dockercfg_path (str): Use a custom path for the .dockercfg file
(default `$HOME/.dockercfg`)
**Returns** (dict): The response from the login request **Returns** (dict): The response from the login request
@ -636,6 +638,7 @@ from. Optionally a single string joining container id's with commas
`['on-failure', 'always']` `['on-failure', 'always']`
* cap_add (list of str): See note above * cap_add (list of str): See note above
* cap_drop (list of str): See note above * cap_drop (list of str): See note above
* extra_hosts (dict): custom host-to-IP mappings (host:ip)
```python ```python
>>> from docker import Client >>> from docker import Client

1
docs/hostconfig.md
View File

@ -81,6 +81,7 @@ for example:
* restart_policy (dict): "Name" param must be one of `['on-failure', 'always']` * restart_policy (dict): "Name" param must be one of `['on-failure', 'always']`
* cap_add (list of str): Add kernel capabilities * cap_add (list of str): Add kernel capabilities
* cap_drop (list of str): Drop kernel capabilities * cap_drop (list of str): Drop kernel capabilities
* extra_hosts (dict): custom host-to-IP mappings (host:ip)
**Returns** (dict) HostConfig dictionary **Returns** (dict) HostConfig dictionary