An API client for docker written in Python
docker.Client(base_url='unix://var/run/docker.sock', version="1.4", timeout=60)
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 thedocker build
command. Eitherpath
orfileobj
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 thedocker commit
command. -
c.containers(quiet=False, all=False, trunc=True, latest=False, since=None,before=None, limit=-1)
Identical to thedocker ps
command. -
c.copy(container, resource)
Identical to thedocker cp
command. -
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, name=None)
Creates a container that can then bestart
ed. Parameters are similar to those for thedocker run
command except it doesn't support the attach options (-a
)
See "Port bindings" and "Using volumes" below for more information on how to create port bindings and volume mappings. -
c.diff(container)
Identical to thedocker diff
command. -
c.export(container)
Identical to thedocker export
command. -
c.history(image)
Identical to thedocker history
command. -
c.images(name=None, quiet=False, all=False, viz=False)
Identical to thedocker images
command. -
c.import_image(src, repository=None, tag=None)
Identical to thedocker import
command. Ifsrc
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 thedocker info
command. -
c.insert(url, path)
Identical to thedocker insert
command. -
c.inspect_container(container)
Identical to thedocker inspect
command, but only for containers. -
c.inspect_image(image_id)
Identical to thedocker inspect
command, but only for images. -
c.kill(container, signal=None)
Kill a container. Similar to thedocker kill
command. -
c.login(username, password=None, email=None)
Identical to thedocker login
command (but non-interactive, obviously). -
c.logs(container)
Identical to thedocker logs
command. -
c.port(container, private_port)
Identical to thedocker port
command. -
c.pull(repository, tag=None)
Identical to thedocker pull
command. -
c.push(repository)
Identical to thedocker push
command. -
c.remove_container(container, v=False)
Remove a container. Similar to thedocker rm
command. -
c.remove_image(image)
Remove an image. Similar to thedocker rmi
command. -
c.restart(container, timeout=10)
Restart a container. Similar to thedocker restart
command. -
c.search(term)
Identical to thedocker search
command. -
c.start(container, binds=None, port_bindings=None, lxc_conf=None, privileged=False)
Similar to thedocker start
command, but doesn't support attach options. Usedocker logs
to recoverstdout
/stderr
binds
Allows to bind a directory in the host to the container. See "Using volumes" below for more information.port_bindings
Exposes container ports to the host. See "Port bindings" below for more information.lxc_conf
allows to pass LXC configuration options using a dictionary.privileged
starts the container in privileged mode. -
c.stop(container, timeout=10)
Stops a container. Similar to thedocker stop
command. -
c.tag(image, repository, tag=None, force=False)
Identical to thedocker tag
command. -
c.top(container_id)
Identical to thedocker top
command. -
c.version()
Identical to thedocker version
command. -
c.wait(container)
Wait for a container and return its exit code. Similar to thedocker wait
command.
Port bindings is done in two parts. Firstly, by providing a list of ports to
open inside the container in the Client.create_container
method.
client.create_container('busybox', 'ls', ports=[1111, 2222])
If you wish to use UDP instead of TCP (default), you can declare it like such:
client.create_container('busybox', 'ls', ports=[(1111, 'udp'), 2222])
Bindings are then declared in the Client.start
method.
client.start(container_id, port_bindings={
1111: 4567,
2222: None
})
You can limit the host address on which the port will be exposed like such:
client.start(container_id, port_bindings={
1111: ('127.0.0.1', 4567)
})
or without host port assignment:
client.start(container_id, port_bindings={
1111: ('127.0.0.1',)
})
Similarly, volume declaration is done in two parts. First, you have to provide
a list of mountpoints to the Client.create_container
method.
client.create_container('busybox', 'ls', volumes=['/mnt/vol1', '/mnt/vol2'])
Volume mappings are then declared inside the Client.start
method like this:
client.start(container_id, bindings={
'/mnt/vol2': '/home/user1/',
'/mnt/vol1': '/var/www'
})