Safe Haskell	None
Language	Haskell2010

Language.Docker.Syntax

Synopsis

Documentation

type Image = String #

type Tag = String #

data Protocol #

Constructors

TCP
UDP

Instances

Eq Protocol #
Methods (==) :: Protocol -> Protocol -> Bool # (/=) :: Protocol -> Protocol -> Bool #
Ord Protocol #
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 #
Methods showsPrec :: Int -> Protocol -> ShowS # show :: Protocol -> String # showList :: [Protocol] -> ShowS #

data Port #

Constructors

Port Integer Protocol
PortStr String
PortRange Integer Integer

Instances

Eq Port #
Methods (==) :: Port -> Port -> Bool # (/=) :: Port -> Port -> Bool #
Ord Port #
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 #
Methods showsPrec :: Int -> Port -> ShowS # show :: Port -> String # showList :: [Port] -> ShowS #

newtype Ports #

Constructors

Ports
Fields unPorts :: [Port]

Instances

IsList Ports #
Associated Types type Item Ports :: * # Methods fromList :: [Item Ports] -> Ports # fromListN :: Int -> [Item Ports] -> Ports # toList :: Ports -> [Item Ports] #
Eq Ports #
Methods (==) :: Ports -> Ports -> Bool # (/=) :: Ports -> Ports -> Bool #
Ord Ports #
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 #
Methods showsPrec :: Int -> Ports -> ShowS # show :: Ports -> String # showList :: [Ports] -> ShowS #
type Item Ports #
type Item Ports = Port

type Directory = String #

newtype ImageAlias #

Constructors

ImageAlias
Fields unImageAlias :: String

Instances

Eq ImageAlias #
Methods (==) :: ImageAlias -> ImageAlias -> Bool # (/=) :: ImageAlias -> ImageAlias -> Bool #
Ord ImageAlias #
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 #
Methods showsPrec :: Int -> ImageAlias -> ShowS # show :: ImageAlias -> String # showList :: [ImageAlias] -> ShowS #
IsString ImageAlias #
Methods fromString :: String -> ImageAlias #

data BaseImage #

Constructors

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

Instances

Eq BaseImage #
Methods (==) :: BaseImage -> BaseImage -> Bool # (/=) :: BaseImage -> BaseImage -> Bool #
Ord BaseImage #
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 #
Methods showsPrec :: Int -> BaseImage -> ShowS # show :: BaseImage -> String # showList :: [BaseImage] -> ShowS #

type Dockerfile = [InstructionPos] #

Type of the Dockerfile AST

newtype SourcePath #

Constructors

SourcePath
Fields unSourcePath :: String

Instances

Eq SourcePath #
Methods (==) :: SourcePath -> SourcePath -> Bool # (/=) :: SourcePath -> SourcePath -> Bool #
Ord SourcePath #
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 #
Methods showsPrec :: Int -> SourcePath -> ShowS # show :: SourcePath -> String # showList :: [SourcePath] -> ShowS #
IsString SourcePath #
Methods fromString :: String -> SourcePath #

newtype TargetPath #

Constructors

TargetPath
Fields unTargetPath :: String

Instances

Eq TargetPath #
Methods (==) :: TargetPath -> TargetPath -> Bool # (/=) :: TargetPath -> TargetPath -> Bool #
Ord TargetPath #
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 #
Methods showsPrec :: Int -> TargetPath -> ShowS # show :: TargetPath -> String # showList :: [TargetPath] -> ShowS #
IsString TargetPath #
Methods fromString :: String -> TargetPath #

data Chown #

Constructors

Chown String
NoChown

Instances

Eq Chown #
Methods (==) :: Chown -> Chown -> Bool # (/=) :: Chown -> Chown -> Bool #
Ord Chown #
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 #
Methods showsPrec :: Int -> Chown -> ShowS # show :: Chown -> String # showList :: [Chown] -> ShowS #

data CopySource #

Constructors

CopySource String
NoSource

Instances

Eq CopySource #
Methods (==) :: CopySource -> CopySource -> Bool # (/=) :: CopySource -> CopySource -> Bool #
Ord CopySource #
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 #
Methods showsPrec :: Int -> CopySource -> ShowS # show :: CopySource -> String # showList :: [CopySource] -> ShowS #

newtype Duration #

Constructors

Duration
Fields durationTime :: DiffTime

Instances

Eq Duration #
Methods (==) :: Duration -> Duration -> Bool # (/=) :: Duration -> Duration -> Bool #
Num Duration #
Methods (+) :: Duration -> Duration -> Duration # (-) :: Duration -> Duration -> Duration # (*) :: Duration -> Duration -> Duration # negate :: Duration -> Duration # abs :: Duration -> Duration # signum :: Duration -> Duration # fromInteger :: Integer -> Duration #
Ord Duration #
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 #
Methods showsPrec :: Int -> Duration -> ShowS # show :: Duration -> String # showList :: [Duration] -> ShowS #

newtype Retries #

Constructors

Retries
Fields times :: Int

Instances

Eq Retries #
Methods (==) :: Retries -> Retries -> Bool # (/=) :: Retries -> Retries -> Bool #
Num Retries #
Methods (+) :: Retries -> Retries -> Retries # (-) :: Retries -> Retries -> Retries # (*) :: Retries -> Retries -> Retries # negate :: Retries -> Retries # abs :: Retries -> Retries # signum :: Retries -> Retries # fromInteger :: Integer -> Retries #
Ord Retries #
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 #
Methods showsPrec :: Int -> Retries -> ShowS # show :: Retries -> String # showList :: [Retries] -> ShowS #

data CopyArgs #

Constructors

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

Instances

Eq CopyArgs #
Methods (==) :: CopyArgs -> CopyArgs -> Bool # (/=) :: CopyArgs -> CopyArgs -> Bool #
Ord CopyArgs #
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 #
Methods showsPrec :: Int -> CopyArgs -> ShowS # show :: CopyArgs -> String # showList :: [CopyArgs] -> ShowS #

data AddArgs #

Constructors

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

Instances

Eq AddArgs #
Methods (==) :: AddArgs -> AddArgs -> Bool # (/=) :: AddArgs -> AddArgs -> Bool #
Ord AddArgs #
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 #
Methods showsPrec :: Int -> AddArgs -> ShowS # show :: AddArgs -> String # showList :: [AddArgs] -> ShowS #

data Check #

Constructors

Check CheckArgs
NoCheck

Instances

Eq Check #
Methods (==) :: Check -> Check -> Bool # (/=) :: Check -> Check -> Bool #
Ord Check #
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 #
Methods showsPrec :: Int -> Check -> ShowS # show :: Check -> String # showList :: [Check] -> ShowS #

data CheckArgs #

Constructors

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

Instances

Eq CheckArgs #
Methods (==) :: CheckArgs -> CheckArgs -> Bool # (/=) :: CheckArgs -> CheckArgs -> Bool #
Ord CheckArgs #
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 #
Methods showsPrec :: Int -> CheckArgs -> ShowS # show :: CheckArgs -> String # showList :: [CheckArgs] -> ShowS #

type Arguments = [String] #

type Pairs = [(String, String)] #

data Instruction #

All commands available in Dockerfiles

Instances

Eq Instruction #
Methods (==) :: Instruction -> Instruction -> Bool # (/=) :: Instruction -> Instruction -> Bool #
Ord Instruction #
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 #
Methods showsPrec :: Int -> Instruction -> ShowS # show :: Instruction -> String # showList :: [Instruction] -> ShowS #

type Filename = String #

type Linenumber = Int #

data InstructionPos #

Instruction with additional location information required for creating good check messages

Constructors

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

Instances

Eq InstructionPos #
Methods (==) :: InstructionPos -> InstructionPos -> Bool # (/=) :: InstructionPos -> InstructionPos -> Bool #
Ord InstructionPos #
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 #
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