-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Dockerfile parser, pretty-printer and embedded DSL -- -- All functions for parsing, printing and writting Dockerfiles are -- exported through Language.Docker. For more fine-grained -- operations look for specific modules that implement a certain -- functionality. See the GitHub project for the source-code and -- examples. @package language-docker @version 2.0.0 module Language.Docker.Lexer reserved :: String -> Parser () natural :: Parser Integer commaSep :: Parser a -> Parser [a] stringLiteral :: Parser String brackets :: Parser a -> Parser a whiteSpace :: Parser () space :: Parser () spaces1 :: Parser () spaces :: Parser () symbol :: String -> Parser String caseInsensitiveChar :: Char -> Parser Char caseInsensitiveString :: String -> Parser String charsWithEscapedSpaces :: String -> Parser String lexeme :: Parser a -> Parser a module Language.Docker.Normalize -- | Remove new line escapes and join escaped lines together on one line to -- simplify parsing later on. Escapes are replaced with line breaks to -- not alter the line numbers. normalizeEscapedLines :: String -> String module Language.Docker.Syntax type Image = String type Tag = String data Protocol TCP :: Protocol UDP :: Protocol data Port Port :: Integer -> Protocol -> Port PortStr :: String -> Port PortRange :: Integer -> Integer -> Port newtype Ports Ports :: [Port] -> Ports [$sel:unPorts:Ports] :: Ports -> [Port] type Directory = String newtype ImageAlias ImageAlias :: String -> ImageAlias [$sel:unImageAlias:ImageAlias] :: ImageAlias -> String data BaseImage UntaggedImage :: Image -> (Maybe ImageAlias) -> BaseImage TaggedImage :: Image -> Tag -> (Maybe ImageAlias) -> BaseImage DigestedImage :: Image -> ByteString -> (Maybe ImageAlias) -> BaseImage -- | Type of the Dockerfile AST type Dockerfile = [InstructionPos] newtype SourcePath SourcePath :: String -> SourcePath [$sel:unSourcePath:SourcePath] :: SourcePath -> String newtype TargetPath TargetPath :: String -> TargetPath [$sel:unTargetPath:TargetPath] :: TargetPath -> String data Chown Chown :: String -> Chown NoChown :: Chown data CopySource CopySource :: String -> CopySource NoSource :: CopySource newtype Duration Duration :: DiffTime -> Duration [$sel:durationTime:Duration] :: Duration -> DiffTime newtype Retries Retries :: Int -> Retries [$sel:times:Retries] :: Retries -> Int data CopyArgs CopyArgs :: NonEmpty SourcePath -> TargetPath -> Chown -> CopySource -> CopyArgs [$sel:sourcePaths:CopyArgs] :: CopyArgs -> NonEmpty SourcePath [$sel:targetPath:CopyArgs] :: CopyArgs -> TargetPath [$sel:chownFlag:CopyArgs] :: CopyArgs -> Chown [$sel:sourceFlag:CopyArgs] :: CopyArgs -> CopySource data AddArgs AddArgs :: NonEmpty SourcePath -> TargetPath -> Chown -> AddArgs [$sel:sourcePaths:AddArgs] :: AddArgs -> NonEmpty SourcePath [$sel:targetPath:AddArgs] :: AddArgs -> TargetPath [$sel:chownFlag:AddArgs] :: AddArgs -> Chown data Check Check :: CheckArgs -> Check NoCheck :: Check data CheckArgs CheckArgs :: Arguments -> Maybe Duration -> Maybe Duration -> Maybe Duration -> Maybe Retries -> CheckArgs [$sel:checkCommand:CheckArgs] :: CheckArgs -> Arguments [$sel:interval:CheckArgs] :: CheckArgs -> Maybe Duration [$sel:timeout:CheckArgs] :: CheckArgs -> Maybe Duration [$sel:startPeriod:CheckArgs] :: CheckArgs -> Maybe Duration [$sel:retries:CheckArgs] :: CheckArgs -> Maybe Retries type Arguments = [String] type Pairs = [(String, String)] -- | All commands available in Dockerfiles data Instruction From :: BaseImage -> Instruction Add :: AddArgs -> Instruction User :: String -> Instruction Label :: Pairs -> Instruction Stopsignal :: String -> Instruction Copy :: CopyArgs -> Instruction Run :: Arguments -> Instruction Cmd :: Arguments -> Instruction Shell :: Arguments -> Instruction Workdir :: Directory -> Instruction Expose :: Ports -> Instruction Volume :: String -> Instruction Entrypoint :: Arguments -> Instruction Maintainer :: String -> Instruction Env :: Pairs -> Instruction Arg :: String -> (Maybe String) -> Instruction Healthcheck :: Check -> Instruction Comment :: String -> Instruction OnBuild :: Instruction -> Instruction type Filename = String type Linenumber = Int -- | Instruction with additional location information required for -- creating good check messages data InstructionPos InstructionPos :: Instruction -> Filename -> Linenumber -> InstructionPos [$sel:instruction:InstructionPos] :: InstructionPos -> Instruction [$sel:sourcename:InstructionPos] :: InstructionPos -> Filename [$sel:lineNumber:InstructionPos] :: InstructionPos -> Linenumber instance GHC.Show.Show Language.Docker.Syntax.InstructionPos instance GHC.Classes.Ord Language.Docker.Syntax.InstructionPos instance GHC.Classes.Eq Language.Docker.Syntax.InstructionPos instance GHC.Show.Show Language.Docker.Syntax.Instruction instance GHC.Classes.Ord Language.Docker.Syntax.Instruction instance GHC.Classes.Eq Language.Docker.Syntax.Instruction instance GHC.Classes.Ord Language.Docker.Syntax.Check instance GHC.Classes.Eq Language.Docker.Syntax.Check instance GHC.Show.Show Language.Docker.Syntax.Check instance GHC.Classes.Ord Language.Docker.Syntax.CheckArgs instance GHC.Classes.Eq Language.Docker.Syntax.CheckArgs instance GHC.Show.Show Language.Docker.Syntax.CheckArgs instance GHC.Classes.Ord Language.Docker.Syntax.AddArgs instance GHC.Classes.Eq Language.Docker.Syntax.AddArgs instance GHC.Show.Show Language.Docker.Syntax.AddArgs instance GHC.Classes.Ord Language.Docker.Syntax.CopyArgs instance GHC.Classes.Eq Language.Docker.Syntax.CopyArgs instance GHC.Show.Show Language.Docker.Syntax.CopyArgs instance GHC.Num.Num Language.Docker.Syntax.Retries instance GHC.Classes.Ord Language.Docker.Syntax.Retries instance GHC.Classes.Eq Language.Docker.Syntax.Retries instance GHC.Show.Show Language.Docker.Syntax.Retries instance GHC.Num.Num Language.Docker.Syntax.Duration instance GHC.Classes.Ord Language.Docker.Syntax.Duration instance GHC.Classes.Eq Language.Docker.Syntax.Duration instance GHC.Show.Show Language.Docker.Syntax.Duration instance GHC.Classes.Ord Language.Docker.Syntax.CopySource instance GHC.Classes.Eq Language.Docker.Syntax.CopySource instance GHC.Show.Show Language.Docker.Syntax.CopySource instance GHC.Classes.Ord Language.Docker.Syntax.Chown instance GHC.Classes.Eq Language.Docker.Syntax.Chown instance GHC.Show.Show Language.Docker.Syntax.Chown instance Data.String.IsString Language.Docker.Syntax.TargetPath instance GHC.Classes.Ord Language.Docker.Syntax.TargetPath instance GHC.Classes.Eq Language.Docker.Syntax.TargetPath instance GHC.Show.Show Language.Docker.Syntax.TargetPath instance Data.String.IsString Language.Docker.Syntax.SourcePath instance GHC.Classes.Ord Language.Docker.Syntax.SourcePath instance GHC.Classes.Eq Language.Docker.Syntax.SourcePath instance GHC.Show.Show Language.Docker.Syntax.SourcePath instance GHC.Show.Show Language.Docker.Syntax.BaseImage instance GHC.Classes.Ord Language.Docker.Syntax.BaseImage instance GHC.Classes.Eq Language.Docker.Syntax.BaseImage instance Data.String.IsString Language.Docker.Syntax.ImageAlias instance GHC.Classes.Ord Language.Docker.Syntax.ImageAlias instance GHC.Classes.Eq Language.Docker.Syntax.ImageAlias instance GHC.Show.Show Language.Docker.Syntax.ImageAlias instance GHC.Classes.Ord Language.Docker.Syntax.Ports instance GHC.Classes.Eq Language.Docker.Syntax.Ports instance GHC.Show.Show Language.Docker.Syntax.Ports instance GHC.Classes.Ord Language.Docker.Syntax.Port instance GHC.Classes.Eq Language.Docker.Syntax.Port instance GHC.Show.Show Language.Docker.Syntax.Port instance GHC.Classes.Ord Language.Docker.Syntax.Protocol instance GHC.Classes.Eq Language.Docker.Syntax.Protocol instance GHC.Show.Show Language.Docker.Syntax.Protocol instance GHC.Exts.IsList Language.Docker.Syntax.Ports module Language.Docker.PrettyPrint -- | Pretty print a Dockerfile to a String prettyPrint :: Dockerfile -> String -- | Pretty print a InstructionPos to a String prettyPrintInstructionPos :: InstructionPos -> String prettyPrintBaseImage :: BaseImage -> Doc prettyPrintPairs :: Pairs -> Doc prettyPrintPair :: (String, String) -> Doc prettyPrintArguments :: Arguments -> Doc prettyPrintJSON :: Arguments -> Doc prettyPrintPort :: Port -> Doc prettyPrintFileList :: NonEmpty SourcePath -> TargetPath -> Doc prettyPrintChown :: Chown -> Doc prettyPrintCopySource :: CopySource -> Doc prettyPrintDuration :: String -> Maybe Duration -> Doc prettyPrintRetries :: Maybe Retries -> Doc prettyPrintInstruction :: Instruction -> Doc module Language.Docker.Parser data CopyFlag FlagChown :: Chown -> CopyFlag FlagSource :: CopySource -> CopyFlag FlagInvalid :: (String, String) -> CopyFlag data CheckFlag FlagInterval :: Duration -> CheckFlag FlagTimeout :: Duration -> CheckFlag FlagStartPeriod :: Duration -> CheckFlag FlagRetries :: Retries -> CheckFlag CFlagInvalid :: (String, String) -> CheckFlag comment :: Parser Instruction taggedImage :: Parser BaseImage digestedImage :: Parser BaseImage untaggedImage :: Parser BaseImage maybeImageAlias :: Parser (Maybe ImageAlias) imageAlias :: Parser ImageAlias baseImage :: Parser BaseImage from :: Parser Instruction cmd :: Parser Instruction copy :: Parser Instruction copyFlag :: Parser CopyFlag chown :: Parser Chown copySource :: Parser CopySource anyFlag :: Parser (String, String) fileList :: String -> (NonEmpty SourcePath -> TargetPath -> Instruction) -> Parser Instruction unexpectedFlag :: String -> String -> Parser a shell :: Parser Instruction stopsignal :: Parser Instruction doubleQuotedValue :: Parser String singleQuotedValue :: Parser String unquotedString :: String -> Parser String singleValue :: String -> Parser String pair :: Parser (String, String) pairsList :: Parser Pairs label :: Parser Instruction arg :: Parser Instruction env :: Parser Instruction pairs :: Parser Pairs singlePair :: Parser Pairs user :: Parser Instruction add :: Parser Instruction expose :: Parser Instruction port :: Parser Port ports :: Parser Ports portRange :: Parser Port portInt :: Parser Port portWithProtocol :: Parser Port portVariable :: Parser Port run :: Parser Instruction untilEol :: Parser String untilOccurrence :: String -> Parser String workdir :: Parser Instruction volume :: Parser Instruction maintainer :: Parser Instruction argumentsExec :: Parser Arguments argumentsShell :: Parser Arguments arguments :: Parser Arguments entrypoint :: Parser Instruction onbuild :: Parser Instruction healthcheck :: Parser Instruction checkFlag :: Parser CheckFlag durationFlag :: String -> Parser Duration retriesFlag :: Parser Retries parseInstruction :: Parser Instruction contents :: Parser a -> Parser a eol :: Parser () dockerfile :: Parser Dockerfile parseString :: String -> Either ParseError Dockerfile parseFile :: String -> IO (Either ParseError Dockerfile) module Language.Docker.EDSL.Types data EBaseImage EUntaggedImage :: String -> (Maybe ImageAlias) -> EBaseImage ETaggedImage :: String -> String -> (Maybe ImageAlias) -> EBaseImage EDigestedImage :: String -> ByteString -> (Maybe ImageAlias) -> EBaseImage data EInstruction next From :: EBaseImage -> next -> EInstruction next AddArgs :: (NonEmpty SourcePath) -> TargetPath -> Chown -> next -> EInstruction next User :: String -> next -> EInstruction next Label :: Pairs -> next -> EInstruction next StopSignal :: String -> next -> EInstruction next CopyArgs :: (NonEmpty SourcePath) -> TargetPath -> Chown -> CopySource -> next -> EInstruction next RunArgs :: Arguments -> next -> EInstruction next CmdArgs :: Arguments -> next -> EInstruction next Shell :: Arguments -> next -> EInstruction next Workdir :: Directory -> next -> EInstruction next Expose :: Ports -> next -> EInstruction next Volume :: String -> next -> EInstruction next EntrypointArgs :: Arguments -> next -> EInstruction next Maintainer :: String -> next -> EInstruction next Env :: Pairs -> next -> EInstruction next Arg :: String -> (Maybe String) -> next -> EInstruction next Comment :: String -> next -> EInstruction next Healthcheck :: Check -> next -> EInstruction next OnBuildRaw :: Instruction -> next -> EInstruction next Embed :: [InstructionPos] -> next -> EInstruction next instance GHC.Base.Functor Language.Docker.EDSL.Types.EInstruction instance GHC.Classes.Ord Language.Docker.EDSL.Types.EBaseImage instance GHC.Classes.Eq Language.Docker.EDSL.Types.EBaseImage instance GHC.Show.Show Language.Docker.EDSL.Types.EBaseImage instance Data.String.IsString Language.Docker.EDSL.Types.EBaseImage module Language.Docker.EDSL -- | The type of Identity based EDSL blocks type EDockerfileM = Free EInstruction -- | The type of free monad EDSL blocks type EDockerfileTM = FreeT EInstruction type EInstructionM = Free EInstruction type EInstructionTM = FreeT EInstruction embed :: forall m_aCPX. MonadFree EInstruction m_aCPX => [InstructionPos] -> m_aCPX () onBuildRaw :: forall m_aCPU. MonadFree EInstruction m_aCPU => Instruction -> m_aCPU () healthcheck :: forall m_aCPR. MonadFree EInstruction m_aCPR => Check -> m_aCPR () comment :: forall m_aCPO. MonadFree EInstruction m_aCPO => String -> m_aCPO () arg :: forall m_aCPK. MonadFree EInstruction m_aCPK => String -> Maybe String -> m_aCPK () env :: forall m_aCPH. MonadFree EInstruction m_aCPH => Pairs -> m_aCPH () maintainer :: forall m_aCPE. MonadFree EInstruction m_aCPE => String -> m_aCPE () entrypointArgs :: forall m_aCPB. MonadFree EInstruction m_aCPB => Arguments -> m_aCPB () volume :: forall m_aCPy. MonadFree EInstruction m_aCPy => String -> m_aCPy () expose :: forall m_aCPv. MonadFree EInstruction m_aCPv => Ports -> m_aCPv () workdir :: forall m_aCPs. MonadFree EInstruction m_aCPs => Directory -> m_aCPs () shell :: forall m_aCPp. MonadFree EInstruction m_aCPp => Arguments -> m_aCPp () cmdArgs :: forall m_aCPm. MonadFree EInstruction m_aCPm => Arguments -> m_aCPm () runArgs :: forall m_aCPj. MonadFree EInstruction m_aCPj => Arguments -> m_aCPj () copyArgs :: forall m_aCPd. MonadFree EInstruction m_aCPd => NonEmpty SourcePath -> TargetPath -> Chown -> CopySource -> m_aCPd () stopSignal :: forall m_aCPa. MonadFree EInstruction m_aCPa => String -> m_aCPa () label :: forall m_aCP7. MonadFree EInstruction m_aCP7 => Pairs -> m_aCP7 () user :: forall m_aCP4. MonadFree EInstruction m_aCP4 => String -> m_aCP4 () addArgs :: forall m_aCOZ. MonadFree EInstruction m_aCOZ => NonEmpty SourcePath -> TargetPath -> Chown -> m_aCOZ () from :: forall m_aCOk. MonadFree EInstruction m_aCOk => EBaseImage -> m_aCOk () 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 -- | Runs the Dockerfile EDSL and returns a Dockerfile you can -- pretty print or manipulate toDockerfile :: EDockerfileM a -> Dockerfile -- | 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") --toDockerfileStr :: EDockerfileM a -> String untagged :: String -> EBaseImage tagged :: String -> String -> EBaseImage digested :: String -> ByteString -> EBaseImage aliased :: EBaseImage -> String -> EBaseImage ports :: [Port] -> Ports tcpPort :: Integer -> Port udpPort :: Integer -> Port variablePort :: String -> Port portRange :: Integer -> Integer -> Port run :: MonadFree EInstruction m => String -> m () entrypoint :: MonadFree EInstruction m => String -> m () cmd :: MonadFree EInstruction m => String -> m () copy :: MonadFree EInstruction m => NonEmpty SourcePath -> TargetPath -> m () add :: MonadFree EInstruction m => NonEmpty SourcePath -> TargetPath -> m () check :: String -> Check interval :: Check -> Integer -> Check timeout :: Check -> Integer -> Check startPeriod :: Check -> Integer -> Check retries :: Check -> Integer -> Check noCheck :: Check -- | 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" --onBuild :: MonadFree EInstruction m => EDockerfileM a -> m () -- | A version of toDockerfile which allows IO actions toDockerfileIO :: MonadIO m => EDockerfileTM m t -> m Dockerfile -- | A version of toDockerfileStr which allows IO actions toDockerfileStrIO :: MonadIO m => EDockerfileTM m t -> m String -- | Just runs the EDSL's writer monad runDockerfileIO :: MonadIO m => EDockerfileTM m t -> m (t, Dockerfile) -- | Runs the EDSL's writer monad and pretty-prints the result runDockerfileStrIO :: MonadIO m => EDockerfileTM m t -> m (t, String) module Language.Docker.Syntax.Lift instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.Check instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.CheckArgs instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.Retries instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.Duration instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.AddArgs instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.CopyArgs instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.CopySource instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.Chown instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.TargetPath instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.SourcePath instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.InstructionPos instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.Instruction instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.BaseImage instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.ImageAlias instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.Ports instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.Port instance Language.Haskell.TH.Syntax.Lift Language.Docker.Syntax.Protocol instance Language.Haskell.TH.Syntax.Lift Data.Time.Clock.Internal.DiffTime.DiffTime instance Language.Haskell.TH.Syntax.Lift (Data.Fixed.Fixed a) instance Language.Haskell.TH.Syntax.Lift a => Language.Haskell.TH.Syntax.Lift (Data.List.NonEmpty.NonEmpty a) module Language.Docker.EDSL.Quasi -- | 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 -- |] --edockerfile :: QuasiQuoter edockerfileE :: String -> ExpQ dockerfile :: QuasiQuoter dockerfileE :: String -> ExpQ module Language.Docker -- | Type of the Dockerfile AST type Dockerfile = [InstructionPos] parseString :: String -> Either ParseError Dockerfile parseFile :: String -> IO (Either ParseError Dockerfile) -- | Pretty print a Dockerfile to a String prettyPrint :: Dockerfile -> String -- | Pretty print a InstructionPos to a String prettyPrintInstructionPos :: InstructionPos -> 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") --toDockerfileStr :: EDockerfileM a -> String -- | Runs the Dockerfile EDSL and returns a Dockerfile you can -- pretty print or manipulate toDockerfile :: EDockerfileM a -> Dockerfile -- | A version of toDockerfileStr which allows IO actions toDockerfileStrIO :: MonadIO m => EDockerfileTM m t -> m String -- | A version of toDockerfile which allows IO actions toDockerfileIO :: MonadIO m => EDockerfileTM m t -> m Dockerfile -- | Just runs the EDSL's writer monad runDockerfileIO :: MonadIO m => EDockerfileTM m t -> m (t, Dockerfile) -- | Runs the EDSL's writer monad and pretty-prints the result runDockerfileStrIO :: MonadIO m => EDockerfileTM m t -> m (t, String) -- | Lift a computation from the IO monad. liftIO :: MonadIO m => forall a. () => IO a -> m a from :: forall m_aCOk. MonadFree EInstruction m_aCOk => EBaseImage -> m_aCOk () tagged :: String -> String -> EBaseImage untagged :: String -> EBaseImage digested :: String -> ByteString -> EBaseImage aliased :: EBaseImage -> String -> EBaseImage add :: MonadFree EInstruction m => NonEmpty SourcePath -> TargetPath -> m () user :: forall m_aCP4. MonadFree EInstruction m_aCP4 => String -> m_aCP4 () label :: forall m_aCP7. MonadFree EInstruction m_aCP7 => Pairs -> m_aCP7 () stopSignal :: forall m_aCPa. MonadFree EInstruction m_aCPa => String -> m_aCPa () copy :: MonadFree EInstruction m => NonEmpty SourcePath -> TargetPath -> m () run :: MonadFree EInstruction m => String -> m () runArgs :: forall m_aCPj. MonadFree EInstruction m_aCPj => Arguments -> m_aCPj () cmd :: MonadFree EInstruction m => String -> m () cmdArgs :: forall m_aCPm. MonadFree EInstruction m_aCPm => Arguments -> m_aCPm () healthcheck :: forall m_aCPR. MonadFree EInstruction m_aCPR => Check -> m_aCPR () check :: String -> Check interval :: Check -> Integer -> Check timeout :: Check -> Integer -> Check startPeriod :: Check -> Integer -> Check retries :: Check -> Integer -> Check workdir :: forall m_aCPs. MonadFree EInstruction m_aCPs => Directory -> m_aCPs () expose :: forall m_aCPv. MonadFree EInstruction m_aCPv => Ports -> m_aCPv () ports :: [Port] -> Ports tcpPort :: Integer -> Port udpPort :: Integer -> Port variablePort :: String -> Port volume :: forall m_aCPy. MonadFree EInstruction m_aCPy => String -> m_aCPy () entrypoint :: MonadFree EInstruction m => String -> m () entrypointArgs :: forall m_aCPB. MonadFree EInstruction m_aCPB => Arguments -> m_aCPB () maintainer :: forall m_aCPE. MonadFree EInstruction m_aCPE => String -> m_aCPE () env :: forall m_aCPH. MonadFree EInstruction m_aCPH => Pairs -> m_aCPH () arg :: forall m_aCPK. MonadFree EInstruction m_aCPK => String -> Maybe String -> m_aCPK () comment :: forall m_aCPO. MonadFree EInstruction m_aCPO => String -> m_aCPO () -- | 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" --onBuild :: MonadFree EInstruction m => EDockerfileM a -> m () onBuildRaw :: forall m_aCPU. MonadFree EInstruction m_aCPU => Instruction -> m_aCPU () embed :: forall m_aCPX. MonadFree EInstruction m_aCPX => [InstructionPos] -> m_aCPX () -- | 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 -- |] --edockerfile :: QuasiQuoter -- | The type of Identity based EDSL blocks type EDockerfileM = Free EInstruction -- | The type of free monad EDSL blocks type EDockerfileTM = FreeT EInstruction data EBaseImage EUntaggedImage :: String -> (Maybe ImageAlias) -> EBaseImage ETaggedImage :: String -> String -> (Maybe ImageAlias) -> EBaseImage EDigestedImage :: String -> ByteString -> (Maybe ImageAlias) -> EBaseImage dockerfile :: QuasiQuoter -- | All commands available in Dockerfiles data Instruction From :: BaseImage -> Instruction Add :: AddArgs -> Instruction User :: String -> Instruction Label :: Pairs -> Instruction Stopsignal :: String -> Instruction Copy :: CopyArgs -> Instruction Run :: Arguments -> Instruction Cmd :: Arguments -> Instruction Shell :: Arguments -> Instruction Workdir :: Directory -> Instruction Expose :: Ports -> Instruction Volume :: String -> Instruction Entrypoint :: Arguments -> Instruction Maintainer :: String -> Instruction Env :: Pairs -> Instruction Arg :: String -> (Maybe String) -> Instruction Healthcheck :: Check -> Instruction Comment :: String -> Instruction OnBuild :: Instruction -> Instruction -- | Instruction with additional location information required for -- creating good check messages data InstructionPos InstructionPos :: Instruction -> Filename -> Linenumber -> InstructionPos [$sel:instruction:InstructionPos] :: InstructionPos -> Instruction [$sel:sourcename:InstructionPos] :: InstructionPos -> Filename [$sel:lineNumber:InstructionPos] :: InstructionPos -> Linenumber data BaseImage UntaggedImage :: Image -> (Maybe ImageAlias) -> BaseImage TaggedImage :: Image -> Tag -> (Maybe ImageAlias) -> BaseImage DigestedImage :: Image -> ByteString -> (Maybe ImageAlias) -> BaseImage newtype SourcePath SourcePath :: String -> SourcePath [$sel:unSourcePath:SourcePath] :: SourcePath -> String newtype TargetPath TargetPath :: String -> TargetPath [$sel:unTargetPath:TargetPath] :: TargetPath -> String data Chown Chown :: String -> Chown NoChown :: Chown data CopySource CopySource :: String -> CopySource NoSource :: CopySource data CopyArgs CopyArgs :: NonEmpty SourcePath -> TargetPath -> Chown -> CopySource -> CopyArgs [$sel:sourcePaths:CopyArgs] :: CopyArgs -> NonEmpty SourcePath [$sel:targetPath:CopyArgs] :: CopyArgs -> TargetPath [$sel:chownFlag:CopyArgs] :: CopyArgs -> Chown [$sel:sourceFlag:CopyArgs] :: CopyArgs -> CopySource data AddArgs AddArgs :: NonEmpty SourcePath -> TargetPath -> Chown -> AddArgs [$sel:sourcePaths:AddArgs] :: AddArgs -> NonEmpty SourcePath [$sel:targetPath:AddArgs] :: AddArgs -> TargetPath [$sel:chownFlag:AddArgs] :: AddArgs -> Chown data Check Check :: CheckArgs -> Check NoCheck :: Check data CheckArgs CheckArgs :: Arguments -> Maybe Duration -> Maybe Duration -> Maybe Duration -> Maybe Retries -> CheckArgs [$sel:checkCommand:CheckArgs] :: CheckArgs -> Arguments [$sel:interval:CheckArgs] :: CheckArgs -> Maybe Duration [$sel:timeout:CheckArgs] :: CheckArgs -> Maybe Duration [$sel:startPeriod:CheckArgs] :: CheckArgs -> Maybe Duration [$sel:retries:CheckArgs] :: CheckArgs -> Maybe Retries type Image = String type Tag = String data Ports type Directory = String type Arguments = [String] type Pairs = [(String, String)] type Filename = String type Linenumber = Int -- | 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. data ParseError :: * instructionPos :: Instruction -> InstructionPos module Language.Docker.Predef appendLnIfMissing :: FilePath -> Text -> IO () dockerIgnore :: Text -> IO () addGlob :: (MonadIO m, MonadFree EInstruction m) => String -> TargetPath -> m () copyGlob :: (MonadIO m, MonadFree EInstruction m) => String -> TargetPath -> m () stackBuild :: (Monad m, MonadIO m, MonadFree EInstruction m) => m () stackBuild' :: (Monad m, MonadIO m, MonadFree EInstruction m) => String -> m () -> m () nodejs :: (Monad m, MonadIO m, MonadFree EInstruction m) => m () nodejs' :: (Monad m, MonadIO m, MonadFree EInstruction m) => String -> m () -> m ()