t

sbtdocker

DockerfileCommands

trait DockerfileCommands extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
DockerfileLike, Dockerfile, Dockerfile
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DockerfileCommands
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type T <: DockerfileCommands

Abstract Value Members

  1. abstract def addInstruction(instruction: Instruction): T
  2. abstract def addInstructions(instructions: TraversableOnce[Instruction]): T
  3. abstract def self: T
    Attributes
    protected

Concrete 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
  5. def add(sources: Seq[File], destination: String, chown: String): T
  6. def add(source: File, destination: String, chown: String): T
  7. def add(source: File, destination: File): T
  8. def add(sources: Seq[File], destination: String): T
  9. def add(source: File, destination: String): T
  10. def addRaw(source: String, destination: String): T
  11. def arg(key: String, defaultValue: Option[String] = None): T
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  14. def cmd(args: String*): T
  15. def cmdRaw(command: String): T
  16. def cmdShell(args: String*): T
  17. def copy(source: File, destination: File, chown: String): T
  18. def copy(sources: Seq[File], destination: String, chown: String): T
  19. def copy(source: File, destination: String, chown: String): T
  20. def copy(source: File, destination: File): T
  21. def copy(sources: Seq[File], destination: String): T
  22. def copy(source: File, destination: String): T
  23. def copyRaw(source: String, destination: File): T
  24. def copyRaw(source: String, destination: String): T
  25. 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.

    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")
  26. def entryPoint(args: String*): T
  27. def entryPointRaw(command: String): T
  28. def entryPointShell(args: String*): T
  29. def env(variables: Map[String, String]): T
  30. def env(variables: (String, String)*): T
  31. def env(key: String, value: String): T
  32. def envRaw(variables: String): T
  33. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  35. def expose(ports: Int*): T
  36. def from(image: ImageName): T
  37. def from(image: String): T
  38. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. def healthCheck(commands: String*): T
  41. def healthCheck(commands: Seq[String], interval: Option[FiniteDuration] = None, timeout: Option[FiniteDuration] = None, startPeriod: Option[FiniteDuration] = None, retries: Option[Int] = None): T
  42. def healthCheckNone(): T
  43. def healthCheckShell(commands: String*): T
  44. def healthCheckShell(commands: Seq[String], interval: Option[FiniteDuration] = None, timeout: Option[FiniteDuration] = None, startPeriod: Option[FiniteDuration] = None, retries: Option[Int] = None): T
  45. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  46. def label(lables: Map[String, String]): T
  47. def label(lables: (String, String)*): T
  48. def label(labelName: String, labelValue: String): T
  49. def labelRaw(labels: String): T
  50. def maintainer(name: String, email: String): T
  51. def maintainer(name: String): T
  52. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  53. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  54. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  55. def onBuild(instruction: DockerfileInstruction): T
  56. 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.

  57. 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).

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

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

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

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

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

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

Deprecated Value Members

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

    (Since version 1.0.0) Use addRaw instead.

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

    (Since version 1.0.0) Use addRaw instead.

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

    (Since version 1.0.0) Use addRaw instead.

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

    (Since version 1.0.0) Use addRaw instead.

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

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

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

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

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

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

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

    (Since version 1.0.0) Use copyRaw instead.

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

    (Since version 1.0.0) Use copyRaw instead.

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

    (Since version 1.0.0) Use copyRaw instead.

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

    (Since version 1.0.0) Use copyRaw instead.

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

    (Since version 1.0.1) Invalid instruction, use addRaw instead

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

    (Since version 1.0.1) Invalid instruction, use addRaw instead

  14. def copyToStageDir(source: File, targetRelativeToStageDir: File): T
    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 AnyRef

Inherited from Any

Ungrouped