package docker
- Alphabetic
- Public
- All
Type Members
-
case class
Cmd(cmd: String, args: String*) extends CmdLike with Product with Serializable
An arbitrary command
An arbitrary command
val add = Cmd("ADD", "src/resource/LICENSE.txt", "/opt/docker/LICENSE.txt")
, val copy = Cmd("COPY", "src/resource/LICENSE.txt", "/opt/docker/LICENSE.txt")
, val env = Cmd("ENV", "APP_SECRET", "7sdfy7s9hfisdufuusud")
Examples: -
trait
CmdLike extends AnyRef
a single line in a dockerfile.
a single line in a dockerfile. See subclasses for more detail
-
case class
CombinedCmd(cmd: String, arg: CmdLike) extends CmdLike with Product with Serializable
A command that consists of a CMD string and an CmdLike object
A command that consists of a CMD string and an CmdLike object
val onBuildAdd = CombinedCmd("ONBUILD", Cmd("ADD", "src/resource/LICENSE.txt", "/opt/docker/LICENSE.txt"))
, val onBuildEnv = CombinedCmd("ONBUILD", Cmd("ENV", "APP_SECRET", "7sdfy7s9hfisdufuusud"))
Examples: -
case class
Comment(comment: String) extends CmdLike with Product with Serializable
A comment
-
case class
DockerAlias(registryHost: Option[String], username: Option[String], name: String, tag: Option[String]) extends Product with Serializable
This class represents a Docker alias.
This class represents a Docker alias. It generates a string in the form of
[REGISTRY_HOST/][USERNAME/]NAME[:TAG]
, e.g. my-registry.com:1234/my-user/my-service:1.0.0 or just my-service:1.0.0. [REGISTRY_HOST/][USERNAME/]NAME[:TAG] }}} e.g. my-registry.com:1234/my-user/my-service:1.0.0 or just my-service:1.0.0.
- registryHost
Optional hostname of the registry (including port if applicable)
- username
Optional username or other qualifier
- name
Name of the image, e.g. the artifact name
- tag
Optional tag for the image, e.g. the version
- case class DockerApiVersion(major: Int, minor: Int) extends Product with Serializable
-
sealed
trait
DockerChmodType extends AnyRef
This represents a type of file permission changes to run on the working directory.
This represents a type of file permission changes to run on the working directory. Note that group file mode bits must be effective to be OpenShift compatible.
-
sealed
trait
DockerPermissionStrategy extends AnyRef
This represents a strategy to change the file permissions.
- case class DockerVersion(major: Int, minor: Int, patch: Int, release: Option[String]) extends Product with Serializable
-
case class
Dockerfile(commands: CmdLike*) extends Product with Serializable
Represents dockerfile used by docker when constructing packages.
-
case class
ExecCmd(cmd: String, args: String*) extends CmdLike with Product with Serializable
Executable command
Executable command
ExecCmd("RUN", "chown", "-R", daemonUser, ".")
, ExecCmd("ENTRYPOINT", "bin/%s" format execScript),
, ExecCmd("CMD"), ExecCmd("VOLUME", exposedVolumes: _*)
Examples: -
case class
LayeredMapping(layerId: Option[Int], file: File, path: String) extends Product with Serializable
Mapping of file to intermediate layers.
Mapping of file to intermediate layers.
- layerId
The identifier in the layer used to increase cache hits in docker caching. LayerId is present in docker:stage directory structure and in intermediate image produced in the multi-stage docker build. None means the layering is skipped for this file.
- file
The file produced by universal/stage to be moved into
Docker / stagedirectory.- path
The path in the final image
-
trait
DockerKeys extends AnyRef
Docker settings
Docker settings
- Annotations
- @deprecated
- Deprecated
(Since version 1.3.15) Internal use only. Please don't extend this trait
Value Members
- object DockerApiVersion extends Serializable
- object DockerChmodType
- object DockerPermissionStrategy
-
object
DockerPlugin extends AutoPlugin
This plugin helps you build docker containers.
Docker Plugin
This plugin helps you build docker containers.
Configuration
In order to configure this plugin take a look at the available com.typesafe.sbt.packager.docker.DockerKeys
Requirements
You need docker to have docker installed on your system and be able to execute commands. Check with a single command:
docker version
Future versions of the Docker Plugin may use the REST API, so you don't need docker installed locally.
Enable the plugin in the
build.sbtenablePlugins(DockerPlugin)
- Note
this plugin is not intended to build very customizable docker images, but turn your mappings configuration in a docker image with almost no any configuration.
Example: -
object
DockerSpotifyClientPlugin extends AutoPlugin
This plugin helps you build docker containers using Spotify Docker Client.
DockerSpotifyClientPlugin Plugin
This plugin helps you build docker containers using Spotify Docker Client.
Configuration
In order to configure this plugin take a look at the available com.typesafe.sbt.packager.docker.DockerKeys
Requirements
You need docker to have docker installed on your system. Check with a single command:
docker version
Enable the plugin in the
build.sbtenablePlugins(DockerSpotifyClientPlugin)
and add the dependency in your
plugins.sbtlibraryDependencies += "com.spotify" % "docker-client" % "3.5.13"
The Docker-spotify client is a provided dependency so you have to add it on your own. It brings a lot of dependenciesthat could slow your build times. This is the reason the dependency is marked as provided.
- Note
this plugin is not intended to build very customizable docker images, but turn your mappings configuration in a docker image with almost no any configuration.
Example: -
object
DockerStageBreak extends CmdLike with Product with Serializable
A break in Dockerfile to express multi-stage build.
A break in Dockerfile to express multi-stage build. https://docs.docker.com/develop/develop-images/multistage-build/
- object DockerSupport
- object DockerVersion extends Serializable