Packages

case class Dockerfile(instructions: Seq[Instruction] = Seq.empty) extends DockerfileLike with Product with Serializable

Immutable Dockerfile.

instructions

Ordered sequence of instructions.

Example: 

  1. val jarFile: File

Dockerfile.empty
  .from("openjdk:8-jre")
  .add(jarFile, "/srv/app.jar")
  .workDir("/srv")
  .cmd("java", "-jar", "app.jar")
Linear Supertypes
Serializable, Serializable, Product, Equals, DockerfileLike, DockerfileBase, DockerfileCommands, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Dockerfile
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DockerfileLike
  7. DockerfileBase
  8. DockerfileCommands
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Dockerfile(instructions: Seq[Instruction] = Seq.empty)

    instructions

    Ordered sequence of instructions.

Type Members

  1. type T = Dockerfile
    Definition Classes
    Dockerfile → DockerfileLike → DockerfileCommands

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def add(source: File, destination: File, chown: String): T
    Definition Classes
    DockerfileCommands
  5. def add(sources: Seq[File], destination: String, chown: String): T
    Definition Classes
    DockerfileCommands
  6. def add(source: File, destination: String, chown: String): T
    Definition Classes
    DockerfileCommands
  7. def add(source: File, destination: File): T
    Definition Classes
    DockerfileCommands
  8. def add(sources: Seq[File], destination: String): T
    Definition Classes
    DockerfileCommands
  9. def add(source: File, destination: String): T
    Definition Classes
    DockerfileCommands
  10. def addInstruction(instruction: Instruction): Dockerfile
    Definition Classes
    Dockerfile → DockerfileCommands
  11. def addInstructions(instructions: TraversableOnce[Instruction]): Dockerfile
    Definition Classes
    Dockerfile → DockerfileCommands
  12. def addRaw(source: String, destination: String): T
    Definition Classes
    DockerfileCommands
  13. def arg(key: String, defaultValue: Option[String] = None): T
    Definition Classes
    DockerfileCommands
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  16. def cmd(args: String*): T
    Definition Classes
    DockerfileCommands
  17. def cmdRaw(command: String): T
    Definition Classes
    DockerfileCommands
  18. def cmdShell(args: String*): T
    Definition Classes
    DockerfileCommands
  19. def copy(source: File, destination: File, chown: String): T
    Definition Classes
    DockerfileCommands
  20. def copy(sources: Seq[File], destination: String, chown: String): T
    Definition Classes
    DockerfileCommands
  21. def copy(source: File, destination: String, chown: String): T
    Definition Classes
    DockerfileCommands
  22. def copy(source: File, destination: File): T
    Definition Classes
    DockerfileCommands
  23. def copy(sources: Seq[File], destination: String): T
    Definition Classes
    DockerfileCommands
  24. def copy(source: File, destination: String): T
    Definition Classes
    DockerfileCommands
  25. def copyRaw(source: String, destination: File): T
    Definition Classes
    DockerfileCommands
  26. def copyRaw(source: String, destination: String): T
    Definition Classes
    DockerfileCommands
  27. def customInstruction(instructionName: String, arguments: String): T

    Adds a custom Dockerfile instruction that is not currently supported by this DSL.

    Adds a custom Dockerfile instruction that is not currently supported by this DSL.

    Definition Classes
    DockerfileCommands
    Example: 

    1. // Copy in a multi-stage Dockerfile
// Equivalent to: "COPY --from=stage1 /path/to/file /path/to/file"
customInstruction("COPY", "--from=stage1 /path/to/file /path/to/file")

// Onbuild instruction can be represented as:
// ONBUILD RUN /usr/local/bin/python-build --dir /app/src
customInstruction("ONBUILD", "RUN /usr/local/bin/python-build --dir /app/src")
  28. def entryPoint(args: String*): T
    Definition Classes
    DockerfileCommands
  29. def entryPointRaw(command: String): T
    Definition Classes
    DockerfileCommands
  30. def entryPointShell(args: String*): T
    Definition Classes
    DockerfileCommands
  31. def env(variables: Map[String, String]): T
    Definition Classes
    DockerfileCommands
  32. def env(variables: (String, String)*): T
    Definition Classes
    DockerfileCommands
  33. def env(key: String, value: String): T
    Definition Classes
    DockerfileCommands
  34. def envRaw(variables: String): T
    Definition Classes
    DockerfileCommands
  35. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. def expose(ports: Int*): T
    Definition Classes
    DockerfileCommands
  37. def from(image: ImageName): T
    Definition Classes
    DockerfileCommands
  38. def from(image: String): T
    Definition Classes
    DockerfileCommands
  39. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. def healthCheck(commands: String*): T
    Definition Classes
    DockerfileCommands
  41. def healthCheck(commands: Seq[String], interval: Option[FiniteDuration] = None, timeout: Option[FiniteDuration] = None, startPeriod: Option[FiniteDuration] = None, retries: Option[Int] = None): T
    Definition Classes
    DockerfileCommands
  42. def healthCheckNone(): T
    Definition Classes
    DockerfileCommands
  43. def healthCheckShell(commands: String*): T
    Definition Classes
    DockerfileCommands
  44. def healthCheckShell(commands: Seq[String], interval: Option[FiniteDuration] = None, timeout: Option[FiniteDuration] = None, startPeriod: Option[FiniteDuration] = None, retries: Option[Int] = None): T
    Definition Classes
    DockerfileCommands
  45. val instructions: Seq[Instruction]
    Definition Classes
    Dockerfile → DockerfileLike
  46. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  47. def label(lables: Map[String, String]): T
    Definition Classes
    DockerfileCommands
  48. def label(lables: (String, String)*): T
    Definition Classes
    DockerfileCommands
  49. def label(labelName: String, labelValue: String): T
    Definition Classes
    DockerfileCommands
  50. def labelRaw(labels: String): T
    Definition Classes
    DockerfileCommands
  51. def maintainer(name: String, email: String): T
    Definition Classes
    DockerfileCommands
  52. def maintainer(name: String): T
    Definition Classes
    DockerfileCommands
  53. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  54. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  55. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  56. def onBuild(instruction: DockerfileInstruction): T
    Definition Classes
    DockerfileCommands
  57. def run(args: String*): T

    Execute a command in the image.

    Execute a command in the image. Uses exec form. Which means the command will not be executed in a shell.

    Example:

    run("executable", "parameter1", "parameter 2")

    this will yield the raw instruction RUN ["executable", "parameter1", "parameter 2"].

    args

    An executable followed by eventual parameters.

    Definition Classes
    DockerfileCommands
  58. def runRaw(command: String): T

    Execute a command in the image.

    Execute a command in the image.

    Example:

    runRaw("executable parameter1 parameter 2")

    this will yield the raw instruction RUN executable parameter1 parameter 2.

    command

    A command including parameters (on shell or exec form).

    Definition Classes
    DockerfileCommands
  59. def runShell(args: String*): T

    Execute a command in the image.

    Execute a command in the image. The command will be executed through a shell (/bin/sh).

    Example:

    runShell("executable", "parameter1", "parameter 2")

    this will yield the raw instruction RUN executable parameter1 parameter\ 2.

    args

    A command followed by eventual parameters.

    Definition Classes
    DockerfileCommands
  60. def self: Dockerfile
    Attributes
    protected
    Definition Classes
    Dockerfile → DockerfileCommands
  61. def stageFile(source: SourceFile, target: String): T

    Stages a single source.

    Stages a single source.

    source

    What to stage.

    target

    Destination path in the staging directory.

    Definition Classes
    DockerfileCommands
  62. def stageFile(source: File, target: String): T

    Stage a file.

    Stage a file. The file will be copied to the stage directory when the Dockerfile is built.

    If the target ends with / then the source filename will be added at the end.

    The target file must be unique for this Dockerfile. Otherwise later staged files will overwrite previous files on the same target.

    source

    File to copy into stage dir.

    target

    Path to copy file to, should be relative to the stage dir.

    Definition Classes
    DockerfileCommands
  63. def stageFile(source: File, target: File): T

    Stage a file.

    Stage a file. The file will be copied to the stage directory when the Dockerfile is built.

    The target file must be unique for this Dockerfile. Otherwise later staged files will overwrite previous files on the same target.

    source

    File to copy into stage dir.

    target

    Path to copy file to, should be relative to the stage dir.

    Definition Classes
    DockerfileCommands
  64. def stageFiles(sources: Seq[File], target: String): T

    Stages a multiple files.

    Stages a multiple files.

    sources

    What to stage.

    target

    Destination directory in the staging directory.

    Definition Classes
    DockerfileCommands
  65. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  66. def user(username: String): T
    Definition Classes
    DockerfileCommands
  67. def volume(mountPoints: String*): T
    Definition Classes
    DockerfileCommands
  68. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  70. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  71. def workDir(path: String): T
    Definition Classes
    DockerfileCommands

Deprecated Value Members

  1. def add(source: String, destination: File): T
    Definition Classes
    DockerfileCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) Use addRaw instead.

  2. def add(source: String, destination: String): T
    Definition Classes
    DockerfileCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) Use addRaw instead.

  3. def add(source: sbt.URL, destination: File): T
    Definition Classes
    DockerfileCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) Use addRaw instead.

  4. def add(source: sbt.URL, destination: String): T
    Definition Classes
    DockerfileCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) Use addRaw instead.

  5. def addRaw(source: String, destination: File): T
    Definition Classes
    DockerfileCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 1.5.0) Use addRaw(String, String) instead.

  6. def addRaw(source: sbt.URL, destination: File): T
    Definition Classes
    DockerfileCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 1.5.0) Use addRaw(String, String) instead.

  7. def addRaw(source: sbt.URL, destination: String): T
    Definition Classes
    DockerfileCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 1.5.0) Use addRaw(String, String) instead.

  8. def copy(source: String, destination: File): T
    Definition Classes
    DockerfileCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) Use copyRaw instead.

  9. def copy(source: String, destination: String): T
    Definition Classes
    DockerfileCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) Use copyRaw instead.

  10. def copy(source: sbt.URL, destination: File): T
    Definition Classes
    DockerfileCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) Use copyRaw instead.

  11. def copy(source: sbt.URL, destination: String): T
    Definition Classes
    DockerfileCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0) Use copyRaw instead.

  12. def copyRaw(source: sbt.URL, destination: File): T
    Definition Classes
    DockerfileCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.1) Invalid instruction, use addRaw instead

  13. def copyRaw(source: sbt.URL, destination: String): T
    Definition Classes
    DockerfileCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.1) Invalid instruction, use addRaw instead

  14. def copyToStageDir(source: File, targetRelativeToStageDir: File): T
    Definition Classes
    DockerfileCommands
    Annotations
    @deprecated
    Deprecated

    (Since version 0.4.0) Use stageFile instead.

  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DockerfileLike

Inherited from DockerfileBase

Inherited from DockerfileCommands

Inherited from AnyRef

Inherited from Any

Ungrouped