o

container

DockerMetadata

object DockerMetadata

Copyright (C) 2017 Jonathan Passerat-Palmbach

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

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

Type Members

  1. type Command = String
  2. case class ContainerConfig(User: Option[String] = Some(""), Memory: Option[Int] = Some(0), MemorySwap: Option[Int] = Some(0), CpuShares: Option[Int] = Some(0), ExposedPorts: Option[Map[String, EmptyObject]] = None, Env: Option[List[String]] = Some(List.empty), Entrypoint: Option[List[String]] = Some(List.empty), Cmd: Option[List[String]] = Some(List.empty), Healthcheck: Option[HealthCheck] = None, Volumes: Option[Volumes] = Some(Map.empty), WorkingDir: Option[String] = Some(""), Domainname: Option[String] = Some(""), AttachStdout: Option[Boolean] = None, Hostname: Option[String] = Some(""), StdinOnce: Option[Boolean] = None, Labels: Option[Map[String, EmptyObject]] = None, AttachStderr: Option[Boolean] = None, OnBuild: Option[List[String]] = None, Tty: Option[Boolean] = None, OpenStdin: Option[Boolean] = None, Image: Option[String] = None, AttachStdin: Option[Boolean] = None, ArgsEscaped: Option[Boolean] = None) extends Product with Serializable

    Container RunConfig Field Descriptions "The execution parameters which should be used as a base when running a container using the image."

  3. type ContainerID = String
  4. case class Digest(blobSum: String) extends Product with Serializable
  5. type DockerDate = LocalDateTime
  6. case class EmptyObject() extends Product with Serializable
  7. case class HealthCheck(Test: Option[List[String]], Interval: Option[Int], Timeout: Option[Int], Retries: Option[Int]) extends Product with Serializable

    All HealthCheck's fields are optional as a field can be omitted to indicate that the value should be inherited from the base layer

  8. case class HistoryEntry(created: String, created_by: String, empty_layer: Option[Boolean], author: Option[String], comment: Option[String]) extends Product with Serializable

    Most examples seem to have at least created and created_by fields populated

  9. case class ImageJSON(created: Option[DockerDate] = None, author: Option[String] = Some(""), architecture: Option[String] = Some(""), os: Option[String] = Some(""), config: Option[ContainerConfig] = Some(ContainerConfig()), rootfs: Option[RootFS] = Some(RootFS()), history: Option[List[HistoryEntry]] = Some(List.empty), id: Option[String], parent: Option[String], docker_version: Option[String] = None, container: Option[ContainerID] = None, container_config: Option[ContainerConfig] = None) extends Product with Serializable

    Image JSON (term from Terminology https://github.com/moby/moby/blob/master/image/spec/v1.2.md#terminology)

    Image JSON (term from Terminology https://github.com/moby/moby/blob/master/image/spec/v1.2.md#terminology)

    Representation of the metadata stored in the json file under the key Config in manifest.json

    See also

    https://github.com/moby/moby/blob/master/image/spec/v1.2.md

  10. case class ImageManifestV2Schema1(name: Option[String], tag: Option[String], architecture: Option[String], fsLayers: Option[List[Digest]], history: Option[List[V1History]], schemaVersion: Option[Int], signatures: Option[List[Signature]] = None) extends Product with Serializable

    Registry image Manifest of an image in a repo according to Docker image spec v1

    Registry image Manifest of an image in a repo according to Docker image spec v1

    See also

    https://docs.docker.com/registry/spec/manifest-v2-1/

  11. case class JOSE(jwk: Option[JWK], alg: Option[String]) extends Product with Serializable

    JSON Web Signature

    JSON Web Signature

    See also

    http://self-issued.info/docs/draft-ietf-jose-json-web-signature.html#rfc.section.4

  12. case class JWK(crv: Option[String], kid: Option[String], kty: Option[String], x: Option[String], y: Option[String]) extends Product with Serializable

    JSON Web Key

    JSON Web Key

    See also

    http://self-issued.info/docs/draft-ietf-jose-json-web-signature.html#jwkDef

  13. case class RootFS(type: String = "layers", diff_ids: List[String] = List.empty) extends Product with Serializable
  14. case class Signature(header: Option[JOSE], signature: Option[String], protected: Option[String]) extends Product with Serializable

    Support for signed manifests

    Support for signed manifests

    https://docs.docker.com/registry/spec/manifest-v2-1/#signed-manifests

  15. case class TopLevelImageManifest(Config: String, Layers: Vector[String], RepoTags: Vector[String], Parent: Option[String] = None) extends Product with Serializable

    image JSON for the top-level image according to Docker Image spec v1.2

    image JSON for the top-level image according to Docker Image spec v1.2

    NOT TO BE confused with the distribution manifest, used to push and pull images

    Usually presented in a Vector[TopLevelImageManifest] with one entry per image (current one + parent images it was derived from).

    See also

    https:://github.com/moby/moby/blob/master/image/spec/v1.2.md#combined-image-json--filesystem-changeset-format

  16. case class V1History(v1Compatibility: String) extends Product with Serializable
  17. type Volumes = Map[String, EmptyObject]

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. implicit val ContainerConfigDecoder: Decoder[ContainerConfig]
  5. implicit val ContainerConfigEncoder: Encoder[ContainerConfig]
  6. implicit val EmptyObjectDecoder: Decoder[EmptyObject]
  7. implicit val EmptyObjectEncoder: Encoder[EmptyObject]
  8. implicit val HealthCheckDecoder: Decoder[HealthCheck]
  9. implicit val HealthCheckEncoder: Encoder[HealthCheck]
  10. implicit val HistoryEntryDecoder: Decoder[HistoryEntry]
  11. implicit val RootFSDecoder: Decoder[RootFS]
  12. implicit val RootFSEncoder: Encoder[RootFS]
  13. implicit val VolumesDecoder: Decoder[Volumes]
  14. implicit val VolumesEncoder: Encoder[Volumes]
  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  17. def containerConfig(manifest: ImageManifestV2Schema1): Option[ContainerConfig]
  18. implicit val decodeDate: Decoder[DockerDate]
  19. val dockerDateFormatter: DateTimeFormatter
  20. implicit val encodeDate: Encoder[DockerDate]
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. implicit val historyEntryEncoder: Encoder[HistoryEntry]
  26. implicit val imageJSONDecoder: Decoder[ImageJSON]
  27. implicit val imageJSONEncoder: Encoder[ImageJSON]
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. def v1HistoryToImageJson(manifest: ImageManifestV2Schema1, layersHash: Map[String, Option[String]]): ImageJSON
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped