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

Moved docstrings into README.md for consistency.

This commit is contained in:
shin- 2013-10-14 16:39:52 +02:00
parent cf46c4d2d9
commit 07d791d50c
2 changed files with 4 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -27,7 +27,8 @@ Identical to the `docker cp` command.
* `c.create_container(image, command, hostname=None, user=None, detach=False, stdin_open=False, tty=False, mem_limit=0, ports=None, environment=None, dns=None, volumes=None, volumes_from=None, privileged=False)` * `c.create_container(image, command, hostname=None, user=None, detach=False, stdin_open=False, tty=False, mem_limit=0, ports=None, environment=None, dns=None, volumes=None, volumes_from=None, privileged=False)`
Creates a container that can then be `start`ed. Parameters are similar to those Creates a container that can then be `start`ed. Parameters are similar to those
for the `docker run` command except it doesn't support the attach options for the `docker run` command except it doesn't support the attach options
(`-a`) (`-a`)
In order to create volumes that can be rebinded at start time, use the following syntax: `volumes={"/srv": "" }`
* `c.diff(container)` * `c.diff(container)`
Identical to the `docker diff` command. Identical to the `docker diff` command.
@ -96,8 +97,8 @@ Similar to the `docker start` command, but doesn't support attach options.
Use `docker logs` to recover `stdout`/`stderr` Use `docker logs` to recover `stdout`/`stderr`
`binds` Allows to bind a directory in the host to the container. `binds` Allows to bind a directory in the host to the container.
Similar to the `docker run` command with option `-v="/host:/mnt"`. Similar to the `docker run` command with option `-v="/host:/mnt"`.
Requires the container to be created with the volumes argument: Note that you must declare "blank" volumes at container creation to use binds.
`c.create_container(..., volumes={'/mnt': {}})` Example of binds mapping from host to container: `{'/mnt/srv/': '/srv'}`
`lxc_conf` allows to pass LXC configuration options in dict form. `lxc_conf` allows to pass LXC configuration options in dict form.
* `c.stop(container, timeout=10)` * `c.stop(container, timeout=10)`

20
docker/client.py
View File

@ -231,14 +231,7 @@ class Client(requests.Session):
detach=False, stdin_open=False, tty=False, mem_limit=0, ports=None, detach=False, stdin_open=False, tty=False, mem_limit=0, ports=None,
environment=None, dns=None, volumes=None, volumes_from=None, environment=None, dns=None, volumes=None, volumes_from=None,
privileged=False): privileged=False):
'''
NOTES:
- To create modifiable volumes at start time, use::
volumes={"/srv": "" }
'''
config = self._container_config(image, command, hostname, user, config = self._container_config(image, command, hostname, user,
detach, stdin_open, tty, mem_limit, ports, environment, dns, detach, stdin_open, tty, mem_limit, ports, environment, dns,
@ -287,9 +280,6 @@ class Client(requests.Session):
return res return res
def import_image(self, src, data=None, repository=None, tag=None): def import_image(self, src, data=None, repository=None, tag=None):
'''
To import from a local tarball, use the absolute path to the file
'''
u = self._url("/images/create") u = self._url("/images/create")
params = { params = {
'repo': repository, 'repo': repository,
@ -444,16 +434,6 @@ class Client(requests.Session):
params={'term': term}), True) params={'term': term}), True)
def start(self, container, binds=None, lxc_conf=None): def start(self, container, binds=None, lxc_conf=None):
'''
NOTES:
- Remember that you must declare "blank" volumes
at container creation to use binds
- An example of binds mapping from host to container::
{'/mnt/srv/': '/srv'}
'''
if isinstance(container, dict): if isinstance(container, dict):
container = container.get('Id') container = container.get('Id')
start_config = { start_config = {