com.google.cloud.tools.jib.plugins.common

Class JibBuildRunner

java.lang.Object

com.google.cloud.tools.jib.plugins.common.JibBuildRunner

public class JibBuildRunner
extends Object

Runs Jib and builds helpful error messages.

Method Summary

Modifier and Type	Method and Description
static JibBuildRunner	forBuildImage(JibContainerBuilder jibContainerBuilder, Containerizer containerizer, Consumer<LogEvent> logger, HelpfulSuggestions helpfulSuggestions, ImageReference targetImageReference, Set<String> additionalTags) Creates a runner to build an image.
static JibBuildRunner	forBuildTar(JibContainerBuilder jibContainerBuilder, Containerizer containerizer, Consumer<LogEvent> logger, HelpfulSuggestions helpfulSuggestions, Path outputPath) Creates a runner to build an image tarball.
static JibBuildRunner	forBuildToDockerDaemon(JibContainerBuilder jibContainerBuilder, Containerizer containerizer, Consumer<LogEvent> logger, HelpfulSuggestions helpfulSuggestions, ImageReference targetImageReference, Set<String> additionalTags) Creates a runner to build to the Docker daemon.
JibContainer	runBuild() Runs the Jib build.
JibBuildRunner	writeImageDigest(Path imageDigestOutputPath) Set the location where the image digest will be saved.
JibBuildRunner	writeImageId(Path imageIdOutputPath) Set the location where the image id will be saved.

Methods inherited from class java.lang.Object

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

Method Detail

forBuildImage

public static JibBuildRunner forBuildImage(JibContainerBuilder jibContainerBuilder,
                                           Containerizer containerizer,
                                           Consumer<LogEvent> logger,
                                           HelpfulSuggestions helpfulSuggestions,
                                           ImageReference targetImageReference,
                                           Set<String> additionalTags)

Creates a runner to build an image. Creates a directory for the cache, if needed.

Parameters:

jibContainerBuilder - the JibContainerBuilder

containerizer - the Containerizer

logger - consumer for handling log events

helpfulSuggestions - suggestions to use in help messages for exceptions

targetImageReference - the target image reference

additionalTags - additional tags to push to

Returns:

a JibBuildRunner for building to a registry

forBuildToDockerDaemon

public static JibBuildRunner forBuildToDockerDaemon(JibContainerBuilder jibContainerBuilder,
                                                    Containerizer containerizer,
                                                    Consumer<LogEvent> logger,
                                                    HelpfulSuggestions helpfulSuggestions,
                                                    ImageReference targetImageReference,
                                                    Set<String> additionalTags)

Creates a runner to build to the Docker daemon. Creates a directory for the cache, if needed.

Parameters:

jibContainerBuilder - the JibContainerBuilder

containerizer - the Containerizer

logger - consumer for handling log events

helpfulSuggestions - suggestions to use in help messages for exceptions

targetImageReference - the target image reference

additionalTags - additional tags to push to

Returns:

a JibBuildRunner for building to a Docker daemon

forBuildTar

public static JibBuildRunner forBuildTar(JibContainerBuilder jibContainerBuilder,
                                         Containerizer containerizer,
                                         Consumer<LogEvent> logger,
                                         HelpfulSuggestions helpfulSuggestions,
                                         Path outputPath)

Creates a runner to build an image tarball. Creates a directory for the cache, if needed.

Parameters:

jibContainerBuilder - the JibContainerBuilder

containerizer - the Containerizer

logger - consumer for handling log events

helpfulSuggestions - suggestions to use in help messages for exceptions

outputPath - the path to output the tarball to

Returns:

a JibBuildRunner for building a tarball

runBuild

public JibContainer runBuild()
                      throws BuildStepsExecutionException,
                             IOException,
                             CacheDirectoryCreationException

Runs the Jib build.

Returns:

the built JibContainer

Throws:

BuildStepsExecutionException - if another exception is thrown during the build

IOException - if an I/O exception occurs

CacheDirectoryCreationException - if the cache directory could not be created

writeImageDigest

public JibBuildRunner writeImageDigest(@Nullable
                                       Path imageDigestOutputPath)

Set the location where the image digest will be saved. If null then digest is not saved.

Parameters:

imageDigestOutputPath - the location to write the image digest or null to skip

Returns:

this

writeImageId

public JibBuildRunner writeImageId(@Nullable
                                   Path imageIdOutputPath)

Set the location where the image id will be saved. If null then digest is not saved.

Parameters:

imageIdOutputPath - the location to write the image id or null to skip

Returns:

this