@@ -1,7 +1,7 @@
11{-# LANGUAGE RecordWildCards #-}
22{-# LANGUAGE ScopedTypeVariables #-}
33
4−module Docker.Types (
4+module Docker.Client.Types (
55 Endpoint(..)
66 , URL
77 , ApiVersion
@@ -11,7 +11,11 @@ module Docker.Types (
1111 , ImageID
1212 , fromImageID
1313 , toImageID
14+ , NetworkID
15+ , fromNetworkID
16+ , toNetworkID
1417 , Timeout(..)
18+ , StatusCode(..)
1519 , Signal(..)
1620 , ContainerDetails(..)
1721 , DockerClientOpts(..)
@@ -22,40 +26,48 @@ module Docker.Types (
2226 , ContainerPortInfo(..)
2327 , Container(..)
2428 , ContainerState(..)
25− , Status(..)
29+ , State(..)
2630 , Digest
27− , Labels(..)
31+ , Label(..)
2832 , Tag
2933 , Image(..)
34+ , Entrypoint(..)
3035 , dropImagePrefix
3136 , CreateOpts(..)
37+ , BuildOpts(..)
38+ , defaultBuildOpts
3239 , defaultCreateOpts
3340 , DetachKeys(..)
3441 , StartOpts(..)
3542 , defaultStartOpts
36− , DeleteOpts(..)
43+ , ContainerDeleteOpts(..)
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
3747 , Timestamp
3848 , TailLogOpt(..)
3949 , LogOpts(..)
4050 , defaultLogOpts
51+ , CreateNetworkOpts(..)
52+ , defaultCreateNetworkOpts
4153 , VolumePermission(..)
54+ , Bind(..)
4255 , Volume(..)
4356 , Device(..)
4457 , ContainerName
4558 , VolumeFrom(..)
4659 , Link(..)
4760 , LogDriverType(..)
48− , LogDriverOptions(..)
61+ , LogDriverOption(..)
4962 , LogDriverConfig(..)
5063 , NetworkMode(..)
5164 , PortType(..)
52− , NetworkInterface(..)
53− , Networks(..)
65+-- , NetworkInterface(..)
66+ , Network(..)
5467 , NetworkSettings(..)
5568 , NetworkOptions(..)
5669 , Mount(..)
5770 , PortBinding(..)
58− , PortBindings(..)
5971 , HostPort(..)
6072 , RetryCount
6173 , RestartPolicy(..)
@@ -63,6 +75,8 @@ module Docker.Types (
6375 , UTSMode(..)
6476 , HostConfig(..)
6577 , defaultHostConfig
78+ , NetworkingConfig(..)
79+ , EndpointConfig(..)
6680 , Ulimit(..)
6781 , ContainerResources(..)
6882 , defaultContainerResources
@@ -72,7 +86,18 @@ module Docker.Types (
7286 , EnvVar(..)
7387 , ContainerConfig(..)
7488 , defaultContainerConfig
75− , ExposedPorts(..)
89+ , ExposedPort(..)
90+ , DeviceWeight(..)
91+ , DeviceRate(..)
92+ , addPortBinding
93+ , addExposedPort
94+ , addBind
95+ , setCmd
96+ , addLink
97+ , addVolume
98+ , addVolumeFrom
99+ , MemoryConstraint(..)
100+ , MemoryConstraintSize(..)
76101 ) where
77102
78103import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
@@ -82,39 +107,57 @@ import qualified Data.Aeson as JSON
82107import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
83108import Data.Char (isAlphaNum, toUpper)
84109import qualified Data.HashMap.Strict as HM
85−import qualified Data.Map as M
86110import Data.Monoid ((<>))
111+import Data.Scientific (floatingOrInteger)
87112import Data.Text (Text)
88113import qualified Data.Text as T
89114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
90116import GHC.Generics (Generic)
91117import Prelude hiding (all, tail)
92118import Text.Read (readMaybe)
93119
120+-- | List of Docker Engine API endpoints
94121data Endpoint =
95122 VersionEndpoint
96123 | ListContainersEndpoint ListOpts
97124 | ListImagesEndpoint ListOpts
98− | CreateContainerEndpoint CreateOpts
125+ | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
99126 | StartContainerEndpoint StartOpts ContainerID
100127 | StopContainerEndpoint Timeout ContainerID
128+ | WaitContainerEndpoint ContainerID
101129 | KillContainerEndpoint Signal ContainerID
102130 | RestartContainerEndpoint Timeout ContainerID
103131 | PauseContainerEndpoint ContainerID
104132 | UnpauseContainerEndpoint ContainerID
105− | ContainerLogsEndpoint LogOpts Bool ContainerID -- Second argument (Bool) is whether to follow.
106− | DeleteContainerEndpoint DeleteOpts ContainerID
133+ | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
134+ -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
107136 | InspectContainerEndpoint ContainerID
137+ | BuildImageEndpoint BuildOpts FilePath
138+ | CreateImageEndpoint T.Text Tag (Maybe T.Text) -- ^ Either pull an image from docker hub or imports an image from a tarball (or URL)
139+ | DeleteImageEndpoint ImageDeleteOpts ImageID
140+ | CreateNetworkEndpoint CreateNetworkOpts
141+ | RemoveNetworkEndpoint NetworkID
108142 deriving (Eq, Show)
109143
144+-- | We should newtype this
110145type URL = Text
146+
147+-- | We should newtype this
111148type ApiVersion = Text
149+
150+
151+-- | ID of a contianer
112152newtype ContainerID = ContainerID Text
113153 deriving (Eq, Show)
114154
155+-- | Used for extracting the id of the container from the newtype
115156fromContainerID :: ContainerID -> Text
116157fromContainerID (ContainerID t) = t
117158
159+-- | Used for parsing a Text value into a ContainerID. We apply some basic
160+-- validation here.
118161toContainerID :: Text -> Maybe ContainerID
119162toContainerID t =
120163 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
@@ -122,12 +165,16 @@ toContainerID t =
122165 else
123166 Nothing
124167
168+-- ID of an image.
125169newtype ImageID = ImageID Text
126170 deriving (Eq, Show)
127171
172+-- | Used for extracting the id of the image from the newtype.
128173fromImageID :: ImageID -> Text
129174fromImageID (ImageID t) = t
130175
176+-- | Helper function used for parsing a Text value into an ImageID. For now
177+-- just basic validation is used.
131178toImageID :: Text -> Maybe ImageID
132179toImageID t =
133180 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
@@ -135,9 +182,26 @@ toImageID t =
135182 else
136183 Nothing
137184
185+-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
138186data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
139187
188+data StatusCode = StatusCode Int
189+
190+instance ToJSON StatusCode where
191+ toJSON (StatusCode c) = object ["StatusCode" .= c]
192+
193+instance FromJSON StatusCode where
194+ parseJSON (JSON.Object o) = do
195+ c <- o .: "StatusCode"
196+ if c >= 0 && c <= 255 then
197+ return (StatusCode c)
198+ else
199+ fail "Unknown exit code"
200+ parseJSON _ = fail "Unknown exit code"
201+
140202-- TODO: Add more Signals or use an existing lib
203+-- | Signal used for sending to the process running in the container.
204+-- The default signal is SIGTERM.
141205data Signal = SIGHUP
142206 | SIGINT
143207 | SIGQUIT
@@ -149,16 +213,16 @@ data Signal = SIGHUP
149213
150214instance FromJSON Signal where
151215 parseJSON (JSON.String "SIGTERM") = return SIGTERM
152− parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
153− parseJSON (JSON.String "SIGINT") = return SIGINT
216+ parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
217+ parseJSON (JSON.String "SIGINT") = return SIGINT
154218 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
155219 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
156220 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
157− parseJSON _ = fail "Unknown Signal"
221+ parseJSON _ = fail "Unknown Signal"
158222
159223instance ToJSON Signal where
160− toJSON SIGHUP = "SIGHUP"
161− toJSON SIGINT = "SIGINT"
224+ toJSON SIGHUP = "SIGHUP"
225+ toJSON SIGINT = "SIGINT"
162226 toJSON SIGQUIT = "SIGQUIT"
163227 toJSON SIGSTOP = "SIGSTOP"
164228 toJSON SIGTERM = "SIGTERM"
@@ -186,17 +250,19 @@ data ContainerDetails = ContainerDetails {
186250 , processLabel :: Text
187251 , resolveConfPath :: FilePath
188252 , restartCount :: Int
189− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
190254 , mounts :: [Mount]
191255 }
192256 deriving (Eq, Show, Generic)
193257
258+-- | Data type used for parsing the mount information from a container
259+-- list.
194260data Mount = Mount {
195− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
196262 , mountSource :: FilePath
197263 , mountDestination :: FilePath
198− , mountDriver :: Text
199− , mountMode :: Text -- Note: Improve this?
264+ , mountDriver :: Maybe Text
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
200266 , mountRW :: Bool
201267 , mountPropogation :: Text
202268 }
@@ -204,16 +270,18 @@ data Mount = Mount {
204270
205271instance FromJSON Mount where
206272 parseJSON (JSON.Object o) = do
207− name <- o .: "Name"
273+ name <- o .:? "Name"
208274 src <- o .: "Source"
209275 dest <- o .: "Destination"
210− driver <- o .: "Driver"
211− mode <- o .: "Mode"
276+ driver <- o .:? "Driver"
277+ -- mode <- o .: "Mode"
212278 rw <- o .: "RW"
213279 prop <- o .: "Propagation"
214− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
215281 parseJSON _ = fail "Mount is not an object"
216282
283+-- | Data type used for parsing the container state from a list of
284+-- containers.
217285data ContainerState = ContainerState {
218286 containerError :: Text
219287 , exitCode :: Int
@@ -225,7 +293,7 @@ data ContainerState = ContainerState {
225293 , restarting :: Bool
226294 , running :: Bool
227295 , startedAt :: UTCTime
228− , status :: Status
296+ , state :: State
229297 }
230298 deriving (Eq, Show, Generic)
231299
@@ -245,23 +313,30 @@ instance FromJSON ContainerState where
245313 return $ ContainerState err exit finished oomKilled dead paused pid restarting running started st
246314 parseJSON _ = fail "ContainerState is not an object"
247315
316+
317+-- | Client options used to configure the remote engine we're talking to
248318data DockerClientOpts = DockerClientOpts {
249319 apiVer :: ApiVersion
250320 , baseUrl :: URL
251321 }
252322 deriving (Eq, Show)
253323
324+-- | Default "DockerClientOpts" used for talking to the docker engine.
254325defaultClientOpts :: DockerClientOpts
255326defaultClientOpts = DockerClientOpts {
256− apiVer = "v1.23"
327+ apiVer = "v1.24"
257328 , baseUrl = "http://127.0.0.1:2375"
258329 }
259330
331+-- | List options used for filtering the list of container or images.
260332data ListOpts = ListOpts { all :: Bool } deriving (Eq, Show)
261333
334+-- | Default "ListOpts". Doesn't list stopped containers.
262335defaultListOpts :: ListOpts
263336defaultListOpts = ListOpts { all=False }
264337
338+-- | Data type used for represneting the version of the docker engine
339+-- remote API.
265340data DockerVersion = DockerVersion {
266341 version :: Text
267342 , apiVersion :: ApiVersion
@@ -331,6 +406,8 @@ instance FromJSON ImageID where
331406 return iid
332407 parseJSON _ = fail "ImageID is not an object."
333408
409+-- | Data type used for representing the information of various ports that
410+-- a contianer may expose.
334411data ContainerPortInfo = ContainerPortInfo {
335412 ipAddressInfo :: Maybe Text
336413 , privatePortInfo :: Port
@@ -347,6 +424,8 @@ instance FromJSON ContainerPortInfo where
347424 parseJSON _ = fail "ContainerPortInfo: Not a JSON object."
348425
349426-- For inspecting container details.
427+-- | Data type used for parsing the network information of each container
428+-- when listing them.
350429data NetworkOptions = NetworkOptions {
351430-- ipamConfig :: Maybe Text -- Don't see in 1.24
352431-- , links :: Maybe Text -- Don't see in 1.24
@@ -376,41 +455,40 @@ instance FromJSON NetworkOptions where
376455 return $ NetworkOptions networkId endpointId gateway ip ipLen ip6Gateway globalIP6 globalIP6Len mac
377456 parseJSON _ = fail "NetworkOptions is not an object"
378457
379−newtype Networks = Networks (M.Map NetworkMode NetworkOptions) -- Note: Is it ever possible that there will be duplicates of network modes?
458+-- TODO: Not sure what this is used for anymore.
459+data Network = Network NetworkMode NetworkOptions
380460 deriving (Eq, Show)
381461
382−instance FromJSON Networks where
383− parseJSON (JSON.Object o) = do
384− Networks <$> HM.foldlWithKey' f (return M.empty) o
385−
462+instance {-# OVERLAPPING #-} FromJSON [Network] where
463+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
386464 where
387465 f accM k' v' = do
388466 acc <- accM
389467 k <- parseJSON $ JSON.String k'
390468 v <- parseJSON v'
391− return $ M.insert k v acc
392−
469+ return $ (Network k v):acc
393470 parseJSON _ = fail "Networks is not an object"
394471
472+-- | Data type reprsenting the various network settings a container can have.
395473data NetworkSettings = NetworkSettings {
396− networkSettingsBridge :: Text
397− , networkSettingsSandboxId :: Text
398− , networkSettingsHairpinMode :: Bool
399− , networkSettingsLinkLocalIPv6Address :: Text
474+ networkSettingsBridge :: Text
475+ , networkSettingsSandboxId :: Text
476+ , networkSettingsHairpinMode :: Bool
477+ , networkSettingsLinkLocalIPv6Address :: Text
400478 , networkSettingsLinkLocalIPv6PrefixLen :: Int
401− , networkSettingsPorts :: PortBindings
402− , networkSettingsSandboxKey :: Text
403− , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
479+ , networkSettingsPorts :: [PortBinding]
480+ , networkSettingsSandboxKey :: Text
481+ , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
404482 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
405− , networkSettingsEndpointID :: Text
406− , networkSettingsGateway :: Text
407− , networkSettingsGlobalIPv6Address :: Text
408− , networkSettingsGlobalIPv6PrefixLen :: Int
409− , networkSettingsIpAddress :: Text
410− , networkSettingsIpPrefixLen :: Int
411− , networkSettingsIpv6Gateway :: Text
412− , networkSettingsMacAddress :: Text
413− , networkSettingsNetworks :: Networks
483+ , networkSettingsEndpointID :: Text
484+ , networkSettingsGateway :: Text
485+ , networkSettingsGlobalIPv6Address :: Text
486+ , networkSettingsGlobalIPv6PrefixLen :: Int
487+ , networkSettingsIpAddress :: Text
488+ , networkSettingsIpPrefixLen :: Int
489+ , networkSettingsIpv6Gateway :: Text
490+ , networkSettingsMacAddress :: Text
491+ , networkSettingsNetworks :: [Network]
414492 }
415493 deriving (Eq, Show)
416494
@@ -437,6 +515,7 @@ instance FromJSON NetworkSettings where
437515 return $ NetworkSettings bridge sandbox hairpin localIP6 localIP6Len ports sandboxKey secondaryIP secondayIP6 endpointID gateway globalIP6 globalIP6Len ip ipLen ip6Gateway mac networks
438516 parseJSON _ = fail "NetworkSettings is not an object."
439517
518+-- | Data type used for parsing a list of containers.
440519data Container = Container
441520 { containerId :: ContainerID
442521 , containerNames :: [Text]
@@ -444,21 +523,23 @@ data Container = Container
444523 , containerImageId :: ImageID
445524 , containerCommand :: Text
446525 , containerCreatedAt :: Int
447− , containerStatus :: Status
526+ , containerState :: State
527+ , containerStatus :: Maybe Text
448528 , containerPorts :: [ContainerPortInfo]
449− , containerLabels :: Labels
450− , containerNetworks :: Networks
529+ , containerLabels :: [Label]
530+ , containerNetworks :: [Network]
451531 , containerMounts :: [Mount]
452532 } deriving (Show, Eq)
453533
454534instance FromJSON Container where
455− parseJSON (JSON.Object v) =
456− Container <$> (v .: "Id")
535+ parseJSON o@(JSON.Object v) =
536+ Container <$> parseJSON o
457537 <*> (v .: "Names")
458538 <*> (v .: "Image")
459− <*> (v .: "ImageID")
460− <*> (v .: "Command")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
540+ <*> (v .: "Command") -- Doesn't exist anymore
461541 <*> (v .: "Created")
542+ <*> (v .: "State")
462543 <*> (v .: "Status")
463544 <*> (v .: "Ports")
464545 <*> (v .: "Labels")
@@ -468,65 +549,124 @@ instance FromJSON Container where
468549 parseNetworks (JSON.Object v) =
469550 (v .: "Networks") >>= parseJSON
470551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
471−
472552 parseJSON _ = fail "Container: Not a JSON object."
473553
474−data Status = Created | Restarting | Running | Paused | Exited | Dead
554+-- | Represents the state of the container life cycle.
555+data State = Created | Restarting | Running | Paused | Exited | Dead
475556 deriving (Eq, Show, Generic)
476557
477−instance FromJSON Status where
478− parseJSON (JSON.String "running") = return Running
479− parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
558+instance FromJSON State where
559+ parseJSON (JSON.String "running") = return Running
560+ parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
480561 parseJSON (JSON.String "restarting") = return Restarting
481− parseJSON (JSON.String "paused") = return Paused
482− parseJSON (JSON.String "exited") = return Exited
483− parseJSON (JSON.String "dead") = return Dead
484− parseJSON _ = fail "Unknown Status"
562+ parseJSON (JSON.String "paused") = return Paused
563+ parseJSON (JSON.String "exited") = return Exited
564+ parseJSON (JSON.String "dead") = return Dead
565+ parseJSON s = fail $ "Unknown Status: " ++ show s
485566
567+-- | Alias for representing a RepoDigest. We could newtype this and add
568+-- some validation.
486569type Digest = Text
487570
488−newtype Labels = Labels (M.Map Name Value) deriving (Eq, Show)
571+-- | Container and Image Labels.
572+data Label = Label Name Value deriving (Eq, Show)
489573
490−instance FromJSON Labels where
491− parseJSON val = Labels <$> parseJSON val
492574
493−instance ToJSON Labels where
494− toJSON (Labels kvs) = object [k .= v | (k,v) <- (M.toList kvs)]
575+-- If there are multiple lables with the same Name in the list
576+-- then the last one wins.
577+instance {-# OVERLAPPING #-} ToJSON [Label] where
578+ toJSON [] = emptyJsonObject
579+ toJSON (l:ls) = toJsonKeyVal (l:ls) key val
580+ where key (Label k _) = T.unpack k
581+ val (Label _ v) = v
495582
583+instance {-# OVERLAPPING #-} FromJSON [Label] where
584+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
585+ where f accM k v = do
586+ acc <- accM
587+ value <- parseJSON v
588+ return $ (Label k value):acc
589+ parseJSON JSON.Null = return []
590+ parseJSON _ = fail "Failed to parse Labels. Not an object."
591+
592+-- | Alias for Tags.
496593type Tag = Text
497594
595+-- | Data type used for parsing information from a list of images.
498596data Image = DockerImage {
499597 imageId :: ImageID
500598 , imageCreated :: Integer
501599 , imageParentId :: Maybe ImageID
502600 , imageRepoTags :: [Tag]
503− , imageRepoDigests :: Maybe [Digest]
601+ , imageRepoDigests :: [Digest]
504602 , imageSize :: Integer
505603 , imageVirtualSize :: Integer
506− , imageLabels :: Maybe Labels
604+ , imageLabels :: [Label]
507605 } deriving (Show, Eq, Generic)
508606
607+-- | Helper function used for dropping the "image" prefix when serializing
608+-- the Image data type to and from json.
509609dropImagePrefix :: [a] -> [a]
510610dropImagePrefix = drop 5
511611
512−instance FromJSON Image where
513− parseJSON = genericParseJSON defaultOptions {
514− fieldLabelModifier = dropImagePrefix}
515612
613+instance FromJSON Image where
614+ parseJSON (JSON.Object o) = do
615+ imageId <- o .: "Id"
616+ imageCreated <- o .: "Created"
617+ imageParentId <- o .:? "ParentId"
618+ imageRepoTags <- o .:? "RepoTags" .!= []
619+ imageRepoDigests <- o .:? "RepoDigests" .!= []
620+ imageSize <- o .: "Size"
621+ imageVirtualSize <- o .: "VirtualSize"
622+ imageLabels <- o .:? "Labels" .!= []
623+ return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
624+ parseJSON _ = fail "Failed to parse DockerImage."
625+
626+-- | Alias for Aliases.
627+type Alias = Text
628+
629+-- | EndpointsConfig is container configuration for a specific network
630+newtype EndpointConfig = EndpointConfig [Alias] deriving (Eq, Show)
631+
632+instance ToJSON EndpointConfig where
633+ toJSON (EndpointConfig aliases) = JSON.object
634+ [ "Aliases" .= aliases
635+ ]
636+
637+-- | Alias for endpoint name
638+type EndpointName = Text
639+
640+-- | Data type for the NetworkingConfig section of the container settings
641+newtype NetworkingConfig = NetworkingConfig
642+ { endpointsConfig :: HM.HashMap EndpointName EndpointConfig
643+ } deriving (Eq, Show)
644+
645+instance ToJSON NetworkingConfig where
646+ toJSON (NetworkingConfig endpointsConfig) = JSON.object
647+ [ "EndpointsConfig" .= endpointsConfig
648+ ]
649+
650+-- | Options used for creating a Container.
516651data CreateOpts = CreateOpts {
517− containerConfig :: ContainerConfig
518− , hostConfig :: HostConfig
652+ containerConfig :: ContainerConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
519655 } deriving (Eq, Show)
520656
521657instance ToJSON CreateOpts where
522− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
523659 let ccJSON = toJSON cc
524660 let hcJSON = toJSON hc
525661 case ccJSON of
526662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
527− JSON.Object $ HM.insert "HostConfig" hcJSON o
663+ let o1 = HM.insert "HostConfig" hcJSON o
664+ let o2 = HM.insert "NetworkingConfig" (toJSON nc) o1
665+ JSON.Object o2
528666 _ -> error "ContainerConfig is not an object." -- This should never happen.
529667
668+-- | Container configuration used for creating a container with sensible
669+-- defaults.
530670defaultContainerConfig :: Text -> ContainerConfig
531671defaultContainerConfig imageName = ContainerConfig {
532672 hostname=Nothing
@@ -536,28 +676,29 @@ defaultContainerConfig imageName = ContainerConfig {
536676 , attachStdout=False
537677 , image=imageName
538678 , attachStderr=False
539− , exposedPorts=ExposedPorts M.empty
679+ , exposedPorts=[]
540680 , tty=False
541681 , openStdin=False
542682 , stdinOnce=False
543683 , env=[]
544684 , cmd=[]
545− , volumes=Nothing
685+ , volumes=[]
546686 , workingDir=Nothing
547− , entrypoint=Nothing
687+ , entrypoint=Entrypoint []
548688 , networkDisabled=Nothing
549689 , macAddress=Nothing
550− , labels=Nothing
690+ , labels=[]
551691 , stopSignal=SIGTERM
552692 }
553693
694+-- | Default host confiratuon used for creating a container.
554695defaultHostConfig :: HostConfig
555696defaultHostConfig = HostConfig {
556697 binds=[]
557698 , containerIDFile=Nothing
558− , logConfig=LogDriverConfig JsonFile Nothing
559− , networkMode=Bridge
560− , portBindings=PortBindings []
699+ , logConfig=LogDriverConfig JsonFile []
700+ , networkMode=NetworkBridge
701+ , portBindings=[]
561702 , restartPolicy=RestartOff
562703 , volumeDriver=Nothing
563704 , volumesFrom=[]
@@ -578,6 +719,7 @@ defaultHostConfig = HostConfig {
578719 , resources=defaultContainerResources
579720 }
580721
722+-- Default container resource contstraints (None).
581723defaultContainerResources :: ContainerResources
582724defaultContainerResources = ContainerResources {
583725 cpuShares=Nothing
@@ -595,31 +737,80 @@ defaultContainerResources = ContainerResources {
595737 , memory=Nothing
596738 , memoryReservation=Nothing
597739 , memorySwap=Nothing
598− , oomKillDisable=False
740+ , oomKillDisable=Just False
599741 , ulimits=[]
600742 }
601743
602−
744+-- | Default create options when creating a container. You only need to
745+-- specify an image name and the rest is all sensible defaults.
603746defaultCreateOpts :: T.Text -> CreateOpts
604−defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
747+defaultCreateOpts imageName = CreateOpts
748+ { containerConfig = defaultContainerConfig imageName
749+ , hostConfig = defaultHostConfig
750+ , networkingConfig = NetworkingConfig HM.empty
751+ }
605752
606−-- detachKeys – Override the key sequence for detaching a container.
753+-- | Override the key sequence for detaching a container.
607754-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
608755data DetachKeys = WithCtrl Char | WithoutCtrl Char | DefaultDetachKey deriving (Eq, Show)
609756
757+-- | Options for starting a container.
610758data StartOpts = StartOpts { detachKeys :: DetachKeys } deriving (Eq, Show)
611759
760+-- | Default options for staring a container.
612761defaultStartOpts :: StartOpts
613762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
614763
615−data DeleteOpts = DeleteOpts {
616− deleteVolumes :: Bool
617− , force :: Bool
764+-- | Options for deleting a container.
765+data ContainerDeleteOpts = ContainerDeleteOpts {
766+ deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
767+ , force :: Bool -- ^ If the container is still running force deletion anyway.
618768 } deriving (Eq, Show)
619769
770+-- TODO: Add support for container build constraints
771+-- | Options for when building images from a Dockerfile
772+data BuildOpts = BuildOpts {
773+ buildImageName :: Text -- ^ Image name in the form of name:tag; ie. myimage:latest.:w
774+ , buildDockerfileName :: Text -- ^ Name of dockerfile (default: Dockerfile)
775+ , buildQuiet :: Bool
776+ , buildNoCache :: Bool -- ^ Do not use cache when building the image.
777+ , buildRemoveItermediate :: Bool -- ^ Remove intermediate containers after a successful build (default true).
778+ , buildForceRemoveIntermediate :: Bool -- ^ Always remove intermediate containers.
779+ , buildPullParent :: Bool -- ^ Always attempt to pull a newer version of the *parent* image (ie. FROM debian:jessie).
780+ } deriving (Eq, Show)
781+
782+defaultBuildOpts :: Text -> BuildOpts
783+defaultBuildOpts nameTag = BuildOpts { buildImageName = nameTag
784+ , buildDockerfileName = "Dockerfile"
785+ , buildQuiet = False
786+ , buildNoCache = False
787+ , buildRemoveItermediate = True
788+ , buildForceRemoveIntermediate = False
789+ , buildPullParent = False
790+ }
791+
792+-- | Default options for deleting a container. Most of the time we DON'T
793+-- want to delete the container's volumes or force delete it if it's
794+-- running.
795+defaultContainerDeleteOpts :: ContainerDeleteOpts
796+defaultContainerDeleteOpts = ContainerDeleteOpts { deleteVolumes = False, force = False }
797+
798+-- | Image delete opts
799+data ImageDeleteOpts = ImageDeleteOpts deriving (Eq, Show)
800+
801+-- | Sane image deletion defaults
802+defaultImageDeleteOpts :: ImageDeleteOpts
803+defaultImageDeleteOpts = ImageDeleteOpts
804+
805+-- | Timestamp alias.
620806type Timestamp = Integer
807+
808+-- | Used for requesting N number of lines when tailing a containers log
809+-- output.
621810data TailLogOpt = Tail Integer | All deriving (Eq, Show)
622811
812+
813+-- | Log options used when requesting the log output from a container.
623814data LogOpts = LogOpts {
624815 stdout :: Bool
625816 , stderr :: Bool
@@ -628,6 +819,7 @@ data LogOpts = LogOpts {
628819 , tail :: TailLogOpt
629820 } deriving (Eq, Show)
630821
822+-- | Sensible default for log options.
631823defaultLogOpts :: LogOpts
632824defaultLogOpts = LogOpts { stdout = True
633825 , stderr = True
@@ -636,37 +828,87 @@ defaultLogOpts = LogOpts { stdout = True
636828 , tail = All
637829 }
638830
639−data VolumePermission = Rw | Ro deriving (Eq, Show, Generic)
640−
641−-- instance ToJSON VolumePermission where
642−-- toJSON = error "TODO"
643−-- instance FromJSON VolumePermission where
644−-- parseJSON = error "TODO"
645−
646−-- Note: Note really sure what this should be (1.24).
647−-- This is not the same as [Volume] in HostConfig.
648−newtype Volumes = Volumes [Text] -- [Volume]
649− deriving (Eq, Show)
650−
651−instance FromJSON Volumes where
652− parseJSON (JSON.Object o) = return $ Volumes $ HM.keys o
653− parseJSON _ = fail "Volumes is not an object"
654−
655−instance ToJSON Volumes where
656− toJSON (Volumes vs) = toJSON vs
657−
658−data Volume = Volume { hostSrc :: Text
659− , containerDest :: Text
660− , volumePermission :: Maybe VolumePermission
661− } deriving (Eq, Show)
831+-- | Options for creating a network
832+data CreateNetworkOpts = CreateNetworkOpts
833+ { createNetworkName :: Text -- ^ The network's name
834+ , createNetworkCheckDuplicate :: Bool -- ^ Check for networks with duplicate names.
835+ , createNetworkDriver :: Text -- ^ Name of the network driver plugin to use.
836+ , createNetworkInternal :: Bool -- ^ Restrict external access to the network.
837+ , createNetworkEnableIPv6 :: Bool -- ^ Enable IPv6 on the network.
838+ } deriving (Eq, Show)
839+
840+-- | Sensible defalut for create network options
841+defaultCreateNetworkOpts :: Text -> CreateNetworkOpts
842+defaultCreateNetworkOpts name =
843+ CreateNetworkOpts
844+ { createNetworkName = name
845+ , createNetworkCheckDuplicate = False
846+ , createNetworkDriver = "bridge"
847+ , createNetworkInternal = True
848+ , createNetworkEnableIPv6 = False
849+ }
850+
851+instance ToJSON CreateNetworkOpts where
852+ toJSON opts =
853+ object
854+ [ "Name" .= createNetworkName opts
855+ , "CheckDuplicate" .= createNetworkCheckDuplicate opts
856+ , "Driver" .= createNetworkDriver opts
857+ , "Internal" .= createNetworkInternal opts
858+ , "EnableIPv6" .= createNetworkEnableIPv6 opts
859+ ]
860+
861+-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
862+-- | Set permissions on volumes that you mount in the container.
863+data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
864+
865+instance ToJSON VolumePermission where
866+ toJSON ReadWrite = "rw"
867+ toJSON ReadOnly = "ro"
868+
869+instance FromJSON VolumePermission where
870+ parseJSON "rw" = return ReadWrite
871+ parseJSON "ro" = return ReadOnly
872+ parseJSON "RW" = return ReadWrite
873+ parseJSON "RO" = return ReadOnly
874+ parseJSON _ = fail "Failed to parse VolumePermission"
875+
876+-- | Used for marking a directory in the container as "exposed" hence
877+-- taking it outside of the COW filesystem and making it mountable
878+-- in other containers using "VolumesFrom". The volume usually get's
879+-- created somewhere in @/var/lib/docker/volumes@ (depending on the volume
880+-- driver used).
881+-- The CLI example is:
882+--
883+-- @
884+-- docker run --name app -v \/opt\/data -it myapp:latest
885+-- docker run --name app2 --volumes-from app \/bin\/bash -c "ls -l \/opt\/data"
886+-- @
887+newtype Volume = Volume FilePath deriving (Eq, Show)
888+
889+instance {-# OVERLAPPING #-} ToJSON [Volume] where
890+ toJSON [] = emptyJsonObject
891+ toJSON (v:vs) = toJsonKey (v:vs) getKey
892+ where getKey (Volume v) = v
893+
894+instance {-# OVERLAPPING #-} FromJSON [Volume] where
895+ parseJSON (JSON.Object o) = return $ map (Volume . T.unpack) $ HM.keys o
896+ parseJSON (JSON.Null) = return []
897+ parseJSON _ = fail "Volume is not an object"
898+
899+
900+data Bind = Bind { hostSrc :: Text
901+ , containerDest :: Text
902+ , volumePermission :: Maybe VolumePermission
903+ } deriving (Eq, Show)
662904
663−instance FromJSON Volume where
905+instance FromJSON Bind where
664906 parseJSON (JSON.String t) = case T.split (== ':') t of
665− [src, dest] -> return $ Volume src dest Nothing
666− [src, dest, "rw"] -> return $ Volume src dest $ Just Rw
667− [src, dest, "ro"] -> return $ Volume src dest $ Just Ro
668− _ -> fail "Could not parse Volume"
669− parseJSON _ = fail "Volume is not a string"
907+ [src, dest] -> return $ Bind src dest Nothing
908+ [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
909+ [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
910+ _ -> fail "Could not parse Bind"
911+ parseJSON _ = fail "Bind is not a string"
670912
671913data Device = Device {
672914 pathOnHost :: FilePath
@@ -688,19 +930,19 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
688930
689931instance FromJSON VolumeFrom where
690932 parseJSON (JSON.String t) = case T.split (== ':') t of
691− [vol] -> return $ VolumeFrom vol Nothing
692− [vol, "rw"] -> return $ VolumeFrom vol $ Just Rw
693− [vol, "ro"] -> return $ VolumeFrom vol $ Just Ro
694− _ -> fail "Could not parse VolumeFrom"
933+ [vol] -> return $ VolumeFrom vol Nothing
934+ [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
935+ [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
936+ _ -> fail "Could not parse VolumeFrom"
695937 parseJSON _ = fail "VolumeFrom is not a string"
696938
697939instance ToJSON VolumeFrom where
698940 toJSON (VolumeFrom n p) = case p of
699− Nothing -> toJSON $ n <> ":" <> "rw"
941+ Nothing -> toJSON $ n <> ":" <> "rw"
700942 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
701943
702−instance ToJSON Volume where
703− toJSON (Volume src dest mode) = toJSON $ case mode of
944+instance ToJSON Bind where
945+ toJSON (Bind src dest mode) = toJSON $ case mode of
704946 Nothing -> T.concat[src, ":", dest]
705947 Just m -> T.concat[src, ":", dest, ":", (T.pack $ show m)]
706948
@@ -708,63 +950,63 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
708950
709951instance FromJSON Link where
710952 parseJSON (JSON.String t) = case T.split (== ':') t of
711− [f] -> return $ Link f Nothing
953+ [f] -> return $ Link f Nothing
712954 [f,s] -> return $ Link f $ Just s
713− _ -> fail "Could not parse Link"
955+ _ -> fail "Could not parse Link"
714956 parseJSON _ = fail "Link is not a string"
715957
716958instance ToJSON Link where
717959 toJSON (Link n1 n2) = toJSON $ case n2 of
718960 Nothing -> T.concat[n1, ":", n1] -- use same name in container
719− Just n -> T.concat[n1, ":", n] -- used specified name in container
961+ Just n -> T.concat[n1, ":", n] -- used specified name in container
720962
721963-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
722964data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
723965
724966instance FromJSON LogDriverType where
725967 parseJSON (JSON.String "json-file") = return JsonFile
726− parseJSON (JSON.String "syslog") = return Syslog
727− parseJSON (JSON.String "journald") = return Journald
728− parseJSON (JSON.String "gelf") = return Gelf
729− parseJSON (JSON.String "fluentd") = return Fluentd
730− parseJSON (JSON.String "awslogs") = return AwsLogs
731− parseJSON (JSON.String "splunk") = return Splunk
732− parseJSON (JSON.String "etwlogs") = return Etwlogs
733− parseJSON (JSON.String "none") = return LoggingDisabled
734− parseJSON _ = fail "Unknown LogDriverType"
968+ parseJSON (JSON.String "syslog") = return Syslog
969+ parseJSON (JSON.String "journald") = return Journald
970+ parseJSON (JSON.String "gelf") = return Gelf
971+ parseJSON (JSON.String "fluentd") = return Fluentd
972+ parseJSON (JSON.String "awslogs") = return AwsLogs
973+ parseJSON (JSON.String "splunk") = return Splunk
974+ parseJSON (JSON.String "etwlogs") = return Etwlogs
975+ parseJSON (JSON.String "none") = return LoggingDisabled
976+ parseJSON _ = fail "Unknown LogDriverType"
735977
736978instance ToJSON LogDriverType where
737− toJSON JsonFile = JSON.String "json-file"
738− toJSON Syslog = JSON.String "syslog"
739− toJSON Journald = JSON.String "journald"
740− toJSON Gelf = JSON.String "gelf"
741− toJSON Fluentd = JSON.String "fluentd"
742− toJSON AwsLogs = JSON.String "awslogs"
743− toJSON Splunk = JSON.String "splunk"
744− toJSON Etwlogs = JSON.String "etwlogs"
979+ toJSON JsonFile = JSON.String "json-file"
980+ toJSON Syslog = JSON.String "syslog"
981+ toJSON Journald = JSON.String "journald"
982+ toJSON Gelf = JSON.String "gelf"
983+ toJSON Fluentd = JSON.String "fluentd"
984+ toJSON AwsLogs = JSON.String "awslogs"
985+ toJSON Splunk = JSON.String "splunk"
986+ toJSON Etwlogs = JSON.String "etwlogs"
745987 toJSON LoggingDisabled = JSON.String "none"
746988
747−newtype LogDriverOptions = LogDriverOptions (M.Map Text Text) deriving (Eq, Show)
989+data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
748990
749−instance FromJSON LogDriverOptions where
750− parseJSON (JSON.Object o) = do
751− LogDriverOptions <$> HM.foldlWithKey' f (return M.empty) o
991+instance {-# OVERLAPPING #-} ToJSON [LogDriverOption] where
992+ toJSON [] = emptyJsonObject
993+ toJSON (o:os) = toJsonKeyVal (o:os) key val
994+ where key (LogDriverOption n _) = T.unpack n
995+ val (LogDriverOption _ v) = v
752996
753− where
754− f accM k (JSON.String v) = do
997+instance {-# OVERLAPPING #-} FromJSON [LogDriverOption] where
998+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
999+ where f accM k v = do
7551000 acc <- accM
756− return $ M.insert k v acc
757− f _ _ _ = fail "Value of LogDriverOptions is not a string"
758−
759− parseJSON JSON.Null = return $ LogDriverOptions M.empty
760− parseJSON _ = fail "LogDriverOptions is not an object"
1001+ value <- parseJSON v
1002+ return $ (LogDriverOption k value):acc
1003+ parseJSON JSON.Null = return []
1004+ parseJSON _ = fail "Failed to parse LogDriverOptions"
7611005
762−instance ToJSON LogDriverOptions where
763− toJSON (LogDriverOptions mp) = toJSON mp
764−
765−data LogDriverConfig = LogDriverConfig LogDriverType (Maybe LogDriverOptions) deriving (Eq, Show)
1006+data LogDriverConfig = LogDriverConfig LogDriverType [LogDriverOption] deriving (Eq, Show)
7661007
7671008instance ToJSON LogDriverConfig where
1009+ toJSON (LogDriverConfig driverType []) = object ["Type" .= driverType]
7681010 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
7691011
7701012instance FromJSON LogDriverConfig where
@@ -775,21 +1017,47 @@ instance FromJSON LogDriverConfig where
7751017 parseJSON _ = fail "LogDriverConfig is not an object"
7761018
7771019-- TODO: Add container:<name|id> mode
778−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
7791021 deriving (Eq, Show, Ord)
7801022
7811023instance FromJSON NetworkMode where
782− parseJSON (JSON.String "bridge") = return Bridge
783− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
784− parseJSON (JSON.String "none") = return NetworkDisabled
785− parseJSON _ = fail "Unknown NetworkMode"
1024+ parseJSON (JSON.String "bridge") = return NetworkBridge
1025+ parseJSON (JSON.String "host") = return NetworkHost -- Note: Guessing on these.
1026+ parseJSON (JSON.String "none") = return NetworkDisabled
1027+ parseJSON (JSON.String n) = return $ NetworkNamed n
1028+ parseJSON _ = fail "Unknown NetworkMode"
7861029
7871030instance ToJSON NetworkMode where
788− toJSON Bridge = JSON.String "bridge"
789− toJSON Host = JSON.String "host"
1031+ toJSON NetworkBridge = JSON.String "bridge"
1032+ toJSON NetworkHost = JSON.String "host"
7901033 toJSON NetworkDisabled = JSON.String "none"
1034+ toJSON (NetworkNamed n) = JSON.String n
1035+
1036+newtype NetworkID = NetworkID Text
1037+ deriving (Eq, Show)
1038+
1039+-- | Used for extracting the id of the container from the newtype
1040+fromNetworkID :: NetworkID -> Text
1041+fromNetworkID (NetworkID t) = t
7911042
792−data PortType = TCP | UDP deriving (Eq, Show, Generic, Read, Ord)
1043+-- | Used for parsing a Text value into a NetworkID.
1044+toNetworkID :: Text -> Maybe NetworkID
1045+toNetworkID t = Just $ NetworkID t
1046+
1047+instance FromJSON NetworkID where
1048+ parseJSON (JSON.Object o) = do
1049+ nid <- o .: "Id"
1050+ return $ NetworkID nid
1051+ parseJSON _ = fail "NetworkID is not an object."
1052+
1053+instance ToJSON NetworkID where
1054+ toJSON (NetworkID nid) = object ["Id" .= nid]
1055+
1056+data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
1057+
1058+instance Show PortType where
1059+ show TCP = "tcp"
1060+ show UDP = "udp"
7931061
7941062instance ToJSON PortType where
7951063 toJSON TCP = "tcp"
@@ -799,24 +1067,23 @@ instance FromJSON PortType where
7991067 parseJSON val = case val of
8001068 "tcp" -> return TCP
8011069 "udp" -> return UDP
802− _ -> fail "PortType: Invalid port type."
803−
804−newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
1070+ _ -> fail "PortType: Invalid port type."
8051071
806−instance FromJSON NetworkInterface where
807− parseJSON (JSON.String v) = return $ NetworkInterface v
808− parseJSON _ = fail "Network interface is not a string."
809−
810−instance ToJSON NetworkInterface where
811− toJSON (NetworkInterface i) = JSON.String i
1072+-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
1073+--
1074+-- instance FromJSON NetworkInterface where
1075+-- parseJSON (JSON.String v) = return $ NetworkInterface v
1076+-- parseJSON _ = fail "Network interface is not a string."
1077+--
1078+-- instance ToJSON NetworkInterface where
1079+-- toJSON (NetworkInterface i) = JSON.String i
8121080
8131081-- | This datastructure models mapping a Port from the container onto the
8141082-- host system s that the service running in the container can be accessed from
8151083-- the outside world. We either map a port onto all interfaces (default) or onto a specific
8161084-- interface like `127.0.0.1`.
817−newtype PortBindings = PortBindings [PortBinding]
818− deriving (Eq, Show)
819−
1085+-- __NOTE__: We should disallow duplicate port bindings as the ToJSON
1086+-- instance will only send the last one.
8201087-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
8211088data PortBinding = PortBinding {
8221089 containerPort :: Port
@@ -824,17 +1091,65 @@ data PortBinding = PortBinding {
8241091 , hostPorts :: [HostPort]
8251092 } deriving (Eq, Show)
8261093
827−
8281094portAndType2Text :: Port -> PortType -> Text
8291095portAndType2Text p t = (T.pack $ show p) <> "/" <> (T.pack $ show t)
8301096
831−instance ToJSON PortBinding where
832− toJSON (PortBinding {..}) = object [portAndType2Text containerPort portType .= hostPorts]
833−
834−instance FromJSON PortBindings where
835− parseJSON (JSON.Object o) = do
836− PortBindings <$> HM.foldlWithKey' f (return []) o
8371097
1098+-- | A helper function to more easily add a bind mount to existing
1099+-- "CreateOpts" records.
1100+addBind :: Bind -> CreateOpts -> CreateOpts
1101+addBind b c = c{hostConfig=hc{binds=obs <> [b]}}
1102+ where hc = hostConfig c
1103+ obs = binds $ hostConfig c
1104+
1105+-- | Helper function for adding a Command to and existing
1106+-- CreateOpts record.
1107+setCmd :: Text -> CreateOpts -> CreateOpts
1108+setCmd ccmd c = c{containerConfig=cc{cmd=[ccmd]}}
1109+ where cc = containerConfig c
1110+
1111+-- | Helper function for adding a "Link" to and existing
1112+-- CreateOpts record.
1113+addLink :: Link -> CreateOpts -> CreateOpts
1114+addLink l c = c{hostConfig=hc{links=ols <> [l]}}
1115+ where hc = hostConfig c
1116+ ols = links $ hostConfig c
1117+
1118+-- | Helper function for adding a "Volume" to and existing
1119+-- CreateOpts record.
1120+addVolume :: Volume -> CreateOpts -> CreateOpts
1121+addVolume v c = c{containerConfig=cc{volumes=oldvs <> [v]}}
1122+ where cc = containerConfig c
1123+ oldvs = volumes cc
1124+
1125+-- | Helper function for adding a "VolumeFrom" to and existing
1126+-- CreateOpts record.
1127+addVolumeFrom :: VolumeFrom -> CreateOpts -> CreateOpts
1128+addVolumeFrom vf c = c{hostConfig=hc{volumesFrom=oldvfs <> [vf]}}
1129+ where hc = hostConfig c
1130+ oldvfs = volumesFrom hc
1131+
1132+-- | A convenience function that adds PortBindings to and exiting
1133+-- "CreateOpts" record. Useful with 'defaultCreateOpts'
1134+-- Example:
1135+--
1136+-- >>> let pb = PortBinding 80 TCP [HostPort "0.0.0.0" 8000]
1137+-- >>> addPortBinding pb $ defaultCreateOpts "nginx:latest"
1138+addPortBinding :: PortBinding -> CreateOpts -> CreateOpts
1139+addPortBinding pb c = c{hostConfig=hc{portBindings=pbs <> [pb]}}
1140+ where hc = hostConfig c
1141+ pbs = portBindings $ hostConfig c
1142+
1143+-- | Helper function for adding a "ExposedPort" to and existing
1144+-- CreateOpts record.
1145+addExposedPort :: ExposedPort -> CreateOpts -> CreateOpts
1146+addExposedPort ep c = c{containerConfig=cc{exposedPorts=oldeps <> [ep]}}
1147+ where cc = containerConfig c
1148+ oldeps = exposedPorts cc
1149+
1150+
1151+instance {-# OVERLAPPING #-} FromJSON [PortBinding] where
1152+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
8381153 where
8391154 f accM k v = case T.split (== '/') k of
8401155 [port', portType'] -> do
@@ -843,19 +1158,24 @@ instance FromJSON PortBindings where
8431158 acc <- accM
8441159 hps <- parseJSON v
8451160 return $ (PortBinding port portType hps):acc
846− _ ->
847− fail "Could not parse PortBindings"
1161+ _ -> fail "Could not parse PortBindings"
1162+ parseJSON (JSON.Null) = return []
8481163 parseJSON _ = fail "PortBindings is not an object"
8491164
850−instance ToJSON PortBindings where
851− toJSON (PortBindings []) = JSON.Object HM.empty
852− toJSON (PortBindings (p:ps)) = toJSON (p:ps)
1165+instance {-# OVERLAPPING #-} ToJSON [PortBinding] where
1166+ toJSON [] = emptyJsonObject
1167+ toJSON (p:ps) = toJsonKeyVal (p:ps) key val
1168+ where key p = T.unpack $ portAndType2Text (containerPort p) (portType p)
1169+ val p = hostPorts p
8531170
854−data HostPort = HostPort NetworkInterface Port
1171+data HostPort = HostPort {
1172+ hostIp :: Text
1173+ , hostPost :: Port
1174+ }
8551175 deriving (Eq, Show)
8561176
8571177instance ToJSON HostPort where
858− toJSON (HostPort i p) = object ["HostPort" .= p, "HostIP" .= i]
1178+ toJSON (HostPort i p) = object ["HostPort" .= show p, "HostIp" .= i]
8591179
8601180instance FromJSON HostPort where
8611181 parseJSON (JSON.Object o) = do
@@ -864,24 +1184,6 @@ instance FromJSON HostPort where
8641184 return $ HostPort i p
8651185 parseJSON _ = fail "HostPort is not an object."
8661186
867−-- newtype HostPorts = HostPorts [HostPort]
868−-- deriving (Eq, Show)
869−--
870−-- instance ToJSON HostPorts where
871−-- toJSON (HostPorts hps) = toJSON hps
872−--
873−-- instance FromJSON HostPorts where
874−-- parseJSON (JSON.Object o) = do
875−-- HostPorts <$> HM.foldlWithKey' f (return []) o
876−--
877−-- where
878−-- f accM k v = do
879−-- acc <- accM
880−-- p' <- parseJSON v
881−-- p <- parseIntegerText p'
882−-- return $ (HostPort (NetworkInterface k) p):acc
883−-- parseJSON _ = fail $ "HostPorts is not an object"
884−
8851187-- { "Name": "on-failure" , "MaximumRetryCount": 2}
8861188type RetryCount = Integer
8871189data RestartPolicy = RestartAlways | RestartUnlessStopped | RestartOnFailure RetryCount | RestartOff deriving (Eq, Show)
@@ -895,7 +1197,7 @@ instance FromJSON RestartPolicy where
8951197 "on-failure" -> do
8961198 retry <- o .: "MaximumRetryCount"
8971199 return $ RestartOnFailure retry
898− "off" -> return RestartOff
1200+ "no" -> return RestartOff
8991201 _ -> fail "Could not parse RestartPolicy"
9001202 parseJSON _ = fail "RestartPolicy is not an object"
9011203
@@ -903,7 +1205,7 @@ instance ToJSON RestartPolicy where
9031205 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
9041206 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
9051207 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
906− toJSON RestartOff = object ["Name" .= JSON.String "off"]
1208+ toJSON RestartOff = object ["Name" .= JSON.String "no"]
9071209
9081210data Isolation = Default | Process | Hyperv deriving (Eq, Show)
9091211
@@ -913,11 +1215,11 @@ newtype UTSMode = UTSMode Text deriving (Eq, Show)
9131215-- TODO: Add UTSMode : UTS namespace to use for the container
9141216-- TODO: Sysctls map[string]string `json:",omitempty"` // List of Namespaced sysctls used for the container
9151217data HostConfig = HostConfig
916− { binds :: [Volume]
1218+ { binds :: [Bind]
9171219 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
9181220 , logConfig :: LogDriverConfig
9191221 , networkMode :: NetworkMode
920− , portBindings :: PortBindings
1222+ , portBindings :: [PortBinding]
9211223 , restartPolicy :: RestartPolicy
9221224 , volumeDriver :: Maybe Text
9231225 , volumesFrom :: [VolumeFrom]
@@ -971,7 +1273,7 @@ instance FromJSON HostConfig where
9711273 parseJSON _ = fail "HostConfig is not an object."
9721274
9731275instance ToJSON HostConfig where
974− toJSON HostConfig{..} =
1276+ toJSON HostConfig{..} =
9751277 let arr = [
9761278 "Binds" .= binds
9771279 , "ContainerIDFile" .= containerIDFile
@@ -999,7 +1301,7 @@ instance ToJSON HostConfig where
9991301 in
10001302 object $ arr <> ( resourcesArr resources)
10011303
1002− where
1304+ where
10031305 -- JP: Not sure if this is better than a separate ToJSON instance with a bunch of `HM.insert`s.
10041306 resourcesArr ContainerResources{..} = [
10051307 "CpuShares" .= cpuShares
@@ -1020,8 +1322,8 @@ instance ToJSON HostConfig where
10201322 , "OomKillDisable" .= oomKillDisable
10211323 , "Ulimits" .= ulimits
10221324 ]
1023−
1024−
1325+
1326+
10251327
10261328
10271329-- { "Name": <name>, "Soft": <soft limit>, "Hard": <hard limit> }
@@ -1040,27 +1342,79 @@ instance ToJSON Ulimit where
10401342 toJSON = genericToJSON defaultOptions {
10411343 fieldLabelModifier = drop 5}
10421344
1345+data DeviceWeight = DeviceWeight {
1346+ deviceWeightPath :: FilePath
1347+ , deviceWeightWeight :: Text
1348+ }
1349+ deriving (Show, Eq)
1350+
1351+instance FromJSON DeviceWeight where
1352+ parseJSON (JSON.Object o) = DeviceWeight
1353+ <$> o .: "Path"
1354+ <*> o .: "Weight"
1355+ parseJSON _ = fail "DeviceWeight is not an object."
1356+
1357+instance ToJSON DeviceWeight where
1358+ toJSON (DeviceWeight p w) = object [
1359+ "Path" .= p
1360+ , "Weight" .= w
1361+ ]
1362+
1363+data DeviceRate = DeviceRate {
1364+ deviceRatePath :: FilePath
1365+ , deviceRateRate :: Text
1366+ }
1367+ deriving (Show, Eq)
1368+
1369+instance FromJSON DeviceRate where
1370+ parseJSON (JSON.Object o) = DeviceRate
1371+ <$> o .: "Path"
1372+ <*> o .: "Rate"
1373+ parseJSON _ = fail "DeviceRate is not an object."
1374+
1375+instance ToJSON DeviceRate where
1376+ toJSON (DeviceRate p r) = object [
1377+ "Path" .= p
1378+ , "Rate" .= r
1379+ ]
1380+
1381+data MemoryConstraintSize = B | MB | GB deriving (Eq, Show)
1382+
1383+data MemoryConstraint = MemoryConstraint Integer MemoryConstraintSize deriving (Eq, Show)
1384+
1385+instance ToJSON MemoryConstraint where
1386+ toJSON (MemoryConstraint x B) = toJSON x
1387+ toJSON (MemoryConstraint x MB) = toJSON $ x * 1024 * 1024
1388+ toJSON (MemoryConstraint x GB) = toJSON $ x * 1024 * 1024 * 1024
1389+
1390+instance FromJSON MemoryConstraint where
1391+ parseJSON (JSON.Number x) = case (floatingOrInteger x) of
1392+ Left (_ :: Double) -> fail "Failed to parse MemoryConstraint"
1393+ Right i -> return $ MemoryConstraint i B
1394+ -- The docker daemon will always return the number as bytes (integer), regardless of how we set them (using MB or GB)
1395+ parseJSON _ = fail "Failed to parse MemoryConstraint"
1396+
10431397data ContainerResources = ContainerResources {
10441398 cpuShares :: Maybe Integer
10451399 -- , cgroupParent :: Text -- 1.24: Missing from inspecting container details... Going to omit for now.
10461400 , blkioWeight :: Maybe Integer
1047− , blkioWeightDevice :: Maybe Text -- TODO: Not Text
1048− , blkioDeviceReadBps :: Maybe Text -- TODO: Not Text
1049− , blkioDeviceWriteBps :: Maybe Text -- TODO: Not Text
1050− , blkioDeviceReadIOps :: Maybe Text -- TODO: Not Text
1051− , blkioDeviceWriteIOps :: Maybe Text -- TODO: Not Text
1401+ , blkioWeightDevice :: Maybe [DeviceWeight]
1402+ , blkioDeviceReadBps :: Maybe [DeviceRate] -- TODO: Not Text
1403+ , blkioDeviceWriteBps :: Maybe [DeviceRate] -- TODO: Not Text
1404+ , blkioDeviceReadIOps :: Maybe [DeviceRate] -- TODO: Not Text
1405+ , blkioDeviceWriteIOps :: Maybe [DeviceRate] -- TODO: Not Text
10521406 , cpuPeriod :: Maybe Integer
10531407 -- , cpuQuota :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
10541408 , cpusetCpus :: Maybe Text
10551409 , cpusetMems :: Maybe Text
10561410 , devices :: [Device]
10571411 -- , diskQuota :: Integer -- Don't see this ins 1.24.
1058− , kernelMemory :: Maybe Integer
1059− , memory :: Maybe Integer
1060− , memoryReservation :: Maybe Integer
1061− , memorySwap :: Maybe Integer
1412+ , kernelMemory :: Maybe MemoryConstraint
1413+ , memory :: Maybe MemoryConstraint
1414+ , memoryReservation :: Maybe MemoryConstraint
1415+ , memorySwap :: Maybe MemoryConstraint
10621416 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1063− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
10641418 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
10651419 , ulimits :: [Ulimit]
10661420 -- TODO: Missing from 1.24
@@ -1098,41 +1452,59 @@ instance FromJSON EnvVar where
10981452 parseJSON _ = fail "EnvVar is not a string"
10991453
11001454instance ToJSON EnvVar where
1101− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
11021456
1103−-- | ExposedPorts represent a enumeraton of all the ports (and their type)
1457+-- | ExposedPort represents a port (and it's type)
11041458-- that a container should expose to other containers or the host system.
1105−-- `NOTE`: This does not automatically expose the ports onto the host
1106−-- system but rather it just tags them. It's best to be used with
1459+-- `NOTE`: This does not automatically expose the port onto the host
1460+-- system but rather it just tags it. It's best to be used with
11071461-- the PublishAllPorts flag. It is also useful for
11081462-- the daemon to know which Environment variables to
11091463-- inject into a container linking to our container.
11101464-- Example linking a Postgres container named db would inject the following
11111465-- environment variables automatically if we set the corresponding
1112−-- ExposedPorts:
1466+--
1467+-- ExposedPort:
1468+--
1469+-- @
11131470-- DB_PORT_5432_TCP_PORT="5432"
11141471-- DB_PORT_5432_TCP_PROTO="tcp"
11151472-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
1116−newtype ExposedPorts = ExposedPorts (M.Map Port PortType) deriving (Eq, Show)
1117−-- JP: Should this be ExposedPorts [(Port, PortType)]?
1118−
1119−instance FromJSON ExposedPorts where
1120− parseJSON (JSON.Object o) = do
1121− ExposedPorts <$> HM.foldlWithKey' f (return M.empty) o
1473+-- @
1474+data ExposedPort = ExposedPort Port PortType deriving (Eq, Show)
11221475
1476+instance {-# OVERLAPPING #-} FromJSON [ExposedPort] where
1477+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
11231478 where
11241479 f accM k _ = case T.split (== '/') k of
11251480 [port', portType'] -> do
11261481 port <- parseIntegerText port'
11271482 portType <- parseJSON $ JSON.String portType'
11281483 acc <- accM
1129− return $ M.insert port portType acc
1130− _ ->
1131− fail "Could not parse ExposedPorts"
1132− parseJSON _ = fail "ExposedPorts is not an object."
1484+ return $ (ExposedPort port portType):acc
1485+ _ -> fail "Could not parse ExposedPorts"
1486+ parseJSON (JSON.Null) = return []
1487+ parseJSON _ = fail "ExposedPorts is not an object"
1488+
1489+instance {-# OVERLAPPING #-} ToJSON [ExposedPort] where
1490+ toJSON [] = emptyJsonObject
1491+ toJSON (p:ps) = toJsonKey (p:ps) key
1492+ where key (ExposedPort p t) = show p <> slash <> show t
1493+ slash = T.unpack "/"
11331494
1134−instance ToJSON ExposedPorts where
1135− toJSON (ExposedPorts kvs) = object [((T.pack $ show p) <> "/" <> (T.pack $ show t)) .= JSON.Object HM.empty | (p,t) <- (M.toList kvs)]
1495+data Entrypoint = Entrypoint [T.Text] deriving (Eq, Show, Generic)
1496+
1497+instance ToJSON Entrypoint where
1498+ toJSON (Entrypoint (e:es)) = toJSON (e:es)
1499+ toJSON (Entrypoint []) = JSON.Null
1500+
1501+instance FromJSON Entrypoint where
1502+ parseJSON (JSON.String e) = return $ Entrypoint [e]
1503+ parseJSON (JSON.Array ar) = do
1504+ arr <- mapM parseJSON (V.toList ar)
1505+ return $ Entrypoint arr
1506+ parseJSON JSON.Null = return $ Entrypoint []
1507+ parseJSON _ = fail "Failed to parse Entrypoint"
11361508
11371509
11381510data ContainerConfig = ContainerConfig {
@@ -1142,7 +1514,7 @@ data ContainerConfig = ContainerConfig {
11421514 , attachStdin :: Bool
11431515 , attachStdout :: Bool
11441516 , attachStderr :: Bool
1145− , exposedPorts :: ExposedPorts
1517+ , exposedPorts :: [ExposedPort]
11461518 -- , publishService :: Text -- Don't see this in 1.24
11471519 , tty :: Bool
11481520 , openStdin :: Bool
@@ -1151,27 +1523,70 @@ data ContainerConfig = ContainerConfig {
11511523 , cmd :: [Text]
11521524 -- , argsEscaped :: Bool -- Don't see this in 1.24
11531525 , image :: Text
1154− , volumes :: Maybe Volumes
1526+ , volumes :: [Volume]
11551527 , workingDir :: Maybe FilePath
1156− , entrypoint :: Maybe Text -- Can be null?
1528+ , entrypoint :: Entrypoint
11571529 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
11581530 , macAddress :: Maybe Text
11591531 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
1160− , labels :: Maybe Labels
1532+ , labels :: [Label]
11611533 , stopSignal :: Signal
11621534 } deriving (Eq, Show, Generic)
11631535
1536+
11641537instance ToJSON ContainerConfig where
11651538 toJSON = genericToJSON defaultOptions {
11661539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
11671540
11681541instance FromJSON ContainerConfig where
1169− parseJSON = genericParseJSON defaultOptions {
1170− fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
1542+ parseJSON (JSON.Object o) = do
1543+ hostname <- o .:? "Hostname"
1544+ domainname <- o .:? "Domainname"
1545+ user <- o .:? "User"
1546+ attachStdin <- o .: "AttachStdin"
1547+ attachStdout <- o .: "AttachStdout"
1548+ attachStderr <- o .: "AttachStderr"
1549+ exposedPorts <- o .:? "ExposedPorts" .!= []
1550+ tty <- o .: "Tty"
1551+ openStdin <- o .: "OpenStdin"
1552+ stdinOnce <- o .: "StdinOnce"
1553+ env <- o .: "Env"
1554+ cmd <- o .: "Cmd"
1555+ image <- o .: "Image"
1556+ volumes <- o .: "Volumes"
1557+ workingDir <- o .:? "WorkingDir"
1558+ entrypoint <- o .: "Entrypoint"
1559+ networkDisabled <- o .:? "networkDisabled"
1560+ macAddress <- o .:? "MacAddress"
1561+ labels <- o .:? "Labels" .!= []
1562+ stopSignal <- o .: "StopSignal"
1563+ return $ ContainerConfig hostname domainname user attachStdin attachStdout attachStderr exposedPorts tty openStdin stdinOnce env cmd image volumes workingDir entrypoint networkDisabled
1564+ macAddress labels stopSignal
1565+ parseJSON _ = fail "NetworkSettings is not an object."
11711566
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1569+#else
11721570parseIntegerText :: (Monad m) => Text -> m Integer
1571+#endif
11731572parseIntegerText t = case readMaybe $ T.unpack t of
11741573 Nothing ->
11751574 fail "Could not parse Integer"
11761575 Just i ->
11771576 return i
1577+
1578+-- | Helper function for converting a data type [a] to a json dictionary
1579+-- like so {"something": {}, "something2": {}}
1580+toJsonKey :: Foldable t => t a -> (a -> String) -> JSON.Value
1581+toJsonKey vs getKey = JSON.Object $ foldl f HM.empty vs
1582+ where f acc x = HM.insert (T.pack $ getKey x) (JSON.Object HM.empty) acc
1583+
1584+-- | Helper function for converting a data type [a] to a json dictionary
1585+-- like so {"something": "val1", "something2": "val2"}
1586+toJsonKeyVal :: (Foldable t, JSON.ToJSON r) => t a -> (a -> String) -> (a -> r) -> JSON.Value
1587+toJsonKeyVal vs getKey getVal = JSON.Object $ foldl f HM.empty vs
1588+ where f acc x = HM.insert (T.pack $ getKey x) (toJSON $ getVal x) acc
1589+
1590+-- | Helper function that return an empty dictionary "{}"
1591+emptyJsonObject :: JSON.Value
1592+emptyJsonObject = JSON.Object HM.empty