io.fabric8.maven.docker.access

Interface DockerAccess

All Known Implementing Classes:

DockerAccessWithHcClient

public interface DockerAccess

Access to the Docker API which provides the methods needed bu this maven plugin.

Since:

04.04.14

Author:

roland

Method Summary

Modifier and Type	Method and Description
void	buildImage(String image, File dockerArchive, boolean forceRemove, boolean noCache) Create an docker image from a given archive
void	copyArchive(String containerId, File archive, String targetPath) Copy an archive (must be a tar) into a running container Get all containers matching a certain label.
String	createContainer(ContainerCreateConfig configuration, String containerName) Create a container from the given image.
String	createExecContainer(String containerId, Arguments arguments) Sets up an exec instance for a running container id
String	getImageId(String name) Get the image id of a given name or null if no such image exists
LogGetHandle	getLogAsync(String containerId, LogCallback callback) Get logs asynchronously.
void	getLogSync(String containerId, LogCallback callback) Get logs for a container up to now synchronously.
boolean	hasImage(String name) Check whether the given name exists as image at the docker daemon
Container	inspectContainer(String containerId) Inspect a container
List<Container>	listContainers(int limit) List containers
void	pullImage(String image, AuthConfig authConfig, String registry) Pull an image from a remote registry and store it locally.
void	pushImage(String image, AuthConfig authConfig, String registry) Push an image to a registry.
void	removeContainer(String containerId, boolean removeVolumes) Remove a container with the given id
boolean	removeImage(String image, boolean... force) Remove an image from this docker installation
void	shutdown() Lifecycle method which must be called when this object is not needed anymore.
void	start() Lifecycle method for this access class which must be called before any other method is called.
void	startContainer(String containerId) Start a container.
void	startExecContainer(String containerId, LogOutputSpec outputSpec) Starts a previously set up exec instance id.
void	stopContainer(String containerId, int killWait) Stop a container.
void	tag(String sourceImage, String targetImage, boolean force) Alias an image in the repository with a complete new name.

Method Detail

inspectContainer

Container inspectContainer(String containerId)
                    throws DockerAccessException

Inspect a container

Parameters:

containerId - container id

Returns:

ContainerDetails representing the container

Throws:

DockerAccessException - if the container could not be inspected

hasImage

boolean hasImage(String name)
          throws DockerAccessException

Check whether the given name exists as image at the docker daemon

Parameters:

name - image name to check

Returns:

true if the image exists

Throws:

DockerAccessException

getImageId

String getImageId(String name)
           throws DockerAccessException

Get the image id of a given name or null if no such image exists

Parameters:

name - name to lookup

Returns:

the image id or null

Throws:

DockerAccessException

listContainers

List<Container> listContainers(int limit)
                        throws DockerAccessException

List containers

Parameters:

limit - limit of containers to list

Returns:

list of Container objects

Throws:

DockerAccessException - if the containers could not be listed

startExecContainer

void startExecContainer(String containerId,
                        LogOutputSpec outputSpec)
                 throws DockerAccessException

Starts a previously set up exec instance id. this API sets up an interactive session with the exec command. Output is streamed to the log.

Parameters:

containerId - id of the exec container

outputSpec - how to print out the output of the command

Throws:

DockerAccessException - if the container could not be created.

createExecContainer

String createExecContainer(String containerId,
                           Arguments arguments)
                    throws DockerAccessException

Sets up an exec instance for a running container id

Parameters:

containerId - id of the running container which the exec container will be created for

arguments - container exec commands to run

Throws:

DockerAccessException - if the container could not be created.

createContainer

String createContainer(ContainerCreateConfig configuration,
                       String containerName)
                throws DockerAccessException

Create a container from the given image.

The container id will be set on the container upon successful creation.

Parameters:

configuration - container configuration

containerName - name container should be created with or null for a docker provided name

Throws:

DockerAccessException - if the container could not be created.

startContainer

void startContainer(String containerId)
             throws DockerAccessException

Start a container.

Parameters:

containerId - id of the container to start

Throws:

DockerAccessException - if the container could not be started.

stopContainer

void stopContainer(String containerId,
                   int killWait)
            throws DockerAccessException

Stop a container.

Parameters:

containerId - the container id

killWait - the time to wait between stop and kill (in seconds)

Throws:

DockerAccessException - if the container could not be stopped.

copyArchive

void copyArchive(String containerId,
                 File archive,
                 String targetPath)
          throws DockerAccessException

Copy an archive (must be a tar) into a running container Get all containers matching a certain label. This might not be a cheap operation especially if many containers are running. Use with care.

Parameters:

containerId - container to copy into

archive - local archive to copy into

targetPath - target path to use

Throws:

DockerAccessException

getLogSync

void getLogSync(String containerId,
                LogCallback callback)

Get logs for a container up to now synchronously.

Parameters:

containerId - container id

callback - which is called for each line received

getLogAsync

LogGetHandle getLogAsync(String containerId,
                         LogCallback callback)

Get logs asynchronously. This call will start a thread in the background for doing the request. It returns a handle which can be used to abort the request on demand.

Parameters:

containerId - id of the container for which to fetch the logs

callback - to call when log data arrives

Returns:

handle for managing the lifecycle of the thread

removeContainer

void removeContainer(String containerId,
                     boolean removeVolumes)
              throws DockerAccessException

Remove a container with the given id

Parameters:

containerId - container id for the container to remove

removeVolumes - if true, will remove any volumes associated to container

Throws:

DockerAccessException - if the container couldn't be removed.

pullImage

void pullImage(String image,
               AuthConfig authConfig,
               String registry)
        throws DockerAccessException

Pull an image from a remote registry and store it locally.

Parameters:

image - the image to pull.

authConfig - authentication configuration used when pulling an image

registry - an optional registry from where to pull the image. Can be null.

Throws:

DockerAccessException - if the image couldn't be pulled.

pushImage

void pushImage(String image,
               AuthConfig authConfig,
               String registry)
        throws DockerAccessException

Push an image to a registry. An registry can be specified which is used as target if the image name the image does not contain a registry. If an optional registry is used, the image is also tagged with the full name containing the registry as part (if not already existent)

Parameters:

image - image name to push

authConfig - authentication configuration

registry - optional registry to which the image should be pushed.

Throws:

DockerAccessException - in case pushing fails

buildImage

void buildImage(String image,
                File dockerArchive,
                boolean forceRemove,
                boolean noCache)
         throws DockerAccessException

Create an docker image from a given archive

Parameters:

image - name of the image to build or null if none should be used

dockerArchive - from which the docker image should be build

forceRemove - whether to remove intermediate containers

noCache - whether to use cache when building the image

Throws:

DockerAccessException - if docker host reports an error during building of an image

tag

void tag(String sourceImage,
         String targetImage,
         boolean force)
  throws DockerAccessException

Alias an image in the repository with a complete new name. (Note that this maps to a Docker Remote API 'tag' operation, which IMO is badly named since it also can generate a complete alias to a given image)

Parameters:

sourceImage - full name (including tag) of the image to alias

targetImage - the alias name

force - forced tagging

Throws:

DockerAccessException - if the original image doesn't exist or another error occurs somehow.

removeImage

boolean removeImage(String image,
                    boolean... force)
             throws DockerAccessException

Remove an image from this docker installation

Parameters:

image - image to remove

force - if set to true remove containers as well (only the first vararg is evaluated)

Returns:

true if an image was removed, false if none was removed

Throws:

DockerAccessException - if an image cannot be removed

start

void start()
    throws DockerAccessException

Lifecycle method for this access class which must be called before any other method is called.

Throws:

DockerAccessException

shutdown

void shutdown()

Lifecycle method which must be called when this object is not needed anymore. This hook might be used for cleaning up things.