mirror of https://github.com/docker/docker-py.git
135 lines
5.1 KiB
Markdown
135 lines
5.1 KiB
Markdown
docker-py
|
|
=========
|
|
|
|
[](https://travis-ci.org/dotcloud/docker-py)
|
|
|
|
An API client for docker written in Python
|
|
|
|
API
|
|
===
|
|
|
|
`docker.Client(base_url='unix://var/run/docker.sock', version="1.4")`
|
|
Client class. `base_url` refers to the protocol+hostname+port where the docker
|
|
server is hosted. Version is the version of the API the client will use.
|
|
|
|
* `c.build(path=None, tag=None, quiet=False, fileobj=None, nocache=False, rm=False)`
|
|
Similar to the `docker build` command. Either `path` or `fileobj` needs to be
|
|
set. `path` can be a local path (to a directory containing a Dockerfile) or a
|
|
remote URL. `fileobj` must be a readable file-like object to a Dockerfile.
|
|
|
|
* `c.commit(container, repository=None, tag=None, message=None, author=None, conf=None)`
|
|
Identical to the `docker commit` command.
|
|
|
|
* `c.containers(quiet=False, all=False, trunc=True, latest=False, since=None,before=None, limit=-1)`
|
|
Identical to the `docker ps` command.
|
|
|
|
* `c.copy(container, resource)`
|
|
Identical to the `docker cp` command.
|
|
|
|
* <code>c.create_container(image, command=None, 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, name=None)</code>
|
|
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
|
|
(`-a`)
|
|
In order to create volumes that can be rebinded at start time, use the
|
|
following syntax: `volumes={"/srv": "" }`. The `ports` parameter is a
|
|
dictionary whose key is the port to expose and the value is an empty
|
|
dictionary: `ports={"2181/tcp": {}}`. Note, this will simply expose the ports in
|
|
the container, but does not make them available on the host. See `start`
|
|
below.
|
|
|
|
* `c.diff(container)`
|
|
Identical to the `docker diff` command.
|
|
|
|
* `c.export(container)`
|
|
Identical to the `docker export` command.
|
|
|
|
* `c.history(image)`
|
|
Identical to the `docker history` command.
|
|
|
|
* `c.images(name=None, quiet=False, all=False, viz=False)`
|
|
Identical to the `docker images` command.
|
|
|
|
* `c.import_image(src, repository=None, tag=None)`
|
|
Identical to the `docker import` command. If `src` is a string or unicode
|
|
string, it will be treated as a URL to fetch the image from. To import an image
|
|
from the local machine, `src` needs to be a file-like object or bytes
|
|
collection.
|
|
To import from a tarball use your absolute path to your tarball.
|
|
To load arbitrary data as tarball use whatever you want as src and your tarball content in data.
|
|
|
|
* `c.info()`
|
|
Identical to the `docker info` command.
|
|
|
|
* `c.insert(url, path)`
|
|
Identical to the `docker insert` command.
|
|
|
|
* `c.inspect_container(container)`
|
|
Identical to the `docker inspect` command, but only for containers.
|
|
|
|
* `c.inspect_image(image_id)`
|
|
Identical to the `docker inspect` command, but only for images.
|
|
|
|
* `c.kill(container)`
|
|
Kill a container. Similar to the `docker kill` command.
|
|
|
|
* `c.login(username, password=None, email=None)`
|
|
Identical to the `docker login` command (but non-interactive, obviously).
|
|
|
|
* `c.logs(container)`
|
|
Identical to the `docker logs` command.
|
|
|
|
* `c.port(container, private_port)`
|
|
Identical to the `docker port` command.
|
|
|
|
* `c.pull(repository, tag=None)`
|
|
Identical to the `docker pull` command.
|
|
|
|
* `c.push(repository)`
|
|
Identical to the `docker push` command.
|
|
|
|
* `c.remove_container(container, v=False)`
|
|
Remove a container. Similar to the `docker rm` command.
|
|
|
|
* `c.remove_image(image)`
|
|
Remove an image. Similar to the `docker rmi` command.
|
|
|
|
* `c.restart(container, timeout=10)`
|
|
Restart a container. Similar to the `docker restart` command.
|
|
|
|
* `c.search(term)`
|
|
Identical to the `docker search` command.
|
|
|
|
* `c.start(container, binds=None, port_bindings=None, lxc_conf=None)`
|
|
Similar to the `docker start` command, but doesn't support attach options.
|
|
Use `docker logs` to recover `stdout`/`stderr`
|
|
`binds` Allows to bind a directory in the host to the container.
|
|
Similar to the `docker run` command with option `-v="/host:/mnt"`.
|
|
Note that you must declare "blank" volumes at container creation to use binds.
|
|
Example of binds mapping from host to container: `{'/mnt/srv/': '/srv'}`
|
|
`port_bindings` Exposes container ports to the host. This is a
|
|
dictionary whose key is the container's port and the value is a `[{'HostIp': ''
|
|
'HostPort': ''}]` list. Leaving `HostIp` blank will expose the port on
|
|
all host interfaces. By leaving the `HostPort` blank, Docker will
|
|
automatically assign a port. For example: `port_bindings={"2181/tcp": [{'HostIp': ''
|
|
'HostPort': ''}]}`.
|
|
`lxc_conf` allows to pass LXC configuration options using a dictionary.
|
|
|
|
* `c.stop(container, timeout=10)`
|
|
Stops a container. Similar to the `docker stop` command.
|
|
|
|
* `c.tag(image, repository, tag=None, force=False)`
|
|
Identical to the `docker tag` command.
|
|
|
|
* `c.top(container_id)`
|
|
Identical to the `docker top` command.
|
|
|
|
* `c.version()`
|
|
Identical to the `docker version` command.
|
|
|
|
* `c.wait(container)`
|
|
Wait for a container and return its exit code. Similar to the `docker wait`
|
|
command.
|
|
|