com.google.cloud.tools.jib.api

Class Containerizer

java.lang.Object

com.google.cloud.tools.jib.api.Containerizer

public class Containerizer
extends Object

Configures how to containerize.

Field Summary

Fields

Modifier and Type	Field and Description
static Path	DEFAULT_BASE_CACHE_DIRECTORY The default directory for caching the base image layers, in [user cache home]/google-cloud-tools-java/jib.

Method Summary

Modifier and Type	Method and Description
<E extends JibEvent> Containerizer	addEventHandler(Class<E> eventType, Consumer<? super E> eventConsumer) Adds the eventConsumer to handle the JibEvent with class eventType.
Containerizer	addEventHandler(Consumer<JibEvent> eventConsumer) Adds the eventConsumer to handle all JibEvent types.
Containerizer	setAllowInsecureRegistries(boolean allowInsecureRegistries) Sets whether or not to allow communication over HTTP/insecure HTTPS.
Containerizer	setApplicationLayersCache(Path cacheDirectory) Sets the directory to use for caching application layers.
Containerizer	setBaseImageLayersCache(Path cacheDirectory) Sets the directory to use for caching base image layers.
Containerizer	setExecutorService(ExecutorService executorService) Sets the ExecutorService Jib executes on.
Containerizer	setOfflineMode(boolean offline) Sets whether or not to run the build in offline mode.
Containerizer	setToolName(String toolName) Sets the name of the tool that is using Jib Core.
static Containerizer	to(DockerDaemonImage dockerDaemonImage) Gets a new Containerizer that containerizes to a Docker daemon.
static Containerizer	to(RegistryImage registryImage) Gets a new Containerizer that containerizes to a container registry.
static Containerizer	to(TarImage tarImage) Gets a new Containerizer that containerizes to a tarball archive.
Containerizer	withAdditionalTag(String tag) Adds an additional tag to tag the target image with.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BASE_CACHE_DIRECTORY

public static final Path DEFAULT_BASE_CACHE_DIRECTORY

The default directory for caching the base image layers, in [user cache home]/google-cloud-tools-java/jib.

Method Detail

to

public static Containerizer to(RegistryImage registryImage)

Gets a new Containerizer that containerizes to a container registry.

Parameters:

registryImage - the RegistryImage that defines target container registry and credentials

Returns:

a new Containerizer

to

public static Containerizer to(DockerDaemonImage dockerDaemonImage)

Gets a new Containerizer that containerizes to a Docker daemon.

Parameters:

dockerDaemonImage - the DockerDaemonImage that defines target Docker daemon

Returns:

a new Containerizer

to

public static Containerizer to(TarImage tarImage)

Gets a new Containerizer that containerizes to a tarball archive.

Parameters:

tarImage - the TarImage that defines target output file

Returns:

a new Containerizer

withAdditionalTag

public Containerizer withAdditionalTag(String tag)

Adds an additional tag to tag the target image with. For example, the following would containerize to both gcr.io/my-project/my-image:tag and gcr.io/my-project/my-image:tag2:

 Containerizer.to(RegistryImage.named("gcr.io/my-project/my-image:tag")).withAdditionalTag("tag2");
 

Parameters:

tag - the additional tag to push to

Returns:

this

setExecutorService

public Containerizer setExecutorService(@Nullable
                                        ExecutorService executorService)

Sets the ExecutorService Jib executes on. Jib, by default, uses Executors.newCachedThreadPool().

Parameters:

executorService - the ExecutorService

Returns:

this

setBaseImageLayersCache

public Containerizer setBaseImageLayersCache(Path cacheDirectory)

Sets the directory to use for caching base image layers. This cache can (and should) be shared between multiple images. The default base image layers cache directory is [user cache home]/google-cloud-tools-java/jib (DEFAULT_BASE_CACHE_DIRECTORY. This directory can be the same directory used for setApplicationLayersCache(java.nio.file.Path).

Parameters:

cacheDirectory - the cache directory

Returns:

this

setApplicationLayersCache

public Containerizer setApplicationLayersCache(Path cacheDirectory)

Sets the directory to use for caching application layers. This cache can be shared between multiple images. If not set, a temporary directory will be used as the application layers cache. This directory can be the same directory used for setBaseImageLayersCache(java.nio.file.Path).

Parameters:

cacheDirectory - the cache directory

Returns:

this

addEventHandler

public <E extends JibEvent> Containerizer addEventHandler(Class<E> eventType,
                                                          Consumer<? super E> eventConsumer)

Adds the eventConsumer to handle the JibEvent with class eventType. The order in which handlers are added is the order in which they are called when the event is dispatched.

Note: Implementations of eventConsumer must be thread-safe.

Type Parameters:

E - the type of eventType

Parameters:

eventType - the event type that eventConsumer should handle

eventConsumer - the event handler

Returns:

this

addEventHandler

public Containerizer addEventHandler(Consumer<JibEvent> eventConsumer)

Adds the eventConsumer to handle all JibEvent types. See addEventHandler(Class, Consumer) for more details.

Parameters:

eventConsumer - the event handler

Returns:

this

setAllowInsecureRegistries

public Containerizer setAllowInsecureRegistries(boolean allowInsecureRegistries)

Sets whether or not to allow communication over HTTP/insecure HTTPS.

Parameters:

allowInsecureRegistries - if true, insecure connections will be allowed

Returns:

this

setOfflineMode

public Containerizer setOfflineMode(boolean offline)

Sets whether or not to run the build in offline mode. In offline mode, the base image is retrieved from the cache instead of pulled from a registry, and the build will fail if the base image is not in the cache or if the target is an image registry.

Parameters:

offline - if true, the build will run in offline mode

Returns:

this

setToolName

public Containerizer setToolName(String toolName)

Sets the name of the tool that is using Jib Core. The tool name is sent as part of the User-Agent in registry requests and set as the created_by in the container layer history. Defaults to jib-core.

Parameters:

toolName - the name of the tool using this library

Returns:

this