@@ -11,7 +11,11 @@ module Docker.Client.Types (
1111 , ImageID
1212 , fromImageID
1313 , toImageID
14+ , NetworkID
15+ , fromNetworkID
16+ , toNetworkID
1417 , Timeout(..)
18+ , StatusCode(..)
1519 , Signal(..)
1620 , ContainerDetails(..)
1721 , DockerClientOpts(..)
@@ -22,41 +26,48 @@ module Docker.Client.Types (
2226 , ContainerPortInfo(..)
2327 , Container(..)
2428 , ContainerState(..)
25− , Status(..)
29+ , State(..)
2630 , Digest
27− , Labels(..)
31+ , Label(..)
2832 , Tag
2933 , Image(..)
34+ , Entrypoint(..)
3035 , dropImagePrefix
3136 , CreateOpts(..)
37+ , BuildOpts(..)
38+ , defaultBuildOpts
3239 , defaultCreateOpts
3340 , DetachKeys(..)
3441 , StartOpts(..)
3542 , defaultStartOpts
36− , DeleteOpts(..)
37− , defaultDeleteOpts
43+ , ContainerDeleteOpts(..)
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
3847 , Timestamp
3948 , TailLogOpt(..)
4049 , LogOpts(..)
4150 , defaultLogOpts
51+ , CreateNetworkOpts(..)
52+ , defaultCreateNetworkOpts
4253 , VolumePermission(..)
54+ , Bind(..)
4355 , Volume(..)
4456 , Device(..)
4557 , ContainerName
4658 , VolumeFrom(..)
4759 , Link(..)
4860 , LogDriverType(..)
49− , LogDriverOptions(..)
61+ , LogDriverOption(..)
5062 , LogDriverConfig(..)
5163 , NetworkMode(..)
5264 , PortType(..)
5365-- , NetworkInterface(..)
54− , Networks(..)
66+ , Network(..)
5567 , NetworkSettings(..)
5668 , NetworkOptions(..)
5769 , Mount(..)
5870 , PortBinding(..)
59− , PortBindings(..)
6071 , HostPort(..)
6172 , RetryCount
6273 , RestartPolicy(..)
@@ -64,6 +75,8 @@ module Docker.Client.Types (
6475 , UTSMode(..)
6576 , HostConfig(..)
6677 , defaultHostConfig
78+ , NetworkingConfig(..)
79+ , EndpointConfig(..)
6780 , Ulimit(..)
6881 , ContainerResources(..)
6982 , defaultContainerResources
@@ -73,9 +86,18 @@ module Docker.Client.Types (
7386 , EnvVar(..)
7487 , ContainerConfig(..)
7588 , defaultContainerConfig
76− , ExposedPorts(..)
89+ , ExposedPort(..)
7790 , DeviceWeight(..)
7891 , DeviceRate(..)
92+ , addPortBinding
93+ , addExposedPort
94+ , addBind
95+ , setCmd
96+ , addLink
97+ , addVolume
98+ , addVolumeFrom
99+ , MemoryConstraint(..)
100+ , MemoryConstraintSize(..)
79101 ) where
80102
81103import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
@@ -85,40 +107,57 @@ import qualified Data.Aeson as JSON
85107import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
86108import Data.Char (isAlphaNum, toUpper)
87109import qualified Data.HashMap.Strict as HM
88−import qualified Data.Map as M
89110import Data.Monoid ((<>))
111+import Data.Scientific (floatingOrInteger)
90112import Data.Text (Text)
91113import qualified Data.Text as T
92114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
93116import GHC.Generics (Generic)
94117import Prelude hiding (all, tail)
95118import Text.Read (readMaybe)
96119
120+-- | List of Docker Engine API endpoints
97121data Endpoint =
98122 VersionEndpoint
99123 | ListContainersEndpoint ListOpts
100124 | ListImagesEndpoint ListOpts
101− | CreateContainerEndpoint CreateOpts
125+ | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
102126 | StartContainerEndpoint StartOpts ContainerID
103127 | StopContainerEndpoint Timeout ContainerID
128+ | WaitContainerEndpoint ContainerID
104129 | KillContainerEndpoint Signal ContainerID
105130 | RestartContainerEndpoint Timeout ContainerID
106131 | PauseContainerEndpoint ContainerID
107132 | UnpauseContainerEndpoint ContainerID
108133 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
109134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
110− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
111136 | 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
112142 deriving (Eq, Show)
113143
144+-- | We should newtype this
114145type URL = Text
146+
147+-- | We should newtype this
115148type ApiVersion = Text
149+
150+
151+-- | ID of a contianer
116152newtype ContainerID = ContainerID Text
117153 deriving (Eq, Show)
118154
155+-- | Used for extracting the id of the container from the newtype
119156fromContainerID :: ContainerID -> Text
120157fromContainerID (ContainerID t) = t
121158
159+-- | Used for parsing a Text value into a ContainerID. We apply some basic
160+-- validation here.
122161toContainerID :: Text -> Maybe ContainerID
123162toContainerID t =
124163 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
@@ -126,12 +165,16 @@ toContainerID t =
126165 else
127166 Nothing
128167
168+-- ID of an image.
129169newtype ImageID = ImageID Text
130170 deriving (Eq, Show)
131171
172+-- | Used for extracting the id of the image from the newtype.
132173fromImageID :: ImageID -> Text
133174fromImageID (ImageID t) = t
134175
176+-- | Helper function used for parsing a Text value into an ImageID. For now
177+-- just basic validation is used.
135178toImageID :: Text -> Maybe ImageID
136179toImageID t =
137180 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
@@ -139,9 +182,26 @@ toImageID t =
139182 else
140183 Nothing
141184
185+-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
142186data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
143187
188+data StatusCode = StatusCode Int
189+
190+instance ToJSON StatusCode where
191+ toJSON (StatusCode c) = object ["StatusCode" .= c]
192+
193+instance FromJSON StatusCode where
194+ parseJSON (JSON.Object o) = do
195+ c <- o .: "StatusCode"
196+ if c >= 0 && c <= 255 then
197+ return (StatusCode c)
198+ else
199+ fail "Unknown exit code"
200+ parseJSON _ = fail "Unknown exit code"
201+
144202-- 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.
145205data Signal = SIGHUP
146206 | SIGINT
147207 | SIGQUIT
@@ -153,16 +213,16 @@ data Signal = SIGHUP
153213
154214instance FromJSON Signal where
155215 parseJSON (JSON.String "SIGTERM") = return SIGTERM
156− parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
157− parseJSON (JSON.String "SIGINT") = return SIGINT
216+ parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
217+ parseJSON (JSON.String "SIGINT") = return SIGINT
158218 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
159219 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
160220 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
161− parseJSON _ = fail "Unknown Signal"
221+ parseJSON _ = fail "Unknown Signal"
162222
163223instance ToJSON Signal where
164− toJSON SIGHUP = "SIGHUP"
165− toJSON SIGINT = "SIGINT"
224+ toJSON SIGHUP = "SIGHUP"
225+ toJSON SIGINT = "SIGINT"
166226 toJSON SIGQUIT = "SIGQUIT"
167227 toJSON SIGSTOP = "SIGSTOP"
168228 toJSON SIGTERM = "SIGTERM"
@@ -190,17 +250,19 @@ data ContainerDetails = ContainerDetails {
190250 , processLabel :: Text
191251 , resolveConfPath :: FilePath
192252 , restartCount :: Int
193− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
194254 , mounts :: [Mount]
195255 }
196256 deriving (Eq, Show, Generic)
197257
258+-- | Data type used for parsing the mount information from a container
259+-- list.
198260data Mount = Mount {
199− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
200262 , mountSource :: FilePath
201263 , mountDestination :: FilePath
202− , mountDriver :: Text
203− , mountMode :: Text -- Note: Improve this?
264+ , mountDriver :: Maybe Text
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
204266 , mountRW :: Bool
205267 , mountPropogation :: Text
206268 }
@@ -208,16 +270,18 @@ data Mount = Mount {
208270
209271instance FromJSON Mount where
210272 parseJSON (JSON.Object o) = do
211− name <- o .: "Name"
273+ name <- o .:? "Name"
212274 src <- o .: "Source"
213275 dest <- o .: "Destination"
214− driver <- o .: "Driver"
215− mode <- o .: "Mode"
276+ driver <- o .:? "Driver"
277+ -- mode <- o .: "Mode"
216278 rw <- o .: "RW"
217279 prop <- o .: "Propagation"
218− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
219281 parseJSON _ = fail "Mount is not an object"
220282
283+-- | Data type used for parsing the container state from a list of
284+-- containers.
221285data ContainerState = ContainerState {
222286 containerError :: Text
223287 , exitCode :: Int
@@ -229,7 +293,7 @@ data ContainerState = ContainerState {
229293 , restarting :: Bool
230294 , running :: Bool
231295 , startedAt :: UTCTime
232− , status :: Status
296+ , state :: State
233297 }
234298 deriving (Eq, Show, Generic)
235299
@@ -249,23 +313,30 @@ instance FromJSON ContainerState where
249313 return $ ContainerState err exit finished oomKilled dead paused pid restarting running started st
250314 parseJSON _ = fail "ContainerState is not an object"
251315
316+
317+-- | Client options used to configure the remote engine we're talking to
252318data DockerClientOpts = DockerClientOpts {
253319 apiVer :: ApiVersion
254320 , baseUrl :: URL
255321 }
256322 deriving (Eq, Show)
257323
324+-- | Default "DockerClientOpts" used for talking to the docker engine.
258325defaultClientOpts :: DockerClientOpts
259326defaultClientOpts = DockerClientOpts {
260327 apiVer = "v1.24"
261328 , baseUrl = "http://127.0.0.1:2375"
262329 }
263330
331+-- | List options used for filtering the list of container or images.
264332data ListOpts = ListOpts { all :: Bool } deriving (Eq, Show)
265333
334+-- | Default "ListOpts". Doesn't list stopped containers.
266335defaultListOpts :: ListOpts
267336defaultListOpts = ListOpts { all=False }
268337
338+-- | Data type used for represneting the version of the docker engine
339+-- remote API.
269340data DockerVersion = DockerVersion {
270341 version :: Text
271342 , apiVersion :: ApiVersion
@@ -335,6 +406,8 @@ instance FromJSON ImageID where
335406 return iid
336407 parseJSON _ = fail "ImageID is not an object."
337408
409+-- | Data type used for representing the information of various ports that
410+-- a contianer may expose.
338411data ContainerPortInfo = ContainerPortInfo {
339412 ipAddressInfo :: Maybe Text
340413 , privatePortInfo :: Port
@@ -351,6 +424,8 @@ instance FromJSON ContainerPortInfo where
351424 parseJSON _ = fail "ContainerPortInfo: Not a JSON object."
352425
353426-- For inspecting container details.
427+-- | Data type used for parsing the network information of each container
428+-- when listing them.
354429data NetworkOptions = NetworkOptions {
355430-- ipamConfig :: Maybe Text -- Don't see in 1.24
356431-- , links :: Maybe Text -- Don't see in 1.24
@@ -380,29 +455,28 @@ instance FromJSON NetworkOptions where
380455 return $ NetworkOptions networkId endpointId gateway ip ipLen ip6Gateway globalIP6 globalIP6Len mac
381456 parseJSON _ = fail "NetworkOptions is not an object"
382457
383−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
384460 deriving (Eq, Show)
385461
386−instance FromJSON Networks where
387− parseJSON (JSON.Object o) = do
388− Networks <$> HM.foldlWithKey' f (return M.empty) o
389−
462+instance {-# OVERLAPPING #-} FromJSON [Network] where
463+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
390464 where
391465 f accM k' v' = do
392466 acc <- accM
393467 k <- parseJSON $ JSON.String k'
394468 v <- parseJSON v'
395− return $ M.insert k v acc
396−
469+ return $ (Network k v):acc
397470 parseJSON _ = fail "Networks is not an object"
398471
472+-- | Data type reprsenting the various network settings a container can have.
399473data NetworkSettings = NetworkSettings {
400474 networkSettingsBridge :: Text
401475 , networkSettingsSandboxId :: Text
402476 , networkSettingsHairpinMode :: Bool
403477 , networkSettingsLinkLocalIPv6Address :: Text
404478 , networkSettingsLinkLocalIPv6PrefixLen :: Int
405− , networkSettingsPorts :: PortBindings
479+ , networkSettingsPorts :: [PortBinding]
406480 , networkSettingsSandboxKey :: Text
407481 , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
408482 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
@@ -414,7 +488,7 @@ data NetworkSettings = NetworkSettings {
414488 , networkSettingsIpPrefixLen :: Int
415489 , networkSettingsIpv6Gateway :: Text
416490 , networkSettingsMacAddress :: Text
417− , networkSettingsNetworks :: Networks
491+ , networkSettingsNetworks :: [Network]
418492 }
419493 deriving (Eq, Show)
420494
@@ -441,6 +515,7 @@ instance FromJSON NetworkSettings where
441515 return $ NetworkSettings bridge sandbox hairpin localIP6 localIP6Len ports sandboxKey secondaryIP secondayIP6 endpointID gateway globalIP6 globalIP6Len ip ipLen ip6Gateway mac networks
442516 parseJSON _ = fail "NetworkSettings is not an object."
443517
518+-- | Data type used for parsing a list of containers.
444519data Container = Container
445520 { containerId :: ContainerID
446521 , containerNames :: [Text]
@@ -448,21 +523,23 @@ data Container = Container
448523 , containerImageId :: ImageID
449524 , containerCommand :: Text
450525 , containerCreatedAt :: Int
451− , containerStatus :: Status
526+ , containerState :: State
527+ , containerStatus :: Maybe Text
452528 , containerPorts :: [ContainerPortInfo]
453− , containerLabels :: Labels
454− , containerNetworks :: Networks
529+ , containerLabels :: [Label]
530+ , containerNetworks :: [Network]
455531 , containerMounts :: [Mount]
456532 } deriving (Show, Eq)
457533
458534instance FromJSON Container where
459− parseJSON (JSON.Object v) =
460− Container <$> (v .: "Id")
535+ parseJSON o@(JSON.Object v) =
536+ Container <$> parseJSON o
461537 <*> (v .: "Names")
462538 <*> (v .: "Image")
463− <*> (v .: "ImageID")
464− <*> (v .: "Command")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
540+ <*> (v .: "Command") -- Doesn't exist anymore
465541 <*> (v .: "Created")
542+ <*> (v .: "State")
466543 <*> (v .: "Status")
467544 <*> (v .: "Ports")
468545 <*> (v .: "Labels")
@@ -472,65 +549,124 @@ instance FromJSON Container where
472549 parseNetworks (JSON.Object v) =
473550 (v .: "Networks") >>= parseJSON
474551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
475−
476552 parseJSON _ = fail "Container: Not a JSON object."
477553
478−data Status = Created | Restarting | Running | Paused | Exited | Dead
554+-- | Represents the state of the container life cycle.
555+data State = Created | Restarting | Running | Paused | Exited | Dead
479556 deriving (Eq, Show, Generic)
480557
481−instance FromJSON Status where
482− parseJSON (JSON.String "running") = return Running
483− parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
558+instance FromJSON State where
559+ parseJSON (JSON.String "running") = return Running
560+ parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
484561 parseJSON (JSON.String "restarting") = return Restarting
485− parseJSON (JSON.String "paused") = return Paused
486− parseJSON (JSON.String "exited") = return Exited
487− parseJSON (JSON.String "dead") = return Dead
488− parseJSON _ = fail "Unknown Status"
562+ parseJSON (JSON.String "paused") = return Paused
563+ parseJSON (JSON.String "exited") = return Exited
564+ parseJSON (JSON.String "dead") = return Dead
565+ parseJSON s = fail $ "Unknown Status: " ++ show s
489566
567+-- | Alias for representing a RepoDigest. We could newtype this and add
568+-- some validation.
490569type Digest = Text
491570
492−newtype Labels = Labels (M.Map Name Value) deriving (Eq, Show)
571+-- | Container and Image Labels.
572+data Label = Label Name Value deriving (Eq, Show)
573+
493574
494−instance FromJSON Labels where
495− parseJSON val = Labels <$> parseJSON val
575+-- If there are multiple lables with the same Name in the list
576+-- then the last one wins.
577+instance {-# OVERLAPPING #-} ToJSON [Label] where
578+ toJSON [] = emptyJsonObject
579+ toJSON (l:ls) = toJsonKeyVal (l:ls) key val
580+ where key (Label k _) = T.unpack k
581+ val (Label _ v) = v
496582
497−instance ToJSON Labels where
498− toJSON (Labels kvs) = object [k .= v | (k,v) <- (M.toList kvs)]
583+instance {-# OVERLAPPING #-} FromJSON [Label] where
584+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
585+ where f accM k v = do
586+ acc <- accM
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."
499591
592+-- | Alias for Tags.
500593type Tag = Text
501594
595+-- | Data type used for parsing information from a list of images.
502596data Image = DockerImage {
503597 imageId :: ImageID
504598 , imageCreated :: Integer
505599 , imageParentId :: Maybe ImageID
506600 , imageRepoTags :: [Tag]
507− , imageRepoDigests :: Maybe [Digest]
601+ , imageRepoDigests :: [Digest]
508602 , imageSize :: Integer
509603 , imageVirtualSize :: Integer
510− , imageLabels :: Maybe Labels
604+ , imageLabels :: [Label]
511605 } deriving (Show, Eq, Generic)
512606
607+-- | Helper function used for dropping the "image" prefix when serializing
608+-- the Image data type to and from json.
513609dropImagePrefix :: [a] -> [a]
514610dropImagePrefix = drop 5
515611
516−instance FromJSON Image where
517− parseJSON = genericParseJSON defaultOptions {
518− fieldLabelModifier = dropImagePrefix}
519612
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."
625+
626+-- | Alias for Aliases.
627+type Alias = Text
628+
629+-- | EndpointsConfig is container configuration for a specific network
630+newtype EndpointConfig = EndpointConfig [Alias] deriving (Eq, Show)
631+
632+instance ToJSON EndpointConfig where
633+ toJSON (EndpointConfig aliases) = JSON.object
634+ [ "Aliases" .= aliases
635+ ]
636+
637+-- | Alias for endpoint name
638+type EndpointName = Text
639+
640+-- | Data type for the NetworkingConfig section of the container settings
641+newtype NetworkingConfig = NetworkingConfig
642+ { endpointsConfig :: HM.HashMap EndpointName EndpointConfig
643+ } deriving (Eq, Show)
644+
645+instance ToJSON NetworkingConfig where
646+ toJSON (NetworkingConfig endpointsConfig) = JSON.object
647+ [ "EndpointsConfig" .= endpointsConfig
648+ ]
649+
650+-- | Options used for creating a Container.
520651data CreateOpts = CreateOpts {
521− containerConfig :: ContainerConfig
522− , hostConfig :: HostConfig
652+ containerConfig :: ContainerConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
523655 } deriving (Eq, Show)
524656
525657instance ToJSON CreateOpts where
526− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
527659 let ccJSON = toJSON cc
528660 let hcJSON = toJSON hc
529661 case ccJSON of
530662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
531− JSON.Object $ HM.insert "HostConfig" hcJSON o
663+ let o1 = HM.insert "HostConfig" hcJSON o
664+ let o2 = HM.insert "NetworkingConfig" (toJSON nc) o1
665+ JSON.Object o2
532666 _ -> error "ContainerConfig is not an object." -- This should never happen.
533667
668+-- | Container configuration used for creating a container with sensible
669+-- defaults.
534670defaultContainerConfig :: Text -> ContainerConfig
535671defaultContainerConfig imageName = ContainerConfig {
536672 hostname=Nothing
@@ -540,28 +676,29 @@ defaultContainerConfig imageName = ContainerConfig {
540676 , attachStdout=False
541677 , image=imageName
542678 , attachStderr=False
543− , exposedPorts=Nothing -- ExposedPorts M.empty
679+ , exposedPorts=[]
544680 , tty=False
545681 , openStdin=False
546682 , stdinOnce=False
547683 , env=[]
548684 , cmd=[]
549− , volumes=Nothing
685+ , volumes=[]
550686 , workingDir=Nothing
551− , entrypoint=Nothing
687+ , entrypoint=Entrypoint []
552688 , networkDisabled=Nothing
553689 , macAddress=Nothing
554− , labels=Nothing
690+ , labels=[]
555691 , stopSignal=SIGTERM
556692 }
557693
694+-- | Default host confiratuon used for creating a container.
558695defaultHostConfig :: HostConfig
559696defaultHostConfig = HostConfig {
560697 binds=[]
561698 , containerIDFile=Nothing
562− , logConfig=LogDriverConfig JsonFile Nothing
563− , networkMode=Bridge
564− , portBindings=PortBindings []
699+ , logConfig=LogDriverConfig JsonFile []
700+ , networkMode=NetworkBridge
701+ , portBindings=[]
565702 , restartPolicy=RestartOff
566703 , volumeDriver=Nothing
567704 , volumesFrom=[]
@@ -582,6 +719,7 @@ defaultHostConfig = HostConfig {
582719 , resources=defaultContainerResources
583720 }
584721
722+-- Default container resource contstraints (None).
585723defaultContainerResources :: ContainerResources
586724defaultContainerResources = ContainerResources {
587725 cpuShares=Nothing
@@ -599,34 +737,80 @@ defaultContainerResources = ContainerResources {
599737 , memory=Nothing
600738 , memoryReservation=Nothing
601739 , memorySwap=Nothing
602− , oomKillDisable=False
740+ , oomKillDisable=Just False
603741 , ulimits=[]
604742 }
605743
606−
744+-- | Default create options when creating a container. You only need to
745+-- specify an image name and the rest is all sensible defaults.
607746defaultCreateOpts :: T.Text -> CreateOpts
608−defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
747+defaultCreateOpts imageName = CreateOpts
748+ { containerConfig = defaultContainerConfig imageName
749+ , hostConfig = defaultHostConfig
750+ , networkingConfig = NetworkingConfig HM.empty
751+ }
609752
610−-- detachKeys – Override the key sequence for detaching a container.
753+-- | Override the key sequence for detaching a container.
611754-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
612755data DetachKeys = WithCtrl Char | WithoutCtrl Char | DefaultDetachKey deriving (Eq, Show)
613756
757+-- | Options for starting a container.
614758data StartOpts = StartOpts { detachKeys :: DetachKeys } deriving (Eq, Show)
615759
760+-- | Default options for staring a container.
616761defaultStartOpts :: StartOpts
617762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
618763
619−data DeleteOpts = DeleteOpts {
764+-- | Options for deleting a container.
765+data ContainerDeleteOpts = ContainerDeleteOpts {
620766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
621767 , force :: Bool -- ^ If the container is still running force deletion anyway.
622768 } deriving (Eq, Show)
623769
624−defaultDeleteOpts :: DeleteOpts
625−defaultDeleteOpts = DeleteOpts { deleteVolumes = False, force = False }
626−
770+-- TODO: Add support for container build constraints
771+-- | Options for when building images from a Dockerfile
772+data BuildOpts = BuildOpts {
773+ buildImageName :: Text -- ^ Image name in the form of name:tag; ie. myimage:latest.:w
774+ , buildDockerfileName :: Text -- ^ Name of dockerfile (default: Dockerfile)
775+ , buildQuiet :: Bool
776+ , buildNoCache :: Bool -- ^ Do not use cache when building the image.
777+ , buildRemoveItermediate :: Bool -- ^ Remove intermediate containers after a successful build (default true).
778+ , buildForceRemoveIntermediate :: Bool -- ^ Always remove intermediate containers.
779+ , buildPullParent :: Bool -- ^ Always attempt to pull a newer version of the *parent* image (ie. FROM debian:jessie).
780+ } deriving (Eq, Show)
781+
782+defaultBuildOpts :: Text -> BuildOpts
783+defaultBuildOpts nameTag = BuildOpts { buildImageName = nameTag
784+ , buildDockerfileName = "Dockerfile"
785+ , buildQuiet = False
786+ , buildNoCache = False
787+ , buildRemoveItermediate = True
788+ , buildForceRemoveIntermediate = False
789+ , buildPullParent = False
790+ }
791+
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
794+-- running.
795+defaultContainerDeleteOpts :: ContainerDeleteOpts
796+defaultContainerDeleteOpts = ContainerDeleteOpts { deleteVolumes = False, force = False }
797+
798+-- | Image delete opts
799+data ImageDeleteOpts = ImageDeleteOpts deriving (Eq, Show)
800+
801+-- | Sane image deletion defaults
802+defaultImageDeleteOpts :: ImageDeleteOpts
803+defaultImageDeleteOpts = ImageDeleteOpts
804+
805+-- | Timestamp alias.
627806type Timestamp = Integer
807+
808+-- | Used for requesting N number of lines when tailing a containers log
809+-- output.
628810data TailLogOpt = Tail Integer | All deriving (Eq, Show)
629811
812+
813+-- | Log options used when requesting the log output from a container.
630814data LogOpts = LogOpts {
631815 stdout :: Bool
632816 , stderr :: Bool
@@ -635,6 +819,7 @@ data LogOpts = LogOpts {
635819 , tail :: TailLogOpt
636820 } deriving (Eq, Show)
637821
822+-- | Sensible default for log options.
638823defaultLogOpts :: LogOpts
639824defaultLogOpts = LogOpts { stdout = True
640825 , stderr = True
@@ -643,37 +828,87 @@ defaultLogOpts = LogOpts { stdout = True
643828 , tail = All
644829 }
645830
646−data VolumePermission = Rw | Ro deriving (Eq, Show, Generic)
647−
648−-- instance ToJSON VolumePermission where
649−-- toJSON = error "TODO"
650−-- instance FromJSON VolumePermission where
651−-- parseJSON = error "TODO"
652−
653−-- Note: Note really sure what this should be (1.24).
654−-- This is not the same as [Volume] in HostConfig.
655−newtype Volumes = Volumes [Text] -- [Volume]
656− deriving (Eq, Show)
657−
658−instance FromJSON Volumes where
659− parseJSON (JSON.Object o) = return $ Volumes $ HM.keys o
660− parseJSON _ = fail "Volumes is not an object"
661−
662−instance ToJSON Volumes where
663− toJSON (Volumes vs) = toJSON vs
664−
665−data Volume = Volume { hostSrc :: Text
666− , containerDest :: Text
667− , volumePermission :: Maybe VolumePermission
668− } deriving (Eq, Show)
831+-- | Options for creating a network
832+data CreateNetworkOpts = CreateNetworkOpts
833+ { createNetworkName :: Text -- ^ The network's name
834+ , createNetworkCheckDuplicate :: Bool -- ^ Check for networks with duplicate names.
835+ , createNetworkDriver :: Text -- ^ Name of the network driver plugin to use.
836+ , createNetworkInternal :: Bool -- ^ Restrict external access to the network.
837+ , createNetworkEnableIPv6 :: Bool -- ^ Enable IPv6 on the network.
838+ } deriving (Eq, Show)
839+
840+-- | Sensible defalut for create network options
841+defaultCreateNetworkOpts :: Text -> CreateNetworkOpts
842+defaultCreateNetworkOpts name =
843+ CreateNetworkOpts
844+ { createNetworkName = name
845+ , createNetworkCheckDuplicate = False
846+ , createNetworkDriver = "bridge"
847+ , createNetworkInternal = True
848+ , createNetworkEnableIPv6 = False
849+ }
850+
851+instance ToJSON CreateNetworkOpts where
852+ toJSON opts =
853+ object
854+ [ "Name" .= createNetworkName opts
855+ , "CheckDuplicate" .= createNetworkCheckDuplicate opts
856+ , "Driver" .= createNetworkDriver opts
857+ , "Internal" .= createNetworkInternal opts
858+ , "EnableIPv6" .= createNetworkEnableIPv6 opts
859+ ]
860+
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.
863+data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
864+
865+instance ToJSON VolumePermission where
866+ toJSON ReadWrite = "rw"
867+ toJSON ReadOnly = "ro"
868+
869+instance FromJSON VolumePermission where
870+ parseJSON "rw" = return ReadWrite
871+ parseJSON "ro" = return ReadOnly
872+ parseJSON "RW" = return ReadWrite
873+ parseJSON "RO" = return ReadOnly
874+ parseJSON _ = fail "Failed to parse VolumePermission"
875+
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
880+-- driver used).
881+-- The CLI example is:
882+--
883+-- @
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"
886+-- @
887+newtype Volume = Volume FilePath deriving (Eq, Show)
888+
889+instance {-# OVERLAPPING #-} ToJSON [Volume] where
890+ toJSON [] = emptyJsonObject
891+ toJSON (v:vs) = toJsonKey (v:vs) getKey
892+ where getKey (Volume v) = v
893+
894+instance {-# OVERLAPPING #-} FromJSON [Volume] where
895+ parseJSON (JSON.Object o) = return $ map (Volume . T.unpack) $ HM.keys o
896+ parseJSON (JSON.Null) = return []
897+ parseJSON _ = fail "Volume is not an object"
898+
899+
900+data Bind = Bind { hostSrc :: Text
901+ , containerDest :: Text
902+ , volumePermission :: Maybe VolumePermission
903+ } deriving (Eq, Show)
669904
670−instance FromJSON Volume where
905+instance FromJSON Bind where
671906 parseJSON (JSON.String t) = case T.split (== ':') t of
672− [src, dest] -> return $ Volume src dest Nothing
673− [src, dest, "rw"] -> return $ Volume src dest $ Just Rw
674− [src, dest, "ro"] -> return $ Volume src dest $ Just Ro
675− _ -> fail "Could not parse Volume"
676− parseJSON _ = fail "Volume is not a string"
907+ [src, dest] -> return $ Bind src dest Nothing
908+ [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
909+ [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
910+ _ -> fail "Could not parse Bind"
911+ parseJSON _ = fail "Bind is not a string"
677912
678913data Device = Device {
679914 pathOnHost :: FilePath
@@ -695,19 +930,19 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
695930
696931instance FromJSON VolumeFrom where
697932 parseJSON (JSON.String t) = case T.split (== ':') t of
698− [vol] -> return $ VolumeFrom vol Nothing
699− [vol, "rw"] -> return $ VolumeFrom vol $ Just Rw
700− [vol, "ro"] -> return $ VolumeFrom vol $ Just Ro
701− _ -> fail "Could not parse VolumeFrom"
933+ [vol] -> return $ VolumeFrom vol Nothing
934+ [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
935+ [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
936+ _ -> fail "Could not parse VolumeFrom"
702937 parseJSON _ = fail "VolumeFrom is not a string"
703938
704939instance ToJSON VolumeFrom where
705940 toJSON (VolumeFrom n p) = case p of
706− Nothing -> toJSON $ n <> ":" <> "rw"
941+ Nothing -> toJSON $ n <> ":" <> "rw"
707942 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
708943
709−instance ToJSON Volume where
710− toJSON (Volume src dest mode) = toJSON $ case mode of
944+instance ToJSON Bind where
945+ toJSON (Bind src dest mode) = toJSON $ case mode of
711946 Nothing -> T.concat[src, ":", dest]
712947 Just m -> T.concat[src, ":", dest, ":", (T.pack $ show m)]
713948
@@ -715,63 +950,63 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
715950
716951instance FromJSON Link where
717952 parseJSON (JSON.String t) = case T.split (== ':') t of
718− [f] -> return $ Link f Nothing
953+ [f] -> return $ Link f Nothing
719954 [f,s] -> return $ Link f $ Just s
720− _ -> fail "Could not parse Link"
955+ _ -> fail "Could not parse Link"
721956 parseJSON _ = fail "Link is not a string"
722957
723958instance ToJSON Link where
724959 toJSON (Link n1 n2) = toJSON $ case n2 of
725960 Nothing -> T.concat[n1, ":", n1] -- use same name in container
726− Just n -> T.concat[n1, ":", n] -- used specified name in container
961+ Just n -> T.concat[n1, ":", n] -- used specified name in container
727962
728963-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
729964data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
730965
731966instance FromJSON LogDriverType where
732967 parseJSON (JSON.String "json-file") = return JsonFile
733− parseJSON (JSON.String "syslog") = return Syslog
734− parseJSON (JSON.String "journald") = return Journald
735− parseJSON (JSON.String "gelf") = return Gelf
736− parseJSON (JSON.String "fluentd") = return Fluentd
737− parseJSON (JSON.String "awslogs") = return AwsLogs
738− parseJSON (JSON.String "splunk") = return Splunk
739− parseJSON (JSON.String "etwlogs") = return Etwlogs
740− parseJSON (JSON.String "none") = return LoggingDisabled
741− parseJSON _ = fail "Unknown LogDriverType"
968+ parseJSON (JSON.String "syslog") = return Syslog
969+ parseJSON (JSON.String "journald") = return Journald
970+ parseJSON (JSON.String "gelf") = return Gelf
971+ parseJSON (JSON.String "fluentd") = return Fluentd
972+ parseJSON (JSON.String "awslogs") = return AwsLogs
973+ parseJSON (JSON.String "splunk") = return Splunk
974+ parseJSON (JSON.String "etwlogs") = return Etwlogs
975+ parseJSON (JSON.String "none") = return LoggingDisabled
976+ parseJSON _ = fail "Unknown LogDriverType"
742977
743978instance ToJSON LogDriverType where
744− toJSON JsonFile = JSON.String "json-file"
745− toJSON Syslog = JSON.String "syslog"
746− toJSON Journald = JSON.String "journald"
747− toJSON Gelf = JSON.String "gelf"
748− toJSON Fluentd = JSON.String "fluentd"
749− toJSON AwsLogs = JSON.String "awslogs"
750− toJSON Splunk = JSON.String "splunk"
751− toJSON Etwlogs = JSON.String "etwlogs"
979+ toJSON JsonFile = JSON.String "json-file"
980+ toJSON Syslog = JSON.String "syslog"
981+ toJSON Journald = JSON.String "journald"
982+ toJSON Gelf = JSON.String "gelf"
983+ toJSON Fluentd = JSON.String "fluentd"
984+ toJSON AwsLogs = JSON.String "awslogs"
985+ toJSON Splunk = JSON.String "splunk"
986+ toJSON Etwlogs = JSON.String "etwlogs"
752987 toJSON LoggingDisabled = JSON.String "none"
753988
754−newtype LogDriverOptions = LogDriverOptions (M.Map Text Text) deriving (Eq, Show)
989+data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
755990
756−instance FromJSON LogDriverOptions where
757− parseJSON (JSON.Object o) = do
758− LogDriverOptions <$> HM.foldlWithKey' f (return M.empty) o
991+instance {-# OVERLAPPING #-} ToJSON [LogDriverOption] where
992+ toJSON [] = emptyJsonObject
993+ toJSON (o:os) = toJsonKeyVal (o:os) key val
994+ where key (LogDriverOption n _) = T.unpack n
995+ val (LogDriverOption _ v) = v
759996
760− where
761− f accM k (JSON.String v) = do
997+instance {-# OVERLAPPING #-} FromJSON [LogDriverOption] where
998+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
999+ where f accM k v = do
7621000 acc <- accM
763− return $ M.insert k v acc
764− f _ _ _ = fail "Value of LogDriverOptions is not a string"
765−
766− parseJSON JSON.Null = return $ LogDriverOptions M.empty
767− parseJSON _ = fail "LogDriverOptions is not an object"
1001+ value <- parseJSON v
1002+ return $ (LogDriverOption k value):acc
1003+ parseJSON JSON.Null = return []
1004+ parseJSON _ = fail "Failed to parse LogDriverOptions"
7681005
769−instance ToJSON LogDriverOptions where
770− toJSON (LogDriverOptions mp) = toJSON mp
771−
772−data LogDriverConfig = LogDriverConfig LogDriverType (Maybe LogDriverOptions) deriving (Eq, Show)
1006+data LogDriverConfig = LogDriverConfig LogDriverType [LogDriverOption] deriving (Eq, Show)
7731007
7741008instance ToJSON LogDriverConfig where
1009+ toJSON (LogDriverConfig driverType []) = object ["Type" .= driverType]
7751010 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
7761011
7771012instance FromJSON LogDriverConfig where
@@ -782,21 +1017,47 @@ instance FromJSON LogDriverConfig where
7821017 parseJSON _ = fail "LogDriverConfig is not an object"
7831018
7841019-- TODO: Add container:<name|id> mode
785−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
7861021 deriving (Eq, Show, Ord)
7871022
7881023instance FromJSON NetworkMode where
789− parseJSON (JSON.String "bridge") = return Bridge
790− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
791− parseJSON (JSON.String "none") = return NetworkDisabled
792− parseJSON _ = fail "Unknown NetworkMode"
1024+ parseJSON (JSON.String "bridge") = return NetworkBridge
1025+ parseJSON (JSON.String "host") = return NetworkHost -- Note: Guessing on these.
1026+ parseJSON (JSON.String "none") = return NetworkDisabled
1027+ parseJSON (JSON.String n) = return $ NetworkNamed n
1028+ parseJSON _ = fail "Unknown NetworkMode"
7931029
7941030instance ToJSON NetworkMode where
795− toJSON Bridge = JSON.String "bridge"
796− toJSON Host = JSON.String "host"
1031+ toJSON NetworkBridge = JSON.String "bridge"
1032+ toJSON NetworkHost = JSON.String "host"
7971033 toJSON NetworkDisabled = JSON.String "none"
1034+ toJSON (NetworkNamed n) = JSON.String n
1035+
1036+newtype NetworkID = NetworkID Text
1037+ deriving (Eq, Show)
1038+
1039+-- | Used for extracting the id of the container from the newtype
1040+fromNetworkID :: NetworkID -> Text
1041+fromNetworkID (NetworkID t) = t
1042+
1043+-- | Used for parsing a Text value into a NetworkID.
1044+toNetworkID :: Text -> Maybe NetworkID
1045+toNetworkID t = Just $ NetworkID t
7981046
799−data PortType = TCP | UDP deriving (Eq, Show, Generic, Read, Ord)
1047+instance FromJSON NetworkID where
1048+ parseJSON (JSON.Object o) = do
1049+ nid <- o .: "Id"
1050+ return $ NetworkID nid
1051+ parseJSON _ = fail "NetworkID is not an object."
1052+
1053+instance ToJSON NetworkID where
1054+ toJSON (NetworkID nid) = object ["Id" .= nid]
1055+
1056+data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
1057+
1058+instance Show PortType where
1059+ show TCP = "tcp"
1060+ show UDP = "udp"
8001061
8011062instance ToJSON PortType where
8021063 toJSON TCP = "tcp"
@@ -806,7 +1067,7 @@ instance FromJSON PortType where
8061067 parseJSON val = case val of
8071068 "tcp" -> return TCP
8081069 "udp" -> return UDP
809− _ -> fail "PortType: Invalid port type."
1070+ _ -> fail "PortType: Invalid port type."
8101071
8111072-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
8121073--
@@ -821,9 +1082,8 @@ instance FromJSON PortType where
8211082-- host system s that the service running in the container can be accessed from
8221083-- the outside world. We either map a port onto all interfaces (default) or onto a specific
8231084-- interface like `127.0.0.1`.
824−newtype PortBindings = PortBindings [PortBinding]
825− deriving (Eq, Show)
826−
1085+-- __NOTE__: We should disallow duplicate port bindings as the ToJSON
1086+-- instance will only send the last one.
8271087-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
8281088data PortBinding = PortBinding {
8291089 containerPort :: Port
@@ -831,17 +1091,65 @@ data PortBinding = PortBinding {
8311091 , hostPorts :: [HostPort]
8321092 } deriving (Eq, Show)
8331093
834−
8351094portAndType2Text :: Port -> PortType -> Text
8361095portAndType2Text p t = (T.pack $ show p) <> "/" <> (T.pack $ show t)
8371096
838−instance ToJSON PortBinding where
839− toJSON (PortBinding {..}) = object [portAndType2Text containerPort portType .= hostPorts]
840−
841−instance FromJSON PortBindings where
842− parseJSON (JSON.Object o) = do
843− PortBindings <$> HM.foldlWithKey' f (return []) o
8441097
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
1104+
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
1110+
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
1117+
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
1123+ oldvs = volumes cc
1124+
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
1131+
1132+-- | A convenience function that adds PortBindings to and exiting
1133+-- "CreateOpts" record. Useful with 'defaultCreateOpts'
1134+-- Example:
1135+--
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
1142+
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
1149+
1150+
1151+instance {-# OVERLAPPING #-} FromJSON [PortBinding] where
1152+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
8451153 where
8461154 f accM k v = case T.split (== '/') k of
8471155 [port', portType'] -> do
@@ -850,13 +1158,15 @@ instance FromJSON PortBindings where
8501158 acc <- accM
8511159 hps <- parseJSON v
8521160 return $ (PortBinding port portType hps):acc
853− _ ->
854− fail "Could not parse PortBindings"
1161+ _ -> fail "Could not parse PortBindings"
1162+ parseJSON (JSON.Null) = return []
8551163 parseJSON _ = fail "PortBindings is not an object"
8561164
857−instance ToJSON PortBindings where
858− toJSON (PortBindings []) = JSON.Object HM.empty
859− toJSON (PortBindings (p:ps)) = toJSON (p:ps)
1165+instance {-# OVERLAPPING #-} ToJSON [PortBinding] where
1166+ toJSON [] = emptyJsonObject
1167+ toJSON (p:ps) = toJsonKeyVal (p:ps) key val
1168+ where key p = T.unpack $ portAndType2Text (containerPort p) (portType p)
1169+ val p = hostPorts p
8601170
8611171data HostPort = HostPort {
8621172 hostIp :: Text
@@ -874,24 +1184,6 @@ instance FromJSON HostPort where
8741184 return $ HostPort i p
8751185 parseJSON _ = fail "HostPort is not an object."
8761186
877−-- newtype HostPorts = HostPorts [HostPort]
878−-- deriving (Eq, Show)
879−--
880−-- instance ToJSON HostPorts where
881−-- toJSON (HostPorts hps) = toJSON hps
882−--
883−-- instance FromJSON HostPorts where
884−-- parseJSON (JSON.Object o) = do
885−-- HostPorts <$> HM.foldlWithKey' f (return []) o
886−--
887−-- where
888−-- f accM k v = do
889−-- acc <- accM
890−-- p' <- parseJSON v
891−-- p <- parseIntegerText p'
892−-- return $ (HostPort (NetworkInterface k) p):acc
893−-- parseJSON _ = fail $ "HostPorts is not an object"
894−
8951187-- { "Name": "on-failure" , "MaximumRetryCount": 2}
8961188type RetryCount = Integer
8971189data RestartPolicy = RestartAlways | RestartUnlessStopped | RestartOnFailure RetryCount | RestartOff deriving (Eq, Show)
@@ -905,7 +1197,7 @@ instance FromJSON RestartPolicy where
9051197 "on-failure" -> do
9061198 retry <- o .: "MaximumRetryCount"
9071199 return $ RestartOnFailure retry
908− "off" -> return RestartOff
1200+ "no" -> return RestartOff
9091201 _ -> fail "Could not parse RestartPolicy"
9101202 parseJSON _ = fail "RestartPolicy is not an object"
9111203
@@ -913,7 +1205,7 @@ instance ToJSON RestartPolicy where
9131205 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
9141206 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
9151207 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
916− toJSON RestartOff = object ["Name" .= JSON.String "off"]
1208+ toJSON RestartOff = object ["Name" .= JSON.String "no"]
9171209
9181210data Isolation = Default | Process | Hyperv deriving (Eq, Show)
9191211
@@ -923,11 +1215,11 @@ newtype UTSMode = UTSMode Text deriving (Eq, Show)
9231215-- TODO: Add UTSMode : UTS namespace to use for the container
9241216-- TODO: Sysctls map[string]string `json:",omitempty"` // List of Namespaced sysctls used for the container
9251217data HostConfig = HostConfig
926− { binds :: [Volume]
1218+ { binds :: [Bind]
9271219 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
9281220 , logConfig :: LogDriverConfig
9291221 , networkMode :: NetworkMode
930− , portBindings :: PortBindings
1222+ , portBindings :: [PortBinding]
9311223 , restartPolicy :: RestartPolicy
9321224 , volumeDriver :: Maybe Text
9331225 , volumesFrom :: [VolumeFrom]
@@ -1086,6 +1378,22 @@ instance ToJSON DeviceRate where
10861378 , "Rate" .= r
10871379 ]
10881380
1381+data MemoryConstraintSize = B | MB | GB deriving (Eq, Show)
1382+
1383+data MemoryConstraint = MemoryConstraint Integer MemoryConstraintSize deriving (Eq, Show)
1384+
1385+instance ToJSON MemoryConstraint where
1386+ toJSON (MemoryConstraint x B) = toJSON x
1387+ toJSON (MemoryConstraint x MB) = toJSON $ x * 1024 * 1024
1388+ toJSON (MemoryConstraint x GB) = toJSON $ x * 1024 * 1024 * 1024
1389+
1390+instance FromJSON MemoryConstraint where
1391+ parseJSON (JSON.Number x) = case (floatingOrInteger x) of
1392+ Left (_ :: Double) -> fail "Failed to parse MemoryConstraint"
1393+ Right i -> return $ MemoryConstraint i B
1394+ -- The docker daemon will always return the number as bytes (integer), regardless of how we set them (using MB or GB)
1395+ parseJSON _ = fail "Failed to parse MemoryConstraint"
1396+
10891397data ContainerResources = ContainerResources {
10901398 cpuShares :: Maybe Integer
10911399 -- , cgroupParent :: Text -- 1.24: Missing from inspecting container details... Going to omit for now.
@@ -1101,12 +1409,12 @@ data ContainerResources = ContainerResources {
11011409 , cpusetMems :: Maybe Text
11021410 , devices :: [Device]
11031411 -- , diskQuota :: Integer -- Don't see this ins 1.24.
1104− , kernelMemory :: Maybe Integer
1105− , memory :: Maybe Integer
1106− , memoryReservation :: Maybe Integer
1107− , memorySwap :: Maybe Integer
1412+ , kernelMemory :: Maybe MemoryConstraint
1413+ , memory :: Maybe MemoryConstraint
1414+ , memoryReservation :: Maybe MemoryConstraint
1415+ , memorySwap :: Maybe MemoryConstraint
11081416 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1109− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
11101418 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
11111419 , ulimits :: [Ulimit]
11121420 -- TODO: Missing from 1.24
@@ -1144,41 +1452,59 @@ instance FromJSON EnvVar where
11441452 parseJSON _ = fail "EnvVar is not a string"
11451453
11461454instance ToJSON EnvVar where
1147− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
11481456
1149−-- | ExposedPorts represent a enumeraton of all the ports (and their type)
1457+-- | ExposedPort represents a port (and it's type)
11501458-- that a container should expose to other containers or the host system.
1151−-- `NOTE`: This does not automatically expose the ports onto the host
1152−-- system but rather it just tags them. It's best to be used with
1459+-- `NOTE`: This does not automatically expose the port onto the host
1460+-- system but rather it just tags it. It's best to be used with
11531461-- the PublishAllPorts flag. It is also useful for
11541462-- the daemon to know which Environment variables to
11551463-- inject into a container linking to our container.
11561464-- Example linking a Postgres container named db would inject the following
11571465-- environment variables automatically if we set the corresponding
1158−-- ExposedPorts:
1466+--
1467+-- ExposedPort:
1468+--
1469+-- @
11591470-- DB_PORT_5432_TCP_PORT="5432"
11601471-- DB_PORT_5432_TCP_PROTO="tcp"
11611472-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
1162−newtype ExposedPorts = ExposedPorts (M.Map Port PortType) deriving (Eq, Show)
1163−-- JP: Should this be ExposedPorts [(Port, PortType)]?
1164−
1165−instance FromJSON ExposedPorts where
1166− parseJSON (JSON.Object o) = do
1167− ExposedPorts <$> HM.foldlWithKey' f (return M.empty) o
1473+-- @
1474+data ExposedPort = ExposedPort Port PortType deriving (Eq, Show)
11681475
1476+instance {-# OVERLAPPING #-} FromJSON [ExposedPort] where
1477+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
11691478 where
11701479 f accM k _ = case T.split (== '/') k of
11711480 [port', portType'] -> do
11721481 port <- parseIntegerText port'
11731482 portType <- parseJSON $ JSON.String portType'
11741483 acc <- accM
1175− return $ M.insert port portType acc
1176− _ ->
1177− fail "Could not parse ExposedPorts"
1178− parseJSON _ = fail "ExposedPorts is not an object."
1484+ return $ (ExposedPort port portType):acc
1485+ _ -> fail "Could not parse ExposedPorts"
1486+ parseJSON (JSON.Null) = return []
1487+ parseJSON _ = fail "ExposedPorts is not an object"
1488+
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 "/"
11791494
1180−instance ToJSON ExposedPorts where
1181− toJSON (ExposedPorts kvs) = object [((T.pack $ show p) <> "/" <> (T.pack $ show t)) .= JSON.Object HM.empty | (p,t) <- (M.toList kvs)]
1495+data Entrypoint = Entrypoint [T.Text] deriving (Eq, Show, Generic)
1496+
1497+instance ToJSON Entrypoint where
1498+ toJSON (Entrypoint (e:es)) = toJSON (e:es)
1499+ toJSON (Entrypoint []) = JSON.Null
1500+
1501+instance FromJSON Entrypoint where
1502+ parseJSON (JSON.String e) = return $ Entrypoint [e]
1503+ parseJSON (JSON.Array ar) = do
1504+ arr <- mapM parseJSON (V.toList ar)
1505+ return $ Entrypoint arr
1506+ parseJSON JSON.Null = return $ Entrypoint []
1507+ parseJSON _ = fail "Failed to parse Entrypoint"
11821508
11831509
11841510data ContainerConfig = ContainerConfig {
@@ -1188,7 +1514,7 @@ data ContainerConfig = ContainerConfig {
11881514 , attachStdin :: Bool
11891515 , attachStdout :: Bool
11901516 , attachStderr :: Bool
1191− , exposedPorts :: Maybe ExposedPorts -- Note: Should we expand the JSON instance and take away the Maybe?
1517+ , exposedPorts :: [ExposedPort]
11921518 -- , publishService :: Text -- Don't see this in 1.24
11931519 , tty :: Bool
11941520 , openStdin :: Bool
@@ -1197,27 +1523,70 @@ data ContainerConfig = ContainerConfig {
11971523 , cmd :: [Text]
11981524 -- , argsEscaped :: Bool -- Don't see this in 1.24
11991525 , image :: Text
1200− , volumes :: Maybe Volumes
1526+ , volumes :: [Volume]
12011527 , workingDir :: Maybe FilePath
1202− , entrypoint :: Maybe Text -- Can be null?
1528+ , entrypoint :: Entrypoint
12031529 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
12041530 , macAddress :: Maybe Text
12051531 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
1206− , labels :: Maybe Labels
1532+ , labels :: [Label]
12071533 , stopSignal :: Signal
12081534 } deriving (Eq, Show, Generic)
12091535
1536+
12101537instance ToJSON ContainerConfig where
12111538 toJSON = genericToJSON defaultOptions {
12121539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
12131540
12141541instance FromJSON ContainerConfig where
1215− parseJSON = genericParseJSON defaultOptions {
1216− fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
1542+ parseJSON (JSON.Object o) = do
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" .!= []
1550+ tty <- o .: "Tty"
1551+ openStdin <- o .: "OpenStdin"
1552+ stdinOnce <- o .: "StdinOnce"
1553+ env <- o .: "Env"
1554+ cmd <- o .: "Cmd"
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."
12171566
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1569+#else
12181570parseIntegerText :: (Monad m) => Text -> m Integer
1571+#endif
12191572parseIntegerText t = case readMaybe $ T.unpack t of
12201573 Nothing ->
12211574 fail "Could not parse Integer"
12221575 Just i ->
12231576 return i
1577+
1578+-- | Helper function for converting a data type [a] to a json dictionary
1579+-- like so {"something": {}, "something2": {}}
1580+toJsonKey :: Foldable t => t a -> (a -> String) -> JSON.Value
1581+toJsonKey vs getKey = JSON.Object $ foldl f HM.empty vs
1582+ where f acc x = HM.insert (T.pack $ getKey x) (JSON.Object HM.empty) acc
1583+
1584+-- | Helper function for converting a data type [a] to a json dictionary
1585+-- like so {"something": "val1", "something2": "val2"}
1586+toJsonKeyVal :: (Foldable t, JSON.ToJSON r) => t a -> (a -> String) -> (a -> r) -> JSON.Value
1587+toJsonKeyVal vs getKey getVal = JSON.Object $ foldl f HM.empty vs
1588+ where f acc x = HM.insert (T.pack $ getKey x) (toJSON $ getVal x) acc
1589+
1590+-- | Helper function that return an empty dictionary "{}"
1591+emptyJsonObject :: JSON.Value
1592+emptyJsonObject = JSON.Object HM.empty