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-dockerfile"
    workdir "applanguage-dockerfile"
    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

Syntax

add :: forall m. MonadFree EInstruction m => Source -> Destination -> 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 :: forall m. MonadFree EInstruction m => Source -> Destination -> 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 ()

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

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

ports :: [Integer] -> Ports

port :: Integer -> Ports

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

ETaggedImage String String

EDigestedImage String ByteString

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 Source Destination

User String

Label Pairs

Stopsignal String

Copy Source Destination

Run Arguments

Cmd Arguments

Shell Arguments

Workdir Directory

Expose Ports

Volume String

Entrypoint Arguments

Maintainer String

Env Pairs

Arg String

Healthcheck String

Comment String

OnBuild Instruction

EOL

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 Instruction Filename 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

TaggedImage Image Tag

DigestedImage Image ByteString

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

type Tag = String

data Ports

Instances

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

IsString Ports

Methods

fromString :: String -> Ports

type Directory = String

type Source = String

type Destination = 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

instruction :: InstructionPos -> Instruction

instructionPos :: Instruction -> InstructionPos

sourcename :: InstructionPos -> Filename