Safe Haskell	None
Language	Haskell2010

Funflow.Tasks.Docker

Description

Run commands using Docker

Synopsis

Documentation

Configure what task to run in Docker

Constructors

DockerTaskConfig
Fields image :: Text The name of the docker image command :: Text The command to run args :: [Arg] The arguments to pass to the command run inside of the container

Constructors

Instances details

IsFlow DockerTask Source #
Instance details Defined in Funflow.Flow Methods toFlow :: DockerTask i o -> Flow i o Source #

Input to a Docker task to finalize its configuration

Constructors

DockerTaskInput
Fields inputBindings :: [VolumeBinding] Input items to mount on the container argsVals :: Map String Text A map representing how to fill the argument placeholders (placeholder label -> argument value)

Instances details

Eq DockerTaskInput Source #
Instance details Defined in Funflow.Tasks.Docker Methods (==) :: DockerTaskInput -> DockerTaskInput -> Bool # (/=) :: DockerTaskInput -> DockerTaskInput -> Bool #
Show DockerTaskInput Source #
Instance details Defined in Funflow.Tasks.Docker Methods showsPrec :: Int -> DockerTaskInput -> ShowS # show :: DockerTaskInput -> String # showList :: [DockerTaskInput] -> ShowS #
Semigroup DockerTaskInput Source #	Combine task inputs by combining the collections they contain. This treats `inputBindings` as a "priority list"-like structure in case of repeat occurrence of the same mount path. Specifically, the item associated with a particular path will be the first one, left-to-right, from the `inputBinding`s being combined. Analogous for `argsVals`, in accordance with ordinary `Semigroup Map`.
Instance details Defined in Funflow.Tasks.Docker Methods (<>) :: DockerTaskInput -> DockerTaskInput -> DockerTaskInput # sconcat :: NonEmpty DockerTaskInput -> DockerTaskInput # stimes :: Integral b => b -> DockerTaskInput -> DockerTaskInput #
Monoid DockerTaskInput Source #	An empty task input is one with fields of empty collections.
Instance details Defined in Funflow.Tasks.Docker Methods mempty :: DockerTaskInput # mappend :: DockerTaskInput -> DockerTaskInput -> DockerTaskInput # mconcat :: [DockerTaskInput] -> DockerTaskInput #

Represent how to bind a directory from cas-store (CS.Item) to a container internal file system

Constructors

VolumeBinding
Fields item :: Item mount :: Path Abs Dir

Instances details

Eq VolumeBinding Source #
Instance details Defined in Funflow.Tasks.Docker Methods (==) :: VolumeBinding -> VolumeBinding -> Bool # (/=) :: VolumeBinding -> VolumeBinding -> Bool #
Ord VolumeBinding Source #
Instance details Defined in Funflow.Tasks.Docker Methods compare :: VolumeBinding -> VolumeBinding -> Ordering # (<) :: VolumeBinding -> VolumeBinding -> Bool # (<=) :: VolumeBinding -> VolumeBinding -> Bool # (>) :: VolumeBinding -> VolumeBinding -> Bool # (>=) :: VolumeBinding -> VolumeBinding -> Bool # max :: VolumeBinding -> VolumeBinding -> VolumeBinding # min :: VolumeBinding -> VolumeBinding -> VolumeBinding #
Show VolumeBinding Source #
Instance details Defined in Funflow.Tasks.Docker Methods showsPrec :: Int -> VolumeBinding -> ShowS # show :: VolumeBinding -> String # showList :: [VolumeBinding] -> ShowS #

Represent an argument to pass to the command run inside of a Docker container

Constructors

Arg (Configurable Text)	Raw text argument
Placeholder String	A placeholder for an argument to be passed as runtime input to the task (filled by `argsVals`)

Instances details

IsString Arg Source #
Instance details Defined in Funflow.Tasks.Docker Methods fromString :: String -> Arg #

Renders an Arg with external configurations

Extracts a ConfigKey from an Arg, if it exists.