Safe Haskell	None
Language	Haskell2010

Docker.Client.Types

Synopsis

data Endpoint
- = VersionEndpoint
- | ListContainersEndpoint ListOpts
- | ListImagesEndpoint ListOpts
- | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
- | StartContainerEndpoint StartOpts ContainerID
- | StopContainerEndpoint Timeout ContainerID
- | WaitContainerEndpoint ContainerID
- | KillContainerEndpoint Signal ContainerID
- | RestartContainerEndpoint Timeout ContainerID
- | PauseContainerEndpoint ContainerID
- | UnpauseContainerEndpoint ContainerID
- | ContainerLogsEndpoint LogOpts Bool ContainerID
- | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
- | InspectContainerEndpoint ContainerID
- | BuildImageEndpoint BuildOpts FilePath
- | CreateImageEndpoint Text Tag (Maybe Text)
- | DeleteImageEndpoint ImageDeleteOpts ImageID
- | CreateNetworkEndpoint CreateNetworkOpts
- | RemoveNetworkEndpoint NetworkID
type URL = Text
type ApiVersion = Text
data ContainerID
fromContainerID :: ContainerID -> Text
toContainerID :: Text -> Maybe ContainerID
data ImageID
fromImageID :: ImageID -> Text
toImageID :: Text -> Maybe ImageID
data NetworkID
fromNetworkID :: NetworkID -> Text
toNetworkID :: Text -> Maybe NetworkID
data Timeout
- = Timeout Integer
- | DefaultTimeout
data StatusCode = StatusCode Int
data Signal
- = SIGHUP
- | SIGINT
- | SIGQUIT
- | SIGSTOP
- | SIGTERM
- | SIGUSR1
- | SIG Integer
- | SIGKILL
data ContainerDetails = ContainerDetails {
- appArmorProfile :: Text
- args :: [Text]
- containerDetailsConfig :: ContainerConfig
- created :: UTCTime
- driver :: Text
- containerDetailsHostConfig :: HostConfig
- hostnamePath :: FilePath
- hostsPath :: FilePath
- logPath :: FilePath
- containerDetailsId :: ContainerID
- containerDetailsImage :: ImageID
- mountLabel :: Text
- name :: Text
- networkSettings :: NetworkSettings
- path :: FilePath
- processLabel :: Text
- resolveConfPath :: FilePath
- restartCount :: Int
- containerDetailsState :: ContainerState
- mounts :: [Mount]
}
data DockerClientOpts = DockerClientOpts {
- apiVer :: ApiVersion
- baseUrl :: URL
}
defaultClientOpts :: DockerClientOpts
data ListOpts = ListOpts {
- all :: Bool
}
defaultListOpts :: ListOpts
data DockerVersion = DockerVersion {
- version :: Text
- apiVersion :: ApiVersion
- gitCommit :: Text
- goVersion :: Text
- os :: Text
- arch :: Text
- kernelVersion :: Text
- buildTime :: Text
}
data ContainerPortInfo = ContainerPortInfo {
- ipAddressInfo :: Maybe Text
- privatePortInfo :: Port
- publicPortInfo :: Maybe Port
- portTypeInfo :: Maybe PortType
}
data Container = Container {
- containerId :: ContainerID
- containerNames :: [Text]
- containerImageName :: Text
- containerImageId :: ImageID
- containerCommand :: Text
- containerCreatedAt :: Int
- containerState :: State
- containerStatus :: Maybe Text
- containerPorts :: [ContainerPortInfo]
- containerLabels :: [Label]
- containerNetworks :: [Network]
- containerMounts :: [Mount]
}
data ContainerState = ContainerState {
- containerError :: Text
- exitCode :: Int
- finishedAt :: Maybe UTCTime
- oomKilled :: Bool
- dead :: Bool
- paused :: Bool
- pid :: Int
- restarting :: Bool
- running :: Bool
- startedAt :: UTCTime
- state :: State
}
data State
- = Created
- | Restarting
- | Running
- | Paused
- | Exited
- | Dead
type Digest = Text
data Label = Label Name Value
type Tag = Text
data Image = DockerImage {
- imageId :: ImageID
- imageCreated :: Integer
- imageParentId :: Maybe ImageID
- imageRepoTags :: [Tag]
- imageRepoDigests :: [Digest]
- imageSize :: Integer
- imageVirtualSize :: Integer
- imageLabels :: [Label]
}
data Entrypoint = Entrypoint [Text]
dropImagePrefix :: [a] -> [a]
data CreateOpts = CreateOpts {
- containerConfig :: ContainerConfig
- hostConfig :: HostConfig
- networkingConfig :: NetworkingConfig
}
data BuildOpts = BuildOpts {
- buildImageName :: Text
- buildDockerfileName :: Text
- buildQuiet :: Bool
- buildNoCache :: Bool
- buildRemoveItermediate :: Bool
- buildForceRemoveIntermediate :: Bool
- buildPullParent :: Bool
}
defaultBuildOpts :: Text -> BuildOpts
defaultCreateOpts :: Text -> CreateOpts
data DetachKeys
- = WithCtrl Char
- | WithoutCtrl Char
- | DefaultDetachKey
data StartOpts = StartOpts {
- detachKeys :: DetachKeys
}
defaultStartOpts :: StartOpts
data ContainerDeleteOpts = ContainerDeleteOpts {
- deleteVolumes :: Bool
- force :: Bool
}
defaultContainerDeleteOpts :: ContainerDeleteOpts
data ImageDeleteOpts = ImageDeleteOpts
defaultImageDeleteOpts :: ImageDeleteOpts
type Timestamp = Integer
data TailLogOpt
- = Tail Integer
- | All
data LogOpts = LogOpts {
- stdout :: Bool
- stderr :: Bool
- since :: Maybe Timestamp
- timestamps :: Bool
- tail :: TailLogOpt
}
defaultLogOpts :: LogOpts
data CreateNetworkOpts = CreateNetworkOpts {
- createNetworkName :: Text
- createNetworkCheckDuplicate :: Bool
- createNetworkDriver :: Text
- createNetworkInternal :: Bool
- createNetworkEnableIPv6 :: Bool
}
defaultCreateNetworkOpts :: Text -> CreateNetworkOpts
data VolumePermission
- = ReadWrite
- | ReadOnly
data Bind = Bind {
- hostSrc :: Text
- containerDest :: Text
- volumePermission :: Maybe VolumePermission
}
newtype Volume = Volume FilePath
data Device = Device {
- pathOnHost :: FilePath
- pathInContainer :: FilePath
- cgroupPermissions :: Text
}
type ContainerName = Text
data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission)
data Link = Link Text (Maybe Text)
data LogDriverType
- = JsonFile
- | Syslog
- | Journald
- | Gelf
- | Fluentd
- | AwsLogs
- | Splunk
- | Etwlogs
- | LoggingDisabled
data LogDriverOption = LogDriverOption Name Value
data LogDriverConfig = LogDriverConfig LogDriverType [LogDriverOption]
data NetworkMode
- = NetworkBridge
- | NetworkHost
- | NetworkDisabled
- | NetworkNamed Text
data PortType
- = TCP
- | UDP
data Network = Network NetworkMode NetworkOptions
data NetworkSettings = NetworkSettings {
- networkSettingsBridge :: Text
- networkSettingsSandboxId :: Text
- networkSettingsHairpinMode :: Bool
- networkSettingsLinkLocalIPv6Address :: Text
- networkSettingsLinkLocalIPv6PrefixLen :: Int
- networkSettingsPorts :: [PortBinding]
- networkSettingsSandboxKey :: Text
- networkSettingsSecondaryIPAddresses :: Maybe [Text]
- networkSettingsSecondaryIPv6Addresses :: Maybe [Text]
- networkSettingsEndpointID :: Text
- networkSettingsGateway :: Text
- networkSettingsGlobalIPv6Address :: Text
- networkSettingsGlobalIPv6PrefixLen :: Int
- networkSettingsIpAddress :: Text
- networkSettingsIpPrefixLen :: Int
- networkSettingsIpv6Gateway :: Text
- networkSettingsMacAddress :: Text
- networkSettingsNetworks :: [Network]
}
data NetworkOptions = NetworkOptions {
- networkOptionsId :: Text
- networkOptionsEndpointId :: Text
- networkOptionsGateway :: Text
- networkOptionsIpAddress :: Text
- networkOptionsIpPrefixLen :: Int
- networkOptionsIpV6Gateway :: Maybe Text
- networkOptionsGlobalIPv6Address :: Maybe Text
- networkOptionsGlobalIPv6PrefixLen :: Maybe Int
- networkOptionsMacAddress :: Text
}
data Mount = Mount {
- mountName :: Maybe Text
- mountSource :: FilePath
- mountDestination :: FilePath
- mountDriver :: Maybe Text
- mountRW :: Bool
- mountPropogation :: Text
}
data PortBinding = PortBinding {
- containerPort :: Port
- portType :: PortType
- hostPorts :: [HostPort]
}
data HostPort = HostPort {
- hostIp :: Text
- hostPost :: Port
}
type RetryCount = Integer
data RestartPolicy
- = RestartAlways
- | RestartUnlessStopped
- | RestartOnFailure RetryCount
- | RestartOff
data Isolation
- = Default
- | Process
- | Hyperv
newtype UTSMode = UTSMode Text
data HostConfig = HostConfig {
- binds :: [Bind]
- containerIDFile :: Maybe FilePath
- logConfig :: LogDriverConfig
- networkMode :: NetworkMode
- portBindings :: [PortBinding]
- restartPolicy :: RestartPolicy
- volumeDriver :: Maybe Text
- volumesFrom :: [VolumeFrom]
- capAdd :: [Text]
- capDrop :: [Text]
- dns :: [Text]
- dnsOptions :: [Text]
- dnsSearch :: [Text]
- extraHosts :: [Text]
- ipcMode :: Maybe Text
- links :: [Link]
- oomScoreAdj :: Maybe Integer
- privileged :: Bool
- publishAllPorts :: Bool
- readonlyRootfs :: Bool
- securityOpt :: [Text]
- shmSize :: Maybe Integer
- resources :: ContainerResources
}
defaultHostConfig :: HostConfig
newtype NetworkingConfig = NetworkingConfig {
- endpointsConfig :: HashMap EndpointName EndpointConfig
}
newtype EndpointConfig = EndpointConfig [Alias]
data Ulimit = Ulimit {
- ulimitName :: Text
- ulimitSoft :: Integer
- ulimitHard :: Integer
}
data ContainerResources = ContainerResources {
- cpuShares :: Maybe Integer
- blkioWeight :: Maybe Integer
- blkioWeightDevice :: Maybe [DeviceWeight]
- blkioDeviceReadBps :: Maybe [DeviceRate]
- blkioDeviceWriteBps :: Maybe [DeviceRate]
- blkioDeviceReadIOps :: Maybe [DeviceRate]
- blkioDeviceWriteIOps :: Maybe [DeviceRate]
- cpuPeriod :: Maybe Integer
- cpusetCpus :: Maybe Text
- cpusetMems :: Maybe Text
- devices :: [Device]
- kernelMemory :: Maybe MemoryConstraint
- memory :: Maybe MemoryConstraint
- memoryReservation :: Maybe MemoryConstraint
- memorySwap :: Maybe MemoryConstraint
- oomKillDisable :: Maybe Bool
- ulimits :: [Ulimit]
}
defaultContainerResources :: ContainerResources
type Port = Integer
type Name = Text
type Value = Text
data EnvVar = EnvVar Name Value
data ContainerConfig = ContainerConfig {
- hostname :: Maybe Text
- domainname :: Maybe Text
- user :: Maybe Text
- attachStdin :: Bool
- attachStdout :: Bool
- attachStderr :: Bool
- exposedPorts :: [ExposedPort]
- tty :: Bool
- openStdin :: Bool
- stdinOnce :: Bool
- env :: [EnvVar]
- cmd :: [Text]
- image :: Text
- volumes :: [Volume]
- workingDir :: Maybe FilePath
- entrypoint :: Entrypoint
- networkDisabled :: Maybe Bool
- macAddress :: Maybe Text
- labels :: [Label]
- stopSignal :: Signal
}
defaultContainerConfig :: Text -> ContainerConfig
data ExposedPort = ExposedPort Port PortType
data DeviceWeight = DeviceWeight {
- deviceWeightPath :: FilePath
- deviceWeightWeight :: Text
}
data DeviceRate = DeviceRate {
- deviceRatePath :: FilePath
- deviceRateRate :: Text
}
addPortBinding :: PortBinding -> CreateOpts -> CreateOpts
addExposedPort :: ExposedPort -> CreateOpts -> CreateOpts
addBind :: Bind -> CreateOpts -> CreateOpts
setCmd :: Text -> CreateOpts -> CreateOpts
addLink :: Link -> CreateOpts -> CreateOpts
addVolume :: Volume -> CreateOpts -> CreateOpts
addVolumeFrom :: VolumeFrom -> CreateOpts -> CreateOpts
data MemoryConstraint = MemoryConstraint Integer MemoryConstraintSize
data MemoryConstraintSize
- = B
- | MB
- | GB

Documentation

data Endpoint #

List of Docker Engine API endpoints

Constructors

VersionEndpoint
ListContainersEndpoint ListOpts
ListImagesEndpoint ListOpts
CreateContainerEndpoint CreateOpts (Maybe ContainerName)
StartContainerEndpoint StartOpts ContainerID
StopContainerEndpoint Timeout ContainerID
WaitContainerEndpoint ContainerID
KillContainerEndpoint Signal ContainerID
RestartContainerEndpoint Timeout ContainerID
PauseContainerEndpoint ContainerID
UnpauseContainerEndpoint ContainerID
ContainerLogsEndpoint LogOpts Bool ContainerID	Second argument (Bool) is whether to follow which is currently hardcoded to False. See note in `getContainerLogs` for explanation why.
DeleteContainerEndpoint ContainerDeleteOpts ContainerID
InspectContainerEndpoint ContainerID
BuildImageEndpoint BuildOpts FilePath
CreateImageEndpoint Text Tag (Maybe Text)	Either pull an image from docker hub or imports an image from a tarball (or URL)
DeleteImageEndpoint ImageDeleteOpts ImageID
CreateNetworkEndpoint CreateNetworkOpts
RemoveNetworkEndpoint NetworkID

Instances

Eq Endpoint #
Instance details Defined in Docker.Client.Types Methods (==) :: Endpoint -> Endpoint -> Bool # (/=) :: Endpoint -> Endpoint -> Bool #
Show Endpoint #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> Endpoint -> ShowS # show :: Endpoint -> String # showList :: [Endpoint] -> ShowS #

type URL = Text #

We should newtype this

type ApiVersion = Text #

We should newtype this

data ContainerID #

ID of a contianer

Instances

Eq ContainerID #
Instance details Defined in Docker.Client.Types Methods (==) :: ContainerID -> ContainerID -> Bool # (/=) :: ContainerID -> ContainerID -> Bool #
Show ContainerID #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> ContainerID -> ShowS # show :: ContainerID -> String # showList :: [ContainerID] -> ShowS #
ToJSON ContainerID #
Instance details Defined in Docker.Client.Types Methods toJSON :: ContainerID -> Value # toEncoding :: ContainerID -> Encoding # toJSONList :: [ContainerID] -> Value # toEncodingList :: [ContainerID] -> Encoding #
FromJSON ContainerID #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser ContainerID # parseJSONList :: Value -> Parser [ContainerID] #

fromContainerID :: ContainerID -> Text #

Used for extracting the id of the container from the newtype

toContainerID :: Text -> Maybe ContainerID #

Used for parsing a Text value into a ContainerID. We apply some basic validation here.

data ImageID #

Instances

Eq ImageID #
Instance details Defined in Docker.Client.Types Methods (==) :: ImageID -> ImageID -> Bool # (/=) :: ImageID -> ImageID -> Bool #
Show ImageID #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> ImageID -> ShowS # show :: ImageID -> String # showList :: [ImageID] -> ShowS #
ToJSON ImageID #
Instance details Defined in Docker.Client.Types Methods toJSON :: ImageID -> Value # toEncoding :: ImageID -> Encoding # toJSONList :: [ImageID] -> Value # toEncodingList :: [ImageID] -> Encoding #
FromJSON ImageID #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser ImageID # parseJSONList :: Value -> Parser [ImageID] #

fromImageID :: ImageID -> Text #

Used for extracting the id of the image from the newtype.

toImageID :: Text -> Maybe ImageID #

Helper function used for parsing a Text value into an ImageID. For now just basic validation is used.

data NetworkID #

Instances

Eq NetworkID #
Instance details Defined in Docker.Client.Types Methods (==) :: NetworkID -> NetworkID -> Bool # (/=) :: NetworkID -> NetworkID -> Bool #
Show NetworkID #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> NetworkID -> ShowS # show :: NetworkID -> String # showList :: [NetworkID] -> ShowS #
ToJSON NetworkID #
Instance details Defined in Docker.Client.Types Methods toJSON :: NetworkID -> Value # toEncoding :: NetworkID -> Encoding # toJSONList :: [NetworkID] -> Value # toEncodingList :: [NetworkID] -> Encoding #
FromJSON NetworkID #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser NetworkID # parseJSONList :: Value -> Parser [NetworkID] #

fromNetworkID :: NetworkID -> Text #

Used for extracting the id of the container from the newtype

toNetworkID :: Text -> Maybe NetworkID #

Used for parsing a Text value into a NetworkID.

data Timeout #

Timeout used for stopping a container. DefaultTimeout is 10 seconds.

Constructors

Timeout Integer
DefaultTimeout

Instances

Eq Timeout #
Instance details Defined in Docker.Client.Types Methods (==) :: Timeout -> Timeout -> Bool # (/=) :: Timeout -> Timeout -> Bool #
Show Timeout #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> Timeout -> ShowS # show :: Timeout -> String # showList :: [Timeout] -> ShowS #

data StatusCode #

Constructors

StatusCode Int

Instances

ToJSON StatusCode #
Instance details Defined in Docker.Client.Types Methods toJSON :: StatusCode -> Value # toEncoding :: StatusCode -> Encoding # toJSONList :: [StatusCode] -> Value # toEncodingList :: [StatusCode] -> Encoding #
FromJSON StatusCode #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser StatusCode # parseJSONList :: Value -> Parser [StatusCode] #

data Signal #

Signal used for sending to the process running in the container. The default signal is SIGTERM.

Constructors

SIGHUP
SIGINT
SIGQUIT
SIGSTOP
SIGTERM
SIGUSR1
SIG Integer
SIGKILL

Instances

Eq Signal #
Instance details Defined in Docker.Client.Types Methods (==) :: Signal -> Signal -> Bool # (/=) :: Signal -> Signal -> Bool #
Show Signal #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> Signal -> ShowS # show :: Signal -> String # showList :: [Signal] -> ShowS #
ToJSON Signal #
Instance details Defined in Docker.Client.Types Methods toJSON :: Signal -> Value # toEncoding :: Signal -> Encoding # toJSONList :: [Signal] -> Value # toEncodingList :: [Signal] -> Encoding #
FromJSON Signal #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser Signal # parseJSONList :: Value -> Parser [Signal] #

data ContainerDetails #

Constructors

ContainerDetails

Fields

appArmorProfile :: Text
args :: [Text]
containerDetailsConfig :: ContainerConfig
created :: UTCTime
driver :: Text
containerDetailsHostConfig :: HostConfig
hostnamePath :: FilePath
hostsPath :: FilePath
logPath :: FilePath
containerDetailsId :: ContainerID
containerDetailsImage :: ImageID
mountLabel :: Text
name :: Text
networkSettings :: NetworkSettings
path :: FilePath
processLabel :: Text
resolveConfPath :: FilePath
restartCount :: Int
containerDetailsState :: ContainerState
mounts :: [Mount]

Instances

Eq ContainerDetails #
Instance details Defined in Docker.Client.Types Methods (==) :: ContainerDetails -> ContainerDetails -> Bool # (/=) :: ContainerDetails -> ContainerDetails -> Bool #
Show ContainerDetails #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> ContainerDetails -> ShowS # show :: ContainerDetails -> String # showList :: [ContainerDetails] -> ShowS #
Generic ContainerDetails #
Instance details Defined in Docker.Client.Types Associated Types type Rep ContainerDetails :: * -> * # Methods from :: ContainerDetails -> Rep ContainerDetails x # to :: Rep ContainerDetails x -> ContainerDetails #
FromJSON ContainerDetails #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser ContainerDetails # parseJSONList :: Value -> Parser [ContainerDetails] #
type Rep ContainerDetails #
Instance details Defined in Docker.Client.Types type Rep ContainerDetails = D1 (MetaData "ContainerDetails" "Docker.Client.Types" "docker-0.6.0.0-GtJwIiAfbAs4xgCOTSUGuQ" False) (C1 (MetaCons "ContainerDetails" PrefixI True) ((((S1 (MetaSel (Just "appArmorProfile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: S1 (MetaSel (Just "args") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])) :: (S1 (MetaSel (Just "containerDetailsConfig") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ContainerConfig) :: (S1 (MetaSel (Just "created") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UTCTime) :: S1 (MetaSel (Just "driver") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))) :: ((S1 (MetaSel (Just "containerDetailsHostConfig") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HostConfig) :: S1 (MetaSel (Just "hostnamePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :: (S1 (MetaSel (Just "hostsPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :: (S1 (MetaSel (Just "logPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :: S1 (MetaSel (Just "containerDetailsId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ContainerID))))) :: (((S1 (MetaSel (Just "containerDetailsImage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ImageID) :: S1 (MetaSel (Just "mountLabel") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :: (S1 (MetaSel (Just "name") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: (S1 (MetaSel (Just "networkSettings") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 NetworkSettings) :: S1 (MetaSel (Just "path") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)))) :: ((S1 (MetaSel (Just "processLabel") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: S1 (MetaSel (Just "resolveConfPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :: (S1 (MetaSel (Just "restartCount") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: (S1 (MetaSel (Just "containerDetailsState") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ContainerState) :*: S1 (MetaSel (Just "mounts") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Mount])))))))

data DockerClientOpts #

Client options used to configure the remote engine we're talking to

Constructors

DockerClientOpts
Fields apiVer :: ApiVersion baseUrl :: URL

Instances

Eq DockerClientOpts #
Instance details Defined in Docker.Client.Types Methods (==) :: DockerClientOpts -> DockerClientOpts -> Bool # (/=) :: DockerClientOpts -> DockerClientOpts -> Bool #
Show DockerClientOpts #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> DockerClientOpts -> ShowS # show :: DockerClientOpts -> String # showList :: [DockerClientOpts] -> ShowS #
Monad m => MonadReader (DockerClientOpts, HttpHandler m) (DockerT m) #
Instance details Defined in Docker.Client.Http Methods ask :: DockerT m (DockerClientOpts, HttpHandler m) # local :: ((DockerClientOpts, HttpHandler m) -> (DockerClientOpts, HttpHandler m)) -> DockerT m a -> DockerT m a # reader :: ((DockerClientOpts, HttpHandler m) -> a) -> DockerT m a #

defaultClientOpts :: DockerClientOpts #

Default DockerClientOpts used for talking to the docker engine.

data ListOpts #

List options used for filtering the list of container or images.

Constructors

ListOpts
Fields all :: Bool

Instances

Eq ListOpts #
Instance details Defined in Docker.Client.Types Methods (==) :: ListOpts -> ListOpts -> Bool # (/=) :: ListOpts -> ListOpts -> Bool #
Show ListOpts #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> ListOpts -> ShowS # show :: ListOpts -> String # showList :: [ListOpts] -> ShowS #

defaultListOpts :: ListOpts #

Default ListOpts. Doesn't list stopped containers.

data DockerVersion #

Data type used for represneting the version of the docker engine remote API.

Constructors

DockerVersion
Fields version :: Text apiVersion :: ApiVersion gitCommit :: Text goVersion :: Text os :: Text arch :: Text kernelVersion :: Text buildTime :: Text

Instances

Eq DockerVersion #
Instance details Defined in Docker.Client.Types Methods (==) :: DockerVersion -> DockerVersion -> Bool # (/=) :: DockerVersion -> DockerVersion -> Bool #
Show DockerVersion #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> DockerVersion -> ShowS # show :: DockerVersion -> String # showList :: [DockerVersion] -> ShowS #
Generic DockerVersion #
Instance details Defined in Docker.Client.Types Associated Types type Rep DockerVersion :: * -> * # Methods from :: DockerVersion -> Rep DockerVersion x # to :: Rep DockerVersion x -> DockerVersion #
ToJSON DockerVersion #
Instance details Defined in Docker.Client.Types Methods toJSON :: DockerVersion -> Value # toEncoding :: DockerVersion -> Encoding # toJSONList :: [DockerVersion] -> Value # toEncodingList :: [DockerVersion] -> Encoding #
FromJSON DockerVersion #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser DockerVersion # parseJSONList :: Value -> Parser [DockerVersion] #
type Rep DockerVersion #
Instance details Defined in Docker.Client.Types type Rep DockerVersion = D1 (MetaData "DockerVersion" "Docker.Client.Types" "docker-0.6.0.0-GtJwIiAfbAs4xgCOTSUGuQ" False) (C1 (MetaCons "DockerVersion" PrefixI True) (((S1 (MetaSel (Just "version") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: S1 (MetaSel (Just "apiVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ApiVersion)) :: (S1 (MetaSel (Just "gitCommit") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: S1 (MetaSel (Just "goVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) :: ((S1 (MetaSel (Just "os") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: S1 (MetaSel (Just "arch") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :: (S1 (MetaSel (Just "kernelVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "buildTime") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))))

data ContainerPortInfo #

Data type used for representing the information of various ports that a contianer may expose.

Constructors

ContainerPortInfo
Fields ipAddressInfo :: Maybe Text privatePortInfo :: Port publicPortInfo :: Maybe Port portTypeInfo :: Maybe PortType

Instances

Eq ContainerPortInfo #
Instance details Defined in Docker.Client.Types Methods (==) :: ContainerPortInfo -> ContainerPortInfo -> Bool # (/=) :: ContainerPortInfo -> ContainerPortInfo -> Bool #
Show ContainerPortInfo #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> ContainerPortInfo -> ShowS # show :: ContainerPortInfo -> String # showList :: [ContainerPortInfo] -> ShowS #
FromJSON ContainerPortInfo #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser ContainerPortInfo # parseJSONList :: Value -> Parser [ContainerPortInfo] #

data Container #

Data type used for parsing a list of containers.

Constructors

Container
Fields containerId :: ContainerID containerNames :: [Text] containerImageName :: Text containerImageId :: ImageID containerCommand :: Text containerCreatedAt :: Int containerState :: State containerStatus :: Maybe Text containerPorts :: [ContainerPortInfo] containerLabels :: [Label] containerNetworks :: [Network] containerMounts :: [Mount]

Instances

Eq Container #
Instance details Defined in Docker.Client.Types Methods (==) :: Container -> Container -> Bool # (/=) :: Container -> Container -> Bool #
Show Container #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> Container -> ShowS # show :: Container -> String # showList :: [Container] -> ShowS #
FromJSON Container #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser Container # parseJSONList :: Value -> Parser [Container] #

data ContainerState #

Data type used for parsing the container state from a list of containers.

Constructors

ContainerState
Fields containerError :: Text exitCode :: Int finishedAt :: Maybe UTCTime oomKilled :: Bool dead :: Bool paused :: Bool pid :: Int restarting :: Bool running :: Bool startedAt :: UTCTime state :: State

Instances

Eq ContainerState #
Instance details Defined in Docker.Client.Types Methods (==) :: ContainerState -> ContainerState -> Bool # (/=) :: ContainerState -> ContainerState -> Bool #
Show ContainerState #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> ContainerState -> ShowS # show :: ContainerState -> String # showList :: [ContainerState] -> ShowS #
Generic ContainerState #
Instance details Defined in Docker.Client.Types Associated Types type Rep ContainerState :: * -> * # Methods from :: ContainerState -> Rep ContainerState x # to :: Rep ContainerState x -> ContainerState #
FromJSON ContainerState #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser ContainerState # parseJSONList :: Value -> Parser [ContainerState] #
type Rep ContainerState #
Instance details Defined in Docker.Client.Types type Rep ContainerState = D1 (MetaData "ContainerState" "Docker.Client.Types" "docker-0.6.0.0-GtJwIiAfbAs4xgCOTSUGuQ" False) (C1 (MetaCons "ContainerState" PrefixI True) (((S1 (MetaSel (Just "containerError") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: S1 (MetaSel (Just "exitCode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) :: (S1 (MetaSel (Just "finishedAt") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UTCTime)) :: (S1 (MetaSel (Just "oomKilled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "dead") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))) :: ((S1 (MetaSel (Just "paused") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: (S1 (MetaSel (Just "pid") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "restarting") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :: (S1 (MetaSel (Just "running") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: (S1 (MetaSel (Just "startedAt") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UTCTime) :: S1 (MetaSel (Just "state") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 State))))))

data State #

Represents the state of the container life cycle.

Constructors

Created
Restarting
Running
Paused
Exited
Dead

Instances

Eq State #
Instance details Defined in Docker.Client.Types Methods (==) :: State -> State -> Bool # (/=) :: State -> State -> Bool #
Show State #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> State -> ShowS # show :: State -> String # showList :: [State] -> ShowS #
Generic State #
Instance details Defined in Docker.Client.Types Associated Types type Rep State :: * -> * # Methods from :: State -> Rep State x # to :: Rep State x -> State #
FromJSON State #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser State # parseJSONList :: Value -> Parser [State] #
type Rep State #
Instance details Defined in Docker.Client.Types type Rep State = D1 (MetaData "State" "Docker.Client.Types" "docker-0.6.0.0-GtJwIiAfbAs4xgCOTSUGuQ" False) ((C1 (MetaCons "Created" PrefixI False) (U1 :: * -> ) :+: (C1 (MetaCons "Restarting" PrefixI False) (U1 :: -> ) :+: C1 (MetaCons "Running" PrefixI False) (U1 :: -> ))) :+: (C1 (MetaCons "Paused" PrefixI False) (U1 :: -> ) :+: (C1 (MetaCons "Exited" PrefixI False) (U1 :: -> ) :+: C1 (MetaCons "Dead" PrefixI False) (U1 :: -> *))))

type Digest = Text #

Alias for representing a RepoDigest. We could newtype this and add some validation.

data Label #

Container and Image Labels.

Constructors

Label Name Value

Instances

Eq Label #
Instance details Defined in Docker.Client.Types Methods (==) :: Label -> Label -> Bool # (/=) :: Label -> Label -> Bool #
Show Label #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> Label -> ShowS # show :: Label -> String # showList :: [Label] -> ShowS #
ToJSON [Label] #
Instance details Defined in Docker.Client.Types Methods toJSON :: [Label] -> Value # toEncoding :: [Label] -> Encoding # toJSONList :: [[Label]] -> Value # toEncodingList :: [[Label]] -> Encoding #
FromJSON [Label] #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser [Label] # parseJSONList :: Value -> Parser [[Label]] #

type Tag = Text #

Alias for Tags.

data Image #

Data type used for parsing information from a list of images.

Constructors

DockerImage
Fields imageId :: ImageID imageCreated :: Integer imageParentId :: Maybe ImageID imageRepoTags :: [Tag] imageRepoDigests :: [Digest] imageSize :: Integer imageVirtualSize :: Integer imageLabels :: [Label]

Instances

Eq Image #
Instance details Defined in Docker.Client.Types Methods (==) :: Image -> Image -> Bool # (/=) :: Image -> Image -> Bool #
Show Image #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> Image -> ShowS # show :: Image -> String # showList :: [Image] -> ShowS #
Generic Image #
Instance details Defined in Docker.Client.Types Associated Types type Rep Image :: * -> * # Methods from :: Image -> Rep Image x # to :: Rep Image x -> Image #
FromJSON Image #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser Image # parseJSONList :: Value -> Parser [Image] #
type Rep Image #
Instance details Defined in Docker.Client.Types type Rep Image = D1 (MetaData "Image" "Docker.Client.Types" "docker-0.6.0.0-GtJwIiAfbAs4xgCOTSUGuQ" False) (C1 (MetaCons "DockerImage" PrefixI True) (((S1 (MetaSel (Just "imageId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ImageID) :: S1 (MetaSel (Just "imageCreated") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer)) :: (S1 (MetaSel (Just "imageParentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ImageID)) :: S1 (MetaSel (Just "imageRepoTags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Tag]))) :: ((S1 (MetaSel (Just "imageRepoDigests") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Digest]) :: S1 (MetaSel (Just "imageSize") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer)) :: (S1 (MetaSel (Just "imageVirtualSize") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer) :*: S1 (MetaSel (Just "imageLabels") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Label])))))

data Entrypoint #

Constructors

Entrypoint [Text]

Instances

Eq Entrypoint #
Instance details Defined in Docker.Client.Types Methods (==) :: Entrypoint -> Entrypoint -> Bool # (/=) :: Entrypoint -> Entrypoint -> Bool #
Show Entrypoint #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> Entrypoint -> ShowS # show :: Entrypoint -> String # showList :: [Entrypoint] -> ShowS #
Generic Entrypoint #
Instance details Defined in Docker.Client.Types Associated Types type Rep Entrypoint :: * -> * # Methods from :: Entrypoint -> Rep Entrypoint x # to :: Rep Entrypoint x -> Entrypoint #
ToJSON Entrypoint #
Instance details Defined in Docker.Client.Types Methods toJSON :: Entrypoint -> Value # toEncoding :: Entrypoint -> Encoding # toJSONList :: [Entrypoint] -> Value # toEncodingList :: [Entrypoint] -> Encoding #
FromJSON Entrypoint #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser Entrypoint # parseJSONList :: Value -> Parser [Entrypoint] #
type Rep Entrypoint #
Instance details Defined in Docker.Client.Types type Rep Entrypoint = D1 (MetaData "Entrypoint" "Docker.Client.Types" "docker-0.6.0.0-GtJwIiAfbAs4xgCOTSUGuQ" False) (C1 (MetaCons "Entrypoint" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))

dropImagePrefix :: [a] -> [a] #

Helper function used for dropping the "image" prefix when serializing the Image data type to and from json.

data CreateOpts #

Options used for creating a Container.

Constructors

CreateOpts
Fields containerConfig :: ContainerConfig hostConfig :: HostConfig networkingConfig :: NetworkingConfig

Instances

Eq CreateOpts #
Instance details Defined in Docker.Client.Types Methods (==) :: CreateOpts -> CreateOpts -> Bool # (/=) :: CreateOpts -> CreateOpts -> Bool #
Show CreateOpts #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> CreateOpts -> ShowS # show :: CreateOpts -> String # showList :: [CreateOpts] -> ShowS #
ToJSON CreateOpts #
Instance details Defined in Docker.Client.Types Methods toJSON :: CreateOpts -> Value # toEncoding :: CreateOpts -> Encoding # toJSONList :: [CreateOpts] -> Value # toEncodingList :: [CreateOpts] -> Encoding #

data BuildOpts #

Options for when building images from a Dockerfile

Constructors

BuildOpts

Fields

buildImageName :: Text
Image name in the form of name:tag; ie. myimage:latest.:w
buildDockerfileName :: Text
Name of dockerfile (default: Dockerfile)
buildQuiet :: Bool
buildNoCache :: Bool
Do not use cache when building the image.
buildRemoveItermediate :: Bool
Remove intermediate containers after a successful build (default true).
buildForceRemoveIntermediate :: Bool
Always remove intermediate containers.
buildPullParent :: Bool
Always attempt to pull a newer version of the *parent* image (ie. FROM debian:jessie).

Instances

Eq BuildOpts #
Instance details Defined in Docker.Client.Types Methods (==) :: BuildOpts -> BuildOpts -> Bool # (/=) :: BuildOpts -> BuildOpts -> Bool #
Show BuildOpts #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> BuildOpts -> ShowS # show :: BuildOpts -> String # showList :: [BuildOpts] -> ShowS #

defaultBuildOpts :: Text -> BuildOpts #

defaultCreateOpts :: Text -> CreateOpts #

Default create options when creating a container. You only need to specify an image name and the rest is all sensible defaults.

data DetachKeys #

Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl-value where value is one of: a-z, @, ^, [, , or _.

Constructors

WithCtrl Char
WithoutCtrl Char
DefaultDetachKey

Instances

Eq DetachKeys #
Instance details Defined in Docker.Client.Types Methods (==) :: DetachKeys -> DetachKeys -> Bool # (/=) :: DetachKeys -> DetachKeys -> Bool #
Show DetachKeys #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> DetachKeys -> ShowS # show :: DetachKeys -> String # showList :: [DetachKeys] -> ShowS #

data StartOpts #

Options for starting a container.

Constructors

StartOpts
Fields detachKeys :: DetachKeys

Instances

Eq StartOpts #
Instance details Defined in Docker.Client.Types Methods (==) :: StartOpts -> StartOpts -> Bool # (/=) :: StartOpts -> StartOpts -> Bool #
Show StartOpts #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> StartOpts -> ShowS # show :: StartOpts -> String # showList :: [StartOpts] -> ShowS #

defaultStartOpts :: StartOpts #

Default options for staring a container.

data ContainerDeleteOpts #

Options for deleting a container.

Constructors

ContainerDeleteOpts
Fields deleteVolumes :: Bool Automatically cleanup volumes that the container created as well. force :: Bool If the container is still running force deletion anyway.

Instances

Eq ContainerDeleteOpts #
Instance details Defined in Docker.Client.Types Methods (==) :: ContainerDeleteOpts -> ContainerDeleteOpts -> Bool # (/=) :: ContainerDeleteOpts -> ContainerDeleteOpts -> Bool #
Show ContainerDeleteOpts #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> ContainerDeleteOpts -> ShowS # show :: ContainerDeleteOpts -> String # showList :: [ContainerDeleteOpts] -> ShowS #

defaultContainerDeleteOpts :: ContainerDeleteOpts #

Default options for deleting a container. Most of the time we DON'T want to delete the container's volumes or force delete it if it's running.

data ImageDeleteOpts #

Image delete opts

Constructors

ImageDeleteOpts

Instances

Eq ImageDeleteOpts #
Instance details Defined in Docker.Client.Types Methods (==) :: ImageDeleteOpts -> ImageDeleteOpts -> Bool # (/=) :: ImageDeleteOpts -> ImageDeleteOpts -> Bool #
Show ImageDeleteOpts #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> ImageDeleteOpts -> ShowS # show :: ImageDeleteOpts -> String # showList :: [ImageDeleteOpts] -> ShowS #

defaultImageDeleteOpts :: ImageDeleteOpts #

Sane image deletion defaults

type Timestamp = Integer #

Timestamp alias.

data TailLogOpt #

Used for requesting N number of lines when tailing a containers log output.

Constructors

Tail Integer
All

Instances

Eq TailLogOpt #
Instance details Defined in Docker.Client.Types Methods (==) :: TailLogOpt -> TailLogOpt -> Bool # (/=) :: TailLogOpt -> TailLogOpt -> Bool #
Show TailLogOpt #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> TailLogOpt -> ShowS # show :: TailLogOpt -> String # showList :: [TailLogOpt] -> ShowS #

data LogOpts #

Log options used when requesting the log output from a container.

Constructors

LogOpts
Fields stdout :: Bool stderr :: Bool since :: Maybe Timestamp timestamps :: Bool tail :: TailLogOpt

Instances

Eq LogOpts #
Instance details Defined in Docker.Client.Types Methods (==) :: LogOpts -> LogOpts -> Bool # (/=) :: LogOpts -> LogOpts -> Bool #
Show LogOpts #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> LogOpts -> ShowS # show :: LogOpts -> String # showList :: [LogOpts] -> ShowS #

defaultLogOpts :: LogOpts #

Sensible default for log options.

data CreateNetworkOpts #

Options for creating a network

Constructors

CreateNetworkOpts
Fields createNetworkName :: Text The network's name createNetworkCheckDuplicate :: Bool Check for networks with duplicate names. createNetworkDriver :: Text Name of the network driver plugin to use. createNetworkInternal :: Bool Restrict external access to the network. createNetworkEnableIPv6 :: Bool Enable IPv6 on the network.

Instances

Eq CreateNetworkOpts #
Instance details Defined in Docker.Client.Types Methods (==) :: CreateNetworkOpts -> CreateNetworkOpts -> Bool # (/=) :: CreateNetworkOpts -> CreateNetworkOpts -> Bool #
Show CreateNetworkOpts #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> CreateNetworkOpts -> ShowS # show :: CreateNetworkOpts -> String # showList :: [CreateNetworkOpts] -> ShowS #
ToJSON CreateNetworkOpts #
Instance details Defined in Docker.Client.Types Methods toJSON :: CreateNetworkOpts -> Value # toEncoding :: CreateNetworkOpts -> Encoding # toJSONList :: [CreateNetworkOpts] -> Value # toEncodingList :: [CreateNetworkOpts] -> Encoding #

defaultCreateNetworkOpts :: Text -> CreateNetworkOpts #

Sensible defalut for create network options

data VolumePermission #

Set permissions on volumes that you mount in the container.

Constructors

ReadWrite
ReadOnly

Instances

Eq VolumePermission #
Instance details Defined in Docker.Client.Types Methods (==) :: VolumePermission -> VolumePermission -> Bool # (/=) :: VolumePermission -> VolumePermission -> Bool #
Show VolumePermission #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> VolumePermission -> ShowS # show :: VolumePermission -> String # showList :: [VolumePermission] -> ShowS #
Generic VolumePermission #
Instance details Defined in Docker.Client.Types Associated Types type Rep VolumePermission :: * -> * # Methods from :: VolumePermission -> Rep VolumePermission x # to :: Rep VolumePermission x -> VolumePermission #
ToJSON VolumePermission #
Instance details Defined in Docker.Client.Types Methods toJSON :: VolumePermission -> Value # toEncoding :: VolumePermission -> Encoding # toJSONList :: [VolumePermission] -> Value # toEncodingList :: [VolumePermission] -> Encoding #
FromJSON VolumePermission #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser VolumePermission # parseJSONList :: Value -> Parser [VolumePermission] #
type Rep VolumePermission #
Instance details Defined in Docker.Client.Types type Rep VolumePermission = D1 (MetaData "VolumePermission" "Docker.Client.Types" "docker-0.6.0.0-GtJwIiAfbAs4xgCOTSUGuQ" False) (C1 (MetaCons "ReadWrite" PrefixI False) (U1 :: * -> ) :+: C1 (MetaCons "ReadOnly" PrefixI False) (U1 :: -> *))

data Bind #

Constructors

Bind
Fields hostSrc :: Text containerDest :: Text volumePermission :: Maybe VolumePermission

Instances

Eq Bind #
Instance details Defined in Docker.Client.Types Methods (==) :: Bind -> Bind -> Bool # (/=) :: Bind -> Bind -> Bool #
Show Bind #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> Bind -> ShowS # show :: Bind -> String # showList :: [Bind] -> ShowS #
ToJSON Bind #
Instance details Defined in Docker.Client.Types Methods toJSON :: Bind -> Value # toEncoding :: Bind -> Encoding # toJSONList :: [Bind] -> Value # toEncodingList :: [Bind] -> Encoding #
FromJSON Bind #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser Bind # parseJSONList :: Value -> Parser [Bind] #

newtype Volume #

Used for marking a directory in the container as "exposed" hence taking it outside of the COW filesystem and making it mountable in other containers using VolumesFrom. The volume usually get's created somewhere in varlibdockervolumes (depending on the volume driver used). The CLI example is:

docker run --name app -v /opt/data -it myapp:latest
docker run --name app2 --volumes-from app /bin/bash -c "ls -l /opt/data"

Constructors

Volume FilePath

Instances

Eq Volume #
Instance details Defined in Docker.Client.Types Methods (==) :: Volume -> Volume -> Bool # (/=) :: Volume -> Volume -> Bool #
Show Volume #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> Volume -> ShowS # show :: Volume -> String # showList :: [Volume] -> ShowS #
ToJSON [Volume] #
Instance details Defined in Docker.Client.Types Methods toJSON :: [Volume] -> Value # toEncoding :: [Volume] -> Encoding # toJSONList :: [[Volume]] -> Value # toEncodingList :: [[Volume]] -> Encoding #
FromJSON [Volume] #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser [Volume] # parseJSONList :: Value -> Parser [[Volume]] #

data Device #

Constructors

Device
Fields pathOnHost :: FilePath pathInContainer :: FilePath cgroupPermissions :: Text

Instances

Eq Device #
Instance details Defined in Docker.Client.Types Methods (==) :: Device -> Device -> Bool # (/=) :: Device -> Device -> Bool #
Show Device #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> Device -> ShowS # show :: Device -> String # showList :: [Device] -> ShowS #
Generic Device #
Instance details Defined in Docker.Client.Types Associated Types type Rep Device :: * -> * # Methods from :: Device -> Rep Device x # to :: Rep Device x -> Device #
ToJSON Device #
Instance details Defined in Docker.Client.Types Methods toJSON :: Device -> Value # toEncoding :: Device -> Encoding # toJSONList :: [Device] -> Value # toEncodingList :: [Device] -> Encoding #
FromJSON Device #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser Device # parseJSONList :: Value -> Parser [Device] #
type Rep Device #
Instance details Defined in Docker.Client.Types type Rep Device = D1 (MetaData "Device" "Docker.Client.Types" "docker-0.6.0.0-GtJwIiAfbAs4xgCOTSUGuQ" False) (C1 (MetaCons "Device" PrefixI True) (S1 (MetaSel (Just "pathOnHost") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :: (S1 (MetaSel (Just "pathInContainer") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :: S1 (MetaSel (Just "cgroupPermissions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))

type ContainerName = Text #

data VolumeFrom #

Constructors

VolumeFrom ContainerName (Maybe VolumePermission)

Instances

Eq VolumeFrom #
Instance details Defined in Docker.Client.Types Methods (==) :: VolumeFrom -> VolumeFrom -> Bool # (/=) :: VolumeFrom -> VolumeFrom -> Bool #
Show VolumeFrom #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> VolumeFrom -> ShowS # show :: VolumeFrom -> String # showList :: [VolumeFrom] -> ShowS #
ToJSON VolumeFrom #
Instance details Defined in Docker.Client.Types Methods toJSON :: VolumeFrom -> Value # toEncoding :: VolumeFrom -> Encoding # toJSONList :: [VolumeFrom] -> Value # toEncodingList :: [VolumeFrom] -> Encoding #
FromJSON VolumeFrom #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser VolumeFrom # parseJSONList :: Value -> Parser [VolumeFrom] #

data Link #

Constructors

Link Text (Maybe Text)

Instances

Eq Link #
Instance details Defined in Docker.Client.Types Methods (==) :: Link -> Link -> Bool # (/=) :: Link -> Link -> Bool #
Show Link #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> Link -> ShowS # show :: Link -> String # showList :: [Link] -> ShowS #
ToJSON Link #
Instance details Defined in Docker.Client.Types Methods toJSON :: Link -> Value # toEncoding :: Link -> Encoding # toJSONList :: [Link] -> Value # toEncodingList :: [Link] -> Encoding #
FromJSON Link #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser Link # parseJSONList :: Value -> Parser [Link] #

data LogDriverType #

Constructors

JsonFile
Syslog
Journald
Gelf
Fluentd
AwsLogs
Splunk
Etwlogs
LoggingDisabled

Instances

Eq LogDriverType #
Instance details Defined in Docker.Client.Types Methods (==) :: LogDriverType -> LogDriverType -> Bool # (/=) :: LogDriverType -> LogDriverType -> Bool #
Show LogDriverType #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> LogDriverType -> ShowS # show :: LogDriverType -> String # showList :: [LogDriverType] -> ShowS #
ToJSON LogDriverType #
Instance details Defined in Docker.Client.Types Methods toJSON :: LogDriverType -> Value # toEncoding :: LogDriverType -> Encoding # toJSONList :: [LogDriverType] -> Value # toEncodingList :: [LogDriverType] -> Encoding #
FromJSON LogDriverType #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser LogDriverType # parseJSONList :: Value -> Parser [LogDriverType] #

data LogDriverOption #

Constructors

LogDriverOption Name Value

Instances

Eq LogDriverOption #
Instance details Defined in Docker.Client.Types Methods (==) :: LogDriverOption -> LogDriverOption -> Bool # (/=) :: LogDriverOption -> LogDriverOption -> Bool #
Show LogDriverOption #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> LogDriverOption -> ShowS # show :: LogDriverOption -> String # showList :: [LogDriverOption] -> ShowS #
ToJSON [LogDriverOption] #
Instance details Defined in Docker.Client.Types Methods toJSON :: [LogDriverOption] -> Value # toEncoding :: [LogDriverOption] -> Encoding # toJSONList :: [[LogDriverOption]] -> Value # toEncodingList :: [[LogDriverOption]] -> Encoding #
FromJSON [LogDriverOption] #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser [LogDriverOption] # parseJSONList :: Value -> Parser [[LogDriverOption]] #

data LogDriverConfig #

Constructors

LogDriverConfig LogDriverType [LogDriverOption]

Instances

Eq LogDriverConfig #
Instance details Defined in Docker.Client.Types Methods (==) :: LogDriverConfig -> LogDriverConfig -> Bool # (/=) :: LogDriverConfig -> LogDriverConfig -> Bool #
Show LogDriverConfig #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> LogDriverConfig -> ShowS # show :: LogDriverConfig -> String # showList :: [LogDriverConfig] -> ShowS #
ToJSON LogDriverConfig #
Instance details Defined in Docker.Client.Types Methods toJSON :: LogDriverConfig -> Value # toEncoding :: LogDriverConfig -> Encoding # toJSONList :: [LogDriverConfig] -> Value # toEncodingList :: [LogDriverConfig] -> Encoding #
FromJSON LogDriverConfig #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser LogDriverConfig # parseJSONList :: Value -> Parser [LogDriverConfig] #

data NetworkMode #

Constructors

NetworkBridge
NetworkHost
NetworkDisabled
NetworkNamed Text

Instances

Eq NetworkMode #
Instance details Defined in Docker.Client.Types Methods (==) :: NetworkMode -> NetworkMode -> Bool # (/=) :: NetworkMode -> NetworkMode -> Bool #
Ord NetworkMode #
Instance details Defined in Docker.Client.Types Methods compare :: NetworkMode -> NetworkMode -> Ordering # (<) :: NetworkMode -> NetworkMode -> Bool # (<=) :: NetworkMode -> NetworkMode -> Bool # (>) :: NetworkMode -> NetworkMode -> Bool # (>=) :: NetworkMode -> NetworkMode -> Bool # max :: NetworkMode -> NetworkMode -> NetworkMode # min :: NetworkMode -> NetworkMode -> NetworkMode #
Show NetworkMode #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> NetworkMode -> ShowS # show :: NetworkMode -> String # showList :: [NetworkMode] -> ShowS #
ToJSON NetworkMode #
Instance details Defined in Docker.Client.Types Methods toJSON :: NetworkMode -> Value # toEncoding :: NetworkMode -> Encoding # toJSONList :: [NetworkMode] -> Value # toEncodingList :: [NetworkMode] -> Encoding #
FromJSON NetworkMode #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser NetworkMode # parseJSONList :: Value -> Parser [NetworkMode] #

data PortType #

Constructors

TCP
UDP

Instances

Eq PortType #
Instance details Defined in Docker.Client.Types Methods (==) :: PortType -> PortType -> Bool # (/=) :: PortType -> PortType -> Bool #
Ord PortType #
Instance details Defined in Docker.Client.Types Methods compare :: PortType -> PortType -> Ordering # (<) :: PortType -> PortType -> Bool # (<=) :: PortType -> PortType -> Bool # (>) :: PortType -> PortType -> Bool # (>=) :: PortType -> PortType -> Bool # max :: PortType -> PortType -> PortType # min :: PortType -> PortType -> PortType #
Read PortType #
Instance details Defined in Docker.Client.Types Methods readsPrec :: Int -> ReadS PortType # readList :: ReadS [PortType] # readPrec :: ReadPrec PortType # readListPrec :: ReadPrec [PortType] #
Show PortType #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> PortType -> ShowS # show :: PortType -> String # showList :: [PortType] -> ShowS #
Generic PortType #
Instance details Defined in Docker.Client.Types Associated Types type Rep PortType :: * -> * # Methods from :: PortType -> Rep PortType x # to :: Rep PortType x -> PortType #
ToJSON PortType #
Instance details Defined in Docker.Client.Types Methods toJSON :: PortType -> Value # toEncoding :: PortType -> Encoding # toJSONList :: [PortType] -> Value # toEncodingList :: [PortType] -> Encoding #
FromJSON PortType #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser PortType # parseJSONList :: Value -> Parser [PortType] #
type Rep PortType #
Instance details Defined in Docker.Client.Types type Rep PortType = D1 (MetaData "PortType" "Docker.Client.Types" "docker-0.6.0.0-GtJwIiAfbAs4xgCOTSUGuQ" False) (C1 (MetaCons "TCP" PrefixI False) (U1 :: * -> ) :+: C1 (MetaCons "UDP" PrefixI False) (U1 :: -> *))

data Network #

Constructors

Network NetworkMode NetworkOptions

Instances

Eq Network #
Instance details Defined in Docker.Client.Types Methods (==) :: Network -> Network -> Bool # (/=) :: Network -> Network -> Bool #
Show Network #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> Network -> ShowS # show :: Network -> String # showList :: [Network] -> ShowS #
FromJSON [Network] #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser [Network] # parseJSONList :: Value -> Parser [[Network]] #

data NetworkSettings #

Data type reprsenting the various network settings a container can have.

Instances

Eq NetworkSettings #
Instance details Defined in Docker.Client.Types Methods (==) :: NetworkSettings -> NetworkSettings -> Bool # (/=) :: NetworkSettings -> NetworkSettings -> Bool #
Show NetworkSettings #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> NetworkSettings -> ShowS # show :: NetworkSettings -> String # showList :: [NetworkSettings] -> ShowS #
FromJSON NetworkSettings #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser NetworkSettings # parseJSONList :: Value -> Parser [NetworkSettings] #

data NetworkOptions #

Data type used for parsing the network information of each container when listing them.

Constructors

NetworkOptions
Fields networkOptionsId :: Text networkOptionsEndpointId :: Text networkOptionsGateway :: Text networkOptionsIpAddress :: Text networkOptionsIpPrefixLen :: Int networkOptionsIpV6Gateway :: Maybe Text networkOptionsGlobalIPv6Address :: Maybe Text networkOptionsGlobalIPv6PrefixLen :: Maybe Int networkOptionsMacAddress :: Text

Instances

Eq NetworkOptions #
Instance details Defined in Docker.Client.Types Methods (==) :: NetworkOptions -> NetworkOptions -> Bool # (/=) :: NetworkOptions -> NetworkOptions -> Bool #
Show NetworkOptions #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> NetworkOptions -> ShowS # show :: NetworkOptions -> String # showList :: [NetworkOptions] -> ShowS #
FromJSON NetworkOptions #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser NetworkOptions # parseJSONList :: Value -> Parser [NetworkOptions] #

data Mount #

Data type used for parsing the mount information from a container list.

Constructors

Mount
Fields mountName :: Maybe Text mountSource :: FilePath mountDestination :: FilePath mountDriver :: Maybe Text mountRW :: Bool mountPropogation :: Text

Instances

Eq Mount #
Instance details Defined in Docker.Client.Types Methods (==) :: Mount -> Mount -> Bool # (/=) :: Mount -> Mount -> Bool #
Show Mount #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> Mount -> ShowS # show :: Mount -> String # showList :: [Mount] -> ShowS #
Generic Mount #
Instance details Defined in Docker.Client.Types Associated Types type Rep Mount :: * -> * # Methods from :: Mount -> Rep Mount x # to :: Rep Mount x -> Mount #
FromJSON Mount #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser Mount # parseJSONList :: Value -> Parser [Mount] #
type Rep Mount #
Instance details Defined in Docker.Client.Types type Rep Mount = D1 (MetaData "Mount" "Docker.Client.Types" "docker-0.6.0.0-GtJwIiAfbAs4xgCOTSUGuQ" False) (C1 (MetaCons "Mount" PrefixI True) ((S1 (MetaSel (Just "mountName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "mountSource") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :: S1 (MetaSel (Just "mountDestination") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath))) :: (S1 (MetaSel (Just "mountDriver") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "mountRW") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "mountPropogation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))))

data PortBinding #

This datastructure models mapping a Port from the container onto the host system s that the service running in the container can be accessed from the outside world. We either map a port onto all interfaces (default) or onto a specific interface like `127.0.0.1`. NOTE: We should disallow duplicate port bindings as the ToJSON instance will only send the last one. { port/protocol: [{ HostPort: "port" }] }

Constructors

PortBinding
Fields containerPort :: Port portType :: PortType hostPorts :: [HostPort]

Instances

Eq PortBinding #
Instance details Defined in Docker.Client.Types Methods (==) :: PortBinding -> PortBinding -> Bool # (/=) :: PortBinding -> PortBinding -> Bool #
Show PortBinding #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> PortBinding -> ShowS # show :: PortBinding -> String # showList :: [PortBinding] -> ShowS #
ToJSON [PortBinding] #
Instance details Defined in Docker.Client.Types Methods toJSON :: [PortBinding] -> Value # toEncoding :: [PortBinding] -> Encoding # toJSONList :: [[PortBinding]] -> Value # toEncodingList :: [[PortBinding]] -> Encoding #
FromJSON [PortBinding] #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser [PortBinding] # parseJSONList :: Value -> Parser [[PortBinding]] #

data HostPort #

Constructors

HostPort
Fields hostIp :: Text hostPost :: Port

Instances

Eq HostPort #
Instance details Defined in Docker.Client.Types Methods (==) :: HostPort -> HostPort -> Bool # (/=) :: HostPort -> HostPort -> Bool #
Show HostPort #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> HostPort -> ShowS # show :: HostPort -> String # showList :: [HostPort] -> ShowS #
ToJSON HostPort #
Instance details Defined in Docker.Client.Types Methods toJSON :: HostPort -> Value # toEncoding :: HostPort -> Encoding # toJSONList :: [HostPort] -> Value # toEncodingList :: [HostPort] -> Encoding #
FromJSON HostPort #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser HostPort # parseJSONList :: Value -> Parser [HostPort] #

type RetryCount = Integer #

data RestartPolicy #

Constructors

RestartAlways
RestartUnlessStopped
RestartOnFailure RetryCount
RestartOff

Instances

Eq RestartPolicy #
Instance details Defined in Docker.Client.Types Methods (==) :: RestartPolicy -> RestartPolicy -> Bool # (/=) :: RestartPolicy -> RestartPolicy -> Bool #
Show RestartPolicy #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> RestartPolicy -> ShowS # show :: RestartPolicy -> String # showList :: [RestartPolicy] -> ShowS #
ToJSON RestartPolicy #
Instance details Defined in Docker.Client.Types Methods toJSON :: RestartPolicy -> Value # toEncoding :: RestartPolicy -> Encoding # toJSONList :: [RestartPolicy] -> Value # toEncodingList :: [RestartPolicy] -> Encoding #
FromJSON RestartPolicy #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser RestartPolicy # parseJSONList :: Value -> Parser [RestartPolicy] #

data Isolation #

Constructors

Default
Process
Hyperv

Instances

Eq Isolation #
Instance details Defined in Docker.Client.Types Methods (==) :: Isolation -> Isolation -> Bool # (/=) :: Isolation -> Isolation -> Bool #
Show Isolation #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> Isolation -> ShowS # show :: Isolation -> String # showList :: [Isolation] -> ShowS #

newtype UTSMode #

Constructors

UTSMode Text

Instances

Eq UTSMode #
Instance details Defined in Docker.Client.Types Methods (==) :: UTSMode -> UTSMode -> Bool # (/=) :: UTSMode -> UTSMode -> Bool #
Show UTSMode #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> UTSMode -> ShowS # show :: UTSMode -> String # showList :: [UTSMode] -> ShowS #

data HostConfig #

Constructors

HostConfig

Fields

Instances

Eq HostConfig #
Instance details Defined in Docker.Client.Types Methods (==) :: HostConfig -> HostConfig -> Bool # (/=) :: HostConfig -> HostConfig -> Bool #
Show HostConfig #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> HostConfig -> ShowS # show :: HostConfig -> String # showList :: [HostConfig] -> ShowS #
Generic HostConfig #
Instance details Defined in Docker.Client.Types Associated Types type Rep HostConfig :: * -> * # Methods from :: HostConfig -> Rep HostConfig x # to :: Rep HostConfig x -> HostConfig #
ToJSON HostConfig #
Instance details Defined in Docker.Client.Types Methods toJSON :: HostConfig -> Value # toEncoding :: HostConfig -> Encoding # toJSONList :: [HostConfig] -> Value # toEncodingList :: [HostConfig] -> Encoding #
FromJSON HostConfig #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser HostConfig # parseJSONList :: Value -> Parser [HostConfig] #
type Rep HostConfig #
Instance details Defined in Docker.Client.Types type Rep HostConfig = D1 (MetaData "HostConfig" "Docker.Client.Types" "docker-0.6.0.0-GtJwIiAfbAs4xgCOTSUGuQ" False) (C1 (MetaCons "HostConfig" PrefixI True) ((((S1 (MetaSel (Just "binds") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Bind]) :: S1 (MetaSel (Just "containerIDFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))) :: (S1 (MetaSel (Just "logConfig") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LogDriverConfig) :: (S1 (MetaSel (Just "networkMode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 NetworkMode) :: S1 (MetaSel (Just "portBindings") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [PortBinding])))) :: ((S1 (MetaSel (Just "restartPolicy") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RestartPolicy) :: (S1 (MetaSel (Just "volumeDriver") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "volumesFrom") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [VolumeFrom]))) :: (S1 (MetaSel (Just "capAdd") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]) :: (S1 (MetaSel (Just "capDrop") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]) :: S1 (MetaSel (Just "dns") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]))))) :: (((S1 (MetaSel (Just "dnsOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]) :: (S1 (MetaSel (Just "dnsSearch") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]) :: S1 (MetaSel (Just "extraHosts") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]))) :: (S1 (MetaSel (Just "ipcMode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "links") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Link]) :: S1 (MetaSel (Just "oomScoreAdj") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer))))) :: ((S1 (MetaSel (Just "privileged") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: (S1 (MetaSel (Just "publishAllPorts") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "readonlyRootfs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :: (S1 (MetaSel (Just "securityOpt") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]) :: (S1 (MetaSel (Just "shmSize") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer)) :: S1 (MetaSel (Just "resources") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ContainerResources)))))))

defaultHostConfig :: HostConfig #

Default host confiratuon used for creating a container.

newtype NetworkingConfig #

Data type for the NetworkingConfig section of the container settings

Constructors

NetworkingConfig
Fields endpointsConfig :: HashMap EndpointName EndpointConfig

Instances

Eq NetworkingConfig #
Instance details Defined in Docker.Client.Types Methods (==) :: NetworkingConfig -> NetworkingConfig -> Bool # (/=) :: NetworkingConfig -> NetworkingConfig -> Bool #
Show NetworkingConfig #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> NetworkingConfig -> ShowS # show :: NetworkingConfig -> String # showList :: [NetworkingConfig] -> ShowS #
ToJSON NetworkingConfig #
Instance details Defined in Docker.Client.Types Methods toJSON :: NetworkingConfig -> Value # toEncoding :: NetworkingConfig -> Encoding # toJSONList :: [NetworkingConfig] -> Value # toEncodingList :: [NetworkingConfig] -> Encoding #

newtype EndpointConfig #

EndpointsConfig is container configuration for a specific network

Constructors

EndpointConfig [Alias]

Instances

Eq EndpointConfig #
Instance details Defined in Docker.Client.Types Methods (==) :: EndpointConfig -> EndpointConfig -> Bool # (/=) :: EndpointConfig -> EndpointConfig -> Bool #
Show EndpointConfig #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> EndpointConfig -> ShowS # show :: EndpointConfig -> String # showList :: [EndpointConfig] -> ShowS #
ToJSON EndpointConfig #
Instance details Defined in Docker.Client.Types Methods toJSON :: EndpointConfig -> Value # toEncoding :: EndpointConfig -> Encoding # toJSONList :: [EndpointConfig] -> Value # toEncodingList :: [EndpointConfig] -> Encoding #

data Ulimit #

Constructors

Ulimit
Fields ulimitName :: Text ulimitSoft :: Integer ulimitHard :: Integer

Instances

Eq Ulimit #
Instance details Defined in Docker.Client.Types Methods (==) :: Ulimit -> Ulimit -> Bool # (/=) :: Ulimit -> Ulimit -> Bool #
Show Ulimit #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> Ulimit -> ShowS # show :: Ulimit -> String # showList :: [Ulimit] -> ShowS #
Generic Ulimit #
Instance details Defined in Docker.Client.Types Associated Types type Rep Ulimit :: * -> * # Methods from :: Ulimit -> Rep Ulimit x # to :: Rep Ulimit x -> Ulimit #
ToJSON Ulimit #
Instance details Defined in Docker.Client.Types Methods toJSON :: Ulimit -> Value # toEncoding :: Ulimit -> Encoding # toJSONList :: [Ulimit] -> Value # toEncodingList :: [Ulimit] -> Encoding #
FromJSON Ulimit #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser Ulimit # parseJSONList :: Value -> Parser [Ulimit] #
type Rep Ulimit #
Instance details Defined in Docker.Client.Types type Rep Ulimit = D1 (MetaData "Ulimit" "Docker.Client.Types" "docker-0.6.0.0-GtJwIiAfbAs4xgCOTSUGuQ" False) (C1 (MetaCons "Ulimit" PrefixI True) (S1 (MetaSel (Just "ulimitName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: (S1 (MetaSel (Just "ulimitSoft") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer) :: S1 (MetaSel (Just "ulimitHard") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer))))

data ContainerResources #

Constructors

ContainerResources

Fields

cpuShares :: Maybe Integer
blkioWeight :: Maybe Integer
blkioWeightDevice :: Maybe [DeviceWeight]
blkioDeviceReadBps :: Maybe [DeviceRate]
blkioDeviceWriteBps :: Maybe [DeviceRate]
blkioDeviceReadIOps :: Maybe [DeviceRate]
blkioDeviceWriteIOps :: Maybe [DeviceRate]
cpuPeriod :: Maybe Integer
cpusetCpus :: Maybe Text
cpusetMems :: Maybe Text
devices :: [Device]
kernelMemory :: Maybe MemoryConstraint
memory :: Maybe MemoryConstraint
memoryReservation :: Maybe MemoryConstraint
memorySwap :: Maybe MemoryConstraint
oomKillDisable :: Maybe Bool
ulimits :: [Ulimit]

Instances

Eq ContainerResources #
Instance details Defined in Docker.Client.Types Methods (==) :: ContainerResources -> ContainerResources -> Bool # (/=) :: ContainerResources -> ContainerResources -> Bool #
Show ContainerResources #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> ContainerResources -> ShowS # show :: ContainerResources -> String # showList :: [ContainerResources] -> ShowS #
Generic ContainerResources #
Instance details Defined in Docker.Client.Types Associated Types type Rep ContainerResources :: * -> * # Methods from :: ContainerResources -> Rep ContainerResources x # to :: Rep ContainerResources x -> ContainerResources #
FromJSON ContainerResources #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser ContainerResources # parseJSONList :: Value -> Parser [ContainerResources] #
type Rep ContainerResources #
Instance details Defined in Docker.Client.Types type Rep ContainerResources = D1 (MetaData "ContainerResources" "Docker.Client.Types" "docker-0.6.0.0-GtJwIiAfbAs4xgCOTSUGuQ" False) (C1 (MetaCons "ContainerResources" PrefixI True) ((((S1 (MetaSel (Just "cpuShares") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer)) :: S1 (MetaSel (Just "blkioWeight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer))) :: (S1 (MetaSel (Just "blkioWeightDevice") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [DeviceWeight])) :: S1 (MetaSel (Just "blkioDeviceReadBps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [DeviceRate])))) :: ((S1 (MetaSel (Just "blkioDeviceWriteBps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [DeviceRate])) :: S1 (MetaSel (Just "blkioDeviceReadIOps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [DeviceRate]))) :: (S1 (MetaSel (Just "blkioDeviceWriteIOps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [DeviceRate])) :: S1 (MetaSel (Just "cpuPeriod") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer))))) :: (((S1 (MetaSel (Just "cpusetCpus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "cpusetMems") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "devices") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Device]) :: S1 (MetaSel (Just "kernelMemory") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe MemoryConstraint)))) :: ((S1 (MetaSel (Just "memory") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe MemoryConstraint)) :: S1 (MetaSel (Just "memoryReservation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe MemoryConstraint))) :: (S1 (MetaSel (Just "memorySwap") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe MemoryConstraint)) :: (S1 (MetaSel (Just "oomKillDisable") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "ulimits") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Ulimit])))))))

defaultContainerResources :: ContainerResources #

type Port = Integer #

type Name = Text #

type Value = Text #

data EnvVar #

Constructors

EnvVar Name Value

Instances

Eq EnvVar #
Instance details Defined in Docker.Client.Types Methods (==) :: EnvVar -> EnvVar -> Bool # (/=) :: EnvVar -> EnvVar -> Bool #
Show EnvVar #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> EnvVar -> ShowS # show :: EnvVar -> String # showList :: [EnvVar] -> ShowS #
ToJSON EnvVar #
Instance details Defined in Docker.Client.Types Methods toJSON :: EnvVar -> Value # toEncoding :: EnvVar -> Encoding # toJSONList :: [EnvVar] -> Value # toEncodingList :: [EnvVar] -> Encoding #
FromJSON EnvVar #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser EnvVar # parseJSONList :: Value -> Parser [EnvVar] #

data ContainerConfig #

Constructors

ContainerConfig

Fields

Instances

Eq ContainerConfig #
Instance details Defined in Docker.Client.Types Methods (==) :: ContainerConfig -> ContainerConfig -> Bool # (/=) :: ContainerConfig -> ContainerConfig -> Bool #
Show ContainerConfig #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> ContainerConfig -> ShowS # show :: ContainerConfig -> String # showList :: [ContainerConfig] -> ShowS #
Generic ContainerConfig #
Instance details Defined in Docker.Client.Types Associated Types type Rep ContainerConfig :: * -> * # Methods from :: ContainerConfig -> Rep ContainerConfig x # to :: Rep ContainerConfig x -> ContainerConfig #
ToJSON ContainerConfig #
Instance details Defined in Docker.Client.Types Methods toJSON :: ContainerConfig -> Value # toEncoding :: ContainerConfig -> Encoding # toJSONList :: [ContainerConfig] -> Value # toEncodingList :: [ContainerConfig] -> Encoding #
FromJSON ContainerConfig #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser ContainerConfig # parseJSONList :: Value -> Parser [ContainerConfig] #
type Rep ContainerConfig #
Instance details Defined in Docker.Client.Types type Rep ContainerConfig = D1 (MetaData "ContainerConfig" "Docker.Client.Types" "docker-0.6.0.0-GtJwIiAfbAs4xgCOTSUGuQ" False) (C1 (MetaCons "ContainerConfig" PrefixI True) ((((S1 (MetaSel (Just "hostname") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "domainname") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "user") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "attachStdin") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "attachStdout") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))) :: ((S1 (MetaSel (Just "attachStderr") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "exposedPorts") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ExposedPort])) :: (S1 (MetaSel (Just "tty") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: (S1 (MetaSel (Just "openStdin") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "stdinOnce") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))) :: (((S1 (MetaSel (Just "env") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [EnvVar]) :: S1 (MetaSel (Just "cmd") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])) :: (S1 (MetaSel (Just "image") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: (S1 (MetaSel (Just "volumes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Volume]) :: S1 (MetaSel (Just "workingDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))))) :: ((S1 (MetaSel (Just "entrypoint") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Entrypoint) :: S1 (MetaSel (Just "networkDisabled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) :: (S1 (MetaSel (Just "macAddress") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "labels") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Label]) :*: S1 (MetaSel (Just "stopSignal") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Signal)))))))

defaultContainerConfig :: Text -> ContainerConfig #

Container configuration used for creating a container with sensible defaults.

data ExposedPort #

ExposedPort represents a port (and it's type) that a container should expose to other containers or the host system. NOTE: This does not automatically expose the port onto the host system but rather it just tags it. It's best to be used with the PublishAllPorts flag. It is also useful for the daemon to know which Environment variables to inject into a container linking to our container. Example linking a Postgres container named db would inject the following environment variables automatically if we set the corresponding

ExposedPort:

DB_PORT_5432_TCP_PORT="5432"
DB_PORT_5432_TCP_PROTO="tcp"
DB_PORT_5432_TCP="tcp://172.17.0.1:5432"

Constructors

ExposedPort Port PortType

Instances

Eq ExposedPort #
Instance details Defined in Docker.Client.Types Methods (==) :: ExposedPort -> ExposedPort -> Bool # (/=) :: ExposedPort -> ExposedPort -> Bool #
Show ExposedPort #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> ExposedPort -> ShowS # show :: ExposedPort -> String # showList :: [ExposedPort] -> ShowS #
ToJSON [ExposedPort] #
Instance details Defined in Docker.Client.Types Methods toJSON :: [ExposedPort] -> Value # toEncoding :: [ExposedPort] -> Encoding # toJSONList :: [[ExposedPort]] -> Value # toEncodingList :: [[ExposedPort]] -> Encoding #
FromJSON [ExposedPort] #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser [ExposedPort] # parseJSONList :: Value -> Parser [[ExposedPort]] #

data DeviceWeight #

Constructors

DeviceWeight
Fields deviceWeightPath :: FilePath deviceWeightWeight :: Text

Instances

Eq DeviceWeight #
Instance details Defined in Docker.Client.Types Methods (==) :: DeviceWeight -> DeviceWeight -> Bool # (/=) :: DeviceWeight -> DeviceWeight -> Bool #
Show DeviceWeight #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> DeviceWeight -> ShowS # show :: DeviceWeight -> String # showList :: [DeviceWeight] -> ShowS #
ToJSON DeviceWeight #
Instance details Defined in Docker.Client.Types Methods toJSON :: DeviceWeight -> Value # toEncoding :: DeviceWeight -> Encoding # toJSONList :: [DeviceWeight] -> Value # toEncodingList :: [DeviceWeight] -> Encoding #
FromJSON DeviceWeight #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser DeviceWeight # parseJSONList :: Value -> Parser [DeviceWeight] #

data DeviceRate #

Constructors

DeviceRate
Fields deviceRatePath :: FilePath deviceRateRate :: Text

Instances

Eq DeviceRate #
Instance details Defined in Docker.Client.Types Methods (==) :: DeviceRate -> DeviceRate -> Bool # (/=) :: DeviceRate -> DeviceRate -> Bool #
Show DeviceRate #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> DeviceRate -> ShowS # show :: DeviceRate -> String # showList :: [DeviceRate] -> ShowS #
ToJSON DeviceRate #
Instance details Defined in Docker.Client.Types Methods toJSON :: DeviceRate -> Value # toEncoding :: DeviceRate -> Encoding # toJSONList :: [DeviceRate] -> Value # toEncodingList :: [DeviceRate] -> Encoding #
FromJSON DeviceRate #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser DeviceRate # parseJSONList :: Value -> Parser [DeviceRate] #

addPortBinding :: PortBinding -> CreateOpts -> CreateOpts #

A convenience function that adds PortBindings to and exiting CreateOpts record. Useful with defaultCreateOpts Example:

>>> let pb = PortBinding 80 TCP [HostPort "0.0.0.0" 8000]
>>> addPortBinding pb $ defaultCreateOpts "nginx:latest"

addExposedPort :: ExposedPort -> CreateOpts -> CreateOpts #

Helper function for adding a ExposedPort to and existing CreateOpts record.

addBind :: Bind -> CreateOpts -> CreateOpts #

A helper function to more easily add a bind mount to existing CreateOpts records.

setCmd :: Text -> CreateOpts -> CreateOpts #

Helper function for adding a Command to and existing CreateOpts record.

addLink :: Link -> CreateOpts -> CreateOpts #

Helper function for adding a Link to and existing CreateOpts record.

addVolume :: Volume -> CreateOpts -> CreateOpts #

Helper function for adding a Volume to and existing CreateOpts record.

addVolumeFrom :: VolumeFrom -> CreateOpts -> CreateOpts #

Helper function for adding a VolumeFrom to and existing CreateOpts record.

data MemoryConstraint #

Constructors

MemoryConstraint Integer MemoryConstraintSize

Instances

Eq MemoryConstraint #
Instance details Defined in Docker.Client.Types Methods (==) :: MemoryConstraint -> MemoryConstraint -> Bool # (/=) :: MemoryConstraint -> MemoryConstraint -> Bool #
Show MemoryConstraint #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> MemoryConstraint -> ShowS # show :: MemoryConstraint -> String # showList :: [MemoryConstraint] -> ShowS #
ToJSON MemoryConstraint #
Instance details Defined in Docker.Client.Types Methods toJSON :: MemoryConstraint -> Value # toEncoding :: MemoryConstraint -> Encoding # toJSONList :: [MemoryConstraint] -> Value # toEncodingList :: [MemoryConstraint] -> Encoding #
FromJSON MemoryConstraint #
Instance details Defined in Docker.Client.Types Methods parseJSON :: Value -> Parser MemoryConstraint # parseJSONList :: Value -> Parser [MemoryConstraint] #

data MemoryConstraintSize #

Constructors

B
MB
GB

Instances

Eq MemoryConstraintSize #
Instance details Defined in Docker.Client.Types Methods (==) :: MemoryConstraintSize -> MemoryConstraintSize -> Bool # (/=) :: MemoryConstraintSize -> MemoryConstraintSize -> Bool #
Show MemoryConstraintSize #
Instance details Defined in Docker.Client.Types Methods showsPrec :: Int -> MemoryConstraintSize -> ShowS # show :: MemoryConstraintSize -> String # showList :: [MemoryConstraintSize] -> ShowS #