Containers

Create a container

import asyncio
import aiodocker

docker = aiodocker.Docker()

config = {
     "Cmd": ["/bin/ls"],
     "Image": "alpine:latest",
     "AttachStdin": False,
     "AttachStdout": False,
     "AttachStderr": False,
     "Tty": False,
     "OpenStdin": False,
 }

async def create_container():
    container = await docker.containers.create(config=config)
    print(container)
    await docker.close()


if __name__ == '__main__':
    loop = asyncio.get_event_loop()
    loop.run_until_complete(create_container())
    loop.close()

Reference

DockerContainers

class aiodocker.docker.DockerContainers(docker)

container(container_id, **kwargs)

coroutine create(config, *, name=None)

coroutine create_or_replace(name, config)

exec(exec_id)

Return Exec instance for already created exec object.

Return type

Exec

coroutine get(container, **kwargs)

coroutine list(**kwargs)

coroutine run(self, config, *, auth=None, name=None)

Create and start a container.

If container.start() will raise an error the exception will contain a container_id attribute with the id of the container.

Use auth for specifying credentials for pulling absent image from a private registry.

DockerContainer

class aiodocker.docker.DockerContainer(docker, **kwargs)

attach(*, stdout=False, stderr=False, stdin=False, detach_keys=None, logs=False)

Return type

Stream

coroutine commit(self, *, repository=None, tag=None, message=None, author=None, changes=None, config=None, pause=True)

Commit a container to an image. Similar to the docker commit command.

Return type

Dict[str, Any]

coroutine delete(**kwargs)

coroutine exec(self, cmd, stdout=True, stderr=True, stdin=False, tty=False, privileged=False, user='', environment=None, workdir=None, detach_keys=None)

coroutine get_archive(self, path)

Return type

TarFile

property id: str

Return type

str

coroutine kill(**kwargs)

log(*, stdout=False, stderr=False, follow=False, **kwargs)

coroutine pause(self)

Return type

None

coroutine port(private_port)

coroutine put_archive(path, data)

coroutine rename(newname)

coroutine resize(self, *, h, w)

Return type

None

coroutine restart(timeout=None)

coroutine show(**kwargs)

coroutine start(**kwargs)

stats(*, stream=True)

coroutine stop(**kwargs)

coroutine unpause(self)

Return type

None

coroutine wait(*, timeout=None, **kwargs)

coroutine websocket(**params)