@@ -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,11 +26,12 @@ 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(..)
3237 , BuildOpts(..)
@@ -35,12 +40,16 @@ module Docker.Client.Types (
3540 , DetachKeys(..)
3641 , StartOpts(..)
3742 , defaultStartOpts
38− , DeleteOpts(..)
39− , defaultDeleteOpts
43+ , ContainerDeleteOpts(..)
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
4047 , Timestamp
4148 , TailLogOpt(..)
4249 , LogOpts(..)
4350 , defaultLogOpts
51+ , CreateNetworkOpts(..)
52+ , defaultCreateNetworkOpts
4453 , VolumePermission(..)
4554 , Bind(..)
4655 , Volume(..)
@@ -66,6 +75,8 @@ module Docker.Client.Types (
6675 , UTSMode(..)
6776 , HostConfig(..)
6877 , defaultHostConfig
78+ , NetworkingConfig(..)
79+ , EndpointConfig(..)
6980 , Ulimit(..)
7081 , ContainerResources(..)
7182 , defaultContainerResources
@@ -85,6 +96,8 @@ module Docker.Client.Types (
8596 , addLink
8697 , addVolume
8798 , addVolumeFrom
99+ , MemoryConstraint(..)
100+ , MemoryConstraintSize(..)
88101 ) where
89102
90103import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
@@ -99,6 +112,7 @@ import Data.Scientific (floatingOrInteger)
99112import Data.Text (Text)
100113import qualified Data.Text as T
101114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
102116import GHC.Generics (Generic)
103117import Prelude hiding (all, tail)
104118import Text.Read (readMaybe)
@@ -111,15 +125,20 @@ data Endpoint =
111125 | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
112126 | StartContainerEndpoint StartOpts ContainerID
113127 | StopContainerEndpoint Timeout ContainerID
128+ | WaitContainerEndpoint ContainerID
114129 | KillContainerEndpoint Signal ContainerID
115130 | RestartContainerEndpoint Timeout ContainerID
116131 | PauseContainerEndpoint ContainerID
117132 | UnpauseContainerEndpoint ContainerID
118133 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
119134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
120− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
121136 | InspectContainerEndpoint ContainerID
122137 | 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
123142 deriving (Eq, Show)
124143
125144-- | We should newtype this
@@ -166,6 +185,20 @@ toImageID t =
166185-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
167186data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
168187
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+
169202-- TODO: Add more Signals or use an existing lib
170203-- | Signal used for sending to the process running in the container.
171204-- The default signal is SIGTERM.
@@ -180,16 +213,16 @@ data Signal = SIGHUP
180213
181214instance FromJSON Signal where
182215 parseJSON (JSON.String "SIGTERM") = return SIGTERM
183− parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
184− 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
185218 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
186219 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
187220 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
188− parseJSON _ = fail "Unknown Signal"
221+ parseJSON _ = fail "Unknown Signal"
189222
190223instance ToJSON Signal where
191− toJSON SIGHUP = "SIGHUP"
192− toJSON SIGINT = "SIGINT"
224+ toJSON SIGHUP = "SIGHUP"
225+ toJSON SIGINT = "SIGINT"
193226 toJSON SIGQUIT = "SIGQUIT"
194227 toJSON SIGSTOP = "SIGSTOP"
195228 toJSON SIGTERM = "SIGTERM"
@@ -217,7 +250,7 @@ data ContainerDetails = ContainerDetails {
217250 , processLabel :: Text
218251 , resolveConfPath :: FilePath
219252 , restartCount :: Int
220− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
221254 , mounts :: [Mount]
222255 }
223256 deriving (Eq, Show, Generic)
@@ -225,11 +258,11 @@ data ContainerDetails = ContainerDetails {
225258-- | Data type used for parsing the mount information from a container
226259-- list.
227260data Mount = Mount {
228− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
229262 , mountSource :: FilePath
230263 , mountDestination :: FilePath
231− , mountDriver :: Text
232− , mountMode :: Maybe VolumePermission -- apparently this can be null
264+ , mountDriver :: Maybe Text
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
233266 , mountRW :: Bool
234267 , mountPropogation :: Text
235268 }
@@ -237,14 +270,14 @@ data Mount = Mount {
237270
238271instance FromJSON Mount where
239272 parseJSON (JSON.Object o) = do
240− name <- o .: "Name"
273+ name <- o .:? "Name"
241274 src <- o .: "Source"
242275 dest <- o .: "Destination"
243− driver <- o .: "Driver"
244− mode <- o .: "Mode"
276+ driver <- o .:? "Driver"
277+ -- mode <- o .: "Mode"
245278 rw <- o .: "RW"
246279 prop <- o .: "Propagation"
247− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
248281 parseJSON _ = fail "Mount is not an object"
249282
250283-- | Data type used for parsing the container state from a list of
@@ -260,7 +293,7 @@ data ContainerState = ContainerState {
260293 , restarting :: Bool
261294 , running :: Bool
262295 , startedAt :: UTCTime
263− , status :: Status
296+ , state :: State
264297 }
265298 deriving (Eq, Show, Generic)
266299
@@ -490,7 +523,8 @@ 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]
496530 , containerNetworks :: [Network]
@@ -498,13 +532,14 @@ data Container = Container
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.
@@ -589,20 +623,46 @@ instance FromJSON Image where
589623 return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
590624 parseJSON _ = fail "Failed to parse DockerImage."
591625
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+ ]
592649
593650-- | Options used for creating a Container.
594651data CreateOpts = CreateOpts {
595− containerConfig :: ContainerConfig
596− , hostConfig :: HostConfig
652+ containerConfig :: ContainerConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
597655 } deriving (Eq, Show)
598656
599657instance ToJSON CreateOpts where
600− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
601659 let ccJSON = toJSON cc
602660 let hcJSON = toJSON hc
603661 case ccJSON of
604662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
605− 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
606666 _ -> error "ContainerConfig is not an object." -- This should never happen.
607667
608668-- | Container configuration used for creating a container with sensible
@@ -624,7 +684,7 @@ defaultContainerConfig imageName = ContainerConfig {
624684 , cmd=[]
625685 , volumes=[]
626686 , workingDir=Nothing
627− , entrypoint=Nothing
687+ , entrypoint=Entrypoint []
628688 , networkDisabled=Nothing
629689 , macAddress=Nothing
630690 , labels=[]
@@ -637,7 +697,7 @@ defaultHostConfig = HostConfig {
637697 binds=[]
638698 , containerIDFile=Nothing
639699 , logConfig=LogDriverConfig JsonFile []
640− , networkMode=Bridge
700+ , networkMode=NetworkBridge
641701 , portBindings=[]
642702 , restartPolicy=RestartOff
643703 , volumeDriver=Nothing
@@ -677,14 +737,18 @@ defaultContainerResources = ContainerResources {
677737 , memory=Nothing
678738 , memoryReservation=Nothing
679739 , memorySwap=Nothing
680− , oomKillDisable=False
740+ , oomKillDisable=Just False
681741 , ulimits=[]
682742 }
683743
684744-- | Default create options when creating a container. You only need to
685745-- specify an image name and the rest is all sensible defaults.
686746defaultCreateOpts :: T.Text -> CreateOpts
687−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+ }
688752
689753-- | Override the key sequence for detaching a container.
690754-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
@@ -698,7 +762,7 @@ defaultStartOpts :: StartOpts
698762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
699763
700764-- | Options for deleting a container.
701−data DeleteOpts = DeleteOpts {
765+data ContainerDeleteOpts = ContainerDeleteOpts {
702766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
703767 , force :: Bool -- ^ If the container is still running force deletion anyway.
704768 } deriving (Eq, Show)
@@ -728,8 +792,15 @@ defaultBuildOpts nameTag = BuildOpts { buildImageName = nameTag
728792-- | Default options for deleting a container. Most of the time we DON'T
729793-- want to delete the container's volumes or force delete it if it's
730794-- running.
731−defaultDeleteOpts :: DeleteOpts
732−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
733804
734805-- | Timestamp alias.
735806type Timestamp = Integer
@@ -757,18 +828,50 @@ defaultLogOpts = LogOpts { stdout = True
757828 , tail = All
758829 }
759830
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+
760861-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
761862-- | Set permissions on volumes that you mount in the container.
762863data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
763864
764865instance ToJSON VolumePermission where
765866 toJSON ReadWrite = "rw"
766− toJSON ReadOnly = "ro"
867+ toJSON ReadOnly = "ro"
767868
768869instance FromJSON VolumePermission where
769870 parseJSON "rw" = return ReadWrite
770871 parseJSON "ro" = return ReadOnly
771− parseJSON _ = fail "Failed to parse VolumePermission"
872+ parseJSON "RW" = return ReadWrite
873+ parseJSON "RO" = return ReadOnly
874+ parseJSON _ = fail "Failed to parse VolumePermission"
772875
773876-- | Used for marking a directory in the container as "exposed" hence
774877-- taking it outside of the COW filesystem and making it mountable
@@ -790,8 +893,8 @@ instance {-# OVERLAPPING #-} ToJSON [Volume] where
790893
791894instance {-# OVERLAPPING #-} FromJSON [Volume] where
792895 parseJSON (JSON.Object o) = return $ map (Volume . T.unpack) $ HM.keys o
793− parseJSON (JSON.Null) = return []
794− parseJSON _ = fail "Volume is not an object"
896+ parseJSON (JSON.Null) = return []
897+ parseJSON _ = fail "Volume is not an object"
795898
796899
797900data Bind = Bind { hostSrc :: Text
@@ -801,10 +904,10 @@ data Bind = Bind { hostSrc :: Text
801904
802905instance FromJSON Bind where
803906 parseJSON (JSON.String t) = case T.split (== ':') t of
804− [src, dest] -> return $ Bind src dest Nothing
907+ [src, dest] -> return $ Bind src dest Nothing
805908 [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
806909 [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
807− _ -> fail "Could not parse Bind"
910+ _ -> fail "Could not parse Bind"
808911 parseJSON _ = fail "Bind is not a string"
809912
810913data Device = Device {
@@ -827,15 +930,15 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
827930
828931instance FromJSON VolumeFrom where
829932 parseJSON (JSON.String t) = case T.split (== ':') t of
830− [vol] -> return $ VolumeFrom vol Nothing
933+ [vol] -> return $ VolumeFrom vol Nothing
831934 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
832935 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
833− _ -> fail "Could not parse VolumeFrom"
936+ _ -> fail "Could not parse VolumeFrom"
834937 parseJSON _ = fail "VolumeFrom is not a string"
835938
836939instance ToJSON VolumeFrom where
837940 toJSON (VolumeFrom n p) = case p of
838− Nothing -> toJSON $ n <> ":" <> "rw"
941+ Nothing -> toJSON $ n <> ":" <> "rw"
839942 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
840943
841944instance ToJSON Bind where
@@ -847,40 +950,40 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
847950
848951instance FromJSON Link where
849952 parseJSON (JSON.String t) = case T.split (== ':') t of
850− [f] -> return $ Link f Nothing
953+ [f] -> return $ Link f Nothing
851954 [f,s] -> return $ Link f $ Just s
852− _ -> fail "Could not parse Link"
955+ _ -> fail "Could not parse Link"
853956 parseJSON _ = fail "Link is not a string"
854957
855958instance ToJSON Link where
856959 toJSON (Link n1 n2) = toJSON $ case n2 of
857960 Nothing -> T.concat[n1, ":", n1] -- use same name in container
858− Just n -> T.concat[n1, ":", n] -- used specified name in container
961+ Just n -> T.concat[n1, ":", n] -- used specified name in container
859962
860963-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
861964data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
862965
863966instance FromJSON LogDriverType where
864967 parseJSON (JSON.String "json-file") = return JsonFile
865− parseJSON (JSON.String "syslog") = return Syslog
866− parseJSON (JSON.String "journald") = return Journald
867− parseJSON (JSON.String "gelf") = return Gelf
868− parseJSON (JSON.String "fluentd") = return Fluentd
869− parseJSON (JSON.String "awslogs") = return AwsLogs
870− parseJSON (JSON.String "splunk") = return Splunk
871− parseJSON (JSON.String "etwlogs") = return Etwlogs
872− parseJSON (JSON.String "none") = return LoggingDisabled
873− 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"
874977
875978instance ToJSON LogDriverType where
876− toJSON JsonFile = JSON.String "json-file"
877− toJSON Syslog = JSON.String "syslog"
878− toJSON Journald = JSON.String "journald"
879− toJSON Gelf = JSON.String "gelf"
880− toJSON Fluentd = JSON.String "fluentd"
881− toJSON AwsLogs = JSON.String "awslogs"
882− toJSON Splunk = JSON.String "splunk"
883− 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"
884987 toJSON LoggingDisabled = JSON.String "none"
885988
886989data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
@@ -914,19 +1017,41 @@ instance FromJSON LogDriverConfig where
9141017 parseJSON _ = fail "LogDriverConfig is not an object"
9151018
9161019-- TODO: Add container:<name|id> mode
917−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
9181021 deriving (Eq, Show, Ord)
9191022
9201023instance FromJSON NetworkMode where
921− parseJSON (JSON.String "bridge") = return Bridge
922− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
923− parseJSON (JSON.String "none") = return NetworkDisabled
924− 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"
9251029
9261030instance ToJSON NetworkMode where
927− toJSON Bridge = JSON.String "bridge"
928− toJSON Host = JSON.String "host"
1031+ toJSON NetworkBridge = JSON.String "bridge"
1032+ toJSON NetworkHost = JSON.String "host"
9291033 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]
9301055
9311056data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
9321057
@@ -942,7 +1067,7 @@ instance FromJSON PortType where
9421067 parseJSON val = case val of
9431068 "tcp" -> return TCP
9441069 "udp" -> return UDP
945− _ -> fail "PortType: Invalid port type."
1070+ _ -> fail "PortType: Invalid port type."
9461071
9471072-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
9481073--
@@ -1072,7 +1197,7 @@ instance FromJSON RestartPolicy where
10721197 "on-failure" -> do
10731198 retry <- o .: "MaximumRetryCount"
10741199 return $ RestartOnFailure retry
1075− "off" -> return RestartOff
1200+ "no" -> return RestartOff
10761201 _ -> fail "Could not parse RestartPolicy"
10771202 parseJSON _ = fail "RestartPolicy is not an object"
10781203
@@ -1080,7 +1205,7 @@ instance ToJSON RestartPolicy where
10801205 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
10811206 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
10821207 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1083− toJSON RestartOff = object ["Name" .= JSON.String "off"]
1208+ toJSON RestartOff = object ["Name" .= JSON.String "no"]
10841209
10851210data Isolation = Default | Process | Hyperv deriving (Eq, Show)
10861211
@@ -1258,7 +1383,7 @@ data MemoryConstraintSize = B | MB | GB deriving (Eq, Show)
12581383data MemoryConstraint = MemoryConstraint Integer MemoryConstraintSize deriving (Eq, Show)
12591384
12601385instance ToJSON MemoryConstraint where
1261− toJSON (MemoryConstraint x B) = toJSON x
1386+ toJSON (MemoryConstraint x B) = toJSON x
12621387 toJSON (MemoryConstraint x MB) = toJSON $ x * 1024 * 1024
12631388 toJSON (MemoryConstraint x GB) = toJSON $ x * 1024 * 1024 * 1024
12641389
@@ -1289,7 +1414,7 @@ data ContainerResources = ContainerResources {
12891414 , memoryReservation :: Maybe MemoryConstraint
12901415 , memorySwap :: Maybe MemoryConstraint
12911416 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1292− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
12931418 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
12941419 , ulimits :: [Ulimit]
12951420 -- TODO: Missing from 1.24
@@ -1327,7 +1452,7 @@ instance FromJSON EnvVar where
13271452 parseJSON _ = fail "EnvVar is not a string"
13281453
13291454instance ToJSON EnvVar where
1330− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
13311456
13321457-- | ExposedPort represents a port (and it's type)
13331458-- that a container should expose to other containers or the host system.
@@ -1367,6 +1492,21 @@ instance {-# OVERLAPPING #-} ToJSON [ExposedPort] where
13671492 where key (ExposedPort p t) = show p <> slash <> show t
13681493 slash = T.unpack "/"
13691494
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+
1509+
13701510data ContainerConfig = ContainerConfig {
13711511 hostname :: Maybe Text
13721512 , domainname :: Maybe Text
@@ -1385,7 +1525,7 @@ data ContainerConfig = ContainerConfig {
13851525 , image :: Text
13861526 , volumes :: [Volume]
13871527 , workingDir :: Maybe FilePath
1388− , entrypoint :: Maybe Text -- Can be null?
1528+ , entrypoint :: Entrypoint
13891529 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
13901530 , macAddress :: Maybe Text
13911531 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
@@ -1393,6 +1533,7 @@ data ContainerConfig = ContainerConfig {
13931533 , stopSignal :: Signal
13941534 } deriving (Eq, Show, Generic)
13951535
1536+
13961537instance ToJSON ContainerConfig where
13971538 toJSON = genericToJSON defaultOptions {
13981539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
@@ -1414,7 +1555,7 @@ instance FromJSON ContainerConfig where
14141555 image <- o .: "Image"
14151556 volumes <- o .: "Volumes"
14161557 workingDir <- o .:? "WorkingDir"
1417− entrypoint <- o .:? "Entrypoint"
1558+ entrypoint <- o .: "Entrypoint"
14181559 networkDisabled <- o .:? "networkDisabled"
14191560 macAddress <- o .:? "MacAddress"
14201561 labels <- o .:? "Labels" .!= []
@@ -1423,7 +1564,11 @@ instance FromJSON ContainerConfig where
14231564 macAddress labels stopSignal
14241565 parseJSON _ = fail "NetworkSettings is not an object."
14251566
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1569+#else
14261570parseIntegerText :: (Monad m) => Text -> m Integer
1571+#endif
14271572parseIntegerText t = case readMaybe $ T.unpack t of
14281573 Nothing ->
14291574 fail "Could not parse Integer"
@@ -1445,4 +1590,3 @@ toJsonKeyVal vs getKey getVal = JSON.Object $ foldl f HM.empty vs
14451590-- | Helper function that return an empty dictionary "{}"
14461591emptyJsonObject :: JSON.Value
14471592emptyJsonObject = JSON.Object HM.empty
1448−