Data.Docker.Image.Types

Documentation

data HockerImageMeta

Metadata needed for constructing a docker image.

Constructors

HockerImageMeta

Fields

• imageRepo :: RepoNamePart

  Docker image repo, the first part of a repository+name separated by a ""; e.g: librarydebian.

• imageName :: ImageNamePart

  Docker image name, the second part of a repository+name separated by a ""; e.g: librarydebian.

• imageTag :: ImageTag

  Docker image tag

• manifestJSON :: ByteString

  A docker image manifest JSON blob as usually fetched from a docker registry.

• dockerRegistry :: RegistryURI

  The URI (even if the default public registry) of the docker registry.

• altImageName :: Maybe Text

  An alternative name for the docker image in the generated nix build instructions.

Instances

Show HockerImageMeta

Methods

showsPrec :: Int -> HockerImageMeta -> ShowS

show :: HockerImageMeta -> String

showList :: [HockerImageMeta] -> ShowS

toDigest :: ByteString -> Maybe (Digest SHA256)

Parse a ByteString into a SHA256.

A digest value, as seen in the docker registry manifest, is the hexadecimal encoding of a hashing function's digest with the hashing function identifier prefixed onto the string. At this time the only prefix used is sha256:.

showSHA :: Digest SHA256 -> String

Show a hexadecimal encoded SHA256 hash digest and prefix sha256: to it.

type RefLayer = Text

A layer hash digest from a docker image's config JSON. This hash is different from those found in the image's manifest JSON.

type RepoTag = String

A String representing the full repository tag, e.g: library/debian.

data ImageManifest

A v1.2 docker image manifest.

Constructors

ImageManifest

Fields

• config :: FilePath

  FilePath within the image archive of the image's config JSON

• repoTags :: [Text]

  List of image repository tags

• layers :: [FilePath]

  List of layers within the image archive named by their hash digest and with a .tar extension

Instances

Eq ImageManifest

Methods

(==) :: ImageManifest -> ImageManifest -> Bool

(/=) :: ImageManifest -> ImageManifest -> Bool

Show ImageManifest

Methods

showsPrec :: Int -> ImageManifest -> ShowS

show :: ImageManifest -> String

showList :: [ImageManifest] -> ShowS

ToJSON ImageManifest

Methods

toJSON :: ImageManifest -> Value

toEncoding :: ImageManifest -> Encoding

toJSONList :: [ImageManifest] -> Value

toEncodingList :: [ImageManifest] -> Encoding

FromJSON ImageManifest

Methods

parseJSON :: Value -> Parser ImageManifest

parseJSONList :: Value -> Parser [ImageManifest]

data ImageRepositories

A map of ImageRepos. The repository names are the top-level keys and their value is a map who's keys are the tags of the repository with the hash-value of the layer that tag references.

Constructors

ImageRepositories [ImageRepo]

Instances

Eq ImageRepositories

Methods

(==) :: ImageRepositories -> ImageRepositories -> Bool

(/=) :: ImageRepositories -> ImageRepositories -> Bool

Show ImageRepositories

Methods

showsPrec :: Int -> ImageRepositories -> ShowS

show :: ImageRepositories -> String

showList :: [ImageRepositories] -> ShowS

ToJSON ImageRepositories

Methods

toJSON :: ImageRepositories -> Value

toEncoding :: ImageRepositories -> Encoding

toJSONList :: [ImageRepositories] -> Value

toEncodingList :: [ImageRepositories] -> Encoding

FromJSON ImageRepositories

Methods

parseJSON :: Value -> Parser ImageRepositories

parseJSONList :: Value -> Parser [ImageRepositories]

data ImageRepo

Constructors

ImageRepo

Fields

• repo :: Text

  Repository tag

• tags :: HashMap Text Text

  HashMap of tags to the top-most layer associated with that tag

Instances

Eq ImageRepo

Methods

(==) :: ImageRepo -> ImageRepo -> Bool

(/=) :: ImageRepo -> ImageRepo -> Bool

Show ImageRepo

Methods

showsPrec :: Int -> ImageRepo -> ShowS

show :: ImageRepo -> String

showList :: [ImageRepo] -> ShowS

ToJSON ImageRepo

Methods

toJSON :: ImageRepo -> Value

toEncoding :: ImageRepo -> Encoding

toJSONList :: [ImageRepo] -> Value

toEncodingList :: [ImageRepo] -> Encoding