Language.Docker

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 "stack build --test --only-dependencies"
    cmd "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 :: Image -> String -> EBaseImage

Use a specific tag for a docker image. This function is meant to be used as an infix operator.

from $ "fpco/stack-build" tagged "lts-10.3"

untagged :: String -> EBaseImage

Use a docker image in a FROM instruction without a tag

The following two examples are equivalent

from $ untagged "fpco/stack-build"

Is equivalent to, when having OverloadedStrings:

from "fpco/stack-build"

digested :: Image -> ByteString -> EBaseImage

aliased :: EBaseImage -> String -> EBaseImage

Alias a FROM instruction to be used as a build stage. This function is meant to be used as an infix operator.

from $ "fpco/stack-build" aliased "builder"

Syntax

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

Create an ADD instruction. This is often used as a shorthand version of copy when no extra options are needed. Currently there is no way to pass extra options to ADD, so you are encouraged to use copy instead.

add ["foo.js", "bar.js"] "."

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 => CopyArgs -> m ()

Create a COPY instruction. This function is meant to be used with the compinators to, fromStage and ownedBy

copy $ ["foo.js", "bar.js"] to "."
copy $ ["some_file"] to "somepath" fromStage "builder"

copyFromStage :: MonadFree EInstruction m => CopySource -> NonEmpty SourcePath -> TargetPath -> m ()

Create a COPY instruction from a given build stage. This is a shorthand version of using copy with combinators.

copyFromStage "builder" ["foo.js", "bar.js"] "."

to :: NonEmpty SourcePath -> TargetPath -> CopyArgs

Usedto join source paths with atarget path as an arguments for copy

This function is meant to be used as an infix operator:

copy $ ["foo.js"] to "." ownedBy

fromStage :: CopyArgs -> CopySource -> CopyArgs

Adds the --from= option to a COPY instruction.

This function is meant to be used as an infix operator:

copy $ ["foo.js"] to "." fromStage "builder"

ownedBy :: CopyArgs -> Chown -> CopyArgs

Adds the --chown= option to a COPY instruction.

This function is meant to be used as an infix operator:

copy $ ["foo.js"] to "." ownedBy "www-data:www-data"

toSources :: NonEmpty String -> NonEmpty SourcePath

Converts a NonEmpty list of strings to a NonEmpty list of SourcePath

This is a convenience function when you need to pass a non-static list of strings that you build somewhere as an argument for copy or add

someFiles <- glob "*.js"
copy $ (toSources someFiles) to "."

toTarget :: String -> TargetPath

Converts a String into a TargetPath

This is a convenience function when you need to pass a string variable as an argument for copy or add

let destination = buildSomePath pwd
add ["foo.js"] (toTarget destination)

run :: MonadFree EInstruction m => Arguments -> m ()

Create a RUN instruction with the given arguments.

run "apt-get install wget"

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

cmd :: MonadFree EInstruction m => Arguments -> m ()

Create a CMD instruction with the given arguments.

cmd "my-program --some-flag"

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

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

check :: Arguments -> 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

portRange :: Integer -> Integer -> Port

udpPortRange :: Integer -> Integer -> Port

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

entrypoint :: MonadFree EInstruction m => Arguments -> m ()

Create an ENTRYPOINT instruction with the given arguments.

entrypoint "usrlocalbinprogram --some-flag"

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 Image (Maybe ImageAlias)

ETaggedImage Image String (Maybe ImageAlias)

EDigestedImage Image 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

Constructors

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

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

IsString Chown

Methods

fromString :: String -> Chown

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

IsString CopySource

Methods

fromString :: String -> CopySource

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

data Image

Constructors

Image

Fields

• registryName :: Maybe Registry
• imageName :: String

Instances

Eq Image

Methods

(==) :: Image -> Image -> Bool

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

Ord Image

Methods

compare :: Image -> Image -> Ordering

(<) :: Image -> Image -> Bool

(<=) :: Image -> Image -> Bool

(>) :: Image -> Image -> Bool

(>=) :: Image -> Image -> Bool

max :: Image -> Image -> Image

min :: Image -> Image -> Image

Show Image

Methods

showsPrec :: Int -> Image -> ShowS

show :: Image -> String

showList :: [Image] -> ShowS

IsString Image

Methods

fromString :: String -> Image

newtype Registry

Constructors

Registry String

Instances

Eq Registry

Methods

(==) :: Registry -> Registry -> Bool

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

Ord Registry

Methods

compare :: Registry -> Registry -> Ordering

(<) :: Registry -> Registry -> Bool

(<=) :: Registry -> Registry -> Bool

(>) :: Registry -> Registry -> Bool

(>=) :: Registry -> Registry -> Bool

max :: Registry -> Registry -> Registry

min :: Registry -> Registry -> Registry

Show Registry

Methods

showsPrec :: Int -> Registry -> ShowS

show :: Registry -> String

showList :: [Registry] -> ShowS

IsString Registry

Methods

fromString :: String -> Registry

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

data Arguments

Instances

IsList Arguments

Associated Types

type Item Arguments :: *

Methods

fromList :: [Item Arguments] -> Arguments

fromListN :: Int -> [Item Arguments] -> Arguments

toList :: Arguments -> [Item Arguments]

Eq Arguments

Methods

(==) :: Arguments -> Arguments -> Bool

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

Ord Arguments

Methods

compare :: Arguments -> Arguments -> Ordering

(<) :: Arguments -> Arguments -> Bool

(<=) :: Arguments -> Arguments -> Bool

(>) :: Arguments -> Arguments -> Bool

(>=) :: Arguments -> Arguments -> Bool

max :: Arguments -> Arguments -> Arguments

min :: Arguments -> Arguments -> Arguments

Show Arguments

Methods

showsPrec :: Int -> Arguments -> ShowS

show :: Arguments -> String

showList :: [Arguments] -> ShowS

IsString Arguments

Methods

fromString :: String -> Arguments

type Item Arguments

type Item 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