@@ -11,7 +11,11 @@ module Docker.Client.Types (
1111 , ImageID
1212 , fromImageID
1313 , toImageID
14+ , NetworkID
15+ , fromNetworkID
16+ , toNetworkID
1417 , Timeout(..)
18+ , StatusCode(..)
1519 , Signal(..)
1620 , ContainerDetails(..)
1721 , DockerClientOpts(..)
@@ -22,23 +26,30 @@ module Docker.Client.Types (
2226 , ContainerPortInfo(..)
2327 , Container(..)
2428 , ContainerState(..)
25− , Status(..)
29+ , State(..)
2630 , Digest
2731 , 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(..)
37− , defaultDeleteOpts
43+ , ContainerDeleteOpts(..)
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
3847 , Timestamp
3948 , TailLogOpt(..)
4049 , LogOpts(..)
4150 , defaultLogOpts
51+ , CreateNetworkOpts(..)
52+ , defaultCreateNetworkOpts
4253 , VolumePermission(..)
4354 , Bind(..)
4455 , Volume(..)
@@ -47,12 +58,12 @@ module Docker.Client.Types (
4758 , VolumeFrom(..)
4859 , Link(..)
4960 , LogDriverType(..)
50− , LogDriverOptions(..)
61+ , LogDriverOption(..)
5162 , LogDriverConfig(..)
5263 , NetworkMode(..)
5364 , PortType(..)
5465-- , NetworkInterface(..)
55− , Networks(..)
66+ , Network(..)
5667 , NetworkSettings(..)
5768 , NetworkOptions(..)
5869 , Mount(..)
@@ -64,6 +75,8 @@ module Docker.Client.Types (
6475 , UTSMode(..)
6576 , HostConfig(..)
6677 , defaultHostConfig
78+ , NetworkingConfig(..)
79+ , EndpointConfig(..)
6780 , Ulimit(..)
6881 , ContainerResources(..)
6982 , defaultContainerResources
@@ -83,6 +96,8 @@ module Docker.Client.Types (
8396 , addLink
8497 , addVolume
8598 , addVolumeFrom
99+ , MemoryConstraint(..)
100+ , MemoryConstraintSize(..)
86101 ) where
87102
88103import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
@@ -92,11 +107,12 @@ import qualified Data.Aeson as JSON
92107import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
93108import Data.Char (isAlphaNum, toUpper)
94109import qualified Data.HashMap.Strict as HM
95−import qualified Data.Map as M
96110import Data.Monoid ((<>))
111+import Data.Scientific (floatingOrInteger)
97112import Data.Text (Text)
98113import qualified Data.Text as T
99114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
100116import GHC.Generics (Generic)
101117import Prelude hiding (all, tail)
102118import Text.Read (readMaybe)
@@ -109,14 +125,20 @@ data Endpoint =
109125 | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
110126 | StartContainerEndpoint StartOpts ContainerID
111127 | StopContainerEndpoint Timeout ContainerID
128+ | WaitContainerEndpoint ContainerID
112129 | KillContainerEndpoint Signal ContainerID
113130 | RestartContainerEndpoint Timeout ContainerID
114131 | PauseContainerEndpoint ContainerID
115132 | UnpauseContainerEndpoint ContainerID
116133 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
117134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
118− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
119136 | 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
120142 deriving (Eq, Show)
121143
122144-- | We should newtype this
@@ -163,6 +185,20 @@ toImageID t =
163185-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
164186data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
165187
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+
166202-- TODO: Add more Signals or use an existing lib
167203-- | Signal used for sending to the process running in the container.
168204-- The default signal is SIGTERM.
@@ -177,16 +213,16 @@ data Signal = SIGHUP
177213
178214instance FromJSON Signal where
179215 parseJSON (JSON.String "SIGTERM") = return SIGTERM
180− parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
181− 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
182218 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
183219 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
184220 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
185− parseJSON _ = fail "Unknown Signal"
221+ parseJSON _ = fail "Unknown Signal"
186222
187223instance ToJSON Signal where
188− toJSON SIGHUP = "SIGHUP"
189− toJSON SIGINT = "SIGINT"
224+ toJSON SIGHUP = "SIGHUP"
225+ toJSON SIGINT = "SIGINT"
190226 toJSON SIGQUIT = "SIGQUIT"
191227 toJSON SIGSTOP = "SIGSTOP"
192228 toJSON SIGTERM = "SIGTERM"
@@ -214,7 +250,7 @@ data ContainerDetails = ContainerDetails {
214250 , processLabel :: Text
215251 , resolveConfPath :: FilePath
216252 , restartCount :: Int
217− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
218254 , mounts :: [Mount]
219255 }
220256 deriving (Eq, Show, Generic)
@@ -222,11 +258,11 @@ data ContainerDetails = ContainerDetails {
222258-- | Data type used for parsing the mount information from a container
223259-- list.
224260data Mount = Mount {
225− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
226262 , mountSource :: FilePath
227263 , mountDestination :: FilePath
228− , mountDriver :: Text
229− , mountMode :: Maybe VolumePermission -- apparently this can be null
264+ , mountDriver :: Maybe Text
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
230266 , mountRW :: Bool
231267 , mountPropogation :: Text
232268 }
@@ -234,14 +270,14 @@ data Mount = Mount {
234270
235271instance FromJSON Mount where
236272 parseJSON (JSON.Object o) = do
237− name <- o .: "Name"
273+ name <- o .:? "Name"
238274 src <- o .: "Source"
239275 dest <- o .: "Destination"
240− driver <- o .: "Driver"
241− mode <- o .: "Mode"
276+ driver <- o .:? "Driver"
277+ -- mode <- o .: "Mode"
242278 rw <- o .: "RW"
243279 prop <- o .: "Propagation"
244− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
245281 parseJSON _ = fail "Mount is not an object"
246282
247283-- | Data type used for parsing the container state from a list of
@@ -257,7 +293,7 @@ data ContainerState = ContainerState {
257293 , restarting :: Bool
258294 , running :: Bool
259295 , startedAt :: UTCTime
260− , status :: Status
296+ , state :: State
261297 }
262298 deriving (Eq, Show, Generic)
263299
@@ -420,20 +456,17 @@ instance FromJSON NetworkOptions where
420456 parseJSON _ = fail "NetworkOptions is not an object"
421457
422458-- TODO: Not sure what this is used for anymore.
423−newtype Networks = Networks (M.Map NetworkMode NetworkOptions) -- Note: Is it ever possible that there will be duplicates of network modes?
459+data Network = Network NetworkMode NetworkOptions
424460 deriving (Eq, Show)
425461
426−instance FromJSON Networks where
427− parseJSON (JSON.Object o) = do
428− Networks <$> HM.foldlWithKey' f (return M.empty) o
429−
462+instance {-# OVERLAPPING #-} FromJSON [Network] where
463+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
430464 where
431465 f accM k' v' = do
432466 acc <- accM
433467 k <- parseJSON $ JSON.String k'
434468 v <- parseJSON v'
435− return $ M.insert k v acc
436−
469+ return $ (Network k v):acc
437470 parseJSON _ = fail "Networks is not an object"
438471
439472-- | Data type reprsenting the various network settings a container can have.
@@ -455,7 +488,7 @@ data NetworkSettings = NetworkSettings {
455488 , networkSettingsIpPrefixLen :: Int
456489 , networkSettingsIpv6Gateway :: Text
457490 , networkSettingsMacAddress :: Text
458− , networkSettingsNetworks :: Networks
491+ , networkSettingsNetworks :: [Network]
459492 }
460493 deriving (Eq, Show)
461494
@@ -490,21 +523,23 @@ data Container = Container
490523 , containerImageId :: ImageID
491524 , containerCommand :: Text
492525 , containerCreatedAt :: Int
493− , containerStatus :: Status
526+ , containerState :: State
527+ , containerStatus :: Maybe Text
494528 , containerPorts :: [ContainerPortInfo]
495529 , containerLabels :: [Label]
496− , containerNetworks :: Networks
530+ , containerNetworks :: [Network]
497531 , containerMounts :: [Mount]
498532 } deriving (Show, Eq)
499533
500534instance FromJSON Container where
501− parseJSON (JSON.Object v) =
502− Container <$> (v .: "Id")
535+ parseJSON o@(JSON.Object v) =
536+ Container <$> parseJSON o
503537 <*> (v .: "Names")
504538 <*> (v .: "Image")
505− <*> (v .: "ImageID")
506− <*> (v .: "Command")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
540+ <*> (v .: "Command") -- Doesn't exist anymore
507541 <*> (v .: "Created")
542+ <*> (v .: "State")
508543 <*> (v .: "Status")
509544 <*> (v .: "Ports")
510545 <*> (v .: "Labels")
@@ -514,21 +549,20 @@ instance FromJSON Container where
514549 parseNetworks (JSON.Object v) =
515550 (v .: "Networks") >>= parseJSON
516551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
517−
518552 parseJSON _ = fail "Container: Not a JSON object."
519553
520−-- | Represents the status of the container life cycle.
521−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
522556 deriving (Eq, Show, Generic)
523557
524−instance FromJSON Status where
525− parseJSON (JSON.String "running") = return Running
526− 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.
527561 parseJSON (JSON.String "restarting") = return Restarting
528− parseJSON (JSON.String "paused") = return Paused
529− parseJSON (JSON.String "exited") = return Exited
530− parseJSON (JSON.String "dead") = return Dead
531− 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
532566
533567-- | Alias for representing a RepoDigest. We could newtype this and add
534568-- some validation.
@@ -540,12 +574,13 @@ data Label = Label Name Value deriving (Eq, Show)
540574
541575-- If there are multiple lables with the same Name in the list
542576-- then the last one wins.
543−instance ToJSON [Label] where
544− toJSON [] = JSON.Object HM.empty
545− toJSON (l:ls) = JSON.Object $ foldl f HM.empty (l:ls)
546− where f acc (Label n v) = HM.insert n (toJSON v) acc
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
547582
548−instance FromJSON [Label] where
583+instance {-# OVERLAPPING #-} FromJSON [Label] where
549584 parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
550585 where f accM k v = do
551586 acc <- accM
@@ -562,8 +597,8 @@ data Image = DockerImage {
562597 imageId :: ImageID
563598 , imageCreated :: Integer
564599 , imageParentId :: Maybe ImageID
565− , imageRepoTags :: Maybe [Tag]
566− , imageRepoDigests :: Maybe [Digest]
600+ , imageRepoTags :: [Tag]
601+ , imageRepoDigests :: [Digest]
567602 , imageSize :: Integer
568603 , imageVirtualSize :: Integer
569604 , imageLabels :: [Label]
@@ -580,30 +615,54 @@ instance FromJSON Image where
580615 imageId <- o .: "Id"
581616 imageCreated <- o .: "Created"
582617 imageParentId <- o .:? "ParentId"
583− imageRepoTags <- o .:? "RepoTags"
584− imageRepoDigests <- o .:? "RepoDigests"
618+ imageRepoTags <- o .:? "RepoTags" .!= []
619+ imageRepoDigests <- o .:? "RepoDigests" .!= []
585620 imageSize <- o .: "Size"
586621 imageVirtualSize <- o .: "VirtualSize"
587− imageLabels <- case HM.lookup "Labels" o of
588− Just ls -> parseJSON ls
589− Nothing -> return []
622+ imageLabels <- o .:? "Labels" .!= []
590623 return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
591624 parseJSON _ = fail "Failed to parse DockerImage."
592625
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+ ]
593649
594650-- | Options used for creating a Container.
595651data CreateOpts = CreateOpts {
596− containerConfig :: ContainerConfig
597− , hostConfig :: HostConfig
652+ containerConfig :: ContainerConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
598655 } deriving (Eq, Show)
599656
600657instance ToJSON CreateOpts where
601− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
602659 let ccJSON = toJSON cc
603660 let hcJSON = toJSON hc
604661 case ccJSON of
605662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
606− 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
607666 _ -> error "ContainerConfig is not an object." -- This should never happen.
608667
609668-- | Container configuration used for creating a container with sensible
@@ -625,7 +684,7 @@ defaultContainerConfig imageName = ContainerConfig {
625684 , cmd=[]
626685 , volumes=[]
627686 , workingDir=Nothing
628− , entrypoint=Nothing
687+ , entrypoint=Entrypoint []
629688 , networkDisabled=Nothing
630689 , macAddress=Nothing
631690 , labels=[]
@@ -637,8 +696,8 @@ defaultHostConfig :: HostConfig
637696defaultHostConfig = HostConfig {
638697 binds=[]
639698 , containerIDFile=Nothing
640− , logConfig=LogDriverConfig JsonFile Nothing
641− , networkMode=Bridge
699+ , logConfig=LogDriverConfig JsonFile []
700+ , networkMode=NetworkBridge
642701 , portBindings=[]
643702 , restartPolicy=RestartOff
644703 , volumeDriver=Nothing
@@ -678,14 +737,18 @@ defaultContainerResources = ContainerResources {
678737 , memory=Nothing
679738 , memoryReservation=Nothing
680739 , memorySwap=Nothing
681− , oomKillDisable=False
740+ , oomKillDisable=Just False
682741 , ulimits=[]
683742 }
684743
685744-- | Default create options when creating a container. You only need to
686745-- specify an image name and the rest is all sensible defaults.
687746defaultCreateOpts :: T.Text -> CreateOpts
688−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+ }
689752
690753-- | Override the key sequence for detaching a container.
691754-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
@@ -699,16 +762,45 @@ defaultStartOpts :: StartOpts
699762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
700763
701764-- | Options for deleting a container.
702−data DeleteOpts = DeleteOpts {
765+data ContainerDeleteOpts = ContainerDeleteOpts {
703766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
704767 , force :: Bool -- ^ If the container is still running force deletion anyway.
705768 } deriving (Eq, Show)
706769
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+
707792-- | Default options for deleting a container. Most of the time we DON'T
708793-- want to delete the container's volumes or force delete it if it's
709794-- running.
710−defaultDeleteOpts :: DeleteOpts
711−defaultDeleteOpts = DeleteOpts { deleteVolumes = False, force = False }
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
712804
713805-- | Timestamp alias.
714806type Timestamp = Integer
@@ -736,18 +828,50 @@ defaultLogOpts = LogOpts { stdout = True
736828 , tail = All
737829 }
738830
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+
739861-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
740862-- | Set permissions on volumes that you mount in the container.
741863data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
742864
743865instance ToJSON VolumePermission where
744866 toJSON ReadWrite = "rw"
745− toJSON ReadOnly = "ro"
867+ toJSON ReadOnly = "ro"
746868
747869instance FromJSON VolumePermission where
748870 parseJSON "rw" = return ReadWrite
749871 parseJSON "ro" = return ReadOnly
750− parseJSON _ = fail "Failed to parse VolumePermission"
872+ parseJSON "RW" = return ReadWrite
873+ parseJSON "RO" = return ReadOnly
874+ parseJSON _ = fail "Failed to parse VolumePermission"
751875
752876-- | Used for marking a directory in the container as "exposed" hence
753877-- taking it outside of the COW filesystem and making it mountable
@@ -762,15 +886,15 @@ instance FromJSON VolumePermission where
762886-- @
763887newtype Volume = Volume FilePath deriving (Eq, Show)
764888
765−instance ToJSON [Volume] where
766− toJSON [] = JSON.Object HM.empty
767− toJSON (v:vs) = JSON.Object $ foldl f HM.empty (v:vs)
768− where f acc (Volume k) = HM.insert (T.pack k) (JSON.Object HM.empty) acc
889+instance {-# OVERLAPPING #-} ToJSON [Volume] where
890+ toJSON [] = emptyJsonObject
891+ toJSON (v:vs) = toJsonKey (v:vs) getKey
892+ where getKey (Volume v) = v
769893
770−instance FromJSON [Volume] where
894+instance {-# OVERLAPPING #-} FromJSON [Volume] where
771895 parseJSON (JSON.Object o) = return $ map (Volume . T.unpack) $ HM.keys o
772− parseJSON (JSON.Null) = return []
773− parseJSON _ = fail "Volume is not an object"
896+ parseJSON (JSON.Null) = return []
897+ parseJSON _ = fail "Volume is not an object"
774898
775899
776900data Bind = Bind { hostSrc :: Text
@@ -780,10 +904,10 @@ data Bind = Bind { hostSrc :: Text
780904
781905instance FromJSON Bind where
782906 parseJSON (JSON.String t) = case T.split (== ':') t of
783− [src, dest] -> return $ Bind src dest Nothing
907+ [src, dest] -> return $ Bind src dest Nothing
784908 [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
785909 [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
786− _ -> fail "Could not parse Bind"
910+ _ -> fail "Could not parse Bind"
787911 parseJSON _ = fail "Bind is not a string"
788912
789913data Device = Device {
@@ -806,15 +930,15 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
806930
807931instance FromJSON VolumeFrom where
808932 parseJSON (JSON.String t) = case T.split (== ':') t of
809− [vol] -> return $ VolumeFrom vol Nothing
933+ [vol] -> return $ VolumeFrom vol Nothing
810934 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
811935 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
812− _ -> fail "Could not parse VolumeFrom"
936+ _ -> fail "Could not parse VolumeFrom"
813937 parseJSON _ = fail "VolumeFrom is not a string"
814938
815939instance ToJSON VolumeFrom where
816940 toJSON (VolumeFrom n p) = case p of
817− Nothing -> toJSON $ n <> ":" <> "rw"
941+ Nothing -> toJSON $ n <> ":" <> "rw"
818942 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
819943
820944instance ToJSON Bind where
@@ -826,63 +950,63 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
826950
827951instance FromJSON Link where
828952 parseJSON (JSON.String t) = case T.split (== ':') t of
829− [f] -> return $ Link f Nothing
953+ [f] -> return $ Link f Nothing
830954 [f,s] -> return $ Link f $ Just s
831− _ -> fail "Could not parse Link"
955+ _ -> fail "Could not parse Link"
832956 parseJSON _ = fail "Link is not a string"
833957
834958instance ToJSON Link where
835959 toJSON (Link n1 n2) = toJSON $ case n2 of
836960 Nothing -> T.concat[n1, ":", n1] -- use same name in container
837− Just n -> T.concat[n1, ":", n] -- used specified name in container
961+ Just n -> T.concat[n1, ":", n] -- used specified name in container
838962
839963-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
840964data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
841965
842966instance FromJSON LogDriverType where
843967 parseJSON (JSON.String "json-file") = return JsonFile
844− parseJSON (JSON.String "syslog") = return Syslog
845− parseJSON (JSON.String "journald") = return Journald
846− parseJSON (JSON.String "gelf") = return Gelf
847− parseJSON (JSON.String "fluentd") = return Fluentd
848− parseJSON (JSON.String "awslogs") = return AwsLogs
849− parseJSON (JSON.String "splunk") = return Splunk
850− parseJSON (JSON.String "etwlogs") = return Etwlogs
851− parseJSON (JSON.String "none") = return LoggingDisabled
852− 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"
853977
854978instance ToJSON LogDriverType where
855− toJSON JsonFile = JSON.String "json-file"
856− toJSON Syslog = JSON.String "syslog"
857− toJSON Journald = JSON.String "journald"
858− toJSON Gelf = JSON.String "gelf"
859− toJSON Fluentd = JSON.String "fluentd"
860− toJSON AwsLogs = JSON.String "awslogs"
861− toJSON Splunk = JSON.String "splunk"
862− 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"
863987 toJSON LoggingDisabled = JSON.String "none"
864988
865−newtype LogDriverOptions = LogDriverOptions (M.Map Text Text) deriving (Eq, Show)
989+data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
866990
867−instance FromJSON LogDriverOptions where
868− parseJSON (JSON.Object o) = do
869− 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
870996
871− where
872− 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
8731000 acc <- accM
874− return $ M.insert k v acc
875− f _ _ _ = fail "Value of LogDriverOptions is not a string"
876−
877− parseJSON JSON.Null = return $ LogDriverOptions M.empty
878− parseJSON _ = fail "LogDriverOptions is not an object"
879−
880−instance ToJSON LogDriverOptions where
881− toJSON (LogDriverOptions mp) = toJSON mp
1001+ value <- parseJSON v
1002+ return $ (LogDriverOption k value):acc
1003+ parseJSON JSON.Null = return []
1004+ parseJSON _ = fail "Failed to parse LogDriverOptions"
8821005
883−data LogDriverConfig = LogDriverConfig LogDriverType (Maybe LogDriverOptions) deriving (Eq, Show)
1006+data LogDriverConfig = LogDriverConfig LogDriverType [LogDriverOption] deriving (Eq, Show)
8841007
8851008instance ToJSON LogDriverConfig where
1009+ toJSON (LogDriverConfig driverType []) = object ["Type" .= driverType]
8861010 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
8871011
8881012instance FromJSON LogDriverConfig where
@@ -893,19 +1017,41 @@ instance FromJSON LogDriverConfig where
8931017 parseJSON _ = fail "LogDriverConfig is not an object"
8941018
8951019-- TODO: Add container:<name|id> mode
896−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
8971021 deriving (Eq, Show, Ord)
8981022
8991023instance FromJSON NetworkMode where
900− parseJSON (JSON.String "bridge") = return Bridge
901− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
902− parseJSON (JSON.String "none") = return NetworkDisabled
903− 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"
9041029
9051030instance ToJSON NetworkMode where
906− toJSON Bridge = JSON.String "bridge"
907− toJSON Host = JSON.String "host"
1031+ toJSON NetworkBridge = JSON.String "bridge"
1032+ toJSON NetworkHost = JSON.String "host"
9081033 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
1042+
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]
9091055
9101056data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
9111057
@@ -921,7 +1067,7 @@ instance FromJSON PortType where
9211067 parseJSON val = case val of
9221068 "tcp" -> return TCP
9231069 "udp" -> return UDP
924− _ -> fail "PortType: Invalid port type."
1070+ _ -> fail "PortType: Invalid port type."
9251071
9261072-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
9271073--
@@ -1002,7 +1148,7 @@ addExposedPort ep c = c{containerConfig=cc{exposedPorts=oldeps <> [ep]}}
10021148 oldeps = exposedPorts cc
10031149
10041150
1005−instance FromJSON [PortBinding] where
1151+instance {-# OVERLAPPING #-} FromJSON [PortBinding] where
10061152 parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
10071153 where
10081154 f accM k v = case T.split (== '/') k of
@@ -1016,12 +1162,11 @@ instance FromJSON [PortBinding] where
10161162 parseJSON (JSON.Null) = return []
10171163 parseJSON _ = fail "PortBindings is not an object"
10181164
1019−instance ToJSON [PortBinding] where
1020− toJSON [] = JSON.Object HM.empty
1021− toJSON (p:ps) = JSON.Object $ foldl f HM.empty (p:ps)
1022− where mKey p = portAndType2Text (containerPort p) (portType p)
1023− mVal p = toJSON $ hostPorts p
1024− f acc p = HM.insert (mKey p) (mVal p) acc
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
10251170
10261171data HostPort = HostPort {
10271172 hostIp :: Text
@@ -1052,7 +1197,7 @@ instance FromJSON RestartPolicy where
10521197 "on-failure" -> do
10531198 retry <- o .: "MaximumRetryCount"
10541199 return $ RestartOnFailure retry
1055− "off" -> return RestartOff
1200+ "no" -> return RestartOff
10561201 _ -> fail "Could not parse RestartPolicy"
10571202 parseJSON _ = fail "RestartPolicy is not an object"
10581203
@@ -1060,7 +1205,7 @@ instance ToJSON RestartPolicy where
10601205 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
10611206 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
10621207 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1063− toJSON RestartOff = object ["Name" .= JSON.String "off"]
1208+ toJSON RestartOff = object ["Name" .= JSON.String "no"]
10641209
10651210data Isolation = Default | Process | Hyperv deriving (Eq, Show)
10661211
@@ -1233,6 +1378,22 @@ instance ToJSON DeviceRate where
12331378 , "Rate" .= r
12341379 ]
12351380
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+
12361397data ContainerResources = ContainerResources {
12371398 cpuShares :: Maybe Integer
12381399 -- , cgroupParent :: Text -- 1.24: Missing from inspecting container details... Going to omit for now.
@@ -1248,12 +1409,12 @@ data ContainerResources = ContainerResources {
12481409 , cpusetMems :: Maybe Text
12491410 , devices :: [Device]
12501411 -- , diskQuota :: Integer -- Don't see this ins 1.24.
1251− , kernelMemory :: Maybe Integer
1252− , memory :: Maybe Integer
1253− , memoryReservation :: Maybe Integer
1254− , memorySwap :: Maybe Integer
1412+ , kernelMemory :: Maybe MemoryConstraint
1413+ , memory :: Maybe MemoryConstraint
1414+ , memoryReservation :: Maybe MemoryConstraint
1415+ , memorySwap :: Maybe MemoryConstraint
12551416 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1256− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
12571418 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
12581419 , ulimits :: [Ulimit]
12591420 -- TODO: Missing from 1.24
@@ -1291,7 +1452,7 @@ instance FromJSON EnvVar where
12911452 parseJSON _ = fail "EnvVar is not a string"
12921453
12931454instance ToJSON EnvVar where
1294− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
12951456
12961457-- | ExposedPort represents a port (and it's type)
12971458-- that a container should expose to other containers or the host system.
@@ -1312,7 +1473,7 @@ instance ToJSON EnvVar where
13121473-- @
13131474data ExposedPort = ExposedPort Port PortType deriving (Eq, Show)
13141475
1315−instance FromJSON [ExposedPort] where
1476+instance {-# OVERLAPPING #-} FromJSON [ExposedPort] where
13161477 parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
13171478 where
13181479 f accM k _ = case T.split (== '/') k of
@@ -1325,11 +1486,26 @@ instance FromJSON [ExposedPort] where
13251486 parseJSON (JSON.Null) = return []
13261487 parseJSON _ = fail "ExposedPorts is not an object"
13271488
1328−instance ToJSON [ExposedPort] where
1329− toJSON [] = JSON.Object HM.empty
1330− toJSON (p:ps) = JSON.Object $ foldl f HM.empty (p:ps)
1331− where f acc (ExposedPort p t) = HM.insert (exposify p t) (JSON.Object HM.empty) acc
1332− exposify p t = (T.pack $ show p) <> "/" <> (T.pack $ show t)
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 "/"
1494+
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"
1508+
13331509
13341510data ContainerConfig = ContainerConfig {
13351511 hostname :: Maybe Text
@@ -1349,7 +1525,7 @@ data ContainerConfig = ContainerConfig {
13491525 , image :: Text
13501526 , volumes :: [Volume]
13511527 , workingDir :: Maybe FilePath
1352− , entrypoint :: Maybe Text -- Can be null?
1528+ , entrypoint :: Entrypoint
13531529 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
13541530 , macAddress :: Maybe Text
13551531 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
@@ -1357,6 +1533,7 @@ data ContainerConfig = ContainerConfig {
13571533 , stopSignal :: Signal
13581534 } deriving (Eq, Show, Generic)
13591535
1536+
13601537instance ToJSON ContainerConfig where
13611538 toJSON = genericToJSON defaultOptions {
13621539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
@@ -1369,9 +1546,7 @@ instance FromJSON ContainerConfig where
13691546 attachStdin <- o .: "AttachStdin"
13701547 attachStdout <- o .: "AttachStdout"
13711548 attachStderr <- o .: "AttachStderr"
1372− exposedPorts <- case HM.lookup "ExposedPorts" o of
1373− Just eps -> parseJSON eps
1374− Nothing -> return []
1549+ exposedPorts <- o .:? "ExposedPorts" .!= []
13751550 tty <- o .: "Tty"
13761551 openStdin <- o .: "OpenStdin"
13771552 stdinOnce <- o .: "StdinOnce"
@@ -1380,20 +1555,38 @@ instance FromJSON ContainerConfig where
13801555 image <- o .: "Image"
13811556 volumes <- o .: "Volumes"
13821557 workingDir <- o .:? "WorkingDir"
1383− entrypoint <- o .:? "Entrypoint"
1558+ entrypoint <- o .: "Entrypoint"
13841559 networkDisabled <- o .:? "networkDisabled"
13851560 macAddress <- o .:? "MacAddress"
1386− labels <- case HM.lookup "Labels" o of
1387− Just ls -> parseJSON ls
1388− Nothing -> return []
1561+ labels <- o .:? "Labels" .!= []
13891562 stopSignal <- o .: "StopSignal"
13901563 return $ ContainerConfig hostname domainname user attachStdin attachStdout attachStderr exposedPorts tty openStdin stdinOnce env cmd image volumes workingDir entrypoint networkDisabled
13911564 macAddress labels stopSignal
13921565 parseJSON _ = fail "NetworkSettings is not an object."
13931566
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1569+#else
13941570parseIntegerText :: (Monad m) => Text -> m Integer
1571+#endif
13951572parseIntegerText t = case readMaybe $ T.unpack t of
13961573 Nothing ->
13971574 fail "Could not parse Integer"
13981575 Just i ->
13991576 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