sbtdocker
package sbtdocker
- Alphabetic
- By Inheritance
- sbtdocker
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
final
case class
BuildOptions(cache: Boolean = true, removeIntermediateContainers: Option = BuildOptions.Remove.OnSuccess, pullBaseImage: Option = BuildOptions.Pull.IfMissing, additionalArguments: Seq[String] = Seq.empty) extends Product with Serializable
Options for when building a Docker image.
Options for when building a Docker image.
- cache
Use cache when building the image.
- removeIntermediateContainers
Remove intermediate containers after a build.
- pullBaseImage
Always attempts to pull a newer version of the base image.
- additionalArguments
Provide any other arguments to the
docker buildtask, see reference at https://docs.docker.com/engine/reference/commandline/build/#options. For exampleSeq("--add-host", "127.0.0.1:12345", "--compress").
- class DockerBuildException extends RuntimeException
- class DockerPushException extends RuntimeException
- type Dockerfile = sbtdocker.mutable.Dockerfile
- sealed trait DockerfileBase extends AnyRef
- trait DockerfileCommands extends AnyRef
-
trait
DockerfileInstruction extends Instruction
A real dockerfile instruction.
A real dockerfile instruction. Contains a instruction name and arguments.
- trait DockerfileLike extends DockerfileCommands with DockerfileBase
-
trait
FileStagingDockerfileInstruction extends FileStagingInstruction
Instruction that both stages files to the staging directory and adds a Dockerfile instruction.
Instruction that both stages files to the staging directory and adds a Dockerfile instruction.
A sbtdocker.staging.DockerfileProcessor is used to stage files in the staging directory, which also requests the Dockerfile instruction when the file paths have been finalized.
-
trait
FileStagingInstruction extends Instruction
Instruction that stages files to the staging directory.
-
final
case class
ImageDigest(algorithm: String, digest: String) extends Product with Serializable
The image digest, the format of the digest is
algorithm:hex-stringThe image digest, the format of the digest is
algorithm:hex-string- algorithm
The algorithm used to produce the digest.
- digest
A digest of the image, as a string.
-
final
case class
ImageId(id: String) extends AnyVal with Product with Serializable
Id of an Docker image.
Id of an Docker image.
- id
Id as a hexadecimal digit string.
-
final
case class
ImageName(registry: Option[String] = None, namespace: Option[String] = None, repository: String, tag: Option[String] = None) extends Product with Serializable
Name of a Docker image.
Name of a Docker image. Format: [registry/][namespace/]repository[:tag] Examples:
docker-registry.example.com/scala:2.11orexample/scala:2.11- registry
Host and optionally port of the registry, example
docker-registry.example.com:5000.- namespace
Namespace name.
- repository
Name of the repository.
- tag
Tag, for example a version number.
- type ImmutableDockerfile = sbtdocker.immutable.Dockerfile
- sealed trait Instruction extends AnyRef
-
case class
NativeDockerfile(path: File) extends DockerfileBase with Product with Serializable
Reference to an existing Dockerfile in the filesystem.
Reference to an existing Dockerfile in the filesystem.
- path
Filesystem path to the Dockerfile.
-
trait
ProductDockerfileInstruction extends DockerfileInstruction
Helper for product classes.
Helper for product classes. Sets instruction name from the class name and uses product values as arguments.
-
type
StageFile = StageFiles
- Annotations
- @deprecated
- Deprecated
(Since version 1.0.0) Use sbtdocker.Instructions.StageFiles
Value Members
- val Dockerfile: sbtdocker.mutable.Dockerfile.type
- val ImmutableDockerfile: sbtdocker.immutable.Dockerfile.type
- object BuildOptions extends Serializable
- object DockerBuild
- object DockerKeys
- object DockerPlugin extends AutoPlugin
- object DockerPush
- object DockerSettings
- object DockerTag
- object ImageName extends Serializable
- object Instructions
Deprecated Value Members
-
val
StageFile: StageFiles.type
- Annotations
- @deprecated
- Deprecated
(Since version 1.0.0) Use sbtdocker.Instructions.StageFiles