@@ -11,7 +11,11 @@ module Docker.Client.Types (
12 , fromImageID
12 , fromImageID
13 , toImageID
13 , toImageID
14 , Timeout(..)
17 , Timeout(..)
15 , Signal(..)
19 , Signal(..)
16 , ContainerDetails(..)
20 , ContainerDetails(..)
17 , DockerClientOpts(..)
21 , DockerClientOpts(..)
@@ -22,23 +26,30 @@ module Docker.Client.Types (
22 , ContainerPortInfo(..)
26 , ContainerPortInfo(..)
23 , Container(..)
27 , Container(..)
24 , ContainerState(..)
28 , ContainerState(..)
25− , Status(..)
29+ , State(..)
27− , Labels(..)
31+ , Label(..)
29 , Image(..)
33 , Image(..)
30 , dropImagePrefix
35 , dropImagePrefix
31 , CreateOpts(..)
36 , CreateOpts(..)
32 , defaultCreateOpts
39 , defaultCreateOpts
33 , DetachKeys(..)
40 , DetachKeys(..)
34 , StartOpts(..)
41 , StartOpts(..)
35 , defaultStartOpts
42 , defaultStartOpts
36− , DeleteOpts(..)
43+ , ContainerDeleteOpts(..)
37− , defaultDeleteOpts
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
38 , Timestamp
47 , Timestamp
39 , TailLogOpt(..)
48 , TailLogOpt(..)
40 , LogOpts(..)
49 , LogOpts(..)
41 , defaultLogOpts
50 , defaultLogOpts
51+ , CreateNetworkOpts(..)
52+ , defaultCreateNetworkOpts
42 , VolumePermission(..)
53 , VolumePermission(..)
43 , Bind(..)
54 , Bind(..)
44 , Volume(..)
55 , Volume(..)
@@ -47,17 +58,16 @@ module Docker.Client.Types (
47 , VolumeFrom(..)
58 , VolumeFrom(..)
48 , Link(..)
59 , Link(..)
49 , LogDriverType(..)
60 , LogDriverType(..)
50− , LogDriverOptions(..)
61+ , LogDriverOption(..)
51 , LogDriverConfig(..)
62 , LogDriverConfig(..)
52 , NetworkMode(..)
63 , NetworkMode(..)
53 , PortType(..)
64 , PortType(..)
54-- , NetworkInterface(..)
65-- , NetworkInterface(..)
55− , Networks(..)
66+ , Network(..)
56 , NetworkSettings(..)
67 , NetworkSettings(..)
57 , NetworkOptions(..)
68 , NetworkOptions(..)
58 , Mount(..)
69 , Mount(..)
59 , PortBinding(..)
70 , PortBinding(..)
61 , HostPort(..)
71 , HostPort(..)
62 , RetryCount
72 , RetryCount
63 , RestartPolicy(..)
73 , RestartPolicy(..)
@@ -65,6 +75,8 @@ module Docker.Client.Types (
65 , UTSMode(..)
75 , UTSMode(..)
66 , HostConfig(..)
76 , HostConfig(..)
67 , defaultHostConfig
77 , defaultHostConfig
78+ , NetworkingConfig(..)
68 , Ulimit(..)
80 , Ulimit(..)
69 , ContainerResources(..)
81 , ContainerResources(..)
70 , defaultContainerResources
82 , defaultContainerResources
@@ -74,15 +86,18 @@ module Docker.Client.Types (
74 , EnvVar(..)
86 , EnvVar(..)
75 , ContainerConfig(..)
87 , ContainerConfig(..)
76 , defaultContainerConfig
88 , defaultContainerConfig
77− , ExposedPorts(..)
89+ , ExposedPort(..)
78 , DeviceWeight(..)
90 , DeviceWeight(..)
79 , DeviceRate(..)
91 , DeviceRate(..)
80 , addPortBinding
92 , addPortBinding
84 , addVolume
97 , addVolume
85 , addVolumeFrom
98 , addVolumeFrom
99+ , MemoryConstraint(..)
100+ , MemoryConstraintSize(..)
88import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
103import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
@@ -92,11 +107,12 @@ import qualified Data.Aeson as JSON
92import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
107import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
93import Data.Char (isAlphaNum, toUpper)
108import Data.Char (isAlphaNum, toUpper)
94import qualified Data.HashMap.Strict as HM
109import qualified Data.HashMap.Strict as HM
95−import qualified Data.Map as M
96import Data.Monoid ((<>))
110import Data.Monoid ((<>))
111+import Data.Scientific (floatingOrInteger)
97import Data.Text (Text)
112import Data.Text (Text)
98import qualified Data.Text as T
113import qualified Data.Text as T
99import Data.Time.Clock (UTCTime)
114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
100import GHC.Generics (Generic)
116import GHC.Generics (Generic)
101import Prelude hiding (all, tail)
117import Prelude hiding (all, tail)
102import Text.Read (readMaybe)
118import Text.Read (readMaybe)
@@ -109,14 +125,20 @@ data Endpoint =
109 | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
125 | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
110 | StartContainerEndpoint StartOpts ContainerID
126 | StartContainerEndpoint StartOpts ContainerID
111 | StopContainerEndpoint Timeout ContainerID
127 | StopContainerEndpoint Timeout ContainerID
128+ | WaitContainerEndpoint ContainerID
112 | KillContainerEndpoint Signal ContainerID
129 | KillContainerEndpoint Signal ContainerID
113 | RestartContainerEndpoint Timeout ContainerID
130 | RestartContainerEndpoint Timeout ContainerID
114 | PauseContainerEndpoint ContainerID
131 | PauseContainerEndpoint ContainerID
115 | UnpauseContainerEndpoint ContainerID
132 | UnpauseContainerEndpoint ContainerID
116 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
133 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
117 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
118− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
119 | InspectContainerEndpoint ContainerID
136 | 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
120 deriving (Eq, Show)
142 deriving (Eq, Show)
122-- | We should newtype this
144-- | We should newtype this
@@ -163,6 +185,20 @@ toImageID t =
163-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
185-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
164data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
186data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
188+data StatusCode = StatusCode Int
190+instance ToJSON StatusCode where
191+ toJSON (StatusCode c) = object ["StatusCode" .= c]
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)
199+ fail "Unknown exit code"
200+ parseJSON _ = fail "Unknown exit code"
166-- TODO: Add more Signals or use an existing lib
202-- TODO: Add more Signals or use an existing lib
167-- | Signal used for sending to the process running in the container.
203-- | Signal used for sending to the process running in the container.
168-- The default signal is SIGTERM.
204-- The default signal is SIGTERM.
@@ -177,16 +213,16 @@ data Signal = SIGHUP
178instance FromJSON Signal where
214instance FromJSON Signal where
179 parseJSON (JSON.String "SIGTERM") = return SIGTERM
215 parseJSON (JSON.String "SIGTERM") = return SIGTERM
180− parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
216+ parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
181− parseJSON (JSON.String "SIGINT") = return SIGINT
217+ parseJSON (JSON.String "SIGINT") = return SIGINT
182 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
218 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
183 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
219 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
184 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
220 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
185− parseJSON _ = fail "Unknown Signal"
221+ parseJSON _ = fail "Unknown Signal"
187instance ToJSON Signal where
223instance ToJSON Signal where
188− toJSON SIGHUP = "SIGHUP"
224+ toJSON SIGHUP = "SIGHUP"
189− toJSON SIGINT = "SIGINT"
225+ toJSON SIGINT = "SIGINT"
190 toJSON SIGQUIT = "SIGQUIT"
226 toJSON SIGQUIT = "SIGQUIT"
191 toJSON SIGSTOP = "SIGSTOP"
227 toJSON SIGSTOP = "SIGSTOP"
192 toJSON SIGTERM = "SIGTERM"
228 toJSON SIGTERM = "SIGTERM"
@@ -208,13 +244,13 @@ data ContainerDetails = ContainerDetails {
208 , containerDetailsId :: ContainerID
244 , containerDetailsId :: ContainerID
209 , containerDetailsImage :: ImageID
245 , containerDetailsImage :: ImageID
210 , mountLabel :: Text
246 , mountLabel :: Text
211− , names :: [Text]
247+ , name :: Text
212 , networkSettings :: NetworkSettings
248 , networkSettings :: NetworkSettings
213 , path :: FilePath
249 , path :: FilePath
214 , processLabel :: Text
250 , processLabel :: Text
215 , resolveConfPath :: FilePath
251 , resolveConfPath :: FilePath
216 , restartCount :: Int
252 , restartCount :: Int
217− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
218 , mounts :: [Mount]
254 , mounts :: [Mount]
220 deriving (Eq, Show, Generic)
256 deriving (Eq, Show, Generic)
@@ -222,11 +258,11 @@ data ContainerDetails = ContainerDetails {
222-- | Data type used for parsing the mount information from a container
258-- | Data type used for parsing the mount information from a container
224data Mount = Mount {
260data Mount = Mount {
225− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
226 , mountSource :: FilePath
262 , mountSource :: FilePath
227 , mountDestination :: FilePath
263 , mountDestination :: FilePath
228− , mountDriver :: Text
264+ , mountDriver :: Maybe Text
229− , mountMode :: Maybe VolumePermission -- apparently this can be null
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
230 , mountRW :: Bool
266 , mountRW :: Bool
231 , mountPropogation :: Text
267 , mountPropogation :: Text
@@ -234,14 +270,14 @@ data Mount = Mount {
235instance FromJSON Mount where
271instance FromJSON Mount where
236 parseJSON (JSON.Object o) = do
272 parseJSON (JSON.Object o) = do
237− name <- o .: "Name"
273+ name <- o .:? "Name"
238 src <- o .: "Source"
274 src <- o .: "Source"
239 dest <- o .: "Destination"
275 dest <- o .: "Destination"
240− driver <- o .: "Driver"
276+ driver <- o .:? "Driver"
241− mode <- o .: "Mode"
277+ -- mode <- o .: "Mode"
242 rw <- o .: "RW"
278 rw <- o .: "RW"
243 prop <- o .: "Propagation"
279 prop <- o .: "Propagation"
244− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
245 parseJSON _ = fail "Mount is not an object"
281 parseJSON _ = fail "Mount is not an object"
247-- | Data type used for parsing the container state from a list of
283-- | Data type used for parsing the container state from a list of
@@ -257,7 +293,7 @@ data ContainerState = ContainerState {
257 , restarting :: Bool
293 , restarting :: Bool
258 , running :: Bool
294 , running :: Bool
259 , startedAt :: UTCTime
295 , startedAt :: UTCTime
260− , status :: Status
296+ , state :: State
262 deriving (Eq, Show, Generic)
298 deriving (Eq, Show, Generic)
@@ -335,7 +371,7 @@ instance FromJSON ContainerDetails where
335 id <- parseJSON v
371 id <- parseJSON v
336 image <- o .: "Image"
372 image <- o .: "Image"
337 mountLabel <- o .: "MountLabel"
373 mountLabel <- o .: "MountLabel"
338− names <- o .: "Names"
374+ name <- o .: "Name"
339 networkSettings <- o .: "NetworkSettings"
375 networkSettings <- o .: "NetworkSettings"
340 path <- o .: "Path"
376 path <- o .: "Path"
341 processLabel <- o .: "ProcessLabel"
377 processLabel <- o .: "ProcessLabel"
@@ -343,7 +379,7 @@ instance FromJSON ContainerDetails where
343 restartCount <- o .: "RestartCount"
379 restartCount <- o .: "RestartCount"
344 state <- o .: "State"
380 state <- o .: "State"
345 mounts <- o .: "Mounts"
381 mounts <- o .: "Mounts"
346− return $ ContainerDetails appArmor args config created driver hostConfig hostnamePath hostsPath logPath id image mountLabel names networkSettings path processLabel resolveConfPath restartCount state mounts
382+ return $ ContainerDetails appArmor args config created driver hostConfig hostnamePath hostsPath logPath id image mountLabel name networkSettings path processLabel resolveConfPath restartCount state mounts
347 parseJSON _ = fail "ContainerDetails is not an object"
383 parseJSON _ = fail "ContainerDetails is not an object"
349instance ToJSON ContainerID where
385instance ToJSON ContainerID where
@@ -420,20 +456,17 @@ instance FromJSON NetworkOptions where
420 parseJSON _ = fail "NetworkOptions is not an object"
456 parseJSON _ = fail "NetworkOptions is not an object"
422-- TODO: Not sure what this is used for anymore.
458-- 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
424 deriving (Eq, Show)
460 deriving (Eq, Show)
426−instance FromJSON Networks where
462+instance {-# OVERLAPPING #-} FromJSON [Network] where
427− parseJSON (JSON.Object o) = do
463+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
428− Networks <$> HM.foldlWithKey' f (return M.empty) o
431 f accM k' v' = do
465 f accM k' v' = do
432 acc <- accM
466 acc <- accM
433 k <- parseJSON $ JSON.String k'
467 k <- parseJSON $ JSON.String k'
434 v <- parseJSON v'
468 v <- parseJSON v'
435− return $ M.insert k v acc
469+ return $ (Network k v):acc
437 parseJSON _ = fail "Networks is not an object"
470 parseJSON _ = fail "Networks is not an object"
439-- | Data type reprsenting the various network settings a container can have.
472-- | Data type reprsenting the various network settings a container can have.
@@ -443,7 +476,7 @@ data NetworkSettings = NetworkSettings {
443 , networkSettingsHairpinMode :: Bool
476 , networkSettingsHairpinMode :: Bool
444 , networkSettingsLinkLocalIPv6Address :: Text
477 , networkSettingsLinkLocalIPv6Address :: Text
445 , networkSettingsLinkLocalIPv6PrefixLen :: Int
478 , networkSettingsLinkLocalIPv6PrefixLen :: Int
446− , networkSettingsPorts :: PortBindings
479+ , networkSettingsPorts :: [PortBinding]
447 , networkSettingsSandboxKey :: Text
480 , networkSettingsSandboxKey :: Text
448 , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
481 , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
449 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
482 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
@@ -455,7 +488,7 @@ data NetworkSettings = NetworkSettings {
455 , networkSettingsIpPrefixLen :: Int
488 , networkSettingsIpPrefixLen :: Int
456 , networkSettingsIpv6Gateway :: Text
489 , networkSettingsIpv6Gateway :: Text
457 , networkSettingsMacAddress :: Text
490 , networkSettingsMacAddress :: Text
458− , networkSettingsNetworks :: Networks
491+ , networkSettingsNetworks :: [Network]
460 deriving (Eq, Show)
493 deriving (Eq, Show)
@@ -490,21 +523,23 @@ data Container = Container
490 , containerImageId :: ImageID
523 , containerImageId :: ImageID
491 , containerCommand :: Text
524 , containerCommand :: Text
492 , containerCreatedAt :: Int
525 , containerCreatedAt :: Int
526+ , containerState :: State
493− , containerStatus :: Status
527+ , containerStatus :: Maybe Text
494 , containerPorts :: [ContainerPortInfo]
528 , containerPorts :: [ContainerPortInfo]
495− , containerLabels :: Labels
529+ , containerLabels :: [Label]
496− , containerNetworks :: Networks
530+ , containerNetworks :: [Network]
497 , containerMounts :: [Mount]
531 , containerMounts :: [Mount]
498 } deriving (Show, Eq)
532 } deriving (Show, Eq)
500instance FromJSON Container where
534instance FromJSON Container where
501− parseJSON (JSON.Object v) =
535+ parseJSON o@(JSON.Object v) =
502− Container <$> (v .: "Id")
536+ Container <$> parseJSON o
503 <*> (v .: "Names")
537 <*> (v .: "Names")
504 <*> (v .: "Image")
538 <*> (v .: "Image")
505− <*> (v .: "ImageID")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
506− <*> (v .: "Command")
540+ <*> (v .: "Command") -- Doesn't exist anymore
507 <*> (v .: "Created")
541 <*> (v .: "Created")
508 <*> (v .: "Status")
543 <*> (v .: "Status")
509 <*> (v .: "Ports")
544 <*> (v .: "Ports")
510 <*> (v .: "Labels")
545 <*> (v .: "Labels")
@@ -514,34 +549,45 @@ instance FromJSON Container where
514 parseNetworks (JSON.Object v) =
549 parseNetworks (JSON.Object v) =
515 (v .: "Networks") >>= parseJSON
550 (v .: "Networks") >>= parseJSON
516 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
518 parseJSON _ = fail "Container: Not a JSON object."
552 parseJSON _ = fail "Container: Not a JSON object."
520−-- | Represents the status of the container life cycle.
554+-- | Represents the state of the container life cycle.
521−data Status = Created | Restarting | Running | Paused | Exited | Dead
555+data State = Created | Restarting | Running | Paused | Exited | Dead
522 deriving (Eq, Show, Generic)
556 deriving (Eq, Show, Generic)
524−instance FromJSON Status where
558+instance FromJSON State where
525− parseJSON (JSON.String "running") = return Running
559+ parseJSON (JSON.String "running") = return Running
526− parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
560+ parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
527 parseJSON (JSON.String "restarting") = return Restarting
561 parseJSON (JSON.String "restarting") = return Restarting
528− parseJSON (JSON.String "paused") = return Paused
562+ parseJSON (JSON.String "paused") = return Paused
529− parseJSON (JSON.String "exited") = return Exited
563+ parseJSON (JSON.String "exited") = return Exited
530− parseJSON (JSON.String "dead") = return Dead
564+ parseJSON (JSON.String "dead") = return Dead
531− parseJSON _ = fail "Unknown Status"
565+ parseJSON s = fail $ "Unknown Status: " ++ show s
533-- | Alias for representing a RepoDigest. We could newtype this and add
567-- | Alias for representing a RepoDigest. We could newtype this and add
534-- some validation.
568-- some validation.
535type Digest = Text
569type Digest = Text
537-- | Container and Image Labels.
571-- | Container and Image Labels.
538−newtype Labels = Labels (M.Map Name Value) deriving (Eq, Show)
572+data Label = Label Name Value deriving (Eq, Show)
575+-- If there are multiple lables with the same Name in the list
576+-- then the last one wins.
540−instance FromJSON Labels where
577+instance {-# OVERLAPPING #-} ToJSON [Label] where
541− parseJSON val = Labels <$> parseJSON val
578+ toJSON [] = emptyJsonObject
579+ toJSON (l:ls) = toJsonKeyVal (l:ls) key val
580+ where key (Label k _) = T.unpack k
543−instance ToJSON Labels where
583+instance {-# OVERLAPPING #-} FromJSON [Label] where
544− toJSON (Labels kvs) = object [k .= v | (k,v) <- (M.toList kvs)]
584+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
585+ where f accM k v = do
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."
546-- | Alias for Tags.
592-- | Alias for Tags.
547type Tag = Text
593type Tag = Text
@@ -552,10 +598,10 @@ data Image = DockerImage {
552 , imageCreated :: Integer
598 , imageCreated :: Integer
553 , imageParentId :: Maybe ImageID
599 , imageParentId :: Maybe ImageID
554 , imageRepoTags :: [Tag]
600 , imageRepoTags :: [Tag]
555− , imageRepoDigests :: Maybe [Digest]
601+ , imageRepoDigests :: [Digest]
556 , imageSize :: Integer
602 , imageSize :: Integer
557 , imageVirtualSize :: Integer
603 , imageVirtualSize :: Integer
558− , imageLabels :: Maybe Labels
604+ , imageLabels :: [Label]
559 } deriving (Show, Eq, Generic)
605 } deriving (Show, Eq, Generic)
561-- | Helper function used for dropping the "image" prefix when serializing
607-- | Helper function used for dropping the "image" prefix when serializing
@@ -563,23 +609,60 @@ data Image = DockerImage {
563dropImagePrefix :: [a] -> [a]
609dropImagePrefix :: [a] -> [a]
564dropImagePrefix = drop 5
610dropImagePrefix = drop 5
566instance FromJSON Image where
613instance FromJSON Image where
567− parseJSON = genericParseJSON defaultOptions {
614+ parseJSON (JSON.Object o) = do
568− fieldLabelModifier = dropImagePrefix}
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."
626+-- | Alias for Aliases.
629+-- | EndpointsConfig is container configuration for a specific network
630+newtype EndpointConfig = EndpointConfig [Alias] deriving (Eq, Show)
632+instance ToJSON EndpointConfig where
633+ toJSON (EndpointConfig aliases) = JSON.object
634+ [ "Aliases" .= aliases
637+-- | Alias for endpoint name
638+type EndpointName = Text
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)
645+instance ToJSON NetworkingConfig where
646+ toJSON (NetworkingConfig endpointsConfig) = JSON.object
647+ [ "EndpointsConfig" .= endpointsConfig
570-- | Options used for creating a Container.
650-- | Options used for creating a Container.
571data CreateOpts = CreateOpts {
651data CreateOpts = CreateOpts {
572− containerConfig :: ContainerConfig
652+ containerConfig :: ContainerConfig
573− , hostConfig :: HostConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
574 } deriving (Eq, Show)
655 } deriving (Eq, Show)
576instance ToJSON CreateOpts where
657instance ToJSON CreateOpts where
577− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
578 let ccJSON = toJSON cc
659 let ccJSON = toJSON cc
579 let hcJSON = toJSON hc
660 let hcJSON = toJSON hc
580 case ccJSON of
661 case ccJSON of
581 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
582− JSON.Object $ HM.insert "HostConfig" hcJSON o
663+ let o1 = HM.insert "HostConfig" hcJSON o
664+ let o2 = HM.insert "NetworkingConfig" (toJSON nc) o1
583 _ -> error "ContainerConfig is not an object." -- This should never happen.
666 _ -> error "ContainerConfig is not an object." -- This should never happen.
585-- | Container configuration used for creating a container with sensible
668-- | Container configuration used for creating a container with sensible
@@ -593,7 +676,7 @@ defaultContainerConfig imageName = ContainerConfig {
593 , attachStdout=False
676 , attachStdout=False
594 , image=imageName
677 , image=imageName
595 , attachStderr=False
678 , attachStderr=False
596− , exposedPorts=Nothing -- ExposedPorts M.empty
679+ , exposedPorts=[]
597 , tty=False
680 , tty=False
598 , openStdin=False
681 , openStdin=False
599 , stdinOnce=False
682 , stdinOnce=False
@@ -601,10 +684,10 @@ defaultContainerConfig imageName = ContainerConfig {
602 , volumes=[]
685 , volumes=[]
603 , workingDir=Nothing
686 , workingDir=Nothing
604− , entrypoint=Nothing
687+ , entrypoint=Entrypoint []
605 , networkDisabled=Nothing
688 , networkDisabled=Nothing
606 , macAddress=Nothing
689 , macAddress=Nothing
607− , labels=Nothing
690+ , labels=[]
608 , stopSignal=SIGTERM
691 , stopSignal=SIGTERM
@@ -613,9 +696,9 @@ defaultHostConfig :: HostConfig
613defaultHostConfig = HostConfig {
696defaultHostConfig = HostConfig {
615 , containerIDFile=Nothing
698 , containerIDFile=Nothing
616− , logConfig=LogDriverConfig JsonFile Nothing
699+ , logConfig=LogDriverConfig JsonFile []
617− , networkMode=Bridge
700+ , networkMode=NetworkBridge
618− , portBindings=PortBindings []
701+ , portBindings=[]
619 , restartPolicy=RestartOff
702 , restartPolicy=RestartOff
620 , volumeDriver=Nothing
703 , volumeDriver=Nothing
621 , volumesFrom=[]
704 , volumesFrom=[]
@@ -654,14 +737,18 @@ defaultContainerResources = ContainerResources {
654 , memory=Nothing
737 , memory=Nothing
655 , memoryReservation=Nothing
738 , memoryReservation=Nothing
656 , memorySwap=Nothing
739 , memorySwap=Nothing
657− , oomKillDisable=False
740+ , oomKillDisable=Just False
658 , ulimits=[]
741 , ulimits=[]
661-- | Default create options when creating a container. You only need to
744-- | Default create options when creating a container. You only need to
662-- specify an image name and the rest is all sensible defaults.
745-- specify an image name and the rest is all sensible defaults.
663defaultCreateOpts :: T.Text -> CreateOpts
746defaultCreateOpts :: T.Text -> CreateOpts
747+defaultCreateOpts imageName = CreateOpts
664−defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
748+ { containerConfig = defaultContainerConfig imageName
749+ , hostConfig = defaultHostConfig
750+ , networkingConfig = NetworkingConfig HM.empty
666-- | Override the key sequence for detaching a container.
753-- | Override the key sequence for detaching a container.
667-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
754-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
@@ -675,16 +762,45 @@ defaultStartOpts :: StartOpts
675defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
677-- | Options for deleting a container.
764-- | Options for deleting a container.
678−data DeleteOpts = DeleteOpts {
765+data ContainerDeleteOpts = ContainerDeleteOpts {
679 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
680 , force :: Bool -- ^ If the container is still running force deletion anyway.
767 , force :: Bool -- ^ If the container is still running force deletion anyway.
681 } deriving (Eq, Show)
768 } deriving (Eq, Show)
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)
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
683-- | Default options for deleting a container. Most of the time we DON'T
792-- | Default options for deleting a container. Most of the time we DON'T
684-- want to delete the container's volumes or force delete it if it's
793-- want to delete the container's volumes or force delete it if it's
685-- running.
794-- running.
686−defaultDeleteOpts :: DeleteOpts
795+defaultContainerDeleteOpts :: ContainerDeleteOpts
687−defaultDeleteOpts = DeleteOpts { deleteVolumes = False, force = False }
796+defaultContainerDeleteOpts = ContainerDeleteOpts { deleteVolumes = False, force = False }
798+-- | Image delete opts
799+data ImageDeleteOpts = ImageDeleteOpts deriving (Eq, Show)
801+-- | Sane image deletion defaults
802+defaultImageDeleteOpts :: ImageDeleteOpts
803+defaultImageDeleteOpts = ImageDeleteOpts
689-- | Timestamp alias.
805-- | Timestamp alias.
690type Timestamp = Integer
806type Timestamp = Integer
@@ -712,18 +828,50 @@ defaultLogOpts = LogOpts { stdout = True
712 , tail = All
828 , tail = All
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)
840+-- | Sensible defalut for create network options
841+defaultCreateNetworkOpts :: Text -> CreateNetworkOpts
842+defaultCreateNetworkOpts name =
844+ { createNetworkName = name
845+ , createNetworkCheckDuplicate = False
846+ , createNetworkDriver = "bridge"
847+ , createNetworkInternal = True
848+ , createNetworkEnableIPv6 = False
851+instance ToJSON CreateNetworkOpts where
854+ [ "Name" .= createNetworkName opts
855+ , "CheckDuplicate" .= createNetworkCheckDuplicate opts
856+ , "Driver" .= createNetworkDriver opts
857+ , "Internal" .= createNetworkInternal opts
858+ , "EnableIPv6" .= createNetworkEnableIPv6 opts
715-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
861-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
716-- | Set permissions on volumes that you mount in the container.
862-- | Set permissions on volumes that you mount in the container.
717data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
863data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
719instance ToJSON VolumePermission where
865instance ToJSON VolumePermission where
720 toJSON ReadWrite = "rw"
866 toJSON ReadWrite = "rw"
721− toJSON ReadOnly = "ro"
867+ toJSON ReadOnly = "ro"
723instance FromJSON VolumePermission where
869instance FromJSON VolumePermission where
724 parseJSON "rw" = return ReadWrite
870 parseJSON "rw" = return ReadWrite
725 parseJSON "ro" = return ReadOnly
871 parseJSON "ro" = return ReadOnly
872+ parseJSON "RW" = return ReadWrite
873+ parseJSON "RO" = return ReadOnly
726− parseJSON _ = fail "Failed to parse VolumePermission"
874+ parseJSON _ = fail "Failed to parse VolumePermission"
728-- | Used for marking a directory in the container as "exposed" hence
876-- | Used for marking a directory in the container as "exposed" hence
729-- taking it outside of the COW filesystem and making it mountable
877-- taking it outside of the COW filesystem and making it mountable
@@ -738,21 +886,15 @@ instance FromJSON VolumePermission where
739newtype Volume = Volume FilePath deriving (Eq, Show)
887newtype Volume = Volume FilePath deriving (Eq, Show)
741−instance ToJSON Volume where
889+instance {-# OVERLAPPING #-} ToJSON [Volume] where
742− toJSON (Volume fp) = JSON.Object $ HM.insert (T.pack fp) (JSON.Object HM.empty) HM.empty
890+ toJSON [] = emptyJsonObject
891+ toJSON (v:vs) = toJsonKey (v:vs) getKey
892+ where getKey (Volume v) = v
744−instance FromJSON Volume where
745− parseJSON (JSON.Object o) = return $ Volume $ T.unpack $ head $ HM.keys o
746− parseJSON _ = fail "Volume is not an object"
748−instance ToJSON [Volume] where
749− toJSON [] = JSON.Object HM.empty
750− toJSON (v:vs) = JSON.Object $ foldl f HM.empty (v:vs)
751− where f acc (Volume k) = HM.insert (T.pack k) (JSON.Object HM.empty) acc
753−instance FromJSON [Volume] where
894+instance {-# OVERLAPPING #-} FromJSON [Volume] where
754 parseJSON (JSON.Object o) = return $ map (Volume . T.unpack) $ HM.keys o
895 parseJSON (JSON.Object o) = return $ map (Volume . T.unpack) $ HM.keys o
896+ parseJSON (JSON.Null) = return []
755− parseJSON _ = fail "Volume is not an object"
897+ parseJSON _ = fail "Volume is not an object"
758data Bind = Bind { hostSrc :: Text
900data Bind = Bind { hostSrc :: Text
@@ -762,10 +904,10 @@ data Bind = Bind { hostSrc :: Text
763instance FromJSON Bind where
905instance FromJSON Bind where
764 parseJSON (JSON.String t) = case T.split (== ':') t of
906 parseJSON (JSON.String t) = case T.split (== ':') t of
765− [src, dest] -> return $ Bind src dest Nothing
907+ [src, dest] -> return $ Bind src dest Nothing
766 [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
908 [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
767 [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
909 [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
768− _ -> fail "Could not parse Bind"
910+ _ -> fail "Could not parse Bind"
769 parseJSON _ = fail "Bind is not a string"
911 parseJSON _ = fail "Bind is not a string"
771data Device = Device {
913data Device = Device {
@@ -788,15 +930,15 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
789instance FromJSON VolumeFrom where
931instance FromJSON VolumeFrom where
790 parseJSON (JSON.String t) = case T.split (== ':') t of
932 parseJSON (JSON.String t) = case T.split (== ':') t of
791− [vol] -> return $ VolumeFrom vol Nothing
933+ [vol] -> return $ VolumeFrom vol Nothing
792 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
934 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
793 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
935 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
794− _ -> fail "Could not parse VolumeFrom"
936+ _ -> fail "Could not parse VolumeFrom"
795 parseJSON _ = fail "VolumeFrom is not a string"
937 parseJSON _ = fail "VolumeFrom is not a string"
797instance ToJSON VolumeFrom where
939instance ToJSON VolumeFrom where
798 toJSON (VolumeFrom n p) = case p of
940 toJSON (VolumeFrom n p) = case p of
799− Nothing -> toJSON $ n <> ":" <> "rw"
941+ Nothing -> toJSON $ n <> ":" <> "rw"
800 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
942 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
802instance ToJSON Bind where
944instance ToJSON Bind where
@@ -808,63 +950,63 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
809instance FromJSON Link where
951instance FromJSON Link where
810 parseJSON (JSON.String t) = case T.split (== ':') t of
952 parseJSON (JSON.String t) = case T.split (== ':') t of
811− [f] -> return $ Link f Nothing
953+ [f] -> return $ Link f Nothing
812 [f,s] -> return $ Link f $ Just s
954 [f,s] -> return $ Link f $ Just s
813− _ -> fail "Could not parse Link"
955+ _ -> fail "Could not parse Link"
814 parseJSON _ = fail "Link is not a string"
956 parseJSON _ = fail "Link is not a string"
816instance ToJSON Link where
958instance ToJSON Link where
817 toJSON (Link n1 n2) = toJSON $ case n2 of
959 toJSON (Link n1 n2) = toJSON $ case n2 of
818 Nothing -> T.concat[n1, ":", n1] -- use same name in container
960 Nothing -> T.concat[n1, ":", n1] -- use same name in container
819− Just n -> T.concat[n1, ":", n] -- used specified name in container
961+ Just n -> T.concat[n1, ":", n] -- used specified name in container
821-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
963-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
822data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
964data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
824instance FromJSON LogDriverType where
966instance FromJSON LogDriverType where
825 parseJSON (JSON.String "json-file") = return JsonFile
967 parseJSON (JSON.String "json-file") = return JsonFile
826− parseJSON (JSON.String "syslog") = return Syslog
968+ parseJSON (JSON.String "syslog") = return Syslog
827− parseJSON (JSON.String "journald") = return Journald
969+ parseJSON (JSON.String "journald") = return Journald
828− parseJSON (JSON.String "gelf") = return Gelf
970+ parseJSON (JSON.String "gelf") = return Gelf
829− parseJSON (JSON.String "fluentd") = return Fluentd
971+ parseJSON (JSON.String "fluentd") = return Fluentd
830− parseJSON (JSON.String "awslogs") = return AwsLogs
972+ parseJSON (JSON.String "awslogs") = return AwsLogs
831− parseJSON (JSON.String "splunk") = return Splunk
973+ parseJSON (JSON.String "splunk") = return Splunk
832− parseJSON (JSON.String "etwlogs") = return Etwlogs
974+ parseJSON (JSON.String "etwlogs") = return Etwlogs
833− parseJSON (JSON.String "none") = return LoggingDisabled
975+ parseJSON (JSON.String "none") = return LoggingDisabled
834− parseJSON _ = fail "Unknown LogDriverType"
976+ parseJSON _ = fail "Unknown LogDriverType"
836instance ToJSON LogDriverType where
978instance ToJSON LogDriverType where
837− toJSON JsonFile = JSON.String "json-file"
979+ toJSON JsonFile = JSON.String "json-file"
838− toJSON Syslog = JSON.String "syslog"
980+ toJSON Syslog = JSON.String "syslog"
839− toJSON Journald = JSON.String "journald"
981+ toJSON Journald = JSON.String "journald"
840− toJSON Gelf = JSON.String "gelf"
982+ toJSON Gelf = JSON.String "gelf"
841− toJSON Fluentd = JSON.String "fluentd"
983+ toJSON Fluentd = JSON.String "fluentd"
842− toJSON AwsLogs = JSON.String "awslogs"
984+ toJSON AwsLogs = JSON.String "awslogs"
843− toJSON Splunk = JSON.String "splunk"
985+ toJSON Splunk = JSON.String "splunk"
844− toJSON Etwlogs = JSON.String "etwlogs"
986+ toJSON Etwlogs = JSON.String "etwlogs"
845 toJSON LoggingDisabled = JSON.String "none"
987 toJSON LoggingDisabled = JSON.String "none"
847−newtype LogDriverOptions = LogDriverOptions (M.Map Text Text) deriving (Eq, Show)
989+data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
849−instance FromJSON LogDriverOptions where
991+instance {-# OVERLAPPING #-} ToJSON [LogDriverOption] where
850− parseJSON (JSON.Object o) = do
992+ toJSON [] = emptyJsonObject
851− LogDriverOptions <$> HM.foldlWithKey' f (return M.empty) o
993+ toJSON (o:os) = toJsonKeyVal (o:os) key val
994+ where key (LogDriverOption n _) = T.unpack n
995+ val (LogDriverOption _ v) = v
853− where
997+instance {-# OVERLAPPING #-} FromJSON [LogDriverOption] where
998+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
854− f accM k (JSON.String v) = do
999+ where f accM k v = do
855 acc <- accM
1000 acc <- accM
1001+ value <- parseJSON v
856− return $ M.insert k v acc
1002+ return $ (LogDriverOption k value):acc
1003+ parseJSON JSON.Null = return []
857− f _ _ _ = fail "Value of LogDriverOptions is not a string"
1004+ parseJSON _ = fail "Failed to parse LogDriverOptions"
859− parseJSON JSON.Null = return $ LogDriverOptions M.empty
860− parseJSON _ = fail "LogDriverOptions is not an object"
862−instance ToJSON LogDriverOptions where
863− toJSON (LogDriverOptions mp) = toJSON mp
865−data LogDriverConfig = LogDriverConfig LogDriverType (Maybe LogDriverOptions) deriving (Eq, Show)
1006+data LogDriverConfig = LogDriverConfig LogDriverType [LogDriverOption] deriving (Eq, Show)
867instance ToJSON LogDriverConfig where
1008instance ToJSON LogDriverConfig where
1009+ toJSON (LogDriverConfig driverType []) = object ["Type" .= driverType]
868 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
1010 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
870instance FromJSON LogDriverConfig where
1012instance FromJSON LogDriverConfig where
@@ -875,19 +1017,41 @@ instance FromJSON LogDriverConfig where
875 parseJSON _ = fail "LogDriverConfig is not an object"
1017 parseJSON _ = fail "LogDriverConfig is not an object"
877-- TODO: Add container:<name|id> mode
1019-- TODO: Add container:<name|id> mode
878−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
879 deriving (Eq, Show, Ord)
1021 deriving (Eq, Show, Ord)
881instance FromJSON NetworkMode where
1023instance FromJSON NetworkMode where
882− parseJSON (JSON.String "bridge") = return Bridge
1024+ parseJSON (JSON.String "bridge") = return NetworkBridge
883− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
1025+ parseJSON (JSON.String "host") = return NetworkHost -- Note: Guessing on these.
884− parseJSON (JSON.String "none") = return NetworkDisabled
1026+ parseJSON (JSON.String "none") = return NetworkDisabled
1027+ parseJSON (JSON.String n) = return $ NetworkNamed n
885− parseJSON _ = fail "Unknown NetworkMode"
1028+ parseJSON _ = fail "Unknown NetworkMode"
887instance ToJSON NetworkMode where
1030instance ToJSON NetworkMode where
888− toJSON Bridge = JSON.String "bridge"
1031+ toJSON NetworkBridge = JSON.String "bridge"
889− toJSON Host = JSON.String "host"
1032+ toJSON NetworkHost = JSON.String "host"
890 toJSON NetworkDisabled = JSON.String "none"
1033 toJSON NetworkDisabled = JSON.String "none"
1034+ toJSON (NetworkNamed n) = JSON.String n
1036+newtype NetworkID = NetworkID Text
1037+ deriving (Eq, Show)
1039+-- | Used for extracting the id of the container from the newtype
1040+fromNetworkID :: NetworkID -> Text
1041+fromNetworkID (NetworkID t) = t
1043+-- | Used for parsing a Text value into a NetworkID.
1044+toNetworkID :: Text -> Maybe NetworkID
1045+toNetworkID t = Just $ NetworkID t
1047+instance FromJSON NetworkID where
1048+ parseJSON (JSON.Object o) = do
1050+ return $ NetworkID nid
1051+ parseJSON _ = fail "NetworkID is not an object."
1053+instance ToJSON NetworkID where
1054+ toJSON (NetworkID nid) = object ["Id" .= nid]
892data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
1056data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
@@ -903,7 +1067,7 @@ instance FromJSON PortType where
903 parseJSON val = case val of
1067 parseJSON val = case val of
904 "tcp" -> return TCP
1068 "tcp" -> return TCP
905 "udp" -> return UDP
1069 "udp" -> return UDP
906− _ -> fail "PortType: Invalid port type."
1070+ _ -> fail "PortType: Invalid port type."
908-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
1072-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
@@ -920,13 +1084,6 @@ instance FromJSON PortType where
920-- interface like `127.0.0.1`.
1084-- interface like `127.0.0.1`.
921-- __NOTE__: We should disallow duplicate port bindings as the ToJSON
1085-- __NOTE__: We should disallow duplicate port bindings as the ToJSON
922-- instance will only send the last one.
1086-- instance will only send the last one.
923−newtype PortBindings = PortBindings [PortBinding]
926−instance Monoid PortBindings where
927− mempty = PortBindings []
928− mappend (PortBindings p1) (PortBindings p2) = PortBindings (p1 ++ p2)
930-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
1087-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
931data PortBinding = PortBinding {
1088data PortBinding = PortBinding {
932 containerPort :: Port
1089 containerPort :: Port
@@ -977,19 +1134,22 @@ addVolumeFrom vf c = c{hostConfig=hc{volumesFrom=oldvfs <> [vf]}}
977-- Example:
1134-- Example:
979-- >>> let pb = PortBinding 80 TCP [HostPort "0.0.0.0" 8000]
1136-- >>> let pb = PortBinding 80 TCP [HostPort "0.0.0.0" 8000]
980−-- >>> addPortBinding (defaultCreateOpts "nginx:latest") pb
1137+-- >>> addPortBinding pb $ defaultCreateOpts "nginx:latest"
981addPortBinding :: PortBinding -> CreateOpts -> CreateOpts
1138addPortBinding :: PortBinding -> CreateOpts -> CreateOpts
982−addPortBinding pb c = c{hostConfig=hc{portBindings=pbs <> PortBindings [pb]}}
1139+addPortBinding pb c = c{hostConfig=hc{portBindings=pbs <> [pb]}}
983 where hc = hostConfig c
1140 where hc = hostConfig c
984 pbs = portBindings $ hostConfig c
1141 pbs = portBindings $ hostConfig c
986−instance ToJSON PortBinding where
1143+-- | Helper function for adding a "ExposedPort" to and existing
987− toJSON (PortBinding {..}) = object [portAndType2Text containerPort portType .= hostPorts]
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
989−instance FromJSON PortBindings where
990− parseJSON (JSON.Object o) = do
991− PortBindings <$> HM.foldlWithKey' f (return []) o
1151+instance {-# OVERLAPPING #-} FromJSON [PortBinding] where
1152+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
994 f accM k v = case T.split (== '/') k of
1154 f accM k v = case T.split (== '/') k of
995 [port', portType'] -> do
1155 [port', portType'] -> do
@@ -998,16 +1158,15 @@ instance FromJSON PortBindings where
998 acc <- accM
1158 acc <- accM
999 hps <- parseJSON v
1159 hps <- parseJSON v
1000 return $ (PortBinding port portType hps):acc
1160 return $ (PortBinding port portType hps):acc
1002− fail "Could not parse PortBindings"
1161+ _ -> fail "Could not parse PortBindings"
1162+ parseJSON (JSON.Null) = return []
1003 parseJSON _ = fail "PortBindings is not an object"
1163 parseJSON _ = fail "PortBindings is not an object"
1005−instance ToJSON PortBindings where
1165+instance {-# OVERLAPPING #-} ToJSON [PortBinding] where
1006− toJSON (PortBindings []) = JSON.Object HM.empty
1166+ toJSON [] = emptyJsonObject
1007− toJSON (PortBindings (p:ps)) = JSON.Object $ foldl f HM.empty (p:ps)
1167+ toJSON (p:ps) = toJsonKeyVal (p:ps) key val
1008− where mKey p = portAndType2Text (containerPort p) (portType p)
1168+ where key p = T.unpack $ portAndType2Text (containerPort p) (portType p)
1009− mVal p = toJSON $ hostPorts p
1169+ val p = hostPorts p
1010− f acc p = HM.insert (mKey p) (mVal p) acc
1012data HostPort = HostPort {
1171data HostPort = HostPort {
1013 hostIp :: Text
1172 hostIp :: Text
@@ -1038,7 +1197,7 @@ instance FromJSON RestartPolicy where
1038 "on-failure" -> do
1197 "on-failure" -> do
1039 retry <- o .: "MaximumRetryCount"
1198 retry <- o .: "MaximumRetryCount"
1040 return $ RestartOnFailure retry
1199 return $ RestartOnFailure retry
1041− "off" -> return RestartOff
1200+ "no" -> return RestartOff
1042 _ -> fail "Could not parse RestartPolicy"
1201 _ -> fail "Could not parse RestartPolicy"
1043 parseJSON _ = fail "RestartPolicy is not an object"
1202 parseJSON _ = fail "RestartPolicy is not an object"
@@ -1046,7 +1205,7 @@ instance ToJSON RestartPolicy where
1046 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
1205 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
1047 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
1206 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
1048 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1207 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1049− toJSON RestartOff = object ["Name" .= JSON.String "off"]
1208+ toJSON RestartOff = object ["Name" .= JSON.String "no"]
1051data Isolation = Default | Process | Hyperv deriving (Eq, Show)
1210data Isolation = Default | Process | Hyperv deriving (Eq, Show)
@@ -1060,7 +1219,7 @@ data HostConfig = HostConfig
1060 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
1219 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
1061 , logConfig :: LogDriverConfig
1220 , logConfig :: LogDriverConfig
1062 , networkMode :: NetworkMode
1221 , networkMode :: NetworkMode
1063− , portBindings :: PortBindings
1222+ , portBindings :: [PortBinding]
1064 , restartPolicy :: RestartPolicy
1223 , restartPolicy :: RestartPolicy
1065 , volumeDriver :: Maybe Text
1224 , volumeDriver :: Maybe Text
1066 , volumesFrom :: [VolumeFrom]
1225 , volumesFrom :: [VolumeFrom]
@@ -1219,6 +1378,22 @@ instance ToJSON DeviceRate where
1219 , "Rate" .= r
1378 , "Rate" .= r
1381+data MemoryConstraintSize = B | MB | GB deriving (Eq, Show)
1383+data MemoryConstraint = MemoryConstraint Integer MemoryConstraintSize deriving (Eq, Show)
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
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"
1222data ContainerResources = ContainerResources {
1397data ContainerResources = ContainerResources {
1223 cpuShares :: Maybe Integer
1398 cpuShares :: Maybe Integer
1224 -- , cgroupParent :: Text -- 1.24: Missing from inspecting container details... Going to omit for now.
1399 -- , cgroupParent :: Text -- 1.24: Missing from inspecting container details... Going to omit for now.
@@ -1234,12 +1409,12 @@ data ContainerResources = ContainerResources {
1234 , cpusetMems :: Maybe Text
1409 , cpusetMems :: Maybe Text
1235 , devices :: [Device]
1410 , devices :: [Device]
1236 -- , diskQuota :: Integer -- Don't see this ins 1.24.
1411 -- , diskQuota :: Integer -- Don't see this ins 1.24.
1237− , kernelMemory :: Maybe Integer
1412+ , kernelMemory :: Maybe MemoryConstraint
1238− , memory :: Maybe Integer
1413+ , memory :: Maybe MemoryConstraint
1239− , memoryReservation :: Maybe Integer
1414+ , memoryReservation :: Maybe MemoryConstraint
1240− , memorySwap :: Maybe Integer
1415+ , memorySwap :: Maybe MemoryConstraint
1241 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1416 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1242− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
1243 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1418 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1244 , ulimits :: [Ulimit]
1419 , ulimits :: [Ulimit]
1245 -- TODO: Missing from 1.24
1420 -- TODO: Missing from 1.24
@@ -1277,45 +1452,59 @@ instance FromJSON EnvVar where
1277 parseJSON _ = fail "EnvVar is not a string"
1452 parseJSON _ = fail "EnvVar is not a string"
1279instance ToJSON EnvVar where
1454instance ToJSON EnvVar where
1280− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
1282−-- | ExposedPorts represent a enumeraton of all the ports (and their type)
1457+-- | ExposedPort represents a port (and it's type)
1283-- that a container should expose to other containers or the host system.
1458-- that a container should expose to other containers or the host system.
1284−-- `NOTE`: This does not automatically expose the ports onto the host
1459+-- `NOTE`: This does not automatically expose the port onto the host
1285−-- system but rather it just tags them. It's best to be used with
1460+-- system but rather it just tags it. It's best to be used with
1286-- the PublishAllPorts flag. It is also useful for
1461-- the PublishAllPorts flag. It is also useful for
1287-- the daemon to know which Environment variables to
1462-- the daemon to know which Environment variables to
1288-- inject into a container linking to our container.
1463-- inject into a container linking to our container.
1289-- Example linking a Postgres container named db would inject the following
1464-- Example linking a Postgres container named db would inject the following
1290-- environment variables automatically if we set the corresponding
1465-- environment variables automatically if we set the corresponding
1292−-- ExposedPorts:
1467+-- ExposedPort:
1295-- DB_PORT_5432_TCP_PORT="5432"
1470-- DB_PORT_5432_TCP_PORT="5432"
1296-- DB_PORT_5432_TCP_PROTO="tcp"
1471-- DB_PORT_5432_TCP_PROTO="tcp"
1297-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
1472-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
1299−newtype ExposedPorts = ExposedPorts (M.Map Port PortType) deriving (Eq, Show)
1474+data ExposedPort = ExposedPort Port PortType deriving (Eq, Show)
1300−-- JP: Should this be ExposedPorts [(Port, PortType)]?
1302−instance FromJSON ExposedPorts where
1303− parseJSON (JSON.Object o) = do
1304− ExposedPorts <$> HM.foldlWithKey' f (return M.empty) o
1476+instance {-# OVERLAPPING #-} FromJSON [ExposedPort] where
1477+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
1307 f accM k _ = case T.split (== '/') k of
1479 f accM k _ = case T.split (== '/') k of
1308 [port', portType'] -> do
1480 [port', portType'] -> do
1309 port <- parseIntegerText port'
1481 port <- parseIntegerText port'
1310 portType <- parseJSON $ JSON.String portType'
1482 portType <- parseJSON $ JSON.String portType'
1311 acc <- accM
1483 acc <- accM
1312− return $ M.insert port portType acc
1484+ return $ (ExposedPort port portType):acc
1314− fail "Could not parse ExposedPorts"
1485+ _ -> fail "Could not parse ExposedPorts"
1486+ parseJSON (JSON.Null) = return []
1315− parseJSON _ = fail "ExposedPorts is not an object."
1487+ parseJSON _ = fail "ExposedPorts is not an object"
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 "/"
1495+data Entrypoint = Entrypoint [T.Text] deriving (Eq, Show, Generic)
1497+instance ToJSON Entrypoint where
1498+ toJSON (Entrypoint (e:es)) = toJSON (e:es)
1499+ toJSON (Entrypoint []) = JSON.Null
1317−instance ToJSON ExposedPorts where
1501+instance FromJSON Entrypoint where
1318− toJSON (ExposedPorts kvs) = object [((T.pack $ show p) <> "/" <> (T.pack $ show t)) .= JSON.Object HM.empty | (p,t) <- (M.toList kvs)]
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"
1321data ContainerConfig = ContainerConfig {
1510data ContainerConfig = ContainerConfig {
@@ -1325,7 +1514,7 @@ data ContainerConfig = ContainerConfig {
1325 , attachStdin :: Bool
1514 , attachStdin :: Bool
1326 , attachStdout :: Bool
1515 , attachStdout :: Bool
1327 , attachStderr :: Bool
1516 , attachStderr :: Bool
1328− , exposedPorts :: Maybe ExposedPorts -- Note: Should we expand the JSON instance and take away the Maybe?
1517+ , exposedPorts :: [ExposedPort]
1329 -- , publishService :: Text -- Don't see this in 1.24
1518 -- , publishService :: Text -- Don't see this in 1.24
1330 , tty :: Bool
1519 , tty :: Bool
1331 , openStdin :: Bool
1520 , openStdin :: Bool
@@ -1336,25 +1525,68 @@ data ContainerConfig = ContainerConfig {
1336 , image :: Text
1525 , image :: Text
1337 , volumes :: [Volume]
1526 , volumes :: [Volume]
1338 , workingDir :: Maybe FilePath
1527 , workingDir :: Maybe FilePath
1339− , entrypoint :: Maybe Text -- Can be null?
1528+ , entrypoint :: Entrypoint
1340 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
1529 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
1341 , macAddress :: Maybe Text
1530 , macAddress :: Maybe Text
1342 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
1531 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
1343− , labels :: Maybe Labels
1532+ , labels :: [Label]
1344 , stopSignal :: Signal
1533 , stopSignal :: Signal
1345 } deriving (Eq, Show, Generic)
1534 } deriving (Eq, Show, Generic)
1347instance ToJSON ContainerConfig where
1537instance ToJSON ContainerConfig where
1348 toJSON = genericToJSON defaultOptions {
1538 toJSON = genericToJSON defaultOptions {
1349 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
1539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
1351instance FromJSON ContainerConfig where
1541instance FromJSON ContainerConfig where
1352− parseJSON = genericParseJSON defaultOptions {
1542+ parseJSON (JSON.Object o) = do
1353− fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
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" .!= []
1551+ openStdin <- o .: "OpenStdin"
1552+ stdinOnce <- o .: "StdinOnce"
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."
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1355parseIntegerText :: (Monad m) => Text -> m Integer
1570parseIntegerText :: (Monad m) => Text -> m Integer
1356parseIntegerText t = case readMaybe $ T.unpack t of
1572parseIntegerText t = case readMaybe $ T.unpack t of
1357 Nothing ->
1573 Nothing ->
1358 fail "Could not parse Integer"
1574 fail "Could not parse Integer"
1359 Just i ->
1575 Just i ->
1360 return i
1576 return i
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
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
1590+-- | Helper function that return an empty dictionary "{}"
1591+emptyJsonObject :: JSON.Value
1592+emptyJsonObject = JSON.Object HM.empty