@@ -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,42 +26,48 @@ 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 , Volume(..)
55 , Volume(..)
45 , Device(..)
56 , Device(..)
46 , ContainerName
57 , ContainerName
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,10 +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
99+ , MemoryConstraint(..)
100+ , MemoryConstraintSize(..)
83import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
103import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
@@ -87,40 +107,57 @@ import qualified Data.Aeson as JSON
87import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
107import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
88import Data.Char (isAlphaNum, toUpper)
108import Data.Char (isAlphaNum, toUpper)
89import qualified Data.HashMap.Strict as HM
109import qualified Data.HashMap.Strict as HM
90−import qualified Data.Map as M
91import Data.Monoid ((<>))
110import Data.Monoid ((<>))
111+import Data.Scientific (floatingOrInteger)
92import Data.Text (Text)
112import Data.Text (Text)
93import qualified Data.Text as T
113import qualified Data.Text as T
94import Data.Time.Clock (UTCTime)
114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
95import GHC.Generics (Generic)
116import GHC.Generics (Generic)
96import Prelude hiding (all, tail)
117import Prelude hiding (all, tail)
97import Text.Read (readMaybe)
118import Text.Read (readMaybe)
120+-- | List of Docker Engine API endpoints
99data Endpoint =
121data Endpoint =
100 VersionEndpoint
122 VersionEndpoint
101 | ListContainersEndpoint ListOpts
123 | ListContainersEndpoint ListOpts
102 | ListImagesEndpoint ListOpts
124 | ListImagesEndpoint ListOpts
103− | CreateContainerEndpoint CreateOpts
125+ | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
104 | StartContainerEndpoint StartOpts ContainerID
126 | StartContainerEndpoint StartOpts ContainerID
105 | StopContainerEndpoint Timeout ContainerID
127 | StopContainerEndpoint Timeout ContainerID
128+ | WaitContainerEndpoint ContainerID
106 | KillContainerEndpoint Signal ContainerID
129 | KillContainerEndpoint Signal ContainerID
107 | RestartContainerEndpoint Timeout ContainerID
130 | RestartContainerEndpoint Timeout ContainerID
108 | PauseContainerEndpoint ContainerID
131 | PauseContainerEndpoint ContainerID
109 | UnpauseContainerEndpoint ContainerID
132 | UnpauseContainerEndpoint ContainerID
110 | 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.
111 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
112− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
113 | 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
114 deriving (Eq, Show)
142 deriving (Eq, Show)
144+-- | We should newtype this
116type URL = Text
145type URL = Text
147+-- | We should newtype this
117type ApiVersion = Text
148type ApiVersion = Text
151+-- | ID of a contianer
118newtype ContainerID = ContainerID Text
152newtype ContainerID = ContainerID Text
119 deriving (Eq, Show)
153 deriving (Eq, Show)
155+-- | Used for extracting the id of the container from the newtype
121fromContainerID :: ContainerID -> Text
156fromContainerID :: ContainerID -> Text
122fromContainerID (ContainerID t) = t
157fromContainerID (ContainerID t) = t
159+-- | Used for parsing a Text value into a ContainerID. We apply some basic
124toContainerID :: Text -> Maybe ContainerID
161toContainerID :: Text -> Maybe ContainerID
125toContainerID t =
162toContainerID t =
126 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
163 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
@@ -128,12 +165,16 @@ toContainerID t =
131newtype ImageID = ImageID Text
169newtype ImageID = ImageID Text
132 deriving (Eq, Show)
170 deriving (Eq, Show)
172+-- | Used for extracting the id of the image from the newtype.
134fromImageID :: ImageID -> Text
173fromImageID :: ImageID -> Text
135fromImageID (ImageID t) = t
174fromImageID (ImageID t) = t
176+-- | Helper function used for parsing a Text value into an ImageID. For now
177+-- just basic validation is used.
137toImageID :: Text -> Maybe ImageID
178toImageID :: Text -> Maybe ImageID
138toImageID t =
179toImageID t =
139 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
180 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
@@ -141,9 +182,26 @@ toImageID t =
185+-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
144data 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"
146-- TODO: Add more Signals or use an existing lib
202-- TODO: Add more Signals or use an existing lib
203+-- | Signal used for sending to the process running in the container.
204+-- The default signal is SIGTERM.
147data Signal = SIGHUP
205data Signal = SIGHUP
149 | SIGQUIT
207 | SIGQUIT
@@ -155,16 +213,16 @@ data Signal = SIGHUP
156instance FromJSON Signal where
214instance FromJSON Signal where
157 parseJSON (JSON.String "SIGTERM") = return SIGTERM
215 parseJSON (JSON.String "SIGTERM") = return SIGTERM
158− 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.
159− parseJSON (JSON.String "SIGINT") = return SIGINT
217+ parseJSON (JSON.String "SIGINT") = return SIGINT
160 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
218 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
161 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
219 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
162 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
220 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
163− parseJSON _ = fail "Unknown Signal"
221+ parseJSON _ = fail "Unknown Signal"
165instance ToJSON Signal where
223instance ToJSON Signal where
166− toJSON SIGHUP = "SIGHUP"
224+ toJSON SIGHUP = "SIGHUP"
167− toJSON SIGINT = "SIGINT"
225+ toJSON SIGINT = "SIGINT"
168 toJSON SIGQUIT = "SIGQUIT"
226 toJSON SIGQUIT = "SIGQUIT"
169 toJSON SIGSTOP = "SIGSTOP"
227 toJSON SIGSTOP = "SIGSTOP"
170 toJSON SIGTERM = "SIGTERM"
228 toJSON SIGTERM = "SIGTERM"
@@ -192,17 +250,19 @@ data ContainerDetails = ContainerDetails {
192 , processLabel :: Text
250 , processLabel :: Text
193 , resolveConfPath :: FilePath
251 , resolveConfPath :: FilePath
194 , restartCount :: Int
252 , restartCount :: Int
195− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
196 , mounts :: [Mount]
254 , mounts :: [Mount]
198 deriving (Eq, Show, Generic)
256 deriving (Eq, Show, Generic)
258+-- | Data type used for parsing the mount information from a container
200data Mount = Mount {
260data Mount = Mount {
201− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
202 , mountSource :: FilePath
262 , mountSource :: FilePath
203 , mountDestination :: FilePath
263 , mountDestination :: FilePath
204− , mountDriver :: Text
264+ , mountDriver :: Maybe Text
205− , mountMode :: Maybe VolumePermission -- apparently this can be null
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
206 , mountRW :: Bool
266 , mountRW :: Bool
207 , mountPropogation :: Text
267 , mountPropogation :: Text
@@ -210,16 +270,18 @@ data Mount = Mount {
211instance FromJSON Mount where
271instance FromJSON Mount where
212 parseJSON (JSON.Object o) = do
272 parseJSON (JSON.Object o) = do
213− name <- o .: "Name"
273+ name <- o .:? "Name"
214 src <- o .: "Source"
274 src <- o .: "Source"
215 dest <- o .: "Destination"
275 dest <- o .: "Destination"
216− driver <- o .: "Driver"
276+ driver <- o .:? "Driver"
217− mode <- o .: "Mode"
277+ -- mode <- o .: "Mode"
218 rw <- o .: "RW"
278 rw <- o .: "RW"
219 prop <- o .: "Propagation"
279 prop <- o .: "Propagation"
220− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
221 parseJSON _ = fail "Mount is not an object"
281 parseJSON _ = fail "Mount is not an object"
283+-- | Data type used for parsing the container state from a list of
223data ContainerState = ContainerState {
285data ContainerState = ContainerState {
224 containerError :: Text
286 containerError :: Text
225 , exitCode :: Int
287 , exitCode :: Int
@@ -231,7 +293,7 @@ data ContainerState = ContainerState {
231 , restarting :: Bool
293 , restarting :: Bool
232 , running :: Bool
294 , running :: Bool
233 , startedAt :: UTCTime
295 , startedAt :: UTCTime
234− , status :: Status
296+ , state :: State
236 deriving (Eq, Show, Generic)
298 deriving (Eq, Show, Generic)
@@ -251,23 +313,30 @@ instance FromJSON ContainerState where
251 return $ ContainerState err exit finished oomKilled dead paused pid restarting running started st
313 return $ ContainerState err exit finished oomKilled dead paused pid restarting running started st
252 parseJSON _ = fail "ContainerState is not an object"
314 parseJSON _ = fail "ContainerState is not an object"
317+-- | Client options used to configure the remote engine we're talking to
254data DockerClientOpts = DockerClientOpts {
318data DockerClientOpts = DockerClientOpts {
255 apiVer :: ApiVersion
319 apiVer :: ApiVersion
256 , baseUrl :: URL
320 , baseUrl :: URL
258 deriving (Eq, Show)
322 deriving (Eq, Show)
324+-- | Default "DockerClientOpts" used for talking to the docker engine.
260defaultClientOpts :: DockerClientOpts
325defaultClientOpts :: DockerClientOpts
261defaultClientOpts = DockerClientOpts {
326defaultClientOpts = DockerClientOpts {
262 apiVer = "v1.24"
327 apiVer = "v1.24"
263 , baseUrl = "http://127.0.0.1:2375"
328 , baseUrl = "http://127.0.0.1:2375"
331+-- | List options used for filtering the list of container or images.
266data ListOpts = ListOpts { all :: Bool } deriving (Eq, Show)
332data ListOpts = ListOpts { all :: Bool } deriving (Eq, Show)
334+-- | Default "ListOpts". Doesn't list stopped containers.
268defaultListOpts :: ListOpts
335defaultListOpts :: ListOpts
269defaultListOpts = ListOpts { all=False }
336defaultListOpts = ListOpts { all=False }
338+-- | Data type used for represneting the version of the docker engine
271data DockerVersion = DockerVersion {
340data DockerVersion = DockerVersion {
272 version :: Text
341 version :: Text
273 , apiVersion :: ApiVersion
342 , apiVersion :: ApiVersion
@@ -337,6 +406,8 @@ instance FromJSON ImageID where
337 return iid
406 return iid
338 parseJSON _ = fail "ImageID is not an object."
407 parseJSON _ = fail "ImageID is not an object."
409+-- | Data type used for representing the information of various ports that
410+-- a contianer may expose.
340data ContainerPortInfo = ContainerPortInfo {
411data ContainerPortInfo = ContainerPortInfo {
341 ipAddressInfo :: Maybe Text
412 ipAddressInfo :: Maybe Text
342 , privatePortInfo :: Port
413 , privatePortInfo :: Port
@@ -353,6 +424,8 @@ instance FromJSON ContainerPortInfo where
353 parseJSON _ = fail "ContainerPortInfo: Not a JSON object."
424 parseJSON _ = fail "ContainerPortInfo: Not a JSON object."
355-- For inspecting container details.
426-- For inspecting container details.
427+-- | Data type used for parsing the network information of each container
428+-- when listing them.
356data NetworkOptions = NetworkOptions {
429data NetworkOptions = NetworkOptions {
357-- ipamConfig :: Maybe Text -- Don't see in 1.24
430-- ipamConfig :: Maybe Text -- Don't see in 1.24
358-- , links :: Maybe Text -- Don't see in 1.24
431-- , links :: Maybe Text -- Don't see in 1.24
@@ -382,29 +455,28 @@ instance FromJSON NetworkOptions where
382 return $ NetworkOptions networkId endpointId gateway ip ipLen ip6Gateway globalIP6 globalIP6Len mac
455 return $ NetworkOptions networkId endpointId gateway ip ipLen ip6Gateway globalIP6 globalIP6Len mac
383 parseJSON _ = fail "NetworkOptions is not an object"
456 parseJSON _ = fail "NetworkOptions is not an object"
385−newtype Networks = Networks (M.Map NetworkMode NetworkOptions) -- Note: Is it ever possible that there will be duplicates of network modes?
458+-- TODO: Not sure what this is used for anymore.
459+data Network = Network NetworkMode NetworkOptions
386 deriving (Eq, Show)
460 deriving (Eq, Show)
388−instance FromJSON Networks where
462+instance {-# OVERLAPPING #-} FromJSON [Network] where
389− parseJSON (JSON.Object o) = do
463+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
390− Networks <$> HM.foldlWithKey' f (return M.empty) o
393 f accM k' v' = do
465 f accM k' v' = do
394 acc <- accM
466 acc <- accM
395 k <- parseJSON $ JSON.String k'
467 k <- parseJSON $ JSON.String k'
396 v <- parseJSON v'
468 v <- parseJSON v'
397− return $ M.insert k v acc
469+ return $ (Network k v):acc
399 parseJSON _ = fail "Networks is not an object"
470 parseJSON _ = fail "Networks is not an object"
472+-- | Data type reprsenting the various network settings a container can have.
401data NetworkSettings = NetworkSettings {
473data NetworkSettings = NetworkSettings {
402 networkSettingsBridge :: Text
474 networkSettingsBridge :: Text
403 , networkSettingsSandboxId :: Text
475 , networkSettingsSandboxId :: Text
404 , networkSettingsHairpinMode :: Bool
476 , networkSettingsHairpinMode :: Bool
405 , networkSettingsLinkLocalIPv6Address :: Text
477 , networkSettingsLinkLocalIPv6Address :: Text
406 , networkSettingsLinkLocalIPv6PrefixLen :: Int
478 , networkSettingsLinkLocalIPv6PrefixLen :: Int
407− , networkSettingsPorts :: PortBindings
479+ , networkSettingsPorts :: [PortBinding]
408 , networkSettingsSandboxKey :: Text
480 , networkSettingsSandboxKey :: Text
409 , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
481 , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
410 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
482 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
@@ -416,7 +488,7 @@ data NetworkSettings = NetworkSettings {
416 , networkSettingsIpPrefixLen :: Int
488 , networkSettingsIpPrefixLen :: Int
417 , networkSettingsIpv6Gateway :: Text
489 , networkSettingsIpv6Gateway :: Text
418 , networkSettingsMacAddress :: Text
490 , networkSettingsMacAddress :: Text
419− , networkSettingsNetworks :: Networks
491+ , networkSettingsNetworks :: [Network]
421 deriving (Eq, Show)
493 deriving (Eq, Show)
@@ -443,6 +515,7 @@ instance FromJSON NetworkSettings where
443 return $ NetworkSettings bridge sandbox hairpin localIP6 localIP6Len ports sandboxKey secondaryIP secondayIP6 endpointID gateway globalIP6 globalIP6Len ip ipLen ip6Gateway mac networks
515 return $ NetworkSettings bridge sandbox hairpin localIP6 localIP6Len ports sandboxKey secondaryIP secondayIP6 endpointID gateway globalIP6 globalIP6Len ip ipLen ip6Gateway mac networks
444 parseJSON _ = fail "NetworkSettings is not an object."
516 parseJSON _ = fail "NetworkSettings is not an object."
518+-- | Data type used for parsing a list of containers.
446data Container = Container
519data Container = Container
447 { containerId :: ContainerID
520 { containerId :: ContainerID
448 , containerNames :: [Text]
521 , containerNames :: [Text]
@@ -450,21 +523,23 @@ data Container = Container
450 , containerImageId :: ImageID
523 , containerImageId :: ImageID
451 , containerCommand :: Text
524 , containerCommand :: Text
452 , containerCreatedAt :: Int
525 , containerCreatedAt :: Int
526+ , containerState :: State
453− , containerStatus :: Status
527+ , containerStatus :: Maybe Text
454 , containerPorts :: [ContainerPortInfo]
528 , containerPorts :: [ContainerPortInfo]
455− , containerLabels :: Labels
529+ , containerLabels :: [Label]
456− , containerNetworks :: Networks
530+ , containerNetworks :: [Network]
457 , containerMounts :: [Mount]
531 , containerMounts :: [Mount]
458 } deriving (Show, Eq)
532 } deriving (Show, Eq)
460instance FromJSON Container where
534instance FromJSON Container where
461− parseJSON (JSON.Object v) =
535+ parseJSON o@(JSON.Object v) =
462− Container <$> (v .: "Id")
536+ Container <$> parseJSON o
463 <*> (v .: "Names")
537 <*> (v .: "Names")
464 <*> (v .: "Image")
538 <*> (v .: "Image")
465− <*> (v .: "ImageID")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
466− <*> (v .: "Command")
540+ <*> (v .: "Command") -- Doesn't exist anymore
467 <*> (v .: "Created")
541 <*> (v .: "Created")
468 <*> (v .: "Status")
543 <*> (v .: "Status")
469 <*> (v .: "Ports")
544 <*> (v .: "Ports")
470 <*> (v .: "Labels")
545 <*> (v .: "Labels")
@@ -474,65 +549,124 @@ instance FromJSON Container where
474 parseNetworks (JSON.Object v) =
549 parseNetworks (JSON.Object v) =
475 (v .: "Networks") >>= parseJSON
550 (v .: "Networks") >>= parseJSON
476 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
478 parseJSON _ = fail "Container: Not a JSON object."
552 parseJSON _ = fail "Container: Not a JSON object."
554+-- | Represents the state of the container life cycle.
480−data Status = Created | Restarting | Running | Paused | Exited | Dead
555+data State = Created | Restarting | Running | Paused | Exited | Dead
481 deriving (Eq, Show, Generic)
556 deriving (Eq, Show, Generic)
483−instance FromJSON Status where
558+instance FromJSON State where
484− parseJSON (JSON.String "running") = return Running
559+ parseJSON (JSON.String "running") = return Running
485− 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.
486 parseJSON (JSON.String "restarting") = return Restarting
561 parseJSON (JSON.String "restarting") = return Restarting
487− parseJSON (JSON.String "paused") = return Paused
562+ parseJSON (JSON.String "paused") = return Paused
488− parseJSON (JSON.String "exited") = return Exited
563+ parseJSON (JSON.String "exited") = return Exited
489− parseJSON (JSON.String "dead") = return Dead
564+ parseJSON (JSON.String "dead") = return Dead
490− parseJSON _ = fail "Unknown Status"
565+ parseJSON s = fail $ "Unknown Status: " ++ show s
567+-- | Alias for representing a RepoDigest. We could newtype this and add
492type Digest = Text
569type Digest = Text
571+-- | Container and Image Labels.
494−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.
496−instance FromJSON Labels where
577+instance {-# OVERLAPPING #-} ToJSON [Label] where
497− 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
499−instance ToJSON Labels where
583+instance {-# OVERLAPPING #-} FromJSON [Label] where
500− 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."
502type Tag = Text
593type Tag = Text
595+-- | Data type used for parsing information from a list of images.
504data Image = DockerImage {
596data Image = DockerImage {
505 imageId :: ImageID
597 imageId :: ImageID
506 , imageCreated :: Integer
598 , imageCreated :: Integer
507 , imageParentId :: Maybe ImageID
599 , imageParentId :: Maybe ImageID
508 , imageRepoTags :: [Tag]
600 , imageRepoTags :: [Tag]
509− , imageRepoDigests :: Maybe [Digest]
601+ , imageRepoDigests :: [Digest]
510 , imageSize :: Integer
602 , imageSize :: Integer
511 , imageVirtualSize :: Integer
603 , imageVirtualSize :: Integer
512− , imageLabels :: Maybe Labels
604+ , imageLabels :: [Label]
513 } deriving (Show, Eq, Generic)
605 } deriving (Show, Eq, Generic)
607+-- | Helper function used for dropping the "image" prefix when serializing
608+-- the Image data type to and from json.
515dropImagePrefix :: [a] -> [a]
609dropImagePrefix :: [a] -> [a]
516dropImagePrefix = drop 5
610dropImagePrefix = drop 5
518−instance FromJSON Image where
519− parseJSON = genericParseJSON defaultOptions {
520− fieldLabelModifier = dropImagePrefix}
613+instance FromJSON Image where
614+ parseJSON (JSON.Object o) = do
615+ imageId <- o .: "Id"
616+ imageCreated <- o .: "Created"
617+ imageParentId <- o .:? "ParentId"
618+ imageRepoTags <- o .:? "RepoTags" .!= []
619+ imageRepoDigests <- o .:? "RepoDigests" .!= []
620+ imageSize <- o .: "Size"
621+ imageVirtualSize <- o .: "VirtualSize"
622+ imageLabels <- o .:? "Labels" .!= []
623+ return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
624+ parseJSON _ = fail "Failed to parse DockerImage."
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
650+-- | Options used for creating a Container.
522data CreateOpts = CreateOpts {
651data CreateOpts = CreateOpts {
523− containerConfig :: ContainerConfig
652+ containerConfig :: ContainerConfig
524− , hostConfig :: HostConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
525 } deriving (Eq, Show)
655 } deriving (Eq, Show)
527instance ToJSON CreateOpts where
657instance ToJSON CreateOpts where
528− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
529 let ccJSON = toJSON cc
659 let ccJSON = toJSON cc
530 let hcJSON = toJSON hc
660 let hcJSON = toJSON hc
531 case ccJSON of
661 case ccJSON of
532 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
533− JSON.Object $ HM.insert "HostConfig" hcJSON o
663+ let o1 = HM.insert "HostConfig" hcJSON o
664+ let o2 = HM.insert "NetworkingConfig" (toJSON nc) o1
534 _ -> error "ContainerConfig is not an object." -- This should never happen.
666 _ -> error "ContainerConfig is not an object." -- This should never happen.
668+-- | Container configuration used for creating a container with sensible
536defaultContainerConfig :: Text -> ContainerConfig
670defaultContainerConfig :: Text -> ContainerConfig
537defaultContainerConfig imageName = ContainerConfig {
671defaultContainerConfig imageName = ContainerConfig {
538 hostname=Nothing
672 hostname=Nothing
@@ -542,28 +676,29 @@ defaultContainerConfig imageName = ContainerConfig {
542 , attachStdout=False
676 , attachStdout=False
543 , image=imageName
677 , image=imageName
544 , attachStderr=False
678 , attachStderr=False
545− , exposedPorts=Nothing -- ExposedPorts M.empty
679+ , exposedPorts=[]
546 , tty=False
680 , tty=False
547 , openStdin=False
681 , openStdin=False
548 , stdinOnce=False
682 , stdinOnce=False
551− , volumes=Nothing
685+ , volumes=[]
552 , workingDir=Nothing
686 , workingDir=Nothing
553− , entrypoint=Nothing
687+ , entrypoint=Entrypoint []
554 , networkDisabled=Nothing
688 , networkDisabled=Nothing
555 , macAddress=Nothing
689 , macAddress=Nothing
556− , labels=Nothing
690+ , labels=[]
557 , stopSignal=SIGTERM
691 , stopSignal=SIGTERM
694+-- | Default host confiratuon used for creating a container.
560defaultHostConfig :: HostConfig
695defaultHostConfig :: HostConfig
561defaultHostConfig = HostConfig {
696defaultHostConfig = HostConfig {
563 , containerIDFile=Nothing
698 , containerIDFile=Nothing
564− , logConfig=LogDriverConfig JsonFile Nothing
699+ , logConfig=LogDriverConfig JsonFile []
565− , networkMode=Bridge
700+ , networkMode=NetworkBridge
566− , portBindings=PortBindings []
701+ , portBindings=[]
567 , restartPolicy=RestartOff
702 , restartPolicy=RestartOff
568 , volumeDriver=Nothing
703 , volumeDriver=Nothing
569 , volumesFrom=[]
704 , volumesFrom=[]
@@ -584,6 +719,7 @@ defaultHostConfig = HostConfig {
584 , resources=defaultContainerResources
719 , resources=defaultContainerResources
722+-- Default container resource contstraints (None).
587defaultContainerResources :: ContainerResources
723defaultContainerResources :: ContainerResources
588defaultContainerResources = ContainerResources {
724defaultContainerResources = ContainerResources {
589 cpuShares=Nothing
725 cpuShares=Nothing
@@ -601,34 +737,80 @@ defaultContainerResources = ContainerResources {
601 , memory=Nothing
737 , memory=Nothing
602 , memoryReservation=Nothing
738 , memoryReservation=Nothing
603 , memorySwap=Nothing
739 , memorySwap=Nothing
604− , oomKillDisable=False
740+ , oomKillDisable=Just False
605 , ulimits=[]
741 , ulimits=[]
608−
744+-- | Default create options when creating a container. You only need to
745+-- specify an image name and the rest is all sensible defaults.
609defaultCreateOpts :: T.Text -> CreateOpts
746defaultCreateOpts :: T.Text -> CreateOpts
747+defaultCreateOpts imageName = CreateOpts
610−defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
748+ { containerConfig = defaultContainerConfig imageName
749+ , hostConfig = defaultHostConfig
750+ , networkingConfig = NetworkingConfig HM.empty
612−-- detachKeys – Override the key sequence for detaching a container.
753+-- | Override the key sequence for detaching a container.
613-- 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 _.
614data DetachKeys = WithCtrl Char | WithoutCtrl Char | DefaultDetachKey deriving (Eq, Show)
755data DetachKeys = WithCtrl Char | WithoutCtrl Char | DefaultDetachKey deriving (Eq, Show)
757+-- | Options for starting a container.
616data StartOpts = StartOpts { detachKeys :: DetachKeys } deriving (Eq, Show)
758data StartOpts = StartOpts { detachKeys :: DetachKeys } deriving (Eq, Show)
760+-- | Default options for staring a container.
618defaultStartOpts :: StartOpts
761defaultStartOpts :: StartOpts
619defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
621−data DeleteOpts = DeleteOpts {
764+-- | Options for deleting a container.
765+data ContainerDeleteOpts = ContainerDeleteOpts {
622 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
623 , force :: Bool -- ^ If the container is still running force deletion anyway.
767 , force :: Bool -- ^ If the container is still running force deletion anyway.
624 } deriving (Eq, Show)
768 } deriving (Eq, Show)
626−defaultDeleteOpts :: DeleteOpts
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
792+-- | Default options for deleting a container. Most of the time we DON'T
793+-- want to delete the container's volumes or force delete it if it's
795+defaultContainerDeleteOpts :: ContainerDeleteOpts
627−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
805+-- | Timestamp alias.
629type Timestamp = Integer
806type Timestamp = Integer
808+-- | Used for requesting N number of lines when tailing a containers log
630data TailLogOpt = Tail Integer | All deriving (Eq, Show)
810data TailLogOpt = Tail Integer | All deriving (Eq, Show)
813+-- | Log options used when requesting the log output from a container.
632data LogOpts = LogOpts {
814data LogOpts = LogOpts {
633 stdout :: Bool
815 stdout :: Bool
634 , stderr :: Bool
816 , stderr :: Bool
@@ -637,6 +819,7 @@ data LogOpts = LogOpts {
637 , tail :: TailLogOpt
819 , tail :: TailLogOpt
638 } deriving (Eq, Show)
820 } deriving (Eq, Show)
822+-- | Sensible default for log options.
640defaultLogOpts :: LogOpts
823defaultLogOpts :: LogOpts
641defaultLogOpts = LogOpts { stdout = True
824defaultLogOpts = LogOpts { stdout = True
642 , stderr = True
825 , stderr = True
@@ -645,18 +828,50 @@ defaultLogOpts = LogOpts { stdout = True
645 , 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
648-- 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")
649-- | Set permissions on volumes that you mount in the container.
862-- | Set permissions on volumes that you mount in the container.
650data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
863data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
652instance ToJSON VolumePermission where
865instance ToJSON VolumePermission where
653 toJSON ReadWrite = "rw"
866 toJSON ReadWrite = "rw"
654− toJSON ReadOnly = "ro"
867+ toJSON ReadOnly = "ro"
656instance FromJSON VolumePermission where
869instance FromJSON VolumePermission where
657 parseJSON "rw" = return ReadWrite
870 parseJSON "rw" = return ReadWrite
658 parseJSON "ro" = return ReadOnly
871 parseJSON "ro" = return ReadOnly
872+ parseJSON "RW" = return ReadWrite
873+ parseJSON "RO" = return ReadOnly
659− parseJSON _ = fail "Failed to parse VolumePermission"
874+ parseJSON _ = fail "Failed to parse VolumePermission"
661-- | Used for marking a directory in the container as "exposed" hence
876-- | Used for marking a directory in the container as "exposed" hence
662-- taking it outside of the COW filesystem and making it mountable
877-- taking it outside of the COW filesystem and making it mountable
@@ -669,29 +884,31 @@ instance FromJSON VolumePermission where
669-- docker run --name app -v \/opt\/data -it myapp:latest
884-- docker run --name app -v \/opt\/data -it myapp:latest
670-- docker run --name app2 --volumes-from app \/bin\/bash -c "ls -l \/opt\/data"
885-- docker run --name app2 --volumes-from app \/bin\/bash -c "ls -l \/opt\/data"
672−newtype Volumes = Volumes [FilePath] deriving (Eq, Show)
887+newtype Volume = Volume FilePath deriving (Eq, Show)
674−instance FromJSON Volumes where
889+instance {-# OVERLAPPING #-} ToJSON [Volume] where
675− parseJSON (JSON.Object o) = return $ Volumes $ map T.unpack $ HM.keys o
890+ toJSON [] = emptyJsonObject
676− parseJSON _ = fail "Volumes is not an object"
891+ toJSON (v:vs) = toJsonKey (v:vs) getKey
892+ where getKey (Volume v) = v
678−instance ToJSON Volumes where
894+instance {-# OVERLAPPING #-} FromJSON [Volume] where
679− toJSON (Volumes []) = JSON.Object HM.empty
895+ parseJSON (JSON.Object o) = return $ map (Volume . T.unpack) $ HM.keys o
680− toJSON (Volumes (v:vs)) = JSON.Object $ foldl f HM.empty (v:vs)
896+ parseJSON (JSON.Null) = return []
681− where f acc k = HM.insert (T.pack k) (JSON.Object HM.empty) acc
897+ parseJSON _ = fail "Volume is not an object"
683−data Volume = Volume { hostSrc :: Text
684− , containerDest :: Text
685− , volumePermission :: Maybe VolumePermission
686− } deriving (Eq, Show)
900+data Bind = Bind { hostSrc :: Text
901+ , containerDest :: Text
902+ , volumePermission :: Maybe VolumePermission
903+ } deriving (Eq, Show)
688−instance FromJSON Volume where
905+instance FromJSON Bind where
689 parseJSON (JSON.String t) = case T.split (== ':') t of
906 parseJSON (JSON.String t) = case T.split (== ':') t of
690− [src, dest] -> return $ Volume src dest Nothing
907+ [src, dest] -> return $ Bind src dest Nothing
691− [src, dest, "rw"] -> return $ Volume src dest $ Just ReadWrite
908+ [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
692− [src, dest, "ro"] -> return $ Volume src dest $ Just ReadOnly
909+ [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
693− _ -> fail "Could not parse Volume"
910+ _ -> fail "Could not parse Bind"
694− parseJSON _ = fail "Volume is not a string"
911+ parseJSON _ = fail "Bind is not a string"
696data Device = Device {
913data Device = Device {
697 pathOnHost :: FilePath
914 pathOnHost :: FilePath
@@ -713,19 +930,19 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
714instance FromJSON VolumeFrom where
931instance FromJSON VolumeFrom where
715 parseJSON (JSON.String t) = case T.split (== ':') t of
932 parseJSON (JSON.String t) = case T.split (== ':') t of
716− [vol] -> return $ VolumeFrom vol Nothing
933+ [vol] -> return $ VolumeFrom vol Nothing
717 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
934 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
718 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
935 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
719− _ -> fail "Could not parse VolumeFrom"
936+ _ -> fail "Could not parse VolumeFrom"
720 parseJSON _ = fail "VolumeFrom is not a string"
937 parseJSON _ = fail "VolumeFrom is not a string"
722instance ToJSON VolumeFrom where
939instance ToJSON VolumeFrom where
723 toJSON (VolumeFrom n p) = case p of
940 toJSON (VolumeFrom n p) = case p of
724− Nothing -> toJSON $ n <> ":" <> "rw"
941+ Nothing -> toJSON $ n <> ":" <> "rw"
725 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
942 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
727−instance ToJSON Volume where
944+instance ToJSON Bind where
728− toJSON (Volume src dest mode) = toJSON $ case mode of
945+ toJSON (Bind src dest mode) = toJSON $ case mode of
729 Nothing -> T.concat[src, ":", dest]
946 Nothing -> T.concat[src, ":", dest]
730 Just m -> T.concat[src, ":", dest, ":", (T.pack $ show m)]
947 Just m -> T.concat[src, ":", dest, ":", (T.pack $ show m)]
@@ -733,63 +950,63 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
734instance FromJSON Link where
951instance FromJSON Link where
735 parseJSON (JSON.String t) = case T.split (== ':') t of
952 parseJSON (JSON.String t) = case T.split (== ':') t of
736− [f] -> return $ Link f Nothing
953+ [f] -> return $ Link f Nothing
737 [f,s] -> return $ Link f $ Just s
954 [f,s] -> return $ Link f $ Just s
738− _ -> fail "Could not parse Link"
955+ _ -> fail "Could not parse Link"
739 parseJSON _ = fail "Link is not a string"
956 parseJSON _ = fail "Link is not a string"
741instance ToJSON Link where
958instance ToJSON Link where
742 toJSON (Link n1 n2) = toJSON $ case n2 of
959 toJSON (Link n1 n2) = toJSON $ case n2 of
743 Nothing -> T.concat[n1, ":", n1] -- use same name in container
960 Nothing -> T.concat[n1, ":", n1] -- use same name in container
744− Just n -> T.concat[n1, ":", n] -- used specified name in container
961+ Just n -> T.concat[n1, ":", n] -- used specified name in container
746-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
963-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
747data 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)
749instance FromJSON LogDriverType where
966instance FromJSON LogDriverType where
750 parseJSON (JSON.String "json-file") = return JsonFile
967 parseJSON (JSON.String "json-file") = return JsonFile
751− parseJSON (JSON.String "syslog") = return Syslog
968+ parseJSON (JSON.String "syslog") = return Syslog
752− parseJSON (JSON.String "journald") = return Journald
969+ parseJSON (JSON.String "journald") = return Journald
753− parseJSON (JSON.String "gelf") = return Gelf
970+ parseJSON (JSON.String "gelf") = return Gelf
754− parseJSON (JSON.String "fluentd") = return Fluentd
971+ parseJSON (JSON.String "fluentd") = return Fluentd
755− parseJSON (JSON.String "awslogs") = return AwsLogs
972+ parseJSON (JSON.String "awslogs") = return AwsLogs
756− parseJSON (JSON.String "splunk") = return Splunk
973+ parseJSON (JSON.String "splunk") = return Splunk
757− parseJSON (JSON.String "etwlogs") = return Etwlogs
974+ parseJSON (JSON.String "etwlogs") = return Etwlogs
758− parseJSON (JSON.String "none") = return LoggingDisabled
975+ parseJSON (JSON.String "none") = return LoggingDisabled
759− parseJSON _ = fail "Unknown LogDriverType"
976+ parseJSON _ = fail "Unknown LogDriverType"
761instance ToJSON LogDriverType where
978instance ToJSON LogDriverType where
762− toJSON JsonFile = JSON.String "json-file"
979+ toJSON JsonFile = JSON.String "json-file"
763− toJSON Syslog = JSON.String "syslog"
980+ toJSON Syslog = JSON.String "syslog"
764− toJSON Journald = JSON.String "journald"
981+ toJSON Journald = JSON.String "journald"
765− toJSON Gelf = JSON.String "gelf"
982+ toJSON Gelf = JSON.String "gelf"
766− toJSON Fluentd = JSON.String "fluentd"
983+ toJSON Fluentd = JSON.String "fluentd"
767− toJSON AwsLogs = JSON.String "awslogs"
984+ toJSON AwsLogs = JSON.String "awslogs"
768− toJSON Splunk = JSON.String "splunk"
985+ toJSON Splunk = JSON.String "splunk"
769− toJSON Etwlogs = JSON.String "etwlogs"
986+ toJSON Etwlogs = JSON.String "etwlogs"
770 toJSON LoggingDisabled = JSON.String "none"
987 toJSON LoggingDisabled = JSON.String "none"
772−newtype LogDriverOptions = LogDriverOptions (M.Map Text Text) deriving (Eq, Show)
989+data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
774−instance FromJSON LogDriverOptions where
991+instance {-# OVERLAPPING #-} ToJSON [LogDriverOption] where
775− parseJSON (JSON.Object o) = do
992+ toJSON [] = emptyJsonObject
776− 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
778− where
997+instance {-# OVERLAPPING #-} FromJSON [LogDriverOption] where
998+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
779− f accM k (JSON.String v) = do
999+ where f accM k v = do
780 acc <- accM
1000 acc <- accM
781− return $ M.insert k v acc
1001+ value <- parseJSON v
782− f _ _ _ = fail "Value of LogDriverOptions is not a string"
1002+ return $ (LogDriverOption k value):acc
784− parseJSON JSON.Null = return $ LogDriverOptions M.empty
1003+ parseJSON JSON.Null = return []
785− parseJSON _ = fail "LogDriverOptions is not an object"
787−instance ToJSON LogDriverOptions where
788− toJSON (LogDriverOptions mp) = toJSON mp
1004+ parseJSON _ = fail "Failed to parse LogDriverOptions"
790−data LogDriverConfig = LogDriverConfig LogDriverType (Maybe LogDriverOptions) deriving (Eq, Show)
1006+data LogDriverConfig = LogDriverConfig LogDriverType [LogDriverOption] deriving (Eq, Show)
792instance ToJSON LogDriverConfig where
1008instance ToJSON LogDriverConfig where
1009+ toJSON (LogDriverConfig driverType []) = object ["Type" .= driverType]
793 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
1010 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
795instance FromJSON LogDriverConfig where
1012instance FromJSON LogDriverConfig where
@@ -800,19 +1017,41 @@ instance FromJSON LogDriverConfig where
800 parseJSON _ = fail "LogDriverConfig is not an object"
1017 parseJSON _ = fail "LogDriverConfig is not an object"
802-- TODO: Add container:<name|id> mode
1019-- TODO: Add container:<name|id> mode
803−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
804 deriving (Eq, Show, Ord)
1021 deriving (Eq, Show, Ord)
806instance FromJSON NetworkMode where
1023instance FromJSON NetworkMode where
807− parseJSON (JSON.String "bridge") = return Bridge
1024+ parseJSON (JSON.String "bridge") = return NetworkBridge
808− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
1025+ parseJSON (JSON.String "host") = return NetworkHost -- Note: Guessing on these.
809− parseJSON (JSON.String "none") = return NetworkDisabled
1026+ parseJSON (JSON.String "none") = return NetworkDisabled
1027+ parseJSON (JSON.String n) = return $ NetworkNamed n
810− parseJSON _ = fail "Unknown NetworkMode"
1028+ parseJSON _ = fail "Unknown NetworkMode"
812instance ToJSON NetworkMode where
1030instance ToJSON NetworkMode where
813− toJSON Bridge = JSON.String "bridge"
1031+ toJSON NetworkBridge = JSON.String "bridge"
814− toJSON Host = JSON.String "host"
1032+ toJSON NetworkHost = JSON.String "host"
815 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]
817data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
1056data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
@@ -828,7 +1067,7 @@ instance FromJSON PortType where
828 parseJSON val = case val of
1067 parseJSON val = case val of
829 "tcp" -> return TCP
1068 "tcp" -> return TCP
830 "udp" -> return UDP
1069 "udp" -> return UDP
831− _ -> fail "PortType: Invalid port type."
1070+ _ -> fail "PortType: Invalid port type."
833-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
1072-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
@@ -845,13 +1084,6 @@ instance FromJSON PortType where
845-- interface like `127.0.0.1`.
1084-- interface like `127.0.0.1`.
846-- __NOTE__: We should disallow duplicate port bindings as the ToJSON
1085-- __NOTE__: We should disallow duplicate port bindings as the ToJSON
847-- instance will only send the last one.
1086-- instance will only send the last one.
848−newtype PortBindings = PortBindings [PortBinding]
851−instance Monoid PortBindings where
852− mempty = PortBindings []
853− mappend (PortBindings p1) (PortBindings p2) = PortBindings (p1 ++ p2)
855-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
1087-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
856data PortBinding = PortBinding {
1088data PortBinding = PortBinding {
857 containerPort :: Port
1089 containerPort :: Port
@@ -862,24 +1094,62 @@ data PortBinding = PortBinding {
862portAndType2Text :: Port -> PortType -> Text
1094portAndType2Text :: Port -> PortType -> Text
863portAndType2Text p t = (T.pack $ show p) <> "/" <> (T.pack $ show t)
1095portAndType2Text p t = (T.pack $ show p) <> "/" <> (T.pack $ show t)
1098+-- | A helper function to more easily add a bind mount to existing
1099+-- "CreateOpts" records.
1100+addBind :: Bind -> CreateOpts -> CreateOpts
1101+addBind b c = c{hostConfig=hc{binds=obs <> [b]}}
1102+ where hc = hostConfig c
1103+ obs = binds $ hostConfig c
1105+-- | Helper function for adding a Command to and existing
1106+-- CreateOpts record.
1107+setCmd :: Text -> CreateOpts -> CreateOpts
1108+setCmd ccmd c = c{containerConfig=cc{cmd=[ccmd]}}
1109+ where cc = containerConfig c
1111+-- | Helper function for adding a "Link" to and existing
1112+-- CreateOpts record.
1113+addLink :: Link -> CreateOpts -> CreateOpts
1114+addLink l c = c{hostConfig=hc{links=ols <> [l]}}
1115+ where hc = hostConfig c
1116+ ols = links $ hostConfig c
1118+-- | Helper function for adding a "Volume" to and existing
1119+-- CreateOpts record.
1120+addVolume :: Volume -> CreateOpts -> CreateOpts
1121+addVolume v c = c{containerConfig=cc{volumes=oldvs <> [v]}}
1122+ where cc = containerConfig c
1125+-- | Helper function for adding a "VolumeFrom" to and existing
1126+-- CreateOpts record.
1127+addVolumeFrom :: VolumeFrom -> CreateOpts -> CreateOpts
1128+addVolumeFrom vf c = c{hostConfig=hc{volumesFrom=oldvfs <> [vf]}}
1129+ where hc = hostConfig c
1130+ oldvfs = volumesFrom hc
865-- | A convenience function that adds PortBindings to and exiting
1132-- | A convenience function that adds PortBindings to and exiting
866-- "CreateOpts" record. Useful with 'defaultCreateOpts'
1133-- "CreateOpts" record. Useful with 'defaultCreateOpts'
867-- Example:
1134-- Example:
869-- >>> let pb = PortBinding 80 TCP [HostPort "0.0.0.0" 8000]
1136-- >>> let pb = PortBinding 80 TCP [HostPort "0.0.0.0" 8000]
870−-- >>> addPortBinding (defaultCreateOpts "nginx:latest") pb
1137+-- >>> addPortBinding pb $ defaultCreateOpts "nginx:latest"
871−addPortBinding :: CreateOpts -> PortBinding -> CreateOpts
1138+addPortBinding :: PortBinding -> CreateOpts -> CreateOpts
872−addPortBinding c pb = c{hostConfig=hc{portBindings=pbs <> PortBindings [pb]}}
1139+addPortBinding pb c = c{hostConfig=hc{portBindings=pbs <> [pb]}}
873 where hc = hostConfig c
1140 where hc = hostConfig c
874 pbs = portBindings $ hostConfig c
1141 pbs = portBindings $ hostConfig c
876−instance ToJSON PortBinding where
1143+-- | Helper function for adding a "ExposedPort" to and existing
877− 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
879−instance FromJSON PortBindings where
880− parseJSON (JSON.Object o) = do
881− PortBindings <$> HM.foldlWithKey' f (return []) o
1151+instance {-# OVERLAPPING #-} FromJSON [PortBinding] where
1152+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
884 f accM k v = case T.split (== '/') k of
1154 f accM k v = case T.split (== '/') k of
885 [port', portType'] -> do
1155 [port', portType'] -> do
@@ -888,16 +1158,15 @@ instance FromJSON PortBindings where
888 acc <- accM
1158 acc <- accM
889 hps <- parseJSON v
1159 hps <- parseJSON v
890 return $ (PortBinding port portType hps):acc
1160 return $ (PortBinding port portType hps):acc
892− fail "Could not parse PortBindings"
1161+ _ -> fail "Could not parse PortBindings"
1162+ parseJSON (JSON.Null) = return []
893 parseJSON _ = fail "PortBindings is not an object"
1163 parseJSON _ = fail "PortBindings is not an object"
895−instance ToJSON PortBindings where
1165+instance {-# OVERLAPPING #-} ToJSON [PortBinding] where
896− toJSON (PortBindings []) = JSON.Object HM.empty
1166+ toJSON [] = emptyJsonObject
897− toJSON (PortBindings (p:ps)) = JSON.Object $ foldl f HM.empty (p:ps)
1167+ toJSON (p:ps) = toJsonKeyVal (p:ps) key val
898− where mKey p = portAndType2Text (containerPort p) (portType p)
1168+ where key p = T.unpack $ portAndType2Text (containerPort p) (portType p)
899− mVal p = toJSON $ hostPorts p
1169+ val p = hostPorts p
900− f acc p = HM.insert (mKey p) (mVal p) acc
902data HostPort = HostPort {
1171data HostPort = HostPort {
903 hostIp :: Text
1172 hostIp :: Text
@@ -928,7 +1197,7 @@ instance FromJSON RestartPolicy where
928 "on-failure" -> do
1197 "on-failure" -> do
929 retry <- o .: "MaximumRetryCount"
1198 retry <- o .: "MaximumRetryCount"
930 return $ RestartOnFailure retry
1199 return $ RestartOnFailure retry
931− "off" -> return RestartOff
1200+ "no" -> return RestartOff
932 _ -> fail "Could not parse RestartPolicy"
1201 _ -> fail "Could not parse RestartPolicy"
933 parseJSON _ = fail "RestartPolicy is not an object"
1202 parseJSON _ = fail "RestartPolicy is not an object"
@@ -936,7 +1205,7 @@ instance ToJSON RestartPolicy where
936 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
1205 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
937 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
1206 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
938 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1207 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
939− toJSON RestartOff = object ["Name" .= JSON.String "off"]
1208+ toJSON RestartOff = object ["Name" .= JSON.String "no"]
941data Isolation = Default | Process | Hyperv deriving (Eq, Show)
1210data Isolation = Default | Process | Hyperv deriving (Eq, Show)
@@ -946,11 +1215,11 @@ newtype UTSMode = UTSMode Text deriving (Eq, Show)
946-- TODO: Add UTSMode : UTS namespace to use for the container
1215-- TODO: Add UTSMode : UTS namespace to use for the container
947-- TODO: Sysctls map[string]string `json:",omitempty"` // List of Namespaced sysctls used for the container
1216-- TODO: Sysctls map[string]string `json:",omitempty"` // List of Namespaced sysctls used for the container
948data HostConfig = HostConfig
1217data HostConfig = HostConfig
949− { binds :: [Volume]
1218+ { binds :: [Bind]
950 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
1219 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
951 , logConfig :: LogDriverConfig
1220 , logConfig :: LogDriverConfig
952 , networkMode :: NetworkMode
1221 , networkMode :: NetworkMode
953− , portBindings :: PortBindings
1222+ , portBindings :: [PortBinding]
954 , restartPolicy :: RestartPolicy
1223 , restartPolicy :: RestartPolicy
955 , volumeDriver :: Maybe Text
1224 , volumeDriver :: Maybe Text
956 , volumesFrom :: [VolumeFrom]
1225 , volumesFrom :: [VolumeFrom]
@@ -1109,6 +1378,22 @@ instance ToJSON DeviceRate where
1109 , "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"
1112data ContainerResources = ContainerResources {
1397data ContainerResources = ContainerResources {
1113 cpuShares :: Maybe Integer
1398 cpuShares :: Maybe Integer
1114 -- , 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.
@@ -1124,12 +1409,12 @@ data ContainerResources = ContainerResources {
1124 , cpusetMems :: Maybe Text
1409 , cpusetMems :: Maybe Text
1125 , devices :: [Device]
1410 , devices :: [Device]
1126 -- , diskQuota :: Integer -- Don't see this ins 1.24.
1411 -- , diskQuota :: Integer -- Don't see this ins 1.24.
1127− , kernelMemory :: Maybe Integer
1412+ , kernelMemory :: Maybe MemoryConstraint
1128− , memory :: Maybe Integer
1413+ , memory :: Maybe MemoryConstraint
1129− , memoryReservation :: Maybe Integer
1414+ , memoryReservation :: Maybe MemoryConstraint
1130− , memorySwap :: Maybe Integer
1415+ , memorySwap :: Maybe MemoryConstraint
1131 -- , 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.
1132− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
1133 -- , 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.
1134 , ulimits :: [Ulimit]
1419 , ulimits :: [Ulimit]
1135 -- TODO: Missing from 1.24
1420 -- TODO: Missing from 1.24
@@ -1167,45 +1452,59 @@ instance FromJSON EnvVar where
1167 parseJSON _ = fail "EnvVar is not a string"
1452 parseJSON _ = fail "EnvVar is not a string"
1169instance ToJSON EnvVar where
1454instance ToJSON EnvVar where
1170− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
1172−-- | ExposedPorts represent a enumeraton of all the ports (and their type)
1457+-- | ExposedPort represents a port (and it's type)
1173-- 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.
1174−-- `NOTE`: This does not automatically expose the ports onto the host
1459+-- `NOTE`: This does not automatically expose the port onto the host
1175−-- 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
1176-- the PublishAllPorts flag. It is also useful for
1461-- the PublishAllPorts flag. It is also useful for
1177-- the daemon to know which Environment variables to
1462-- the daemon to know which Environment variables to
1178-- inject into a container linking to our container.
1463-- inject into a container linking to our container.
1179-- Example linking a Postgres container named db would inject the following
1464-- Example linking a Postgres container named db would inject the following
1180-- environment variables automatically if we set the corresponding
1465-- environment variables automatically if we set the corresponding
1182−-- ExposedPorts:
1467+-- ExposedPort:
1185-- DB_PORT_5432_TCP_PORT="5432"
1470-- DB_PORT_5432_TCP_PORT="5432"
1186-- DB_PORT_5432_TCP_PROTO="tcp"
1471-- DB_PORT_5432_TCP_PROTO="tcp"
1187-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
1472-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
1189−newtype ExposedPorts = ExposedPorts (M.Map Port PortType) deriving (Eq, Show)
1474+data ExposedPort = ExposedPort Port PortType deriving (Eq, Show)
1190−-- JP: Should this be ExposedPorts [(Port, PortType)]?
1192−instance FromJSON ExposedPorts where
1193− parseJSON (JSON.Object o) = do
1194− ExposedPorts <$> HM.foldlWithKey' f (return M.empty) o
1476+instance {-# OVERLAPPING #-} FromJSON [ExposedPort] where
1477+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
1197 f accM k _ = case T.split (== '/') k of
1479 f accM k _ = case T.split (== '/') k of
1198 [port', portType'] -> do
1480 [port', portType'] -> do
1199 port <- parseIntegerText port'
1481 port <- parseIntegerText port'
1200 portType <- parseJSON $ JSON.String portType'
1482 portType <- parseJSON $ JSON.String portType'
1201 acc <- accM
1483 acc <- accM
1202− return $ M.insert port portType acc
1484+ return $ (ExposedPort port portType):acc
1204− fail "Could not parse ExposedPorts"
1485+ _ -> fail "Could not parse ExposedPorts"
1486+ parseJSON (JSON.Null) = return []
1205− 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
1207−instance ToJSON ExposedPorts where
1501+instance FromJSON Entrypoint where
1208− 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"
1211data ContainerConfig = ContainerConfig {
1510data ContainerConfig = ContainerConfig {
@@ -1215,7 +1514,7 @@ data ContainerConfig = ContainerConfig {
1215 , attachStdin :: Bool
1514 , attachStdin :: Bool
1216 , attachStdout :: Bool
1515 , attachStdout :: Bool
1217 , attachStderr :: Bool
1516 , attachStderr :: Bool
1218− , exposedPorts :: Maybe ExposedPorts -- Note: Should we expand the JSON instance and take away the Maybe?
1517+ , exposedPorts :: [ExposedPort]
1219 -- , publishService :: Text -- Don't see this in 1.24
1518 -- , publishService :: Text -- Don't see this in 1.24
1220 , tty :: Bool
1519 , tty :: Bool
1221 , openStdin :: Bool
1520 , openStdin :: Bool
@@ -1224,27 +1523,70 @@ data ContainerConfig = ContainerConfig {
1224 , cmd :: [Text]
1523 , cmd :: [Text]
1225 -- , argsEscaped :: Bool -- Don't see this in 1.24
1524 -- , argsEscaped :: Bool -- Don't see this in 1.24
1226 , image :: Text
1525 , image :: Text
1227− , volumes :: Maybe Volumes
1526+ , volumes :: [Volume]
1228 , workingDir :: Maybe FilePath
1527 , workingDir :: Maybe FilePath
1229− , entrypoint :: Maybe Text -- Can be null?
1528+ , entrypoint :: Entrypoint
1230 , 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?
1231 , macAddress :: Maybe Text
1530 , macAddress :: Maybe Text
1232 -- , 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.
1233− , labels :: Maybe Labels
1532+ , labels :: [Label]
1234 , stopSignal :: Signal
1533 , stopSignal :: Signal
1235 } deriving (Eq, Show, Generic)
1534 } deriving (Eq, Show, Generic)
1237instance ToJSON ContainerConfig where
1537instance ToJSON ContainerConfig where
1238 toJSON = genericToJSON defaultOptions {
1538 toJSON = genericToJSON defaultOptions {
1239 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
1539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
1241instance FromJSON ContainerConfig where
1541instance FromJSON ContainerConfig where
1242− parseJSON = genericParseJSON defaultOptions {
1542+ parseJSON (JSON.Object o) = do
1243− 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
1245parseIntegerText :: (Monad m) => Text -> m Integer
1570parseIntegerText :: (Monad m) => Text -> m Integer
1246parseIntegerText t = case readMaybe $ T.unpack t of
1572parseIntegerText t = case readMaybe $ T.unpack t of
1247 Nothing ->
1573 Nothing ->
1248 fail "Could not parse Integer"
1574 fail "Could not parse Integer"
1249 Just i ->
1575 Just i ->
1250 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