Safe Haskell	None
Language	Haskell2010

Language.Docker.Syntax

Synopsis

Documentation

type Image = String Source #

type Tag = String Source #

data Protocol Source #

Constructors

TCP
UDP

Instances

Eq Protocol Source #
Methods (==) :: Protocol -> Protocol -> Bool # (/=) :: Protocol -> Protocol -> Bool #
Ord Protocol Source #
Methods compare :: Protocol -> Protocol -> Ordering # (<) :: Protocol -> Protocol -> Bool # (<=) :: Protocol -> Protocol -> Bool # (>) :: Protocol -> Protocol -> Bool # (>=) :: Protocol -> Protocol -> Bool # max :: Protocol -> Protocol -> Protocol # min :: Protocol -> Protocol -> Protocol #
Show Protocol Source #
Methods showsPrec :: Int -> Protocol -> ShowS # show :: Protocol -> String # showList :: [Protocol] -> ShowS #

data Port Source #

Constructors

Port Integer Protocol
PortStr String
PortRange Integer Integer

Instances

Eq Port Source #
Methods (==) :: Port -> Port -> Bool # (/=) :: Port -> Port -> Bool #
Ord Port Source #
Methods compare :: Port -> Port -> Ordering # (<) :: Port -> Port -> Bool # (<=) :: Port -> Port -> Bool # (>) :: Port -> Port -> Bool # (>=) :: Port -> Port -> Bool # max :: Port -> Port -> Port # min :: Port -> Port -> Port #
Show Port Source #
Methods showsPrec :: Int -> Port -> ShowS # show :: Port -> String # showList :: [Port] -> ShowS #

newtype Ports Source #

Constructors

Ports
Fields unPorts :: [Port]

Instances

IsList Ports Source #
Associated Types type Item Ports :: * # Methods fromList :: [Item Ports] -> Ports # fromListN :: Int -> [Item Ports] -> Ports # toList :: Ports -> [Item Ports] #
Eq Ports Source #
Methods (==) :: Ports -> Ports -> Bool # (/=) :: Ports -> Ports -> Bool #
Ord Ports Source #
Methods compare :: Ports -> Ports -> Ordering # (<) :: Ports -> Ports -> Bool # (<=) :: Ports -> Ports -> Bool # (>) :: Ports -> Ports -> Bool # (>=) :: Ports -> Ports -> Bool # max :: Ports -> Ports -> Ports # min :: Ports -> Ports -> Ports #
Show Ports Source #
Methods showsPrec :: Int -> Ports -> ShowS # show :: Ports -> String # showList :: [Ports] -> ShowS #
type Item Ports Source #
type Item Ports = Port

type Directory = String Source #

newtype ImageAlias Source #

Constructors

ImageAlias
Fields unImageAlias :: String

Instances

Eq ImageAlias Source #
Methods (==) :: ImageAlias -> ImageAlias -> Bool # (/=) :: ImageAlias -> ImageAlias -> Bool #
Ord ImageAlias Source #
Methods compare :: ImageAlias -> ImageAlias -> Ordering # (<) :: ImageAlias -> ImageAlias -> Bool # (<=) :: ImageAlias -> ImageAlias -> Bool # (>) :: ImageAlias -> ImageAlias -> Bool # (>=) :: ImageAlias -> ImageAlias -> Bool # max :: ImageAlias -> ImageAlias -> ImageAlias # min :: ImageAlias -> ImageAlias -> ImageAlias #
Show ImageAlias Source #
Methods showsPrec :: Int -> ImageAlias -> ShowS # show :: ImageAlias -> String # showList :: [ImageAlias] -> ShowS #
IsString ImageAlias Source #
Methods fromString :: String -> ImageAlias #

data BaseImage Source #

Constructors

UntaggedImage Image (Maybe ImageAlias)
TaggedImage Image Tag (Maybe ImageAlias)
DigestedImage Image ByteString (Maybe ImageAlias)

Instances

Eq BaseImage Source #
Methods (==) :: BaseImage -> BaseImage -> Bool # (/=) :: BaseImage -> BaseImage -> Bool #
Ord BaseImage Source #
Methods compare :: BaseImage -> BaseImage -> Ordering # (<) :: BaseImage -> BaseImage -> Bool # (<=) :: BaseImage -> BaseImage -> Bool # (>) :: BaseImage -> BaseImage -> Bool # (>=) :: BaseImage -> BaseImage -> Bool # max :: BaseImage -> BaseImage -> BaseImage # min :: BaseImage -> BaseImage -> BaseImage #
Show BaseImage Source #
Methods showsPrec :: Int -> BaseImage -> ShowS # show :: BaseImage -> String # showList :: [BaseImage] -> ShowS #

type Dockerfile = [InstructionPos] Source #

Type of the Dockerfile AST

newtype SourcePath Source #

Constructors

SourcePath
Fields unSourcePath :: String

Instances

Eq SourcePath Source #
Methods (==) :: SourcePath -> SourcePath -> Bool # (/=) :: SourcePath -> SourcePath -> Bool #
Ord SourcePath Source #
Methods compare :: SourcePath -> SourcePath -> Ordering # (<) :: SourcePath -> SourcePath -> Bool # (<=) :: SourcePath -> SourcePath -> Bool # (>) :: SourcePath -> SourcePath -> Bool # (>=) :: SourcePath -> SourcePath -> Bool # max :: SourcePath -> SourcePath -> SourcePath # min :: SourcePath -> SourcePath -> SourcePath #
Show SourcePath Source #
Methods showsPrec :: Int -> SourcePath -> ShowS # show :: SourcePath -> String # showList :: [SourcePath] -> ShowS #
IsString SourcePath Source #
Methods fromString :: String -> SourcePath #

newtype TargetPath Source #

Constructors

TargetPath
Fields unTargetPath :: String

Instances

Eq TargetPath Source #
Methods (==) :: TargetPath -> TargetPath -> Bool # (/=) :: TargetPath -> TargetPath -> Bool #
Ord TargetPath Source #
Methods compare :: TargetPath -> TargetPath -> Ordering # (<) :: TargetPath -> TargetPath -> Bool # (<=) :: TargetPath -> TargetPath -> Bool # (>) :: TargetPath -> TargetPath -> Bool # (>=) :: TargetPath -> TargetPath -> Bool # max :: TargetPath -> TargetPath -> TargetPath # min :: TargetPath -> TargetPath -> TargetPath #
Show TargetPath Source #
Methods showsPrec :: Int -> TargetPath -> ShowS # show :: TargetPath -> String # showList :: [TargetPath] -> ShowS #
IsString TargetPath Source #
Methods fromString :: String -> TargetPath #

data Chown Source #

Constructors

Chown String
NoChown

Instances

Eq Chown Source #
Methods (==) :: Chown -> Chown -> Bool # (/=) :: Chown -> Chown -> Bool #
Ord Chown Source #
Methods compare :: Chown -> Chown -> Ordering # (<) :: Chown -> Chown -> Bool # (<=) :: Chown -> Chown -> Bool # (>) :: Chown -> Chown -> Bool # (>=) :: Chown -> Chown -> Bool # max :: Chown -> Chown -> Chown # min :: Chown -> Chown -> Chown #
Show Chown Source #
Methods showsPrec :: Int -> Chown -> ShowS # show :: Chown -> String # showList :: [Chown] -> ShowS #

data CopySource Source #

Constructors

CopySource String
NoSource

Instances

Eq CopySource Source #
Methods (==) :: CopySource -> CopySource -> Bool # (/=) :: CopySource -> CopySource -> Bool #
Ord CopySource Source #
Methods compare :: CopySource -> CopySource -> Ordering # (<) :: CopySource -> CopySource -> Bool # (<=) :: CopySource -> CopySource -> Bool # (>) :: CopySource -> CopySource -> Bool # (>=) :: CopySource -> CopySource -> Bool # max :: CopySource -> CopySource -> CopySource # min :: CopySource -> CopySource -> CopySource #
Show CopySource Source #
Methods showsPrec :: Int -> CopySource -> ShowS # show :: CopySource -> String # showList :: [CopySource] -> ShowS #

newtype Duration Source #

Constructors

Duration
Fields durationTime :: DiffTime

Instances

Eq Duration Source #
Methods (==) :: Duration -> Duration -> Bool # (/=) :: Duration -> Duration -> Bool #
Num Duration Source #
Methods (+) :: Duration -> Duration -> Duration # (-) :: Duration -> Duration -> Duration # (*) :: Duration -> Duration -> Duration # negate :: Duration -> Duration # abs :: Duration -> Duration # signum :: Duration -> Duration # fromInteger :: Integer -> Duration #
Ord Duration Source #
Methods compare :: Duration -> Duration -> Ordering # (<) :: Duration -> Duration -> Bool # (<=) :: Duration -> Duration -> Bool # (>) :: Duration -> Duration -> Bool # (>=) :: Duration -> Duration -> Bool # max :: Duration -> Duration -> Duration # min :: Duration -> Duration -> Duration #
Show Duration Source #
Methods showsPrec :: Int -> Duration -> ShowS # show :: Duration -> String # showList :: [Duration] -> ShowS #

newtype Retries Source #

Constructors

Retries
Fields times :: Int

Instances

Eq Retries Source #
Methods (==) :: Retries -> Retries -> Bool # (/=) :: Retries -> Retries -> Bool #
Num Retries Source #
Methods (+) :: Retries -> Retries -> Retries # (-) :: Retries -> Retries -> Retries # (*) :: Retries -> Retries -> Retries # negate :: Retries -> Retries # abs :: Retries -> Retries # signum :: Retries -> Retries # fromInteger :: Integer -> Retries #
Ord Retries Source #
Methods compare :: Retries -> Retries -> Ordering # (<) :: Retries -> Retries -> Bool # (<=) :: Retries -> Retries -> Bool # (>) :: Retries -> Retries -> Bool # (>=) :: Retries -> Retries -> Bool # max :: Retries -> Retries -> Retries # min :: Retries -> Retries -> Retries #
Show Retries Source #
Methods showsPrec :: Int -> Retries -> ShowS # show :: Retries -> String # showList :: [Retries] -> ShowS #

data CopyArgs Source #

Constructors

CopyArgs
Fields sourcePaths :: NonEmpty SourcePath targetPath :: TargetPath chownFlag :: Chown sourceFlag :: CopySource

Instances

Eq CopyArgs Source #
Methods (==) :: CopyArgs -> CopyArgs -> Bool # (/=) :: CopyArgs -> CopyArgs -> Bool #
Ord CopyArgs Source #
Methods compare :: CopyArgs -> CopyArgs -> Ordering # (<) :: CopyArgs -> CopyArgs -> Bool # (<=) :: CopyArgs -> CopyArgs -> Bool # (>) :: CopyArgs -> CopyArgs -> Bool # (>=) :: CopyArgs -> CopyArgs -> Bool # max :: CopyArgs -> CopyArgs -> CopyArgs # min :: CopyArgs -> CopyArgs -> CopyArgs #
Show CopyArgs Source #
Methods showsPrec :: Int -> CopyArgs -> ShowS # show :: CopyArgs -> String # showList :: [CopyArgs] -> ShowS #

data AddArgs Source #

Constructors

AddArgs
Fields sourcePaths :: NonEmpty SourcePath targetPath :: TargetPath chownFlag :: Chown

Instances

Eq AddArgs Source #
Methods (==) :: AddArgs -> AddArgs -> Bool # (/=) :: AddArgs -> AddArgs -> Bool #
Ord AddArgs Source #
Methods compare :: AddArgs -> AddArgs -> Ordering # (<) :: AddArgs -> AddArgs -> Bool # (<=) :: AddArgs -> AddArgs -> Bool # (>) :: AddArgs -> AddArgs -> Bool # (>=) :: AddArgs -> AddArgs -> Bool # max :: AddArgs -> AddArgs -> AddArgs # min :: AddArgs -> AddArgs -> AddArgs #
Show AddArgs Source #
Methods showsPrec :: Int -> AddArgs -> ShowS # show :: AddArgs -> String # showList :: [AddArgs] -> ShowS #

data Check Source #

Constructors

Check CheckArgs
NoCheck

Instances

Eq Check Source #
Methods (==) :: Check -> Check -> Bool # (/=) :: Check -> Check -> Bool #
Ord Check Source #
Methods compare :: Check -> Check -> Ordering # (<) :: Check -> Check -> Bool # (<=) :: Check -> Check -> Bool # (>) :: Check -> Check -> Bool # (>=) :: Check -> Check -> Bool # max :: Check -> Check -> Check # min :: Check -> Check -> Check #
Show Check Source #
Methods showsPrec :: Int -> Check -> ShowS # show :: Check -> String # showList :: [Check] -> ShowS #

data CheckArgs Source #

Constructors

CheckArgs
Fields checkCommand :: Arguments interval :: Maybe Duration timeout :: Maybe Duration startPeriod :: Maybe Duration retries :: Maybe Retries

Instances

Eq CheckArgs Source #
Methods (==) :: CheckArgs -> CheckArgs -> Bool # (/=) :: CheckArgs -> CheckArgs -> Bool #
Ord CheckArgs Source #
Methods compare :: CheckArgs -> CheckArgs -> Ordering # (<) :: CheckArgs -> CheckArgs -> Bool # (<=) :: CheckArgs -> CheckArgs -> Bool # (>) :: CheckArgs -> CheckArgs -> Bool # (>=) :: CheckArgs -> CheckArgs -> Bool # max :: CheckArgs -> CheckArgs -> CheckArgs # min :: CheckArgs -> CheckArgs -> CheckArgs #
Show CheckArgs Source #
Methods showsPrec :: Int -> CheckArgs -> ShowS # show :: CheckArgs -> String # showList :: [CheckArgs] -> ShowS #

type Arguments = [String] Source #

type Pairs = [(String, String)] Source #

data Instruction Source #

All commands available in Dockerfiles

Instances

Eq Instruction Source #
Methods (==) :: Instruction -> Instruction -> Bool # (/=) :: Instruction -> Instruction -> Bool #
Ord Instruction Source #
Methods compare :: Instruction -> Instruction -> Ordering # (<) :: Instruction -> Instruction -> Bool # (<=) :: Instruction -> Instruction -> Bool # (>) :: Instruction -> Instruction -> Bool # (>=) :: Instruction -> Instruction -> Bool # max :: Instruction -> Instruction -> Instruction # min :: Instruction -> Instruction -> Instruction #
Show Instruction Source #
Methods showsPrec :: Int -> Instruction -> ShowS # show :: Instruction -> String # showList :: [Instruction] -> ShowS #

type Filename = String Source #

type Linenumber = Int Source #

data InstructionPos Source #

Instruction with additional location information required for creating good check messages

Constructors

InstructionPos
Fields instruction :: Instruction sourcename :: Filename lineNumber :: Linenumber

Instances

Eq InstructionPos Source #
Methods (==) :: InstructionPos -> InstructionPos -> Bool # (/=) :: InstructionPos -> InstructionPos -> Bool #
Ord InstructionPos Source #
Methods compare :: InstructionPos -> InstructionPos -> Ordering # (<) :: InstructionPos -> InstructionPos -> Bool # (<=) :: InstructionPos -> InstructionPos -> Bool # (>) :: InstructionPos -> InstructionPos -> Bool # (>=) :: InstructionPos -> InstructionPos -> Bool # max :: InstructionPos -> InstructionPos -> InstructionPos # min :: InstructionPos -> InstructionPos -> InstructionPos #
Show InstructionPos Source #
Methods showsPrec :: Int -> InstructionPos -> ShowS # show :: InstructionPos -> String # showList :: [InstructionPos] -> ShowS #

From BaseImage
Add AddArgs
User String
Label Pairs
Stopsignal String
Copy CopyArgs
Run Arguments
Cmd Arguments
Shell Arguments
Workdir Directory
Expose Ports
Volume String
Entrypoint Arguments
Maintainer String
Env Pairs
Arg String (Maybe String)
Healthcheck Check
Comment String
OnBuild Instruction