com.google.cloud.tools.jib.docker

Class DockerContextGenerator

java.lang.Object

com.google.cloud.tools.jib.docker.DockerContextGenerator

public class DockerContextGenerator
extends Object

Generates a Docker context that mimics how Jib builds the image.

The image consists of a base image layer and 5 application layers under the directories:

• libs/ (dependency jars)
• snapshot-libs/ (snapshot dependency jars)
• resources/ (resource files)
• classes/ (.class files)
• root/ (extra files)

Empty application layers are omitted.

Constructor Summary

Constructors

Constructor and Description
DockerContextGenerator(LayerEntry dependenciesLayerEntry, LayerEntry snapshotDependenciesLayerEntry, LayerEntry resourcesLayerEntry, LayerEntry classesLayerEntry, LayerEntry extraFilesLayerEntry)

Method Summary

Modifier and Type	Method and Description
void	generate(Path targetDirectory) Creates the Docker context in #targetDirectory.
DockerContextGenerator	setBaseImage(String baseImage) Sets the base image for the FROM directive.
DockerContextGenerator	setExposedPorts(List<String> exposedPorts) Sets the exposed ports.
DockerContextGenerator	setJavaArguments(List<String> javaArguments) Sets the arguments used in the CMD.
DockerContextGenerator	setJvmFlags(List<String> jvmFlags) Sets the JVM flags used in the ENTRYPOINT.
DockerContextGenerator	setMainClass(String mainClass) Sets the main class used in the ENTRYPOINT.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerContextGenerator

public DockerContextGenerator(LayerEntry dependenciesLayerEntry,
                              LayerEntry snapshotDependenciesLayerEntry,
                              LayerEntry resourcesLayerEntry,
                              LayerEntry classesLayerEntry,
                              LayerEntry extraFilesLayerEntry)

Method Detail

setBaseImage

public DockerContextGenerator setBaseImage(String baseImage)

Sets the base image for the FROM directive. This must be called before generate(java.nio.file.Path).

Parameters:

baseImage - the base image.

Returns:

this

setJvmFlags

public DockerContextGenerator setJvmFlags(List<String> jvmFlags)

Sets the JVM flags used in the ENTRYPOINT.

Parameters:

jvmFlags - the jvm flags.

Returns:

this

setMainClass

public DockerContextGenerator setMainClass(String mainClass)

Sets the main class used in the ENTRYPOINT.

Parameters:

mainClass - the name of the main class.

Returns:

this

setJavaArguments

public DockerContextGenerator setJavaArguments(List<String> javaArguments)

Sets the arguments used in the CMD.

Parameters:

javaArguments - the list of arguments to pass into main.

Returns:

this

setExposedPorts

public DockerContextGenerator setExposedPorts(List<String> exposedPorts)

Sets the exposed ports.

Parameters:

exposedPorts - the list of port numbers/port ranges to expose

Returns:

this

generate

public void generate(Path targetDirectory)
              throws IOException

Creates the Docker context in #targetDirectory.

Parameters:

targetDirectory - the directory to generate the Docker context in

Throws:

IOException - if the export fails