DockerConfig

mill.contrib.docker.DockerModule.DockerConfig
trait DockerConfig extends Module

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

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

def baseImage: Simple[String]

Attributes

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

Attributes

Source
DockerModule.scala
def dockerEnv: Simple[Map[String, String]]

Environment to pass to the docker commands. Example: DOCKER_DEFAULT_PLATFORM=linux/amd64

Environment to pass to the docker commands. Example: DOCKER_DEFAULT_PLATFORM=linux/amd64

See also the Docker docs on Environment variables for more information.

Attributes

Source
DockerModule.scala
def dockerfile: Simple[String]

Attributes

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

Source
DockerModule.scala
def executable: Simple[String]

The name of the executable to use, the default is "docker".

The name of the executable to use, the default is "docker".

Attributes

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

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

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

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

Attributes

Source
DockerModule.scala
def platform: Simple[String]

Optional platform parameter, if set uses buildkit to build for specified platform.

Optional platform parameter, if set uses buildkit to build for specified platform.

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

Attributes

Source
DockerModule.scala
def pullBaseImage: Simple[Boolean]

Attributes

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

Attributes

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

Commands to add as RUN instructions.

Commands to add as RUN instructions.

See also the Docker docs on RUN for more information.

Attributes

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

Source
DockerModule.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

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

The names of mount points.

The names of mount points.

See also the Docker docs on volumes for more information.

Attributes

Source
DockerModule.scala

Inherited methods

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