final case class ClientConfig(globalReuse: DockerReusePolicy = ClientConfig.defaultReusePolicy, useRemote: Boolean = false, useGlobalRegistry: Boolean = false, remote: Option[RemoteDockerConfig] = None, globalRegistry: Option[String] = None, registryConfigs: List[DockerRegistryConfig] = List.empty) extends Product with Serializable
Client configuration that will be read from HOCON config.
See docker-reference.conf
for an example configuration.
You can include
the reference configuration if you want to use defaults.
- globalReuse
If true and container's ContainerConfig#reuse is also true, keeps container alive after initialization. If false, the container will be shut down.
- useRemote
Connect to Remote Docker Daemon
- useGlobalRegistry
Use specified global Docker Registry.
- remote
Options to connect to a Remote or Custom Docker Daemon (e.g. custom unix socket or pipe), will try to connect to using these options only if useRemote is
true
- globalRegistry
Registry for global usage if not overriden in ContainerConfig and if useGlobalRegistry is
true
.- registryConfigs
Registry credentials to connect to custom Docker Registry host.
- Alphabetic
- By Inheritance
- ClientConfig
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ClientConfig(globalReuse: DockerReusePolicy = ClientConfig.defaultReusePolicy, useRemote: Boolean = false, useGlobalRegistry: Boolean = false, remote: Option[RemoteDockerConfig] = None, globalRegistry: Option[String] = None, registryConfigs: List[DockerRegistryConfig] = List.empty)
- globalReuse
If true and container's ContainerConfig#reuse is also true, keeps container alive after initialization. If false, the container will be shut down.
- useRemote
Connect to Remote Docker Daemon
- useGlobalRegistry
Use specified global Docker Registry.
- remote
Options to connect to a Remote or Custom Docker Daemon (e.g. custom unix socket or pipe), will try to connect to using these options only if useRemote is
true
- globalRegistry
Registry for global usage if not overriden in ContainerConfig and if useGlobalRegistry is
true
.- registryConfigs
Registry credentials to connect to custom Docker Registry host.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val globalRegistry: Option[String]
- val globalReuse: DockerReusePolicy
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val registryConfigMap: Map[String, DockerRegistryConfig]
- val registryConfigs: List[DockerRegistryConfig]
- val remote: Option[RemoteDockerConfig]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val useGlobalRegistry: Boolean
- val useRemote: Boolean
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()