@@ -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,40 +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(..)
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
37 , Timestamp
47 , Timestamp
38 , TailLogOpt(..)
48 , TailLogOpt(..)
39 , LogOpts(..)
49 , LogOpts(..)
40 , defaultLogOpts
50 , defaultLogOpts
51+ , CreateNetworkOpts(..)
52+ , defaultCreateNetworkOpts
41 , VolumePermission(..)
53 , VolumePermission(..)
42 , Volume(..)
55 , Volume(..)
43 , Device(..)
56 , Device(..)
44 , ContainerName
57 , ContainerName
45 , VolumeFrom(..)
58 , VolumeFrom(..)
46 , Link(..)
59 , Link(..)
47 , LogDriverType(..)
60 , LogDriverType(..)
48− , LogDriverOptions(..)
61+ , LogDriverOption(..)
49 , LogDriverConfig(..)
62 , LogDriverConfig(..)
50 , NetworkMode(..)
63 , NetworkMode(..)
51 , PortType(..)
64 , PortType(..)
52-- , NetworkInterface(..)
65-- , NetworkInterface(..)
53− , Networks(..)
66+ , Network(..)
54 , NetworkSettings(..)
67 , NetworkSettings(..)
55 , NetworkOptions(..)
68 , NetworkOptions(..)
56 , Mount(..)
69 , Mount(..)
57 , PortBinding(..)
70 , PortBinding(..)
59 , HostPort(..)
71 , HostPort(..)
60 , RetryCount
72 , RetryCount
61 , RestartPolicy(..)
73 , RestartPolicy(..)
@@ -63,6 +75,8 @@ module Docker.Client.Types (
63 , UTSMode(..)
75 , UTSMode(..)
64 , HostConfig(..)
76 , HostConfig(..)
65 , defaultHostConfig
77 , defaultHostConfig
78+ , NetworkingConfig(..)
66 , Ulimit(..)
80 , Ulimit(..)
67 , ContainerResources(..)
81 , ContainerResources(..)
68 , defaultContainerResources
82 , defaultContainerResources
@@ -72,9 +86,18 @@ module Docker.Client.Types (
72 , EnvVar(..)
86 , EnvVar(..)
73 , ContainerConfig(..)
87 , ContainerConfig(..)
74 , defaultContainerConfig
88 , defaultContainerConfig
75− , ExposedPorts(..)
89+ , ExposedPort(..)
76 , DeviceWeight(..)
90 , DeviceWeight(..)
77 , DeviceRate(..)
91 , DeviceRate(..)
99+ , MemoryConstraint(..)
100+ , MemoryConstraintSize(..)
80import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
103import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
@@ -84,40 +107,57 @@ import qualified Data.Aeson as JSON
84import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
107import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
85import Data.Char (isAlphaNum, toUpper)
108import Data.Char (isAlphaNum, toUpper)
86import qualified Data.HashMap.Strict as HM
109import qualified Data.HashMap.Strict as HM
87−import qualified Data.Map as M
88import Data.Monoid ((<>))
110import Data.Monoid ((<>))
111+import Data.Scientific (floatingOrInteger)
89import Data.Text (Text)
112import Data.Text (Text)
90import qualified Data.Text as T
113import qualified Data.Text as T
91import Data.Time.Clock (UTCTime)
114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
92import GHC.Generics (Generic)
116import GHC.Generics (Generic)
93import Prelude hiding (all, tail)
117import Prelude hiding (all, tail)
94import Text.Read (readMaybe)
118import Text.Read (readMaybe)
120+-- | List of Docker Engine API endpoints
96data Endpoint =
121data Endpoint =
97 VersionEndpoint
122 VersionEndpoint
98 | ListContainersEndpoint ListOpts
123 | ListContainersEndpoint ListOpts
99 | ListImagesEndpoint ListOpts
124 | ListImagesEndpoint ListOpts
100− | CreateContainerEndpoint CreateOpts
125+ | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
101 | StartContainerEndpoint StartOpts ContainerID
126 | StartContainerEndpoint StartOpts ContainerID
102 | StopContainerEndpoint Timeout ContainerID
127 | StopContainerEndpoint Timeout ContainerID
128+ | WaitContainerEndpoint ContainerID
103 | KillContainerEndpoint Signal ContainerID
129 | KillContainerEndpoint Signal ContainerID
104 | RestartContainerEndpoint Timeout ContainerID
130 | RestartContainerEndpoint Timeout ContainerID
105 | PauseContainerEndpoint ContainerID
131 | PauseContainerEndpoint ContainerID
106 | UnpauseContainerEndpoint ContainerID
132 | UnpauseContainerEndpoint ContainerID
107 | 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.
108− -- See note in "getContainerLogs" for explanation why.
134+ -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
109− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
110 | 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
111 deriving (Eq, Show)
142 deriving (Eq, Show)
144+-- | We should newtype this
113type URL = Text
145type URL = Text
147+-- | We should newtype this
114type ApiVersion = Text
148type ApiVersion = Text
151+-- | ID of a contianer
115newtype ContainerID = ContainerID Text
152newtype ContainerID = ContainerID Text
116 deriving (Eq, Show)
153 deriving (Eq, Show)
155+-- | Used for extracting the id of the container from the newtype
118fromContainerID :: ContainerID -> Text
156fromContainerID :: ContainerID -> Text
119fromContainerID (ContainerID t) = t
157fromContainerID (ContainerID t) = t
159+-- | Used for parsing a Text value into a ContainerID. We apply some basic
121toContainerID :: Text -> Maybe ContainerID
161toContainerID :: Text -> Maybe ContainerID
122toContainerID t =
162toContainerID t =
123 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?
@@ -125,12 +165,16 @@ toContainerID t =
128newtype ImageID = ImageID Text
169newtype ImageID = ImageID Text
129 deriving (Eq, Show)
170 deriving (Eq, Show)
172+-- | Used for extracting the id of the image from the newtype.
131fromImageID :: ImageID -> Text
173fromImageID :: ImageID -> Text
132fromImageID (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.
134toImageID :: Text -> Maybe ImageID
178toImageID :: Text -> Maybe ImageID
135toImageID t =
179toImageID t =
136 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?
@@ -138,9 +182,26 @@ toImageID t =
185+-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
141data 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"
143-- 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.
144data Signal = SIGHUP
205data Signal = SIGHUP
146 | SIGQUIT
207 | SIGQUIT
@@ -152,16 +213,16 @@ data Signal = SIGHUP
153instance FromJSON Signal where
214instance FromJSON Signal where
154 parseJSON (JSON.String "SIGTERM") = return SIGTERM
215 parseJSON (JSON.String "SIGTERM") = return SIGTERM
155− 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.
156− parseJSON (JSON.String "SIGINT") = return SIGINT
217+ parseJSON (JSON.String "SIGINT") = return SIGINT
157 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
218 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
158 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
219 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
159 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
220 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
160− parseJSON _ = fail "Unknown Signal"
221+ parseJSON _ = fail "Unknown Signal"
162instance ToJSON Signal where
223instance ToJSON Signal where
163− toJSON SIGHUP = "SIGHUP"
224+ toJSON SIGHUP = "SIGHUP"
164− toJSON SIGINT = "SIGINT"
225+ toJSON SIGINT = "SIGINT"
165 toJSON SIGQUIT = "SIGQUIT"
226 toJSON SIGQUIT = "SIGQUIT"
166 toJSON SIGSTOP = "SIGSTOP"
227 toJSON SIGSTOP = "SIGSTOP"
167 toJSON SIGTERM = "SIGTERM"
228 toJSON SIGTERM = "SIGTERM"
@@ -189,17 +250,19 @@ data ContainerDetails = ContainerDetails {
189 , processLabel :: Text
250 , processLabel :: Text
190 , resolveConfPath :: FilePath
251 , resolveConfPath :: FilePath
191 , restartCount :: Int
252 , restartCount :: Int
192− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
193 , mounts :: [Mount]
254 , mounts :: [Mount]
195 deriving (Eq, Show, Generic)
256 deriving (Eq, Show, Generic)
258+-- | Data type used for parsing the mount information from a container
197data Mount = Mount {
260data Mount = Mount {
198− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
199 , mountSource :: FilePath
262 , mountSource :: FilePath
200 , mountDestination :: FilePath
263 , mountDestination :: FilePath
201− , mountDriver :: Text
264+ , mountDriver :: Maybe Text
202− , mountMode :: Text -- Note: Improve this?
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
203 , mountRW :: Bool
266 , mountRW :: Bool
204 , mountPropogation :: Text
267 , mountPropogation :: Text
@@ -207,16 +270,18 @@ data Mount = Mount {
208instance FromJSON Mount where
271instance FromJSON Mount where
209 parseJSON (JSON.Object o) = do
272 parseJSON (JSON.Object o) = do
210− name <- o .: "Name"
273+ name <- o .:? "Name"
211 src <- o .: "Source"
274 src <- o .: "Source"
212 dest <- o .: "Destination"
275 dest <- o .: "Destination"
213− driver <- o .: "Driver"
276+ driver <- o .:? "Driver"
214− mode <- o .: "Mode"
277+ -- mode <- o .: "Mode"
215 rw <- o .: "RW"
278 rw <- o .: "RW"
216 prop <- o .: "Propagation"
279 prop <- o .: "Propagation"
217− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
218 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
220data ContainerState = ContainerState {
285data ContainerState = ContainerState {
221 containerError :: Text
286 containerError :: Text
222 , exitCode :: Int
287 , exitCode :: Int
@@ -228,7 +293,7 @@ data ContainerState = ContainerState {
228 , restarting :: Bool
293 , restarting :: Bool
229 , running :: Bool
294 , running :: Bool
230 , startedAt :: UTCTime
295 , startedAt :: UTCTime
231− , status :: Status
296+ , state :: State
233 deriving (Eq, Show, Generic)
298 deriving (Eq, Show, Generic)
@@ -248,23 +313,30 @@ instance FromJSON ContainerState where
248 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
249 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
251data DockerClientOpts = DockerClientOpts {
318data DockerClientOpts = DockerClientOpts {
252 apiVer :: ApiVersion
319 apiVer :: ApiVersion
253 , baseUrl :: URL
320 , baseUrl :: URL
255 deriving (Eq, Show)
322 deriving (Eq, Show)
324+-- | Default "DockerClientOpts" used for talking to the docker engine.
257defaultClientOpts :: DockerClientOpts
325defaultClientOpts :: DockerClientOpts
258defaultClientOpts = DockerClientOpts {
326defaultClientOpts = DockerClientOpts {
259 apiVer = "v1.24"
327 apiVer = "v1.24"
260 , 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.
263data ListOpts = ListOpts { all :: Bool } deriving (Eq, Show)
332data ListOpts = ListOpts { all :: Bool } deriving (Eq, Show)
334+-- | Default "ListOpts". Doesn't list stopped containers.
265defaultListOpts :: ListOpts
335defaultListOpts :: ListOpts
266defaultListOpts = ListOpts { all=False }
336defaultListOpts = ListOpts { all=False }
338+-- | Data type used for represneting the version of the docker engine
268data DockerVersion = DockerVersion {
340data DockerVersion = DockerVersion {
269 version :: Text
341 version :: Text
270 , apiVersion :: ApiVersion
342 , apiVersion :: ApiVersion
@@ -334,6 +406,8 @@ instance FromJSON ImageID where
334 return iid
406 return iid
335 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.
337data ContainerPortInfo = ContainerPortInfo {
411data ContainerPortInfo = ContainerPortInfo {
338 ipAddressInfo :: Maybe Text
412 ipAddressInfo :: Maybe Text
339 , privatePortInfo :: Port
413 , privatePortInfo :: Port
@@ -350,6 +424,8 @@ instance FromJSON ContainerPortInfo where
350 parseJSON _ = fail "ContainerPortInfo: Not a JSON object."
424 parseJSON _ = fail "ContainerPortInfo: Not a JSON object."
352-- 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.
353data NetworkOptions = NetworkOptions {
429data NetworkOptions = NetworkOptions {
354-- ipamConfig :: Maybe Text -- Don't see in 1.24
430-- ipamConfig :: Maybe Text -- Don't see in 1.24
355-- , links :: Maybe Text -- Don't see in 1.24
431-- , links :: Maybe Text -- Don't see in 1.24
@@ -379,29 +455,28 @@ instance FromJSON NetworkOptions where
379 return $ NetworkOptions networkId endpointId gateway ip ipLen ip6Gateway globalIP6 globalIP6Len mac
455 return $ NetworkOptions networkId endpointId gateway ip ipLen ip6Gateway globalIP6 globalIP6Len mac
380 parseJSON _ = fail "NetworkOptions is not an object"
456 parseJSON _ = fail "NetworkOptions is not an object"
382−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
383 deriving (Eq, Show)
460 deriving (Eq, Show)
385−instance FromJSON Networks where
462+instance {-# OVERLAPPING #-} FromJSON [Network] where
386− parseJSON (JSON.Object o) = do
463+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
387− Networks <$> HM.foldlWithKey' f (return M.empty) o
390 f accM k' v' = do
465 f accM k' v' = do
391 acc <- accM
466 acc <- accM
392 k <- parseJSON $ JSON.String k'
467 k <- parseJSON $ JSON.String k'
393 v <- parseJSON v'
468 v <- parseJSON v'
394− return $ M.insert k v acc
469+ return $ (Network k v):acc
396 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.
398data NetworkSettings = NetworkSettings {
473data NetworkSettings = NetworkSettings {
399 networkSettingsBridge :: Text
474 networkSettingsBridge :: Text
400 , networkSettingsSandboxId :: Text
475 , networkSettingsSandboxId :: Text
401 , networkSettingsHairpinMode :: Bool
476 , networkSettingsHairpinMode :: Bool
402 , networkSettingsLinkLocalIPv6Address :: Text
477 , networkSettingsLinkLocalIPv6Address :: Text
403 , networkSettingsLinkLocalIPv6PrefixLen :: Int
478 , networkSettingsLinkLocalIPv6PrefixLen :: Int
404− , networkSettingsPorts :: PortBindings
479+ , networkSettingsPorts :: [PortBinding]
405 , networkSettingsSandboxKey :: Text
480 , networkSettingsSandboxKey :: Text
406 , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
481 , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
407 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
482 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
@@ -413,7 +488,7 @@ data NetworkSettings = NetworkSettings {
413 , networkSettingsIpPrefixLen :: Int
488 , networkSettingsIpPrefixLen :: Int
414 , networkSettingsIpv6Gateway :: Text
489 , networkSettingsIpv6Gateway :: Text
415 , networkSettingsMacAddress :: Text
490 , networkSettingsMacAddress :: Text
416− , networkSettingsNetworks :: Networks
491+ , networkSettingsNetworks :: [Network]
418 deriving (Eq, Show)
493 deriving (Eq, Show)
@@ -440,6 +515,7 @@ instance FromJSON NetworkSettings where
440 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
441 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.
443data Container = Container
519data Container = Container
444 { containerId :: ContainerID
520 { containerId :: ContainerID
445 , containerNames :: [Text]
521 , containerNames :: [Text]
@@ -447,21 +523,23 @@ data Container = Container
447 , containerImageId :: ImageID
523 , containerImageId :: ImageID
448 , containerCommand :: Text
524 , containerCommand :: Text
449 , containerCreatedAt :: Int
525 , containerCreatedAt :: Int
526+ , containerState :: State
450− , containerStatus :: Status
527+ , containerStatus :: Maybe Text
451 , containerPorts :: [ContainerPortInfo]
528 , containerPorts :: [ContainerPortInfo]
452− , containerLabels :: Labels
529+ , containerLabels :: [Label]
453− , containerNetworks :: Networks
530+ , containerNetworks :: [Network]
454 , containerMounts :: [Mount]
531 , containerMounts :: [Mount]
455 } deriving (Show, Eq)
532 } deriving (Show, Eq)
457instance FromJSON Container where
534instance FromJSON Container where
458− parseJSON (JSON.Object v) =
535+ parseJSON o@(JSON.Object v) =
459− Container <$> (v .: "Id")
536+ Container <$> parseJSON o
460 <*> (v .: "Names")
537 <*> (v .: "Names")
461 <*> (v .: "Image")
538 <*> (v .: "Image")
462− <*> (v .: "ImageID")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
463− <*> (v .: "Command")
540+ <*> (v .: "Command") -- Doesn't exist anymore
464 <*> (v .: "Created")
541 <*> (v .: "Created")
465 <*> (v .: "Status")
543 <*> (v .: "Status")
466 <*> (v .: "Ports")
544 <*> (v .: "Ports")
467 <*> (v .: "Labels")
545 <*> (v .: "Labels")
@@ -471,65 +549,124 @@ instance FromJSON Container where
471 parseNetworks (JSON.Object v) =
549 parseNetworks (JSON.Object v) =
472 (v .: "Networks") >>= parseJSON
550 (v .: "Networks") >>= parseJSON
473 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
475 parseJSON _ = fail "Container: Not a JSON object."
552 parseJSON _ = fail "Container: Not a JSON object."
554+-- | Represents the state of the container life cycle.
477−data Status = Created | Restarting | Running | Paused | Exited | Dead
555+data State = Created | Restarting | Running | Paused | Exited | Dead
478 deriving (Eq, Show, Generic)
556 deriving (Eq, Show, Generic)
480−instance FromJSON Status where
558+instance FromJSON State where
481− parseJSON (JSON.String "running") = return Running
559+ parseJSON (JSON.String "running") = return Running
482− 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.
483 parseJSON (JSON.String "restarting") = return Restarting
561 parseJSON (JSON.String "restarting") = return Restarting
484− parseJSON (JSON.String "paused") = return Paused
562+ parseJSON (JSON.String "paused") = return Paused
485− parseJSON (JSON.String "exited") = return Exited
563+ parseJSON (JSON.String "exited") = return Exited
486− parseJSON (JSON.String "dead") = return Dead
564+ parseJSON (JSON.String "dead") = return Dead
487− parseJSON _ = fail "Unknown Status"
565+ parseJSON s = fail $ "Unknown Status: " ++ show s
567+-- | Alias for representing a RepoDigest. We could newtype this and add
489type Digest = Text
569type Digest = Text
571+-- | Container and Image Labels.
491−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.
493−instance FromJSON Labels where
577+instance {-# OVERLAPPING #-} ToJSON [Label] where
494− 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
496−instance ToJSON Labels where
583+instance {-# OVERLAPPING #-} FromJSON [Label] where
497− 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."
499type Tag = Text
593type Tag = Text
595+-- | Data type used for parsing information from a list of images.
501data Image = DockerImage {
596data Image = DockerImage {
502 imageId :: ImageID
597 imageId :: ImageID
503 , imageCreated :: Integer
598 , imageCreated :: Integer
504 , imageParentId :: Maybe ImageID
599 , imageParentId :: Maybe ImageID
505 , imageRepoTags :: [Tag]
600 , imageRepoTags :: [Tag]
506− , imageRepoDigests :: Maybe [Digest]
601+ , imageRepoDigests :: [Digest]
507 , imageSize :: Integer
602 , imageSize :: Integer
508 , imageVirtualSize :: Integer
603 , imageVirtualSize :: Integer
509− , imageLabels :: Maybe Labels
604+ , imageLabels :: [Label]
510 } 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.
512dropImagePrefix :: [a] -> [a]
609dropImagePrefix :: [a] -> [a]
513dropImagePrefix = drop 5
610dropImagePrefix = drop 5
515−instance FromJSON Image where
516− parseJSON = genericParseJSON defaultOptions {
517− 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.
519data CreateOpts = CreateOpts {
651data CreateOpts = CreateOpts {
520− containerConfig :: ContainerConfig
652+ containerConfig :: ContainerConfig
521− , hostConfig :: HostConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
522 } deriving (Eq, Show)
655 } deriving (Eq, Show)
524instance ToJSON CreateOpts where
657instance ToJSON CreateOpts where
525− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
526 let ccJSON = toJSON cc
659 let ccJSON = toJSON cc
527 let hcJSON = toJSON hc
660 let hcJSON = toJSON hc
528 case ccJSON of
661 case ccJSON of
529 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
530− JSON.Object $ HM.insert "HostConfig" hcJSON o
663+ let o1 = HM.insert "HostConfig" hcJSON o
664+ let o2 = HM.insert "NetworkingConfig" (toJSON nc) o1
531 _ -> 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
533defaultContainerConfig :: Text -> ContainerConfig
670defaultContainerConfig :: Text -> ContainerConfig
534defaultContainerConfig imageName = ContainerConfig {
671defaultContainerConfig imageName = ContainerConfig {
535 hostname=Nothing
672 hostname=Nothing
@@ -539,28 +676,29 @@ defaultContainerConfig imageName = ContainerConfig {
539 , attachStdout=False
676 , attachStdout=False
540 , image=imageName
677 , image=imageName
541 , attachStderr=False
678 , attachStderr=False
542− , exposedPorts=Nothing -- ExposedPorts M.empty
679+ , exposedPorts=[]
543 , tty=False
680 , tty=False
544 , openStdin=False
681 , openStdin=False
545 , stdinOnce=False
682 , stdinOnce=False
548− , volumes=Nothing
685+ , volumes=[]
549 , workingDir=Nothing
686 , workingDir=Nothing
550− , entrypoint=Nothing
687+ , entrypoint=Entrypoint []
551 , networkDisabled=Nothing
688 , networkDisabled=Nothing
552 , macAddress=Nothing
689 , macAddress=Nothing
553− , labels=Nothing
690+ , labels=[]
554 , stopSignal=SIGTERM
691 , stopSignal=SIGTERM
694+-- | Default host confiratuon used for creating a container.
557defaultHostConfig :: HostConfig
695defaultHostConfig :: HostConfig
558defaultHostConfig = HostConfig {
696defaultHostConfig = HostConfig {
560 , containerIDFile=Nothing
698 , containerIDFile=Nothing
561− , logConfig=LogDriverConfig JsonFile Nothing
699+ , logConfig=LogDriverConfig JsonFile []
562− , networkMode=Bridge
700+ , networkMode=NetworkBridge
563− , portBindings=PortBindings []
701+ , portBindings=[]
564 , restartPolicy=RestartOff
702 , restartPolicy=RestartOff
565 , volumeDriver=Nothing
703 , volumeDriver=Nothing
566 , volumesFrom=[]
704 , volumesFrom=[]
@@ -581,6 +719,7 @@ defaultHostConfig = HostConfig {
581 , resources=defaultContainerResources
719 , resources=defaultContainerResources
722+-- Default container resource contstraints (None).
584defaultContainerResources :: ContainerResources
723defaultContainerResources :: ContainerResources
585defaultContainerResources = ContainerResources {
724defaultContainerResources = ContainerResources {
586 cpuShares=Nothing
725 cpuShares=Nothing
@@ -598,31 +737,80 @@ defaultContainerResources = ContainerResources {
598 , memory=Nothing
737 , memory=Nothing
599 , memoryReservation=Nothing
738 , memoryReservation=Nothing
600 , memorySwap=Nothing
739 , memorySwap=Nothing
601− , oomKillDisable=False
740+ , oomKillDisable=Just False
602 , ulimits=[]
741 , ulimits=[]
605−
744+-- | Default create options when creating a container. You only need to
745+-- specify an image name and the rest is all sensible defaults.
606defaultCreateOpts :: T.Text -> CreateOpts
746defaultCreateOpts :: T.Text -> CreateOpts
747+defaultCreateOpts imageName = CreateOpts
607−defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
748+ { containerConfig = defaultContainerConfig imageName
749+ , hostConfig = defaultHostConfig
750+ , networkingConfig = NetworkingConfig HM.empty
609−-- detachKeys – Override the key sequence for detaching a container.
753+-- | Override the key sequence for detaching a container.
610-- 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 _.
611data 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.
613data StartOpts = StartOpts { detachKeys :: DetachKeys } deriving (Eq, Show)
758data StartOpts = StartOpts { detachKeys :: DetachKeys } deriving (Eq, Show)
760+-- | Default options for staring a container.
615defaultStartOpts :: StartOpts
761defaultStartOpts :: StartOpts
616defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
618−data DeleteOpts = DeleteOpts {
764+-- | Options for deleting a container.
619− deleteVolumes :: Bool
765+data ContainerDeleteOpts = ContainerDeleteOpts {
620− , force :: Bool
766+ deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
767+ , force :: Bool -- ^ If the container is still running force deletion anyway.
621 } 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
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
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.
623type Timestamp = Integer
806type Timestamp = Integer
808+-- | Used for requesting N number of lines when tailing a containers log
624data 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.
626data LogOpts = LogOpts {
814data LogOpts = LogOpts {
627 stdout :: Bool
815 stdout :: Bool
628 , stderr :: Bool
816 , stderr :: Bool
@@ -631,6 +819,7 @@ data LogOpts = LogOpts {
631 , tail :: TailLogOpt
819 , tail :: TailLogOpt
632 } deriving (Eq, Show)
820 } deriving (Eq, Show)
822+-- | Sensible default for log options.
634defaultLogOpts :: LogOpts
823defaultLogOpts :: LogOpts
635defaultLogOpts = LogOpts { stdout = True
824defaultLogOpts = LogOpts { stdout = True
636 , stderr = True
825 , stderr = True
@@ -639,37 +828,87 @@ defaultLogOpts = LogOpts { stdout = True
639 , 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
861+-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
862+-- | Set permissions on volumes that you mount in the container.
642−data VolumePermission = Rw | Ro deriving (Eq, Show, Generic)
863+data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
644−-- instance ToJSON VolumePermission where
865+instance ToJSON VolumePermission where
645−-- toJSON = error "TODO"
866+ toJSON ReadWrite = "rw"
867+ toJSON ReadOnly = "ro"
646−-- instance FromJSON VolumePermission where
869+instance FromJSON VolumePermission where
647−-- parseJSON = error "TODO"
870+ parseJSON "rw" = return ReadWrite
648−
871+ parseJSON "ro" = return ReadOnly
649−-- Note: Note really sure what this should be (1.24).
872+ parseJSON "RW" = return ReadWrite
650−-- This is not the same as [Volume] in HostConfig.
873+ parseJSON "RO" = return ReadOnly
651−newtype Volumes = Volumes [Text] -- [Volume]
874+ parseJSON _ = fail "Failed to parse VolumePermission"
652− deriving (Eq, Show)
875+
653−
876+-- | Used for marking a directory in the container as "exposed" hence
877+-- taking it outside of the COW filesystem and making it mountable
878+-- in other containers using "VolumesFrom". The volume usually get's
879+-- created somewhere in @/var/lib/docker/volumes@ (depending on the volume
881+-- The CLI example is:
884+-- docker run --name app -v \/opt\/data -it myapp:latest
885+-- docker run --name app2 --volumes-from app \/bin\/bash -c "ls -l \/opt\/data"
887+newtype Volume = Volume FilePath deriving (Eq, Show)
889+instance {-# OVERLAPPING #-} ToJSON [Volume] where
890+ toJSON [] = emptyJsonObject
891+ toJSON (v:vs) = toJsonKey (v:vs) getKey
892+ where getKey (Volume v) = v
654−instance FromJSON Volumes where
894+instance {-# OVERLAPPING #-} FromJSON [Volume] where
655− parseJSON (JSON.Object o) = return $ Volumes $ HM.keys o
895+ parseJSON (JSON.Object o) = return $ map (Volume . T.unpack) $ HM.keys o
896+ parseJSON (JSON.Null) = return []
656− parseJSON _ = fail "Volumes is not an object"
897+ parseJSON _ = fail "Volume is not an object"
658−instance ToJSON Volumes where
899+
659− toJSON (Volumes vs) = toJSON vs
661−data Volume = Volume { hostSrc :: Text
900+data Bind = Bind { hostSrc :: Text
662− , containerDest :: Text
901+ , containerDest :: Text
663− , volumePermission :: Maybe VolumePermission
902+ , volumePermission :: Maybe VolumePermission
664− } deriving (Eq, Show)
903+ } deriving (Eq, Show)
666−instance FromJSON Volume where
905+instance FromJSON Bind where
667 parseJSON (JSON.String t) = case T.split (== ':') t of
906 parseJSON (JSON.String t) = case T.split (== ':') t of
668− [src, dest] -> return $ Volume src dest Nothing
907+ [src, dest] -> return $ Bind src dest Nothing
669− [src, dest, "rw"] -> return $ Volume src dest $ Just Rw
908+ [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
670− [src, dest, "ro"] -> return $ Volume src dest $ Just Ro
909+ [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
671− _ -> fail "Could not parse Volume"
910+ _ -> fail "Could not parse Bind"
672− parseJSON _ = fail "Volume is not a string"
911+ parseJSON _ = fail "Bind is not a string"
674data Device = Device {
913data Device = Device {
675 pathOnHost :: FilePath
914 pathOnHost :: FilePath
@@ -691,19 +930,19 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
692instance FromJSON VolumeFrom where
931instance FromJSON VolumeFrom where
693 parseJSON (JSON.String t) = case T.split (== ':') t of
932 parseJSON (JSON.String t) = case T.split (== ':') t of
694− [vol] -> return $ VolumeFrom vol Nothing
933+ [vol] -> return $ VolumeFrom vol Nothing
695− [vol, "rw"] -> return $ VolumeFrom vol $ Just Rw
934+ [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
696− [vol, "ro"] -> return $ VolumeFrom vol $ Just Ro
935+ [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
697− _ -> fail "Could not parse VolumeFrom"
936+ _ -> fail "Could not parse VolumeFrom"
698 parseJSON _ = fail "VolumeFrom is not a string"
937 parseJSON _ = fail "VolumeFrom is not a string"
700instance ToJSON VolumeFrom where
939instance ToJSON VolumeFrom where
701 toJSON (VolumeFrom n p) = case p of
940 toJSON (VolumeFrom n p) = case p of
702− Nothing -> toJSON $ n <> ":" <> "rw"
941+ Nothing -> toJSON $ n <> ":" <> "rw"
703 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
942 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
705−instance ToJSON Volume where
944+instance ToJSON Bind where
706− toJSON (Volume src dest mode) = toJSON $ case mode of
945+ toJSON (Bind src dest mode) = toJSON $ case mode of
707 Nothing -> T.concat[src, ":", dest]
946 Nothing -> T.concat[src, ":", dest]
708 Just m -> T.concat[src, ":", dest, ":", (T.pack $ show m)]
947 Just m -> T.concat[src, ":", dest, ":", (T.pack $ show m)]
@@ -711,63 +950,63 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
712instance FromJSON Link where
951instance FromJSON Link where
713 parseJSON (JSON.String t) = case T.split (== ':') t of
952 parseJSON (JSON.String t) = case T.split (== ':') t of
714− [f] -> return $ Link f Nothing
953+ [f] -> return $ Link f Nothing
715 [f,s] -> return $ Link f $ Just s
954 [f,s] -> return $ Link f $ Just s
716− _ -> fail "Could not parse Link"
955+ _ -> fail "Could not parse Link"
717 parseJSON _ = fail "Link is not a string"
956 parseJSON _ = fail "Link is not a string"
719instance ToJSON Link where
958instance ToJSON Link where
720 toJSON (Link n1 n2) = toJSON $ case n2 of
959 toJSON (Link n1 n2) = toJSON $ case n2 of
721 Nothing -> T.concat[n1, ":", n1] -- use same name in container
960 Nothing -> T.concat[n1, ":", n1] -- use same name in container
722− Just n -> T.concat[n1, ":", n] -- used specified name in container
961+ Just n -> T.concat[n1, ":", n] -- used specified name in container
724-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
963-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
725data 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)
727instance FromJSON LogDriverType where
966instance FromJSON LogDriverType where
728 parseJSON (JSON.String "json-file") = return JsonFile
967 parseJSON (JSON.String "json-file") = return JsonFile
729− parseJSON (JSON.String "syslog") = return Syslog
968+ parseJSON (JSON.String "syslog") = return Syslog
730− parseJSON (JSON.String "journald") = return Journald
969+ parseJSON (JSON.String "journald") = return Journald
731− parseJSON (JSON.String "gelf") = return Gelf
970+ parseJSON (JSON.String "gelf") = return Gelf
732− parseJSON (JSON.String "fluentd") = return Fluentd
971+ parseJSON (JSON.String "fluentd") = return Fluentd
733− parseJSON (JSON.String "awslogs") = return AwsLogs
972+ parseJSON (JSON.String "awslogs") = return AwsLogs
734− parseJSON (JSON.String "splunk") = return Splunk
973+ parseJSON (JSON.String "splunk") = return Splunk
735− parseJSON (JSON.String "etwlogs") = return Etwlogs
974+ parseJSON (JSON.String "etwlogs") = return Etwlogs
736− parseJSON (JSON.String "none") = return LoggingDisabled
975+ parseJSON (JSON.String "none") = return LoggingDisabled
737− parseJSON _ = fail "Unknown LogDriverType"
976+ parseJSON _ = fail "Unknown LogDriverType"
739instance ToJSON LogDriverType where
978instance ToJSON LogDriverType where
740− toJSON JsonFile = JSON.String "json-file"
979+ toJSON JsonFile = JSON.String "json-file"
741− toJSON Syslog = JSON.String "syslog"
980+ toJSON Syslog = JSON.String "syslog"
742− toJSON Journald = JSON.String "journald"
981+ toJSON Journald = JSON.String "journald"
743− toJSON Gelf = JSON.String "gelf"
982+ toJSON Gelf = JSON.String "gelf"
744− toJSON Fluentd = JSON.String "fluentd"
983+ toJSON Fluentd = JSON.String "fluentd"
745− toJSON AwsLogs = JSON.String "awslogs"
984+ toJSON AwsLogs = JSON.String "awslogs"
746− toJSON Splunk = JSON.String "splunk"
985+ toJSON Splunk = JSON.String "splunk"
747− toJSON Etwlogs = JSON.String "etwlogs"
986+ toJSON Etwlogs = JSON.String "etwlogs"
748 toJSON LoggingDisabled = JSON.String "none"
987 toJSON LoggingDisabled = JSON.String "none"
750−newtype LogDriverOptions = LogDriverOptions (M.Map Text Text) deriving (Eq, Show)
989+data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
752−instance FromJSON LogDriverOptions where
991+instance {-# OVERLAPPING #-} ToJSON [LogDriverOption] where
753− parseJSON (JSON.Object o) = do
992+ toJSON [] = emptyJsonObject
754− 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
756− where
997+instance {-# OVERLAPPING #-} FromJSON [LogDriverOption] where
998+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
757− f accM k (JSON.String v) = do
999+ where f accM k v = do
758 acc <- accM
1000 acc <- accM
759− return $ M.insert k v acc
1001+ value <- parseJSON v
760− f _ _ _ = fail "Value of LogDriverOptions is not a string"
1002+ return $ (LogDriverOption k value):acc
762− parseJSON JSON.Null = return $ LogDriverOptions M.empty
1003+ parseJSON JSON.Null = return []
763− parseJSON _ = fail "LogDriverOptions is not an object"
765−instance ToJSON LogDriverOptions where
766− toJSON (LogDriverOptions mp) = toJSON mp
1004+ parseJSON _ = fail "Failed to parse LogDriverOptions"
768−data LogDriverConfig = LogDriverConfig LogDriverType (Maybe LogDriverOptions) deriving (Eq, Show)
1006+data LogDriverConfig = LogDriverConfig LogDriverType [LogDriverOption] deriving (Eq, Show)
770instance ToJSON LogDriverConfig where
1008instance ToJSON LogDriverConfig where
1009+ toJSON (LogDriverConfig driverType []) = object ["Type" .= driverType]
771 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
1010 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
773instance FromJSON LogDriverConfig where
1012instance FromJSON LogDriverConfig where
@@ -778,21 +1017,47 @@ instance FromJSON LogDriverConfig where
778 parseJSON _ = fail "LogDriverConfig is not an object"
1017 parseJSON _ = fail "LogDriverConfig is not an object"
780-- TODO: Add container:<name|id> mode
1019-- TODO: Add container:<name|id> mode
781−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
782 deriving (Eq, Show, Ord)
1021 deriving (Eq, Show, Ord)
784instance FromJSON NetworkMode where
1023instance FromJSON NetworkMode where
785− parseJSON (JSON.String "bridge") = return Bridge
1024+ parseJSON (JSON.String "bridge") = return NetworkBridge
786− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
1025+ parseJSON (JSON.String "host") = return NetworkHost -- Note: Guessing on these.
787− parseJSON (JSON.String "none") = return NetworkDisabled
1026+ parseJSON (JSON.String "none") = return NetworkDisabled
1027+ parseJSON (JSON.String n) = return $ NetworkNamed n
788− parseJSON _ = fail "Unknown NetworkMode"
1028+ parseJSON _ = fail "Unknown NetworkMode"
790instance ToJSON NetworkMode where
1030instance ToJSON NetworkMode where
791− toJSON Bridge = JSON.String "bridge"
1031+ toJSON NetworkBridge = JSON.String "bridge"
792− toJSON Host = JSON.String "host"
1032+ toJSON NetworkHost = JSON.String "host"
793 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]
795−data PortType = TCP | UDP deriving (Eq, Show, Generic, Read, Ord)
1056+data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
1058+instance Show PortType where
797instance ToJSON PortType where
1062instance ToJSON PortType where
798 toJSON TCP = "tcp"
1063 toJSON TCP = "tcp"
@@ -802,7 +1067,7 @@ instance FromJSON PortType where
802 parseJSON val = case val of
1067 parseJSON val = case val of
803 "tcp" -> return TCP
1068 "tcp" -> return TCP
804 "udp" -> return UDP
1069 "udp" -> return UDP
805− _ -> fail "PortType: Invalid port type."
1070+ _ -> fail "PortType: Invalid port type."
807-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
1072-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
@@ -817,9 +1082,8 @@ instance FromJSON PortType where
817-- host system s that the service running in the container can be accessed from
1082-- host system s that the service running in the container can be accessed from
818-- the outside world. We either map a port onto all interfaces (default) or onto a specific
1083-- the outside world. We either map a port onto all interfaces (default) or onto a specific
819-- interface like `127.0.0.1`.
1084-- interface like `127.0.0.1`.
820−newtype PortBindings = PortBindings [PortBinding]
1085+-- __NOTE__: We should disallow duplicate port bindings as the ToJSON
821− deriving (Eq, Show)
1086+-- instance will only send the last one.
823-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
1087-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
824data PortBinding = PortBinding {
1088data PortBinding = PortBinding {
825 containerPort :: Port
1089 containerPort :: Port
@@ -827,17 +1091,65 @@ data PortBinding = PortBinding {
827 , hostPorts :: [HostPort]
1091 , hostPorts :: [HostPort]
828 } deriving (Eq, Show)
1092 } deriving (Eq, Show)
831portAndType2Text :: Port -> PortType -> Text
1094portAndType2Text :: Port -> PortType -> Text
832portAndType2Text p t = (T.pack $ show p) <> "/" <> (T.pack $ show t)
1095portAndType2Text p t = (T.pack $ show p) <> "/" <> (T.pack $ show t)
834−instance ToJSON PortBinding where
835− toJSON (PortBinding {..}) = object [portAndType2Text containerPort portType .= hostPorts]
837−instance FromJSON PortBindings where
838− parseJSON (JSON.Object o) = do
839− PortBindings <$> HM.foldlWithKey' f (return []) o
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
1132+-- | A convenience function that adds PortBindings to and exiting
1133+-- "CreateOpts" record. Useful with 'defaultCreateOpts'
1136+-- >>> let pb = PortBinding 80 TCP [HostPort "0.0.0.0" 8000]
1137+-- >>> addPortBinding pb $ defaultCreateOpts "nginx:latest"
1138+addPortBinding :: PortBinding -> CreateOpts -> CreateOpts
1139+addPortBinding pb c = c{hostConfig=hc{portBindings=pbs <> [pb]}}
1140+ where hc = hostConfig c
1141+ pbs = portBindings $ hostConfig c
1143+-- | Helper function for adding a "ExposedPort" to and existing
1144+-- CreateOpts record.
1145+addExposedPort :: ExposedPort -> CreateOpts -> CreateOpts
1146+addExposedPort ep c = c{containerConfig=cc{exposedPorts=oldeps <> [ep]}}
1147+ where cc = containerConfig c
1148+ oldeps = exposedPorts cc
1151+instance {-# OVERLAPPING #-} FromJSON [PortBinding] where
1152+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
842 f accM k v = case T.split (== '/') k of
1154 f accM k v = case T.split (== '/') k of
843 [port', portType'] -> do
1155 [port', portType'] -> do
@@ -846,13 +1158,15 @@ instance FromJSON PortBindings where
846 acc <- accM
1158 acc <- accM
847 hps <- parseJSON v
1159 hps <- parseJSON v
848 return $ (PortBinding port portType hps):acc
1160 return $ (PortBinding port portType hps):acc
850− fail "Could not parse PortBindings"
1161+ _ -> fail "Could not parse PortBindings"
1162+ parseJSON (JSON.Null) = return []
851 parseJSON _ = fail "PortBindings is not an object"
1163 parseJSON _ = fail "PortBindings is not an object"
853−instance ToJSON PortBindings where
1165+instance {-# OVERLAPPING #-} ToJSON [PortBinding] where
854− toJSON (PortBindings []) = JSON.Object HM.empty
1166+ toJSON [] = emptyJsonObject
855− toJSON (PortBindings (p:ps)) = toJSON (p:ps)
1167+ toJSON (p:ps) = toJsonKeyVal (p:ps) key val
1168+ where key p = T.unpack $ portAndType2Text (containerPort p) (portType p)
1169+ val p = hostPorts p
857data HostPort = HostPort {
1171data HostPort = HostPort {
858 hostIp :: Text
1172 hostIp :: Text
@@ -870,24 +1184,6 @@ instance FromJSON HostPort where
870 return $ HostPort i p
1184 return $ HostPort i p
871 parseJSON _ = fail "HostPort is not an object."
1185 parseJSON _ = fail "HostPort is not an object."
873−-- newtype HostPorts = HostPorts [HostPort]
874−-- deriving (Eq, Show)
876−-- instance ToJSON HostPorts where
877−-- toJSON (HostPorts hps) = toJSON hps
879−-- instance FromJSON HostPorts where
880−-- parseJSON (JSON.Object o) = do
881−-- HostPorts <$> HM.foldlWithKey' f (return []) o
887−-- p <- parseIntegerText p'
888−-- return $ (HostPort (NetworkInterface k) p):acc
889−-- parseJSON _ = fail $ "HostPorts is not an object"
891-- { "Name": "on-failure" , "MaximumRetryCount": 2}
1187-- { "Name": "on-failure" , "MaximumRetryCount": 2}
892type RetryCount = Integer
1188type RetryCount = Integer
893data RestartPolicy = RestartAlways | RestartUnlessStopped | RestartOnFailure RetryCount | RestartOff deriving (Eq, Show)
1189data RestartPolicy = RestartAlways | RestartUnlessStopped | RestartOnFailure RetryCount | RestartOff deriving (Eq, Show)
@@ -901,7 +1197,7 @@ instance FromJSON RestartPolicy where
901 "on-failure" -> do
1197 "on-failure" -> do
902 retry <- o .: "MaximumRetryCount"
1198 retry <- o .: "MaximumRetryCount"
903 return $ RestartOnFailure retry
1199 return $ RestartOnFailure retry
904− "off" -> return RestartOff
1200+ "no" -> return RestartOff
905 _ -> fail "Could not parse RestartPolicy"
1201 _ -> fail "Could not parse RestartPolicy"
906 parseJSON _ = fail "RestartPolicy is not an object"
1202 parseJSON _ = fail "RestartPolicy is not an object"
@@ -909,7 +1205,7 @@ instance ToJSON RestartPolicy where
909 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
1205 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
910 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
1206 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
911 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1207 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
912− toJSON RestartOff = object ["Name" .= JSON.String "off"]
1208+ toJSON RestartOff = object ["Name" .= JSON.String "no"]
914data Isolation = Default | Process | Hyperv deriving (Eq, Show)
1210data Isolation = Default | Process | Hyperv deriving (Eq, Show)
@@ -919,11 +1215,11 @@ newtype UTSMode = UTSMode Text deriving (Eq, Show)
919-- TODO: Add UTSMode : UTS namespace to use for the container
1215-- TODO: Add UTSMode : UTS namespace to use for the container
920-- 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
921data HostConfig = HostConfig
1217data HostConfig = HostConfig
922− { binds :: [Volume]
1218+ { binds :: [Bind]
923 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
1219 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
924 , logConfig :: LogDriverConfig
1220 , logConfig :: LogDriverConfig
925 , networkMode :: NetworkMode
1221 , networkMode :: NetworkMode
926− , portBindings :: PortBindings
1222+ , portBindings :: [PortBinding]
927 , restartPolicy :: RestartPolicy
1223 , restartPolicy :: RestartPolicy
928 , volumeDriver :: Maybe Text
1224 , volumeDriver :: Maybe Text
929 , volumesFrom :: [VolumeFrom]
1225 , volumesFrom :: [VolumeFrom]
@@ -1082,6 +1378,22 @@ instance ToJSON DeviceRate where
1082 , "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"
1085data ContainerResources = ContainerResources {
1397data ContainerResources = ContainerResources {
1086 cpuShares :: Maybe Integer
1398 cpuShares :: Maybe Integer
1087 -- , 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.
@@ -1097,12 +1409,12 @@ data ContainerResources = ContainerResources {
1097 , cpusetMems :: Maybe Text
1409 , cpusetMems :: Maybe Text
1098 , devices :: [Device]
1410 , devices :: [Device]
1099 -- , diskQuota :: Integer -- Don't see this ins 1.24.
1411 -- , diskQuota :: Integer -- Don't see this ins 1.24.
1100− , kernelMemory :: Maybe Integer
1412+ , kernelMemory :: Maybe MemoryConstraint
1101− , memory :: Maybe Integer
1413+ , memory :: Maybe MemoryConstraint
1102− , memoryReservation :: Maybe Integer
1414+ , memoryReservation :: Maybe MemoryConstraint
1103− , memorySwap :: Maybe Integer
1415+ , memorySwap :: Maybe MemoryConstraint
1104 -- , 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.
1105− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
1106 -- , 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.
1107 , ulimits :: [Ulimit]
1419 , ulimits :: [Ulimit]
1108 -- TODO: Missing from 1.24
1420 -- TODO: Missing from 1.24
@@ -1140,41 +1452,59 @@ instance FromJSON EnvVar where
1140 parseJSON _ = fail "EnvVar is not a string"
1452 parseJSON _ = fail "EnvVar is not a string"
1142instance ToJSON EnvVar where
1454instance ToJSON EnvVar where
1143− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
1145−-- | ExposedPorts represent a enumeraton of all the ports (and their type)
1457+-- | ExposedPort represents a port (and it's type)
1146-- 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.
1147−-- `NOTE`: This does not automatically expose the ports onto the host
1459+-- `NOTE`: This does not automatically expose the port onto the host
1148−-- 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
1149-- the PublishAllPorts flag. It is also useful for
1461-- the PublishAllPorts flag. It is also useful for
1150-- the daemon to know which Environment variables to
1462-- the daemon to know which Environment variables to
1151-- inject into a container linking to our container.
1463-- inject into a container linking to our container.
1152-- Example linking a Postgres container named db would inject the following
1464-- Example linking a Postgres container named db would inject the following
1153-- environment variables automatically if we set the corresponding
1465-- environment variables automatically if we set the corresponding
1154−-- ExposedPorts:
1466+--
1155-- DB_PORT_5432_TCP_PORT="5432"
1470-- DB_PORT_5432_TCP_PORT="5432"
1156-- DB_PORT_5432_TCP_PROTO="tcp"
1471-- DB_PORT_5432_TCP_PROTO="tcp"
1157-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
1472-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
1158−newtype ExposedPorts = ExposedPorts (M.Map Port PortType) deriving (Eq, Show)
1474+data ExposedPort = ExposedPort Port PortType deriving (Eq, Show)
1159−-- JP: Should this be ExposedPorts [(Port, PortType)]?
1161−instance FromJSON ExposedPorts where
1162− parseJSON (JSON.Object o) = do
1163− ExposedPorts <$> HM.foldlWithKey' f (return M.empty) o
1476+instance {-# OVERLAPPING #-} FromJSON [ExposedPort] where
1477+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
1166 f accM k _ = case T.split (== '/') k of
1479 f accM k _ = case T.split (== '/') k of
1167 [port', portType'] -> do
1480 [port', portType'] -> do
1168 port <- parseIntegerText port'
1481 port <- parseIntegerText port'
1169 portType <- parseJSON $ JSON.String portType'
1482 portType <- parseJSON $ JSON.String portType'
1170 acc <- accM
1483 acc <- accM
1171− return $ M.insert port portType acc
1484+ return $ (ExposedPort port portType):acc
1173− fail "Could not parse ExposedPorts"
1485+ _ -> fail "Could not parse ExposedPorts"
1486+ parseJSON (JSON.Null) = return []
1174− 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)
1176−instance ToJSON ExposedPorts where
1497+instance ToJSON Entrypoint where
1177− toJSON (ExposedPorts kvs) = object [((T.pack $ show p) <> "/" <> (T.pack $ show t)) .= JSON.Object HM.empty | (p,t) <- (M.toList kvs)]
1498+ toJSON (Entrypoint (e:es)) = toJSON (e:es)
1499+ toJSON (Entrypoint []) = JSON.Null
1501+instance FromJSON Entrypoint where
1502+ parseJSON (JSON.String e) = return $ Entrypoint [e]
1503+ parseJSON (JSON.Array ar) = do
1504+ arr <- mapM parseJSON (V.toList ar)
1505+ return $ Entrypoint arr
1506+ parseJSON JSON.Null = return $ Entrypoint []
1507+ parseJSON _ = fail "Failed to parse Entrypoint"
1180data ContainerConfig = ContainerConfig {
1510data ContainerConfig = ContainerConfig {
@@ -1184,7 +1514,7 @@ data ContainerConfig = ContainerConfig {
1184 , attachStdin :: Bool
1514 , attachStdin :: Bool
1185 , attachStdout :: Bool
1515 , attachStdout :: Bool
1186 , attachStderr :: Bool
1516 , attachStderr :: Bool
1187− , exposedPorts :: Maybe ExposedPorts -- Note: Should we expand the JSON instance and take away the Maybe?
1517+ , exposedPorts :: [ExposedPort]
1188 -- , publishService :: Text -- Don't see this in 1.24
1518 -- , publishService :: Text -- Don't see this in 1.24
1189 , tty :: Bool
1519 , tty :: Bool
1190 , openStdin :: Bool
1520 , openStdin :: Bool
@@ -1193,27 +1523,70 @@ data ContainerConfig = ContainerConfig {
1193 , cmd :: [Text]
1523 , cmd :: [Text]
1194 -- , argsEscaped :: Bool -- Don't see this in 1.24
1524 -- , argsEscaped :: Bool -- Don't see this in 1.24
1195 , image :: Text
1525 , image :: Text
1196− , volumes :: Maybe Volumes
1526+ , volumes :: [Volume]
1197 , workingDir :: Maybe FilePath
1527 , workingDir :: Maybe FilePath
1198− , entrypoint :: Maybe Text -- Can be null?
1528+ , entrypoint :: Entrypoint
1199 , 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?
1200 , macAddress :: Maybe Text
1530 , macAddress :: Maybe Text
1201 -- , 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.
1202− , labels :: Maybe Labels
1532+ , labels :: [Label]
1203 , stopSignal :: Signal
1533 , stopSignal :: Signal
1204 } deriving (Eq, Show, Generic)
1534 } deriving (Eq, Show, Generic)
1206instance ToJSON ContainerConfig where
1537instance ToJSON ContainerConfig where
1207 toJSON = genericToJSON defaultOptions {
1538 toJSON = genericToJSON defaultOptions {
1208 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
1539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
1210instance FromJSON ContainerConfig where
1541instance FromJSON ContainerConfig where
1211− parseJSON = genericParseJSON defaultOptions {
1542+ parseJSON (JSON.Object o) = do
1212− 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
1214parseIntegerText :: (Monad m) => Text -> m Integer
1570parseIntegerText :: (Monad m) => Text -> m Integer
1215parseIntegerText t = case readMaybe $ T.unpack t of
1572parseIntegerText t = case readMaybe $ T.unpack t of
1216 Nothing ->
1573 Nothing ->
1217 fail "Could not parse Integer"
1574 fail "Could not parse Integer"
1218 Just i ->
1575 Just i ->
1219 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