JibDockerConfig

mill.contrib.docker.DockerModule.JibDockerConfig

A DockerConfig that builds images using Jib (Google's container image builder). Jib builds without requiring a Docker daemon or CLI, producing optimized layered images.

Attributes

Source
DockerModule.scala
Graph
Supertypes
trait Module
trait ModuleApi
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Type members

Inherited classlikes

object moduleInternal extends Internal

Miscellaneous machinery around traversing & querying the build hierarchy, that should not be needed by normal users of Mill

Miscellaneous machinery around traversing & querying the build hierarchy, that should not be needed by normal users of Mill

Attributes

Inherited from:
Module
Source
Module.scala
Supertypes
class Internal
class Object
trait Matchable
class Any

Value members

Concrete methods

Allow connections to insecure registries.

Allow connections to insecure registries.

Attributes

Source
DockerModule.scala
def build: Simple[Seq[String]]

Attributes

Source
DockerModule.scala
def entrypoint: Simple[Seq[String]]

Custom entrypoint for the container.

Custom entrypoint for the container.

Attributes

Source
DockerModule.scala
def getJavaBuilder: Task[JavaContainerBuilder]

Creates the JavaContainerBuilder with Jib's standard Java layering. Override for advanced customization of the layer structure.

Creates the JavaContainerBuilder with Jib's standard Java layering. Override for advanced customization of the layer structure.

Attributes

Source
DockerModule.scala
def getJibBuilder: Task[JibContainerBuilder]

Creates the JibContainerBuilder from the JavaContainerBuilder and applies container parameters (ports, env, labels, etc.). Override for advanced customization of the container configuration.

Creates the JibContainerBuilder from the JavaContainerBuilder and applies container parameters (ports, env, labels, etc.). Override for advanced customization of the container configuration.

Attributes

Source
DockerModule.scala

The image format for Jib: Docker (default) or OCI.

The image format for Jib: Docker (default) or OCI.

Attributes

Source
DockerModule.scala
def jibProgramArgs: Simple[Seq[String]]

Program arguments passed to the main class.

Program arguments passed to the main class.

Attributes

Source
DockerModule.scala

The source image for Jib. Defaults to a RegistryImage using baseImage.

The source image for Jib. Defaults to a RegistryImage using baseImage.

Attributes

Source
DockerModule.scala

The target image for Jib. Defaults to a DockerDaemonImage using the first tag.

The target image for Jib. Defaults to a DockerDaemonImage using the first tag.

Attributes

Source
DockerModule.scala
def push(): Command[Unit]

Attributes

Source
DockerModule.scala

Inherited methods

def baseImage: Simple[String]

Attributes

Inherited from:
BaseDockerConfig
Source
DockerModule.scala
def envVars: Simple[Map[String, String]]

Environment variables to be set in the container.

Environment variables to be set in the container.

See also the Docker docs on ENV for more information.

Attributes

Inherited from:
BaseDockerConfig
Source
DockerModule.scala
def exposedPorts: Simple[Seq[Int]]

TCP Ports the container will listen to at runtime.

TCP Ports the container will listen to at runtime.

See also the Docker docs on ports for more information.

Attributes

Inherited from:
BaseDockerConfig
Source
DockerModule.scala
def exposedUdpPorts: Simple[Seq[Int]]

UDP Ports the container will listen to at runtime.

UDP Ports the container will listen to at runtime.

See also the Docker docs on ports for more information.

Attributes

Inherited from:
BaseDockerConfig
Source
DockerModule.scala
def jvmOptions: Simple[Seq[String]]

JVM runtime options. Each item of the Seq should consist of an option and its desired value, like

JVM runtime options. Each item of the Seq should consist of an option and its desired value, like

def jvmOptions = Seq("-Xmx1024M", "-agentlib:jdwp=transport=dt_socket,server=y,address=8000", …)

For a full list of options consult the official documentation at https://docs.oracle.com/en/java/javase/21/docs/specs/man/java.html#overview-of-java-options

Attributes

Inherited from:
BaseDockerConfig
Source
DockerModule.scala
def labels: Simple[Map[String, String]]

Attributes

Inherited from:
BaseDockerConfig
Source
DockerModule.scala

Attributes

Inherited from:
BaseClass
Source
Module.scala
def moduleDir: Path

Attributes

Inherited from:
Module
Source
Module.scala

Attributes

Inherited from:
Module
Source
Module.scala

Attributes

Inherited from:
Module
Source
Module.scala
def platform: Simple[String]

Optional platform parameter.

Optional platform parameter.

In classic Dockerfile mode, uses buildkit to build for specified platform. In Jib mode, parsed as "os/architecture" into a JibPlatform.

See also the Docker docs on https://docs.docker.com/reference/cli/docker/buildx/build/#platform for more information.

Attributes

Inherited from:
BaseDockerConfig
Source
DockerModule.scala
def pullBaseImage: Simple[Boolean]

Attributes

Inherited from:
BaseDockerConfig
Source
DockerModule.scala
def tags: Simple[Seq[String]]

Tags that should be applied to the built image In the standard registry/repository:tag format

Tags that should be applied to the built image In the standard registry/repository:tag format

Attributes

Inherited from:
BaseDockerConfig
Source
DockerModule.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Module -> Any
Inherited from:
Module
Source
Module.scala
def user: Simple[String]

Any applicable string to the USER instruction.

Any applicable string to the USER instruction.

An empty string will be ignored and will result in USER not being specified. See also the Docker docs on USER for more information.

Attributes

Inherited from:
BaseDockerConfig
Source
DockerModule.scala