com.google.cloud.tools.jib.api.buildplan

Class ContainerBuildPlan.Builder

java.lang.Object

com.google.cloud.tools.jib.api.buildplan.ContainerBuildPlan.Builder

Enclosing class:

ContainerBuildPlan

public static class ContainerBuildPlan.Builder
extends java.lang.Object

Builder for ContainerBuildPlan.

Method Summary

Modifier and Type	Method and Description
ContainerBuildPlan.Builder	addEnvironmentVariable(java.lang.String name, java.lang.String value) Adds a variable in the container environment.
ContainerBuildPlan.Builder	addExposedPort(Port exposedPort) Adds a port to expose from the container.
ContainerBuildPlan.Builder	addLabel(java.lang.String key, java.lang.String value) Sets a label for the container.
ContainerBuildPlan.Builder	addLayer(LayerObject layer)
ContainerBuildPlan.Builder	addPlatform(java.lang.String architecture, java.lang.String os) Adds a desired image platform (OS and architecture pair).
ContainerBuildPlan.Builder	addVolume(AbsoluteUnixPath volume) Adds a directory that may hold an externally mounted volume.
ContainerBuildPlan	build() Returns the built ContainerBuildPlan.
ContainerBuildPlan.Builder	setBaseImage(java.lang.String baseImage) Image reference to a base image.
ContainerBuildPlan.Builder	setCmd(java.util.List<java.lang.String> cmd) Sets the container entrypoint program arguments.
ContainerBuildPlan.Builder	setCreationTime(java.time.Instant creationTime) Sets the container image creation time.
ContainerBuildPlan.Builder	setEntrypoint(java.util.List<java.lang.String> entrypoint) Sets the container entrypoint.
ContainerBuildPlan.Builder	setEnvironment(java.util.Map<java.lang.String,java.lang.String> environment) Sets the container environment.
ContainerBuildPlan.Builder	setExposedPorts(java.util.Set<Port> exposedPorts) Sets the ports to expose from the container.
ContainerBuildPlan.Builder	setFormat(ImageFormat format) Sets the format to build the container image as.
ContainerBuildPlan.Builder	setLabels(java.util.Map<java.lang.String,java.lang.String> labels) Sets the labels for the container.
ContainerBuildPlan.Builder	setLayers(java.util.List<? extends LayerObject> layer)
ContainerBuildPlan.Builder	setPlatforms(java.util.Set<Platform> platforms) Sets a desired platform (properties including OS and architecture) list.
ContainerBuildPlan.Builder	setUser(java.lang.String user) Sets the user and group to run the container as.
ContainerBuildPlan.Builder	setVolumes(java.util.Set<AbsoluteUnixPath> volumes) Sets the directories that may hold externally mounted volumes.
ContainerBuildPlan.Builder	setWorkingDirectory(AbsoluteUnixPath workingDirectory) Sets the working directory in the container.

Methods inherited from class java.lang.Object

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

Method Detail

setBaseImage

public ContainerBuildPlan.Builder setBaseImage(java.lang.String baseImage)

Image reference to a base image. The default is scratch.

Parameters:

baseImage - image reference to a base image

Returns:

this

addPlatform

public ContainerBuildPlan.Builder addPlatform(java.lang.String architecture,
                                              java.lang.String os)

Adds a desired image platform (OS and architecture pair). If the base image reference is a Docker manifest list or an OCI image index, an image builder may select the base image matching the given platform. If the base image reference is an image manifest, an image builder may ignore the given platform and use the platform of the base image or may decide to raise on error.

Note that a new build plan starts with "amd64/linux" as the default platform. If you want to reset the default platform instead of adding a new one, use setPlatforms(Set).

Parameters:

architecture - architecture (for example, amd64) to select a base image in case of a manifest list

os - OS (for example, linux) to select a base image in case of a manifest list

Returns:

this

setPlatforms

public ContainerBuildPlan.Builder setPlatforms(java.util.Set<Platform> platforms)

Sets a desired platform (properties including OS and architecture) list. If the base image reference is a Docker manifest list or an OCI image index, an image builder may select the base images matching the given platforms. If the base image reference is an image manifest, an image builder may ignore the given platforms and use the platform of the base image or may decide to raise on error.

Note that a new build plan starts with "amd64/linux" as the default platform.

Parameters:

platforms - list of platforms to select base images in case of a manifest list

Returns:

this

setCreationTime

public ContainerBuildPlan.Builder setCreationTime(java.time.Instant creationTime)

Sets the container image creation time. The default is Instant.EPOCH.

Parameters:

creationTime - the container image creation time

Returns:

this

setFormat

public ContainerBuildPlan.Builder setFormat(ImageFormat format)

Sets the format to build the container image as. Use ImageFormat.Docker for Docker V2.2 or ImageFormat.OCI for OCI.

Parameters:

format - the ImageFormat

Returns:

this

setEnvironment

public ContainerBuildPlan.Builder setEnvironment(java.util.Map<java.lang.String,java.lang.String> environment)

Sets the container environment. These environment variables are available to the program launched by the container entrypoint command. This replaces any previously-set environment variables. Note that these values are added to the base image values.

This is similar to ENV in Dockerfiles or env in the Kubernetes Container spec.

Parameters:

environment - a map of environment variable names to values

Returns:

this

addEnvironmentVariable

public ContainerBuildPlan.Builder addEnvironmentVariable(java.lang.String name,
                                                         java.lang.String value)

Adds a variable in the container environment.

Parameters:

name - the environment variable name

value - the environment variable value

Returns:

this

See Also:

setEnvironment(java.util.Map<java.lang.String, java.lang.String>)

setVolumes

public ContainerBuildPlan.Builder setVolumes(java.util.Set<AbsoluteUnixPath> volumes)

Sets the directories that may hold externally mounted volumes. Note that these values are added to the base image values.

This is similar to VOLUME in Dockerfiles.

Parameters:

volumes - the directory paths on the container filesystem to set as volumes

Returns:

this

addVolume

public ContainerBuildPlan.Builder addVolume(AbsoluteUnixPath volume)

Adds a directory that may hold an externally mounted volume.

Parameters:

volume - a directory path on the container filesystem to represent a volume

Returns:

this

See Also:

setVolumes(Set)

setLabels

public ContainerBuildPlan.Builder setLabels(java.util.Map<java.lang.String,java.lang.String> labels)

Sets the labels for the container. This replaces any previously-set labels. Note that these values are added to the base image values.

This is similar to LABEL in Dockerfiles.

Parameters:

labels - a map of label keys to values

Returns:

this

addLabel

public ContainerBuildPlan.Builder addLabel(java.lang.String key,
                                           java.lang.String value)

Sets a label for the container.

Parameters:

key - the label key

value - the label value

Returns:

this

setExposedPorts

public ContainerBuildPlan.Builder setExposedPorts(java.util.Set<Port> exposedPorts)

Sets the ports to expose from the container. Ports exposed will allow ingress traffic. This replaces any previously-set exposed ports. Note that these values are added to the base image values.

Use Port.tcp(int) to expose a port for TCP traffic and Port.udp(int) to expose a port for UDP traffic.

This is similar to EXPOSE in Dockerfiles or ports in the Kubernetes Container spec.

Parameters:

exposedPorts - the ports to expose

Returns:

this

addExposedPort

public ContainerBuildPlan.Builder addExposedPort(Port exposedPort)

Adds a port to expose from the container.

Parameters:

exposedPort - the port to expose

Returns:

this

See Also:

setExposedPorts(Set)

setUser

public ContainerBuildPlan.Builder setUser(@Nullable
                                          java.lang.String user)

Sets the user and group to run the container as. user can be a username or UID along with an optional groupname or GID. null signals to use the base image value.

The following are valid formats for user

• user
• uid
• :group
• :gid
• user:group
• uid:gid
• uid:group
• user:gid

Parameters:

user - the user to run the container as

Returns:

this

setWorkingDirectory

public ContainerBuildPlan.Builder setWorkingDirectory(@Nullable
                                                      AbsoluteUnixPath workingDirectory)

Sets the working directory in the container. null signals to use the base image value.

Parameters:

workingDirectory - the working directory

Returns:

this

setEntrypoint

public ContainerBuildPlan.Builder setEntrypoint(@Nullable
                                                java.util.List<java.lang.String> entrypoint)

Sets the container entrypoint. This is the beginning of the command that is run when the container starts. setCmd(java.util.List<java.lang.String>) sets additional tokens. null signals to use the base image value.

This is similar to ENTRYPOINT in Dockerfiles or command in the Kubernetes Container spec.

Parameters:

entrypoint - a list of the entrypoint command

Returns:

this

setCmd

public ContainerBuildPlan.Builder setCmd(@Nullable
                                         java.util.List<java.lang.String> cmd)

Sets the container entrypoint program arguments. These are additional tokens added to the end of the entrypoint command. null signals to use the base image value (only when entrypoint is also null).

This is similar to CMD in Dockerfiles or args in the Kubernetes Container spec.

For example, if the entrypoint was myprogram --flag subcommand and program arguments were hello world, then the command that run when the container starts is myprogram --flag subcommand hello world.

Parameters:

cmd - a list of program argument tokens

Returns:

this

addLayer

public ContainerBuildPlan.Builder addLayer(LayerObject layer)

setLayers

public ContainerBuildPlan.Builder setLayers(java.util.List<? extends LayerObject> layer)

build

public ContainerBuildPlan build()

Returns the built ContainerBuildPlan.

Returns:

container build plan