c

izumi.distage.docker.Docker

ContainerConfig

final case class ContainerConfig[T](image: String, ports: Seq[DockerPort], name: Option[String] = None, env: Map[String, String] = Map.empty, cmd: Seq[String] = Seq.empty, entrypoint: Seq[String] = Seq.empty, cwd: Option[String] = None, user: Option[String] = None, mounts: Seq[Mount] = Seq.empty, networks: Set[ContainerNetwork[_]] = Set.empty, reuse: DockerReusePolicy = DockerReusePolicy.ReuseEnabled, autoRemove: Boolean = true, healthCheckInterval: FiniteDuration = FiniteDuration(1, TimeUnit.SECONDS), healthCheckMaxAttempts: Int = 120, pullTimeout: FiniteDuration = FiniteDuration(120, TimeUnit.SECONDS), healthCheck: ContainerHealthCheck[T] = ContainerHealthCheck.portCheck[T], portProbeTimeout: FiniteDuration = FiniteDuration(200, TimeUnit.MILLISECONDS), alwaysPull: Boolean = true) extends Product with Serializable

Parameters that define the behavior of this docker container, Will be interpreted by izumi.distage.docker.ContainerResource

image

Docker Image to use

ports

Ports to map on the docker container

name

Name of the container, if left at None Docker will generate a random name

env

Setup environment variables visible inside docker container

cmd

Entrypoint command to use

entrypoint

Docker entrypoint to use

cwd

Working directory to use inside the docker container

mounts

Host paths mounted to Volumes inside the docker container

networks

Docker networks to connect this container to

reuse

If true and ClientConfig#globalReuse is also true, keeps container alive after tests. If false, the container will be shut down. default: true

healthCheckInterval

Sleep interval between healthChecks default: 1 second

pullTimeout

Maximum amount of time to wait for docker pull to download the image default: 120 seconds

healthCheck

The function to use to test if a container has started already, by default probes to check if all ports are open and proceeds if so.

portProbeTimeout

Sleep interval between port probes in the default healthCheck default: 200 milliseconds

alwaysPull

Pull the image before starting the container default: true

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ContainerConfig
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ContainerConfig(image: String, ports: Seq[DockerPort], name: Option[String] = None, env: Map[String, String] = Map.empty, cmd: Seq[String] = Seq.empty, entrypoint: Seq[String] = Seq.empty, cwd: Option[String] = None, user: Option[String] = None, mounts: Seq[Mount] = Seq.empty, networks: Set[ContainerNetwork[_]] = Set.empty, reuse: DockerReusePolicy = DockerReusePolicy.ReuseEnabled, autoRemove: Boolean = true, healthCheckInterval: FiniteDuration = FiniteDuration(1, TimeUnit.SECONDS), healthCheckMaxAttempts: Int = 120, pullTimeout: FiniteDuration = FiniteDuration(120, TimeUnit.SECONDS), healthCheck: ContainerHealthCheck[T] = ContainerHealthCheck.portCheck[T], portProbeTimeout: FiniteDuration = FiniteDuration(200, TimeUnit.MILLISECONDS), alwaysPull: Boolean = true)

    image

    Docker Image to use

    ports

    Ports to map on the docker container

    name

    Name of the container, if left at None Docker will generate a random name

    env

    Setup environment variables visible inside docker container

    cmd

    Entrypoint command to use

    entrypoint

    Docker entrypoint to use

    cwd

    Working directory to use inside the docker container

    mounts

    Host paths mounted to Volumes inside the docker container

    networks

    Docker networks to connect this container to

    reuse

    If true and ClientConfig#globalReuse is also true, keeps container alive after tests. If false, the container will be shut down. default: true

    healthCheckInterval

    Sleep interval between healthChecks default: 1 second

    pullTimeout

    Maximum amount of time to wait for docker pull to download the image default: 120 seconds

    healthCheck

    The function to use to test if a container has started already, by default probes to check if all ports are open and proceeds if so.

    portProbeTimeout

    Sleep interval between port probes in the default healthCheck default: 200 milliseconds

    alwaysPull

    Pull the image before starting the container default: true

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. val alwaysPull: Boolean
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val autoRemove: Boolean
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. val cmd: Seq[String]
  9. val cwd: Option[String]
  10. val entrypoint: Seq[String]
  11. val env: Map[String, String]
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. val healthCheck: ContainerHealthCheck[T]
  16. val healthCheckInterval: FiniteDuration
  17. val healthCheckMaxAttempts: Int
  18. val image: String
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val mounts: Seq[Mount]
  21. val name: Option[String]
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. val networks: Set[ContainerNetwork[_]]
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. val portProbeTimeout: FiniteDuration
  27. val ports: Seq[DockerPort]
  28. def productElementNames: Iterator[String]
    Definition Classes
    Product
  29. val pullTimeout: FiniteDuration
  30. val reuse: DockerReusePolicy
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. def tcpPorts: Set[DockerPort]
  33. def udpPorts: Set[DockerPort]
  34. val user: Option[String]
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped