com.google.cloud.tools.jib.docker

Class DockerClient

java.lang.Object

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

public class DockerClient
extends java.lang.Object

Calls out to the docker CLI.

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.file.Path	DEFAULT_DOCKER_CLIENT Default path to the docker executable.

Constructor Summary

Constructors

Constructor and Description
DockerClient(java.nio.file.Path dockerExecutable, java.util.Map<java.lang.String,java.lang.String> dockerEnvironment) Instantiates with a docker executable and environment variables.

Method Summary

Modifier and Type	Method and Description
static boolean	isDefaultDockerInstalled() Checks if Docker is installed on the user's system and accessible by running the default docker command.
static boolean	isDockerInstalled(java.nio.file.Path dockerExecutable) Checks if Docker is installed on the user's system and accessible by running the given docker executable.
java.lang.String	load(ImageTarball imageTarball, java.util.function.Consumer<java.lang.Long> writtenByteCountListener) Loads an image tarball into the Docker daemon.
void	save(ImageReference imageReference, java.nio.file.Path outputPath, java.util.function.Consumer<java.lang.Long> writtenByteCountListener) Saves an image tarball from the Docker daemon.
long	sizeOf(ImageReference imageReference) Gets the size of an image in the Docker daemon.
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

Field Detail

DEFAULT_DOCKER_CLIENT

public static final java.nio.file.Path DEFAULT_DOCKER_CLIENT

Default path to the docker executable.

Constructor Detail

DockerClient

public DockerClient(java.nio.file.Path dockerExecutable,
                    java.util.Map<java.lang.String,java.lang.String> dockerEnvironment)

Instantiates with a docker executable and environment variables.

Parameters:

dockerExecutable - path to docker

dockerEnvironment - environment variables for docker

Method Detail

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(java.nio.file.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 java.lang.String load(ImageTarball imageTarball,
                             java.util.function.Consumer<java.lang.Long> writtenByteCountListener)
                      throws java.lang.InterruptedException,
                             java.io.IOException

Loads an image tarball into the Docker daemon.

Parameters:

imageTarball - the built container tarball

writtenByteCountListener - callback to call when bytes are loaded

Returns:

stdout from docker

Throws:

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

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

See Also:

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

save

public void save(ImageReference imageReference,
                 java.nio.file.Path outputPath,
                 java.util.function.Consumer<java.lang.Long> writtenByteCountListener)
          throws java.lang.InterruptedException,
                 java.io.IOException

Saves an image tarball from the Docker daemon.

Parameters:

imageReference - the image to save

outputPath - the destination path to save the output tarball

writtenByteCountListener - callback to call when bytes are saved

Throws:

java.lang.InterruptedException - if the 'docker save' process is interrupted

java.io.IOException - if creating the tarball fails

See Also:

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

tag

public void tag(ImageReference originalImageReference,
                ImageReference newImageReference)
         throws java.io.IOException,
                java.lang.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:

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

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

See Also:

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

sizeOf

public long sizeOf(ImageReference imageReference)
            throws java.io.IOException

Gets the size of an image in the Docker daemon.

Parameters:

imageReference - the image to find the size of

Returns:

the size in bytes

Throws:

java.io.IOException - if an I/O exception occurs