Packages

class DockerConfigTemplate extends JsonTemplate

Template for a Docker config file.

Example:


{
  "auths": {
    "registry": {
      "auth": "username:password in base64"
    ,
    "anotherregistry": {},
    ...
  },
  "credsStore": "credential helper name",
  "credHelpers": {
    "registry": "credential helper name",
    "anotherregistry": "another credential helper name",
    ...
  }
}
}

If an auth is defined for a registry, that is a valid Basic authorization to use for that registry.

If credsStore is defined, is a credential helper that stores authorizations for all registries listed under auths.

Each entry in credHelpers is a mapping from a registry to a credential helper that stores the authorization for that registry.

See also

<a href="https://www.projectatomic.io/blog/2016/03/docker-credentials-store/">https://www.projectatomic.io/blog/2016/03/docker-credentials-store/

Linear Supertypes
JsonTemplate, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DockerConfigTemplate
  2. JsonTemplate
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DockerConfigTemplate()

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def getAuthFor(registry: String): String

    Returns the base64-encoded Basic authorization for registry, or null if none exists.

    Returns the base64-encoded Basic authorization for registry, or null if none exists. The order of lookup preference:

    • Exact registry name
    • https:// + registry name
    • registry name + / + arbitrary suffix
    • https:// + registry name + / arbitrary suffix
    registry

    the registry to get the authorization for

    returns

    the base64-encoded Basic authorization for registry, or null if none exists

  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def getCredentialHelperFor(registry: String): String

    Returns credsStore or credHelpers for the given registry.

    Returns credsStore or credHelpers for the given registry. If there exists a matching registry entry in auths, returns credStore; otherwise, a matching entry in credHelpers is returned based on the following lookup order:

    • Exact registry name
    • https:// + registry name
    • registry name + / + arbitrary suffix
    • https:// + registry name + / + arbitrary suffix
    registry

    the registry to get the credential helpers for

    returns

    credsStore if registry is present in auths; otherwise, searches credHelpers; otherwise, null if not found

  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from JsonTemplate

Inherited from AnyRef

Inherited from Any

Ungrouped