system-extra-0.1.0: A bunch of system utilities used by other projects

Safe Haskell	Safe
Language	Haskell2010

System.Docker

Description

Provides types and utility functions to work with docker containers and images

Synopsis

Documentation

newtype ImageName Source #

A Docker image reference

Constructors

ImageName
Fields imageName :: String

Instances

Eq ImageName Source #
Methods (==) :: ImageName -> ImageName -> Bool # (/=) :: ImageName -> ImageName -> Bool #
Read ImageName Source #
Methods readsPrec :: Int -> ReadS ImageName # readList :: ReadS [ImageName] # readPrec :: ReadPrec ImageName # readListPrec :: ReadPrec [ImageName] #
Show ImageName Source #
Methods showsPrec :: Int -> ImageName -> ShowS # show :: ImageName -> String # showList :: [ImageName] -> ShowS #

newtype ContainerName Source #

A Docker container name

Constructors

ContainerName
Fields containerName :: String

Instances

Eq ContainerName Source #
Methods (==) :: ContainerName -> ContainerName -> Bool # (/=) :: ContainerName -> ContainerName -> Bool #
Read ContainerName Source #
Methods readsPrec :: Int -> ReadS ContainerName # readList :: ReadS [ContainerName] # readPrec :: ReadPrec ContainerName # readListPrec :: ReadPrec [ContainerName] #
Show ContainerName Source #
Methods showsPrec :: Int -> ContainerName -> ShowS # show :: ContainerName -> String # showList :: [ContainerName] -> ShowS #

dockerParams :: RunParam -> [String] Source #

data RunParam Source #

Constructors

Port
Fields hostInterface :: IPInterface hostPort :: Port containerPort :: Port proto :: IPProto
Volume
Fields hostPath :: FilePath containerPath :: FilePath
Link
Fields linkedName :: ContainerName linkeeName :: ContainerName
Name
Fields contName :: ContainerName
Image
Fields dockerImage :: ImageName
Restart
Fields restartPolicy :: RestartPolicy
LogConfig
Fields logDriver :: LogDriver logOptions :: [LogOption]
RunParam :-- RunParam infixl 2
Detach
NoParam

Instances

Monoid RunParam Source #
Methods mempty :: RunParam # mappend :: RunParam -> RunParam -> RunParam # mconcat :: [RunParam] -> RunParam #

data LogDriver Source #

Available drivers

see http://docs.docker.com/engine/reference/logging/overview/#the-json-file-options

Constructors

JsonFile
Syslog
Journald
Gelf
Fluentd
Awslogs

Instances

Show LogDriver Source #
Methods showsPrec :: Int -> LogDriver -> ShowS # show :: LogDriver -> String # showList :: [LogDriver] -> ShowS #

type LogOption = (String, String) Source #

data RestartPolicy Source #

Constructors

NeverRestart
OnFailure
Fields maxRetries :: Int
AlwaysRestart

Instances

Show RestartPolicy Source #
Methods showsPrec :: Int -> RestartPolicy -> ShowS # show :: RestartPolicy -> String # showList :: [RestartPolicy] -> ShowS #

ip :: IPInterface -> RunParam -> RunParam Source #

port :: Port -> RunParam Source #

udp :: RunParam -> RunParam Source #

volume :: FilePath -> FilePath -> RunParam Source #

link :: ContainerName -> ContainerName -> RunParam Source #

name :: String -> RunParam Source #

detach :: RunParam Source #

restart :: RestartPolicy -> RunParam Source #

logConfig :: LogDriver -> [LogOption] -> RunParam Source #

container :: [RunParam] -> RunParam Source #