org.eclipse.jkube.kit.build.service.docker.access

Interface DockerAccess

All Known Implementing Classes:

DockerAccessWithHcClient

public interface DockerAccess

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

Author:

roland

Method Summary

Modifier and Type	Method and Description
void	buildImage(String image, File dockerArchive, BuildOptions options) Create a docker image from a given archive
String	getImageId(String name) Get the image id of a given name or null if no such image exists
boolean	hasImage(String name) Check whether the given name exists as image at the docker daemon
void	loadImage(String image, File tarArchive) Load an image from an archive.
void	pullImage(String image, AuthConfig authConfig, String registry, CreateImageOptions options) Pull an image from a remote registry and store it locally.
void	pushImage(String image, AuthConfig authConfig, String registry, int retries) Push an image to a registry.
boolean	removeImage(String image, boolean... force) Remove an image from this docker installation
void	saveImage(String image, String filename, org.eclipse.jkube.kit.common.archive.ArchiveCompression compression) Save an image to a tar file
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	tag(String sourceImage, String targetImage, boolean force) Alias an image in the repository with a complete new name.

Method Detail

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 - docker access exception

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 - docker access exception

loadImage

void loadImage(String image,
               File tarArchive)
        throws DockerAccessException

Load an image from an archive.

Parameters:

image - the image to pull.

tarArchive - archive file

Throws:

DockerAccessException - if the image couldn't be loaded.

pullImage

void pullImage(String image,
               AuthConfig authConfig,
               String registry,
               CreateImageOptions options)
        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.

options - additional query arguments to add when creating the image. Can be null.

Throws:

DockerAccessException - if the image couldn't be pulled.

pushImage

void pushImage(String image,
               AuthConfig authConfig,
               String registry,
               int retries)
        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.

retries - optional number of times the push should be retried on a 500 error

Throws:

DockerAccessException - in case pushing fails

buildImage

void buildImage(String image,
                File dockerArchive,
                BuildOptions options)
         throws DockerAccessException

Create a 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

options - additional query arguments to add when building the image. Can be null.

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

saveImage

void saveImage(String image,
               String filename,
               org.eclipse.jkube.kit.common.archive.ArchiveCompression compression)
        throws DockerAccessException

Save an image to a tar file

Parameters:

image - image to save

filename - target filename

compression - compression to use for the archive

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 - docker access exception

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.