com.google.cloud.tools.jib.docker

Class DockerClient

java.lang.Object

com.google.cloud.tools.jib.docker.DockerClient

public class DockerClient
extends Object

Calls out to the docker CLI.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DockerClient.Builder Builds a DockerClient.

Method Summary

Modifier and Type	Method and Description
static DockerClient.Builder	builder() Gets a new DockerClient.Builder for DockerClient with defaults.
static boolean	isDefaultDockerInstalled() Checks if Docker is installed on the user's system and accessible by running the default docker command.
static boolean	isDockerInstalled(Path dockerExecutable) Checks if Docker is installed on the user's system and accessible by running the given docker executable.
String	load(Blob imageTarballBlob) Loads an image tarball into the Docker daemon.
static DockerClient	newDefaultClient() Instantiates with the default docker executable.
void	tag(ImageReference originalImageReference, ImageReference newImageReference) Tags the image referenced by originalImageReference with a new image reference newImageReference.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static DockerClient.Builder builder()

Gets a new DockerClient.Builder for DockerClient with defaults.

Returns:

a new DockerClient.Builder

newDefaultClient

public static DockerClient newDefaultClient()

Instantiates with the default docker executable.

Returns:

a new DockerClient

isDefaultDockerInstalled

public static boolean isDefaultDockerInstalled()

Checks if Docker is installed on the user's system and accessible by running the default docker command.

Returns:

true if Docker is installed on the user's system and accessible

isDockerInstalled

public static boolean isDockerInstalled(Path dockerExecutable)

Checks if Docker is installed on the user's system and accessible by running the given docker executable.

Parameters:

dockerExecutable - path to the executable to test running

Returns:

true if Docker is installed on the user's system and accessible

load

public String load(Blob imageTarballBlob)
            throws InterruptedException,
                   IOException

Loads an image tarball into the Docker daemon.

Parameters:

imageTarballBlob - the built container tarball.

Returns:

stdout from docker.

Throws:

InterruptedException - if the 'docker load' process is interrupted.

IOException - if streaming the blob to 'docker load' fails.

See Also:

https://docs.docker.com/engine/reference/commandline/load

tag

public void tag(ImageReference originalImageReference,
                ImageReference newImageReference)
         throws IOException,
                InterruptedException

Tags the image referenced by originalImageReference with a new image reference newImageReference.

Parameters:

originalImageReference - the existing image reference on the Docker daemon

newImageReference - the new image reference

Throws:

InterruptedException - if the 'docker tag' process is interrupted.

IOException - if an I/O exception occurs or docker tag failed

See Also:

https://docs.docker.com/engine/reference/commandline/tag/