Communicating with Docker

DockerDaemon

The DockerDaemon object allows us to communicate with the Docker daemon via the Docker HTTP REST API.

exception subuserlib.classes.docker.dockerDaemon.ContainerDependsOnImageException

exception subuserlib.classes.docker.dockerDaemon.ImageBuildException

exception subuserlib.classes.docker.dockerDaemon.ImageDoesNotExistsException

subuserlib.classes.docker.dockerDaemon.RealDockerDaemon

alias of DockerDaemon

exception subuserlib.classes.docker.dockerDaemon.ServerErrorException

subuserlib.classes.docker.dockerDaemon.archiveBuildContext(archive, relativeBuildContextPath, repositoryFileStructure, excludePatterns, dockerfile=None)

Archive files from directoryWithDockerfile into the FileObject archive excluding files who’s paths(relative to directoryWithDockerfile) are in excludePatterns. If dockerfile is set to a string, include that string as the file Dockerfile in the archive.

subuserlib.classes.docker.dockerDaemon.readAndPrintStreamingBuildStatus(user, response)

Container

Container objects allow you to interact with docker containers via the Docker daemon.

class subuserlib.classes.docker.container.Container(user, containerId)

getId()

inspect()

Returns a dictionary of container properties. If the container no longer exists, return None.

remove(force=False)

stop()

Helper functions

This module helps us interact with the Docker executable directly.

subuserlib.docker.buildImageTag(tag, hash)

subuserlib.docker.getAndVerifyExecutable()

Return the name of the docker executable. Exits and displays a user friendly error message if docker is not setup correctly.

subuserlib.docker.getExecutable()

Return the name of the docker executable or None if docker is not installed.

subuserlib.docker.run(args, cwd=None)

Run docker with the given command line arguments. Return Docker’s exit code.

subuserlib.docker.runBackground(args, cwd=None, suppressOutput=True, collectStdout=False, collectStderr=False)

Run docker with the given command line arguments. Return Docker’s pid.