Safe Haskell	None
Language	Haskell2010

Language.Docker

Contents

Parsing Dockerfiles (Language.Docker.Syntax and Language.Docker.Parser)
Pretty-printing Dockerfiles (Language.Docker.PrettyPrint)
Writting Dockerfiles (Language.Docker.EDSL)
QuasiQuoter (Language.Docker.EDSL.Quasi)
Types (Language.Docker.Syntax)
Re-exports from parsec
Instruction and InstructionPos helpers

Synopsis

Documentation

type Dockerfile = [InstructionPos] #

Type of the Dockerfile AST

Parsing Dockerfiles (`Language.Docker.Syntax` and `Language.Docker.Parser`)

parseString :: String -> Either ParseError Dockerfile #

parseFile :: String -> IO (Either ParseError Dockerfile) #

Pretty-printing Dockerfiles (`Language.Docker.PrettyPrint`)

prettyPrint :: Dockerfile -> String #

Pretty print a Dockerfile to a String

prettyPrintInstructionPos :: InstructionPos -> String #

Pretty print a InstructionPos to a String

Writting Dockerfiles (`Language.Docker.EDSL`)

toDockerfileStr :: EDockerfileM a -> String #

runs the Dockerfile EDSL and returns a String using PrettyPrint

import           Language.Docker

main :: IO ()
main = writeFile "something.dockerfile" $ toDockerfileStr $ do
    from (tagged "fpco/stack-build" "lts-6.9")
    add ["."] "applanguage-docker"
    workdir "applanguage-docker"
    run (words "stack build --test --only-dependencies")
    cmd (words "stack test")

toDockerfile :: EDockerfileM a -> Dockerfile #

Runs the Dockerfile EDSL and returns a Dockerfile you can pretty print or manipulate

toDockerfileStrIO :: MonadIO m => EDockerfileTM m t -> m String #

A version of toDockerfileStr which allows IO actions

toDockerfileIO :: MonadIO m => EDockerfileTM m t -> m Dockerfile #

A version of toDockerfile which allows IO actions

runDockerfileIO :: MonadIO m => EDockerfileTM m t -> m (t, Dockerfile) #

Just runs the EDSL's writer monad

runDockerfileStrIO :: MonadIO m => EDockerfileTM m t -> m (t, String) #

Runs the EDSL's writer monad and pretty-prints the result

liftIO :: MonadIO m => forall a. IO a -> m a #

Lift a computation from the IO monad.

from :: forall m. MonadFree EInstruction m => EBaseImage -> m () #

Constructing base images

tagged :: String -> String -> EBaseImage #

untagged :: String -> EBaseImage #

digested :: String -> ByteString -> EBaseImage #

aliased :: EBaseImage -> String -> EBaseImage #

Syntax

add :: MonadFree EInstruction m => NonEmpty SourcePath -> TargetPath -> m () #

user :: forall m. MonadFree EInstruction m => String -> m () #

label :: forall m. MonadFree EInstruction m => Pairs -> m () #

stopSignal :: forall m. MonadFree EInstruction m => String -> m () #

copy :: MonadFree EInstruction m => NonEmpty SourcePath -> TargetPath -> m () #

run :: MonadFree EInstruction m => String -> m () #

runArgs :: forall m. MonadFree EInstruction m => Arguments -> m () #

cmd :: MonadFree EInstruction m => String -> m () #

cmdArgs :: forall m. MonadFree EInstruction m => Arguments -> m () #

healthcheck :: forall m. MonadFree EInstruction m => Check -> m () #

check :: String -> Check #

interval :: Check -> Integer -> Check #

timeout :: Check -> Integer -> Check #

startPeriod :: Check -> Integer -> Check #

retries :: Check -> Integer -> Check #

workdir :: forall m. MonadFree EInstruction m => Directory -> m () #

expose :: forall m. MonadFree EInstruction m => Ports -> m () #

ports :: [Port] -> Ports #

tcpPort :: Integer -> Port #

udpPort :: Integer -> Port #

variablePort :: String -> Port #

volume :: forall m. MonadFree EInstruction m => String -> m () #

entrypoint :: MonadFree EInstruction m => String -> m () #

entrypointArgs :: forall m. MonadFree EInstruction m => Arguments -> m () #

maintainer :: forall m. MonadFree EInstruction m => String -> m () #

env :: forall m. MonadFree EInstruction m => Pairs -> m () #

arg :: forall m. MonadFree EInstruction m => String -> Maybe String -> m () #

comment :: forall m. MonadFree EInstruction m => String -> m () #

onBuild :: MonadFree EInstruction m => EDockerfileM a -> m () #

ONBUILD Dockerfile instruction

Each nested instruction gets emitted as a separate ONBUILD block

toDockerfile $ do
    from "node"
    run "apt-get update"
    onBuild $ do
        run "echo more-stuff"
        run "echo here"

onBuildRaw :: forall m. MonadFree EInstruction m => Instruction -> m () #

embed :: forall m. MonadFree EInstruction m => [InstructionPos] -> m () #

edockerfile :: QuasiQuoter #

Quasiquoter for embedding dockerfiles on the EDSL

putStr $ toDockerfile $ do
    from "node"
    run "apt-get update"
    [edockerfile|
    RUN apt-get update
    CMD node something.js
    |]

Support types for the EDSL

type EDockerfileM = Free EInstruction #

The type of Identity based EDSL blocks

type EDockerfileTM = FreeT EInstruction #

The type of free monad EDSL blocks

data EBaseImage #

Constructors

EUntaggedImage String (Maybe ImageAlias)
ETaggedImage String String (Maybe ImageAlias)
EDigestedImage String ByteString (Maybe ImageAlias)

Instances

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

QuasiQuoter (`Language.Docker.EDSL.Quasi`)

dockerfile :: QuasiQuoter #

Types (`Language.Docker.Syntax`)

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 #

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 #

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 #

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 #

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 Image = 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 #

type Tag = String #

data Ports #

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 #

type Arguments = [String] #

type Pairs = [(String, String)] #

type Filename = String #

type Linenumber = Int #

Re-exports from `parsec`

data ParseError :: * #

The abstract data type ParseError represents parse errors. It provides the source position (SourcePos) of the error and a list of error messages (Message). A ParseError can be returned by the function parse. ParseError is an instance of the Show and Eq classes.

Instances

Eq ParseError
Methods (==) :: ParseError -> ParseError -> Bool # (/=) :: ParseError -> ParseError -> Bool #
Show ParseError
Methods showsPrec :: Int -> ParseError -> ShowS # show :: ParseError -> String # showList :: [ParseError] -> ShowS #

Instruction and InstructionPos helpers

instructionPos :: Instruction -> InstructionPos #

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

Documentation

Parsing Dockerfiles (Language.Docker.Syntax and Language.Docker.Parser)

Pretty-printing Dockerfiles (Language.Docker.PrettyPrint)

Writting Dockerfiles (Language.Docker.EDSL)

Constructing base images

Syntax

Support types for the EDSL

QuasiQuoter (Language.Docker.EDSL.Quasi)

Types (Language.Docker.Syntax)

Re-exports from parsec

Instruction and InstructionPos helpers

Parsing Dockerfiles (`Language.Docker.Syntax` and `Language.Docker.Parser`)

Pretty-printing Dockerfiles (`Language.Docker.PrettyPrint`)

Writting Dockerfiles (`Language.Docker.EDSL`)

QuasiQuoter (`Language.Docker.EDSL.Quasi`)

Types (`Language.Docker.Syntax`)

Re-exports from `parsec`