Safe Haskell | None |
---|---|
Language | Haskell2010 |
- type EDockerfileM = Free EInstruction
- type EDockerfileTM = FreeT EInstruction
- type EInstructionM = Free EInstruction
- type EInstructionTM = FreeT EInstruction
- embed :: forall m. MonadFree EInstruction m => [InstructionPos] -> m ()
- onBuildRaw :: forall m. MonadFree EInstruction m => Instruction -> m ()
- healthcheck :: forall m. MonadFree EInstruction m => Check -> m ()
- comment :: forall m. MonadFree EInstruction m => String -> m ()
- arg :: forall m. MonadFree EInstruction m => String -> Maybe String -> m ()
- env :: forall m. MonadFree EInstruction m => Pairs -> m ()
- maintainer :: forall m. MonadFree EInstruction m => String -> m ()
- entrypointArgs :: forall m. MonadFree EInstruction m => Arguments -> m ()
- volume :: forall m. MonadFree EInstruction m => String -> m ()
- expose :: forall m. MonadFree EInstruction m => Ports -> m ()
- workdir :: forall m. MonadFree EInstruction m => Directory -> m ()
- shell :: forall m. MonadFree EInstruction m => Arguments -> m ()
- cmdArgs :: forall m. MonadFree EInstruction m => Arguments -> m ()
- runArgs :: forall m. MonadFree EInstruction m => Arguments -> m ()
- copyArgs :: forall m. MonadFree EInstruction m => NonEmpty SourcePath -> TargetPath -> Chown -> CopySource -> m ()
- stopSignal :: forall m. MonadFree EInstruction m => String -> m ()
- label :: forall m. MonadFree EInstruction m => Pairs -> m ()
- user :: forall m. MonadFree EInstruction m => String -> m ()
- addArgs :: forall m. MonadFree EInstruction m => NonEmpty SourcePath -> TargetPath -> Chown -> m ()
- from :: forall m. MonadFree EInstruction m => EBaseImage -> m ()
- runDockerWriter :: MonadWriter [Instruction] m => EDockerfileM a -> m a
- runDockerWriterIO :: (Monad m, MonadTrans t, Monad (t m), MonadWriter [Instruction] (t m), MonadIO (t m)) => EDockerfileTM m a -> t m a
- runDef :: MonadWriter [t] m => (t1 -> t) -> t1 -> m b -> m b
- runDef2 :: MonadWriter [t] m => (t1 -> t2 -> t) -> t1 -> t2 -> m b -> m b
- runD :: MonadWriter [Instruction] m => EInstruction (m b) -> m b
- instructionPos :: Instruction -> InstructionPos
- toDockerfile :: EDockerfileM a -> Dockerfile
- toDockerfileStr :: EDockerfileM a -> String
- untagged :: String -> EBaseImage
- tagged :: Image -> String -> EBaseImage
- digested :: Image -> ByteString -> EBaseImage
- aliased :: EBaseImage -> String -> EBaseImage
- run :: MonadFree EInstruction m => Arguments -> m ()
- entrypoint :: MonadFree EInstruction m => Arguments -> m ()
- cmd :: MonadFree EInstruction m => Arguments -> m ()
- copy :: MonadFree EInstruction m => CopyArgs -> m ()
- copyFromStage :: MonadFree EInstruction m => CopySource -> NonEmpty SourcePath -> TargetPath -> m ()
- add :: MonadFree EInstruction m => NonEmpty SourcePath -> TargetPath -> m ()
- toSources :: NonEmpty String -> NonEmpty SourcePath
- toTarget :: String -> TargetPath
- fromStage :: CopyArgs -> CopySource -> CopyArgs
- ownedBy :: CopyArgs -> Chown -> CopyArgs
- to :: NonEmpty SourcePath -> TargetPath -> CopyArgs
- ports :: [Port] -> Ports
- tcpPort :: Integer -> Port
- udpPort :: Integer -> Port
- variablePort :: String -> Port
- portRange :: Integer -> Integer -> Port
- check :: Arguments -> Check
- interval :: Check -> Integer -> Check
- timeout :: Check -> Integer -> Check
- startPeriod :: Check -> Integer -> Check
- retries :: Check -> Integer -> Check
- noCheck :: Check
- onBuild :: MonadFree EInstruction m => EDockerfileM a -> m ()
- toDockerfileIO :: MonadIO m => EDockerfileTM m t -> m Dockerfile
- toDockerfileStrIO :: MonadIO m => EDockerfileTM m t -> m String
- runDockerfileIO :: MonadIO m => EDockerfileTM m t -> m (t, Dockerfile)
- runDockerfileStrIO :: MonadIO m => EDockerfileTM m t -> m (t, String)
Documentation
type EDockerfileM = Free EInstruction Source #
The type of Identity
based EDSL blocks
type EDockerfileTM = FreeT EInstruction Source #
The type of free monad EDSL blocks
type EInstructionM = Free EInstruction Source #
type EInstructionTM = FreeT EInstruction Source #
embed :: forall m. MonadFree EInstruction m => [InstructionPos] -> m () Source #
onBuildRaw :: forall m. MonadFree EInstruction m => Instruction -> m () Source #
healthcheck :: forall m. MonadFree EInstruction m => Check -> m () Source #
maintainer :: forall m. MonadFree EInstruction m => String -> m () Source #
entrypointArgs :: forall m. MonadFree EInstruction m => Arguments -> m () Source #
copyArgs :: forall m. MonadFree EInstruction m => NonEmpty SourcePath -> TargetPath -> Chown -> CopySource -> m () Source #
stopSignal :: forall m. MonadFree EInstruction m => String -> m () Source #
addArgs :: forall m. MonadFree EInstruction m => NonEmpty SourcePath -> TargetPath -> Chown -> m () Source #
from :: forall m. MonadFree EInstruction m => EBaseImage -> m () Source #
runDockerWriter :: MonadWriter [Instruction] m => EDockerfileM a -> m a Source #
runDockerWriterIO :: (Monad m, MonadTrans t, Monad (t m), MonadWriter [Instruction] (t m), MonadIO (t m)) => EDockerfileTM m a -> t m a Source #
runDef :: MonadWriter [t] m => (t1 -> t) -> t1 -> m b -> m b Source #
runDef2 :: MonadWriter [t] m => (t1 -> t2 -> t) -> t1 -> t2 -> m b -> m b Source #
runD :: MonadWriter [Instruction] m => EInstruction (m b) -> m b Source #
toDockerfile :: EDockerfileM a -> Dockerfile Source #
Runs the Dockerfile EDSL and returns a Dockerfile
you can pretty print
or manipulate
toDockerfileStr :: EDockerfileM a -> String Source #
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"
untagged :: String -> EBaseImage Source #
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"
tagged :: Image -> String -> EBaseImage Source #
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"
digested :: Image -> ByteString -> EBaseImage Source #
aliased :: EBaseImage -> String -> EBaseImage Source #
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"
run :: MonadFree EInstruction m => Arguments -> m () Source #
Create a RUN instruction with the given arguments.
run "apt-get install wget"
entrypoint :: MonadFree EInstruction m => Arguments -> m () Source #
Create an ENTRYPOINT instruction with the given arguments.
entrypoint "usrlocalbinprogram --some-flag"
cmd :: MonadFree EInstruction m => Arguments -> m () Source #
Create a CMD instruction with the given arguments.
cmd "my-program --some-flag"
copyFromStage :: MonadFree EInstruction m => CopySource -> NonEmpty SourcePath -> TargetPath -> m () Source #
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"] "."
add :: MonadFree EInstruction m => NonEmpty SourcePath -> TargetPath -> m () Source #
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"] "."
toSources :: NonEmpty String -> NonEmpty SourcePath Source #
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 Source #
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)
to :: NonEmpty SourcePath -> TargetPath -> CopyArgs Source #
variablePort :: String -> Port Source #
onBuild :: MonadFree EInstruction m => EDockerfileM a -> m () Source #
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"
toDockerfileIO :: MonadIO m => EDockerfileTM m t -> m Dockerfile Source #
A version of toDockerfile
which allows IO actions
toDockerfileStrIO :: MonadIO m => EDockerfileTM m t -> m String Source #
A version of toDockerfileStr
which allows IO actions
runDockerfileIO :: MonadIO m => EDockerfileTM m t -> m (t, Dockerfile) Source #
Just runs the EDSL's writer monad
runDockerfileStrIO :: MonadIO m => EDockerfileTM m t -> m (t, String) Source #
Runs the EDSL's writer monad and pretty-prints the result