Type Members

1.  case class Add(sources: Seq[SourceFile], destination: String, chown: Option[String] = None) extends FileStagingDockerfileInstruction with Product with Serializable

   Adds files to the image.

   Adds files to the image. If a source file is a tar file it will be extracted as a directory.

   sources

   Source files.

   destination

   Destination path inside the container.

   chown

   Set the owner user and group of the files in the container. Added in 17.09.0-ce.

2.  case class AddRaw(sources: Seq[String], destination: String, chown: Option[String] = None) extends ProductDockerfileInstruction with Product with Serializable

   Adds files from the staging directory to the image.

   Adds files from the staging directory to the image. If a source file is a tar file it will be extracted as a directory.

   sources

   Source path inside the staging directory.

   destination

   Destination path inside the container.

   chown

   Set the owner user and group of the files in the container. Added in 17.09.0-ce.

3.  case class Arg(key: String, defaultValue: Option[String] = None) extends DockerfileInstruction with Product with Serializable

   Define a build argument.

   Define a build argument. The ARG instruction in a Dockerfile.

4.  case class Cmd(command: String) extends ProductDockerfileInstruction with Product with Serializable

   When an entry point is specified CMD acts as default arguments that is appended the the entry point command.

   When an entry point is specified CMD acts as default arguments that is appended the the entry point command. If an entry point is not specified CMD will be the default command for the image.

   command

   Command.

5.  case class Copy(sources: Seq[SourceFile], destination: String, chown: Option[String] = None) extends FileStagingDockerfileInstruction with Product with Serializable

   Adds files to the image.

   Adds files to the image.

   sources

   Source files. Cannot be empty.

   destination

   Destination path inside the container.

   chown

   Set the owner user and group of the files in the container. Added in 17.09.0-ce.

6.  case class CopyRaw(sources: Seq[String], destination: String, chown: Option[String] = None) extends ProductDockerfileInstruction with Product with Serializable

   Adds files from the staging directory to the image.

   Adds files from the staging directory to the image.

   sources

   Source path inside the staging directory. Cannot be empty.

   destination

   Destination path inside the container.

   chown

   Set the owner user and group of the files in the container. Added in 17.09.0-ce.

7.  case class EntryPoint(command: String) extends ProductDockerfileInstruction with Product with Serializable

   Command to execute when the image starts.

   Command to execute when the image starts.

   command

   Command.

8.  case class Env(variables: String) extends ProductDockerfileInstruction with Product with Serializable

   Sets environment variables in the image.

   Sets environment variables in the image. Example: "A=1 B=2 C=3"

   variables

   Environment variables.

9.  case class Expose(ports: Seq[Int]) extends ProductDockerfileInstruction with Product with Serializable

   Exposes network ports at runtime.

   Exposes network ports at runtime.

   ports

   Port numbers to expose.

10.  case class From(image: String) extends ProductDockerfileInstruction with Product with Serializable

    Sets the base image for the image.

    Sets the base image for the image.

    image

    Name of the image.

11.  case class HealthCheck(command: String, interval: Option[FiniteDuration] = None, timeout: Option[FiniteDuration] = None, startPeriod: Option[FiniteDuration] = None, retries: Option[Int] = None) extends DockerfileInstruction with Product with Serializable

    Defines health check command to run inside the container to check that it is still working.

    Defines health check command to run inside the container to check that it is still working.

    command

    Command to execute for health check

    interval

    The health check will first run interval seconds after the container is started, and then again interval seconds after each previous check completes.

    timeout

    If a single run of the check takes longer than specified then the check is considered to have failed.

    startPeriod

    Provides initialization time for containers that need time to bootstrap.

    retries

    How many consecutive failures of the health check for the container to be considered unhealthy.

12.  case class Label(labels: String) extends ProductDockerfileInstruction with Product with Serializable

    Sets label(s) for the image.

    Sets label(s) for the image. Docker Version >= 1.6 required. Example: "A=1 B=2 C=3"

    labels

    image labels

13.  case class Maintainer(name: String) extends ProductDockerfileInstruction with Product with Serializable

    Author of the image.

    Author of the image.

    name

    Author name.

14.  case class OnBuild(instruction: DockerfileInstruction) extends ProductDockerfileInstruction with Product with Serializable

    Adds a trigger of a instruction that will be run when the image is used as a base image (FROM).

    Adds a trigger of a instruction that will be run when the image is used as a base image (FROM).

    instruction

    Instruction to run.

15.  case class Raw(instructionName: String, arguments: String) extends DockerfileInstruction with Product with Serializable

    This class allows the user to specify a raw Dockerfile instruction.

    This class allows the user to specify a raw Dockerfile instruction. Example:

    Raw("RUN", "echo '123'")
    // Will yield the following string in the Dockerfile:
    "RUN echo '123'"

    instructionName

    Name of the instruction.

    arguments

    Argument string.

16.  case class Run(command: String) extends ProductDockerfileInstruction with Product with Serializable

    Executes a command when building the image.

    Executes a command when building the image.

    command

    Command which should be executed.

17.  case class StageFiles(sources: Seq[SourceFile], destination: String) extends FileStagingInstruction with Product with Serializable

    Stages files.

    Stages files. Only adds files and directories to the staging directory, will not yield an instruction in the Dockerfile. To use the staged files use the sbtdocker.Instructions.AddRaw and sbtdocker.Instructions.CopyRaw instructions.

    sources

    Source files.

    destination

    Destination path.

18.  case class User(username: String) extends ProductDockerfileInstruction with Product with Serializable

    Sets the user inside the container that should be used for the next instructions.

    Sets the user inside the container that should be used for the next instructions.

    username

    Name of the user.

19.  case class Volume(paths: Seq[String]) extends ProductDockerfileInstruction with Product with Serializable

    Add mount points inside the container.

    Add mount points inside the container.

    paths

    Paths inside the container. Cannot be empty.

20.  case class WorkDir(path: String) extends ProductDockerfileInstruction with Product with Serializable

    Sets the current working directory for the instructions that follow.

    Sets the current working directory for the instructions that follow.

    path

    Path inside the container.