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

Class BuildStepsRunner

java.lang.Object

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

public class BuildStepsRunner
extends Object

Runs a BuildSteps and builds helpful error messages.

Method Summary

Modifier and Type	Method and Description
JibContainer	build(JibContainerBuilder jibContainerBuilder, Containerizer containerizer, EventDispatcher eventDispatcher, List<LayerConfiguration> layerConfigurations, HelpfulSuggestions helpfulSuggestions) Runs the BuildSteps.
static BuildStepsRunner	forBuildImage(ImageReference targetImageReference, Set<String> additionalTags) Creates a runner to build an image.
static BuildStepsRunner	forBuildTar(Path outputPath) Creates a runner to build an image tarball.
static BuildStepsRunner	forBuildToDockerDaemon(ImageReference targetImageReference, Set<String> additionalTags) Creates a runner to build to the Docker daemon.
BuildStepsRunner	writeImageDigest(Path imageDigestOutputPath) Set the location where the image digest will be saved.
BuildStepsRunner	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 BuildStepsRunner forBuildImage(ImageReference targetImageReference,
                                             Set<String> additionalTags)

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

Parameters:

targetImageReference - the target image reference

additionalTags - additional tags to push to

Returns:

a BuildStepsRunner for building to a registry

forBuildToDockerDaemon

public static BuildStepsRunner forBuildToDockerDaemon(ImageReference targetImageReference,
                                                      Set<String> additionalTags)

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

Parameters:

targetImageReference - the target image reference

additionalTags - additional tags to push to

Returns:

a BuildStepsRunner for building to a Docker daemon

forBuildTar

public static BuildStepsRunner forBuildTar(Path outputPath)

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

Parameters:

outputPath - the path to output the tarball to

Returns:

a BuildStepsRunner for building a tarball

build

public JibContainer build(JibContainerBuilder jibContainerBuilder,
                          Containerizer containerizer,
                          EventDispatcher eventDispatcher,
                          List<LayerConfiguration> layerConfigurations,
                          HelpfulSuggestions helpfulSuggestions)
                   throws BuildStepsExecutionException,
                          IOException,
                          CacheDirectoryCreationException

Runs the BuildSteps.

Parameters:

jibContainerBuilder - the JibContainerBuilder

containerizer - the Containerizer

eventDispatcher - the EventDispatcher

layerConfigurations - the list of LayerConfigurations

helpfulSuggestions - suggestions to use in help messages for exceptions

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 BuildStepsRunner 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 BuildStepsRunner 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