@@ -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,40 +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(..)
43+ , ContainerDeleteOpts(..)
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
3747 , Timestamp
3848 , TailLogOpt(..)
3949 , LogOpts(..)
4050 , defaultLogOpts
51+ , CreateNetworkOpts(..)
52+ , defaultCreateNetworkOpts
4153 , VolumePermission(..)
54+ , Bind(..)
4255 , Volume(..)
4356 , Device(..)
4457 , ContainerName
4558 , VolumeFrom(..)
4659 , Link(..)
4760 , LogDriverType(..)
48− , LogDriverOptions(..)
61+ , LogDriverOption(..)
4962 , LogDriverConfig(..)
5063 , NetworkMode(..)
5164 , PortType(..)
5265-- , NetworkInterface(..)
53− , Networks(..)
66+ , Network(..)
5467 , NetworkSettings(..)
5568 , NetworkOptions(..)
5669 , Mount(..)
5770 , PortBinding(..)
58− , PortBindings(..)
5971 , HostPort(..)
6072 , RetryCount
6173 , RestartPolicy(..)
@@ -63,6 +75,8 @@ module Docker.Client.Types (
6375 , UTSMode(..)
6476 , HostConfig(..)
6577 , defaultHostConfig
78+ , NetworkingConfig(..)
79+ , EndpointConfig(..)
6680 , Ulimit(..)
6781 , ContainerResources(..)
6882 , defaultContainerResources
@@ -72,9 +86,18 @@ module Docker.Client.Types (
7286 , EnvVar(..)
7387 , ContainerConfig(..)
7488 , defaultContainerConfig
75− , ExposedPorts(..)
89+ , ExposedPort(..)
7690 , DeviceWeight(..)
7791 , DeviceRate(..)
92+ , addPortBinding
93+ , addExposedPort
94+ , addBind
95+ , setCmd
96+ , addLink
97+ , addVolume
98+ , addVolumeFrom
99+ , MemoryConstraint(..)
100+ , MemoryConstraintSize(..)
78101 ) where
79102
80103import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
@@ -84,40 +107,57 @@ import qualified Data.Aeson as JSON
84107import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
85108import Data.Char (isAlphaNum, toUpper)
86109import qualified Data.HashMap.Strict as HM
87−import qualified Data.Map as M
88110import Data.Monoid ((<>))
111+import Data.Scientific (floatingOrInteger)
89112import Data.Text (Text)
90113import qualified Data.Text as T
91114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
92116import GHC.Generics (Generic)
93117import Prelude hiding (all, tail)
94118import Text.Read (readMaybe)
95119
120+-- | List of Docker Engine API endpoints
96121data Endpoint =
97122 VersionEndpoint
98123 | ListContainersEndpoint ListOpts
99124 | ListImagesEndpoint ListOpts
100− | CreateContainerEndpoint CreateOpts
125+ | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
101126 | StartContainerEndpoint StartOpts ContainerID
102127 | StopContainerEndpoint Timeout ContainerID
128+ | WaitContainerEndpoint ContainerID
103129 | KillContainerEndpoint Signal ContainerID
104130 | RestartContainerEndpoint Timeout ContainerID
105131 | PauseContainerEndpoint ContainerID
106132 | UnpauseContainerEndpoint ContainerID
107133 | 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.
109− | DeleteContainerEndpoint DeleteOpts ContainerID
134+ -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
110136 | 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
111142 deriving (Eq, Show)
112143
144+-- | We should newtype this
113145type URL = Text
146+
147+-- | We should newtype this
114148type ApiVersion = Text
149+
150+
151+-- | ID of a contianer
115152newtype ContainerID = ContainerID Text
116153 deriving (Eq, Show)
117154
155+-- | Used for extracting the id of the container from the newtype
118156fromContainerID :: ContainerID -> Text
119157fromContainerID (ContainerID t) = t
120158
159+-- | Used for parsing a Text value into a ContainerID. We apply some basic
160+-- validation here.
121161toContainerID :: Text -> Maybe ContainerID
122162toContainerID t =
123163 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
@@ -125,12 +165,16 @@ toContainerID t =
125165 else
126166 Nothing
127167
168+-- ID of an image.
128169newtype ImageID = ImageID Text
129170 deriving (Eq, Show)
130171
172+-- | Used for extracting the id of the image from the newtype.
131173fromImageID :: ImageID -> Text
132174fromImageID (ImageID t) = t
133175
176+-- | Helper function used for parsing a Text value into an ImageID. For now
177+-- just basic validation is used.
134178toImageID :: Text -> Maybe ImageID
135179toImageID t =
136180 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
@@ -138,9 +182,26 @@ toImageID t =
138182 else
139183 Nothing
140184
185+-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
141186data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
142187
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+
143202-- 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.
144205data Signal = SIGHUP
145206 | SIGINT
146207 | SIGQUIT
@@ -152,16 +213,16 @@ data Signal = SIGHUP
152213
153214instance FromJSON Signal where
154215 parseJSON (JSON.String "SIGTERM") = return SIGTERM
155− parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
156− 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
157218 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
158219 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
159220 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
160− parseJSON _ = fail "Unknown Signal"
221+ parseJSON _ = fail "Unknown Signal"
161222
162223instance ToJSON Signal where
163− toJSON SIGHUP = "SIGHUP"
164− toJSON SIGINT = "SIGINT"
224+ toJSON SIGHUP = "SIGHUP"
225+ toJSON SIGINT = "SIGINT"
165226 toJSON SIGQUIT = "SIGQUIT"
166227 toJSON SIGSTOP = "SIGSTOP"
167228 toJSON SIGTERM = "SIGTERM"
@@ -189,17 +250,19 @@ data ContainerDetails = ContainerDetails {
189250 , processLabel :: Text
190251 , resolveConfPath :: FilePath
191252 , restartCount :: Int
192− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
193254 , mounts :: [Mount]
194255 }
195256 deriving (Eq, Show, Generic)
196257
258+-- | Data type used for parsing the mount information from a container
259+-- list.
197260data Mount = Mount {
198− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
199262 , mountSource :: FilePath
200263 , mountDestination :: FilePath
201− , mountDriver :: Text
202− , mountMode :: Text -- Note: Improve this?
264+ , mountDriver :: Maybe Text
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
203266 , mountRW :: Bool
204267 , mountPropogation :: Text
205268 }
@@ -207,16 +270,18 @@ data Mount = Mount {
207270
208271instance FromJSON Mount where
209272 parseJSON (JSON.Object o) = do
210− name <- o .: "Name"
273+ name <- o .:? "Name"
211274 src <- o .: "Source"
212275 dest <- o .: "Destination"
213− driver <- o .: "Driver"
214− mode <- o .: "Mode"
276+ driver <- o .:? "Driver"
277+ -- mode <- o .: "Mode"
215278 rw <- o .: "RW"
216279 prop <- o .: "Propagation"
217− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
218281 parseJSON _ = fail "Mount is not an object"
219282
283+-- | Data type used for parsing the container state from a list of
284+-- containers.
220285data ContainerState = ContainerState {
221286 containerError :: Text
222287 , exitCode :: Int
@@ -228,7 +293,7 @@ data ContainerState = ContainerState {
228293 , restarting :: Bool
229294 , running :: Bool
230295 , startedAt :: UTCTime
231− , status :: Status
296+ , state :: State
232297 }
233298 deriving (Eq, Show, Generic)
234299
@@ -248,23 +313,30 @@ instance FromJSON ContainerState where
248313 return $ ContainerState err exit finished oomKilled dead paused pid restarting running started st
249314 parseJSON _ = fail "ContainerState is not an object"
250315
316+
317+-- | Client options used to configure the remote engine we're talking to
251318data DockerClientOpts = DockerClientOpts {
252319 apiVer :: ApiVersion
253320 , baseUrl :: URL
254321 }
255322 deriving (Eq, Show)
256323
324+-- | Default "DockerClientOpts" used for talking to the docker engine.
257325defaultClientOpts :: DockerClientOpts
258326defaultClientOpts = DockerClientOpts {
259327 apiVer = "v1.24"
260328 , baseUrl = "http://127.0.0.1:2375"
261329 }
262330
331+-- | List options used for filtering the list of container or images.
263332data ListOpts = ListOpts { all :: Bool } deriving (Eq, Show)
264333
334+-- | Default "ListOpts". Doesn't list stopped containers.
265335defaultListOpts :: ListOpts
266336defaultListOpts = ListOpts { all=False }
267337
338+-- | Data type used for represneting the version of the docker engine
339+-- remote API.
268340data DockerVersion = DockerVersion {
269341 version :: Text
270342 , apiVersion :: ApiVersion
@@ -334,6 +406,8 @@ instance FromJSON ImageID where
334406 return iid
335407 parseJSON _ = fail "ImageID is not an object."
336408
409+-- | Data type used for representing the information of various ports that
410+-- a contianer may expose.
337411data ContainerPortInfo = ContainerPortInfo {
338412 ipAddressInfo :: Maybe Text
339413 , privatePortInfo :: Port
@@ -350,6 +424,8 @@ instance FromJSON ContainerPortInfo where
350424 parseJSON _ = fail "ContainerPortInfo: Not a JSON object."
351425
352426-- For inspecting container details.
427+-- | Data type used for parsing the network information of each container
428+-- when listing them.
353429data NetworkOptions = NetworkOptions {
354430-- ipamConfig :: Maybe Text -- Don't see in 1.24
355431-- , links :: Maybe Text -- Don't see in 1.24
@@ -379,29 +455,28 @@ instance FromJSON NetworkOptions where
379455 return $ NetworkOptions networkId endpointId gateway ip ipLen ip6Gateway globalIP6 globalIP6Len mac
380456 parseJSON _ = fail "NetworkOptions is not an object"
381457
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
383460 deriving (Eq, Show)
384461
385−instance FromJSON Networks where
386− parseJSON (JSON.Object o) = do
387− Networks <$> HM.foldlWithKey' f (return M.empty) o
388−
462+instance {-# OVERLAPPING #-} FromJSON [Network] where
463+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
389464 where
390465 f accM k' v' = do
391466 acc <- accM
392467 k <- parseJSON $ JSON.String k'
393468 v <- parseJSON v'
394− return $ M.insert k v acc
395−
469+ return $ (Network k v):acc
396470 parseJSON _ = fail "Networks is not an object"
397471
472+-- | Data type reprsenting the various network settings a container can have.
398473data NetworkSettings = NetworkSettings {
399474 networkSettingsBridge :: Text
400475 , networkSettingsSandboxId :: Text
401476 , networkSettingsHairpinMode :: Bool
402477 , networkSettingsLinkLocalIPv6Address :: Text
403478 , networkSettingsLinkLocalIPv6PrefixLen :: Int
404− , networkSettingsPorts :: PortBindings
479+ , networkSettingsPorts :: [PortBinding]
405480 , networkSettingsSandboxKey :: Text
406481 , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
407482 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
@@ -413,7 +488,7 @@ data NetworkSettings = NetworkSettings {
413488 , networkSettingsIpPrefixLen :: Int
414489 , networkSettingsIpv6Gateway :: Text
415490 , networkSettingsMacAddress :: Text
416− , networkSettingsNetworks :: Networks
491+ , networkSettingsNetworks :: [Network]
417492 }
418493 deriving (Eq, Show)
419494
@@ -440,6 +515,7 @@ instance FromJSON NetworkSettings where
440515 return $ NetworkSettings bridge sandbox hairpin localIP6 localIP6Len ports sandboxKey secondaryIP secondayIP6 endpointID gateway globalIP6 globalIP6Len ip ipLen ip6Gateway mac networks
441516 parseJSON _ = fail "NetworkSettings is not an object."
442517
518+-- | Data type used for parsing a list of containers.
443519data Container = Container
444520 { containerId :: ContainerID
445521 , containerNames :: [Text]
@@ -447,21 +523,23 @@ data Container = Container
447523 , containerImageId :: ImageID
448524 , containerCommand :: Text
449525 , containerCreatedAt :: Int
450− , containerStatus :: Status
526+ , containerState :: State
527+ , containerStatus :: Maybe Text
451528 , containerPorts :: [ContainerPortInfo]
452− , containerLabels :: Labels
453− , containerNetworks :: Networks
529+ , containerLabels :: [Label]
530+ , containerNetworks :: [Network]
454531 , containerMounts :: [Mount]
455532 } deriving (Show, Eq)
456533
457534instance FromJSON Container where
458− parseJSON (JSON.Object v) =
459− Container <$> (v .: "Id")
535+ parseJSON o@(JSON.Object v) =
536+ Container <$> parseJSON o
460537 <*> (v .: "Names")
461538 <*> (v .: "Image")
462− <*> (v .: "ImageID")
463− <*> (v .: "Command")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
540+ <*> (v .: "Command") -- Doesn't exist anymore
464541 <*> (v .: "Created")
542+ <*> (v .: "State")
465543 <*> (v .: "Status")
466544 <*> (v .: "Ports")
467545 <*> (v .: "Labels")
@@ -471,65 +549,124 @@ instance FromJSON Container where
471549 parseNetworks (JSON.Object v) =
472550 (v .: "Networks") >>= parseJSON
473551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
474−
475552 parseJSON _ = fail "Container: Not a JSON object."
476553
477−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
478556 deriving (Eq, Show, Generic)
479557
480−instance FromJSON Status where
481− parseJSON (JSON.String "running") = return Running
482− 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.
483561 parseJSON (JSON.String "restarting") = return Restarting
484− parseJSON (JSON.String "paused") = return Paused
485− parseJSON (JSON.String "exited") = return Exited
486− parseJSON (JSON.String "dead") = return Dead
487− 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
488566
567+-- | Alias for representing a RepoDigest. We could newtype this and add
568+-- some validation.
489569type Digest = Text
490570
491−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+
492574
493−instance FromJSON Labels where
494− 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
495582
496−instance ToJSON Labels where
497− 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."
498591
592+-- | Alias for Tags.
499593type Tag = Text
500594
595+-- | Data type used for parsing information from a list of images.
501596data Image = DockerImage {
502597 imageId :: ImageID
503598 , imageCreated :: Integer
504599 , imageParentId :: Maybe ImageID
505600 , imageRepoTags :: [Tag]
506− , imageRepoDigests :: Maybe [Digest]
601+ , imageRepoDigests :: [Digest]
507602 , imageSize :: Integer
508603 , imageVirtualSize :: Integer
509− , imageLabels :: Maybe Labels
604+ , imageLabels :: [Label]
510605 } deriving (Show, Eq, Generic)
511606
607+-- | Helper function used for dropping the "image" prefix when serializing
608+-- the Image data type to and from json.
512609dropImagePrefix :: [a] -> [a]
513610dropImagePrefix = drop 5
514611
515−instance FromJSON Image where
516− parseJSON = genericParseJSON defaultOptions {
517− fieldLabelModifier = dropImagePrefix}
518612
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.
519651data CreateOpts = CreateOpts {
520− containerConfig :: ContainerConfig
521− , hostConfig :: HostConfig
652+ containerConfig :: ContainerConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
522655 } deriving (Eq, Show)
523656
524657instance ToJSON CreateOpts where
525− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
526659 let ccJSON = toJSON cc
527660 let hcJSON = toJSON hc
528661 case ccJSON of
529662 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
665+ JSON.Object o2
531666 _ -> error "ContainerConfig is not an object." -- This should never happen.
532667
668+-- | Container configuration used for creating a container with sensible
669+-- defaults.
533670defaultContainerConfig :: Text -> ContainerConfig
534671defaultContainerConfig imageName = ContainerConfig {
535672 hostname=Nothing
@@ -539,28 +676,29 @@ defaultContainerConfig imageName = ContainerConfig {
539676 , attachStdout=False
540677 , image=imageName
541678 , attachStderr=False
542− , exposedPorts=Nothing -- ExposedPorts M.empty
679+ , exposedPorts=[]
543680 , tty=False
544681 , openStdin=False
545682 , stdinOnce=False
546683 , env=[]
547684 , cmd=[]
548− , volumes=Nothing
685+ , volumes=[]
549686 , workingDir=Nothing
550− , entrypoint=Nothing
687+ , entrypoint=Entrypoint []
551688 , networkDisabled=Nothing
552689 , macAddress=Nothing
553− , labels=Nothing
690+ , labels=[]
554691 , stopSignal=SIGTERM
555692 }
556693
694+-- | Default host confiratuon used for creating a container.
557695defaultHostConfig :: HostConfig
558696defaultHostConfig = HostConfig {
559697 binds=[]
560698 , containerIDFile=Nothing
561− , logConfig=LogDriverConfig JsonFile Nothing
562− , networkMode=Bridge
563− , portBindings=PortBindings []
699+ , logConfig=LogDriverConfig JsonFile []
700+ , networkMode=NetworkBridge
701+ , portBindings=[]
564702 , restartPolicy=RestartOff
565703 , volumeDriver=Nothing
566704 , volumesFrom=[]
@@ -581,6 +719,7 @@ defaultHostConfig = HostConfig {
581719 , resources=defaultContainerResources
582720 }
583721
722+-- Default container resource contstraints (None).
584723defaultContainerResources :: ContainerResources
585724defaultContainerResources = ContainerResources {
586725 cpuShares=Nothing
@@ -598,31 +737,80 @@ defaultContainerResources = ContainerResources {
598737 , memory=Nothing
599738 , memoryReservation=Nothing
600739 , memorySwap=Nothing
601− , oomKillDisable=False
740+ , oomKillDisable=Just False
602741 , ulimits=[]
603742 }
604743
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.
606746defaultCreateOpts :: T.Text -> CreateOpts
607−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+ }
608752
609−-- detachKeys – Override the key sequence for detaching a container.
753+-- | Override the key sequence for detaching a container.
610754-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
611755data DetachKeys = WithCtrl Char | WithoutCtrl Char | DefaultDetachKey deriving (Eq, Show)
612756
757+-- | Options for starting a container.
613758data StartOpts = StartOpts { detachKeys :: DetachKeys } deriving (Eq, Show)
614759
760+-- | Default options for staring a container.
615761defaultStartOpts :: StartOpts
616762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
617763
618−data DeleteOpts = DeleteOpts {
619− deleteVolumes :: Bool
620− , force :: Bool
764+-- | Options for deleting a container.
765+data ContainerDeleteOpts = ContainerDeleteOpts {
766+ deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
767+ , force :: Bool -- ^ If the container is still running force deletion anyway.
621768 } deriving (Eq, Show)
622769
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.
623806type Timestamp = Integer
807+
808+-- | Used for requesting N number of lines when tailing a containers log
809+-- output.
624810data TailLogOpt = Tail Integer | All deriving (Eq, Show)
625811
812+
813+-- | Log options used when requesting the log output from a container.
626814data LogOpts = LogOpts {
627815 stdout :: Bool
628816 , stderr :: Bool
@@ -631,6 +819,7 @@ data LogOpts = LogOpts {
631819 , tail :: TailLogOpt
632820 } deriving (Eq, Show)
633821
822+-- | Sensible default for log options.
634823defaultLogOpts :: LogOpts
635824defaultLogOpts = LogOpts { stdout = True
636825 , stderr = True
@@ -639,37 +828,87 @@ defaultLogOpts = LogOpts { stdout = True
639828 , tail = All
640829 }
641830
642−data VolumePermission = Rw | Ro deriving (Eq, Show, Generic)
643−
644−-- instance ToJSON VolumePermission where
645−-- toJSON = error "TODO"
646−-- instance FromJSON VolumePermission where
647−-- parseJSON = error "TODO"
648−
649−-- Note: Note really sure what this should be (1.24).
650−-- This is not the same as [Volume] in HostConfig.
651−newtype Volumes = Volumes [Text] -- [Volume]
652− deriving (Eq, Show)
653−
654−instance FromJSON Volumes where
655− parseJSON (JSON.Object o) = return $ Volumes $ HM.keys o
656− parseJSON _ = fail "Volumes is not an object"
657−
658−instance ToJSON Volumes where
659− toJSON (Volumes vs) = toJSON vs
660−
661−data Volume = Volume { hostSrc :: Text
662− , containerDest :: Text
663− , volumePermission :: Maybe VolumePermission
664− } 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)
665904
666−instance FromJSON Volume where
905+instance FromJSON Bind where
667906 parseJSON (JSON.String t) = case T.split (== ':') t of
668− [src, dest] -> return $ Volume src dest Nothing
669− [src, dest, "rw"] -> return $ Volume src dest $ Just Rw
670− [src, dest, "ro"] -> return $ Volume src dest $ Just Ro
671− _ -> fail "Could not parse Volume"
672− 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"
673912
674913data Device = Device {
675914 pathOnHost :: FilePath
@@ -691,19 +930,19 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
691930
692931instance FromJSON VolumeFrom where
693932 parseJSON (JSON.String t) = case T.split (== ':') t of
694− [vol] -> return $ VolumeFrom vol Nothing
695− [vol, "rw"] -> return $ VolumeFrom vol $ Just Rw
696− [vol, "ro"] -> return $ VolumeFrom vol $ Just Ro
697− _ -> 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"
698937 parseJSON _ = fail "VolumeFrom is not a string"
699938
700939instance ToJSON VolumeFrom where
701940 toJSON (VolumeFrom n p) = case p of
702− Nothing -> toJSON $ n <> ":" <> "rw"
941+ Nothing -> toJSON $ n <> ":" <> "rw"
703942 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
704943
705−instance ToJSON Volume where
706− toJSON (Volume src dest mode) = toJSON $ case mode of
944+instance ToJSON Bind where
945+ toJSON (Bind src dest mode) = toJSON $ case mode of
707946 Nothing -> T.concat[src, ":", dest]
708947 Just m -> T.concat[src, ":", dest, ":", (T.pack $ show m)]
709948
@@ -711,63 +950,63 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
711950
712951instance FromJSON Link where
713952 parseJSON (JSON.String t) = case T.split (== ':') t of
714− [f] -> return $ Link f Nothing
953+ [f] -> return $ Link f Nothing
715954 [f,s] -> return $ Link f $ Just s
716− _ -> fail "Could not parse Link"
955+ _ -> fail "Could not parse Link"
717956 parseJSON _ = fail "Link is not a string"
718957
719958instance ToJSON Link where
720959 toJSON (Link n1 n2) = toJSON $ case n2 of
721960 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
723962
724963-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
725964data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
726965
727966instance FromJSON LogDriverType where
728967 parseJSON (JSON.String "json-file") = return JsonFile
729− parseJSON (JSON.String "syslog") = return Syslog
730− parseJSON (JSON.String "journald") = return Journald
731− parseJSON (JSON.String "gelf") = return Gelf
732− parseJSON (JSON.String "fluentd") = return Fluentd
733− parseJSON (JSON.String "awslogs") = return AwsLogs
734− parseJSON (JSON.String "splunk") = return Splunk
735− parseJSON (JSON.String "etwlogs") = return Etwlogs
736− parseJSON (JSON.String "none") = return LoggingDisabled
737− 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"
738977
739978instance ToJSON LogDriverType where
740− toJSON JsonFile = JSON.String "json-file"
741− toJSON Syslog = JSON.String "syslog"
742− toJSON Journald = JSON.String "journald"
743− toJSON Gelf = JSON.String "gelf"
744− toJSON Fluentd = JSON.String "fluentd"
745− toJSON AwsLogs = JSON.String "awslogs"
746− toJSON Splunk = JSON.String "splunk"
747− 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"
748987 toJSON LoggingDisabled = JSON.String "none"
749988
750−newtype LogDriverOptions = LogDriverOptions (M.Map Text Text) deriving (Eq, Show)
989+data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
751990
752−instance FromJSON LogDriverOptions where
753− parseJSON (JSON.Object o) = do
754− 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
755996
756− where
757− 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
7581000 acc <- accM
759− return $ M.insert k v acc
760− f _ _ _ = fail "Value of LogDriverOptions is not a string"
761−
762− parseJSON JSON.Null = return $ LogDriverOptions M.empty
763− parseJSON _ = fail "LogDriverOptions is not an object"
764−
765−instance ToJSON LogDriverOptions where
766− toJSON (LogDriverOptions mp) = toJSON mp
1001+ value <- parseJSON v
1002+ return $ (LogDriverOption k value):acc
1003+ parseJSON JSON.Null = return []
1004+ parseJSON _ = fail "Failed to parse LogDriverOptions"
7671005
768−data LogDriverConfig = LogDriverConfig LogDriverType (Maybe LogDriverOptions) deriving (Eq, Show)
1006+data LogDriverConfig = LogDriverConfig LogDriverType [LogDriverOption] deriving (Eq, Show)
7691007
7701008instance ToJSON LogDriverConfig where
1009+ toJSON (LogDriverConfig driverType []) = object ["Type" .= driverType]
7711010 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
7721011
7731012instance FromJSON LogDriverConfig where
@@ -778,21 +1017,47 @@ instance FromJSON LogDriverConfig where
7781017 parseJSON _ = fail "LogDriverConfig is not an object"
7791018
7801019-- TODO: Add container:<name|id> mode
781−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
7821021 deriving (Eq, Show, Ord)
7831022
7841023instance FromJSON NetworkMode where
785− parseJSON (JSON.String "bridge") = return Bridge
786− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
787− parseJSON (JSON.String "none") = return NetworkDisabled
788− 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"
7891029
7901030instance ToJSON NetworkMode where
791− toJSON Bridge = JSON.String "bridge"
792− toJSON Host = JSON.String "host"
1031+ toJSON NetworkBridge = JSON.String "bridge"
1032+ toJSON NetworkHost = JSON.String "host"
7931033 toJSON NetworkDisabled = JSON.String "none"
1034+ toJSON (NetworkNamed n) = JSON.String n
7941035
795−data PortType = TCP | UDP deriving (Eq, Show, Generic, Read, Ord)
1036+newtype NetworkID = NetworkID Text
1037+ deriving (Eq, Show)
1038+
1039+-- | Used for extracting the id of the container from the newtype
1040+fromNetworkID :: NetworkID -> Text
1041+fromNetworkID (NetworkID t) = t
1042+
1043+-- | Used for parsing a Text value into a NetworkID.
1044+toNetworkID :: Text -> Maybe NetworkID
1045+toNetworkID t = Just $ NetworkID t
1046+
1047+instance FromJSON NetworkID where
1048+ parseJSON (JSON.Object o) = do
1049+ nid <- o .: "Id"
1050+ return $ NetworkID nid
1051+ parseJSON _ = fail "NetworkID is not an object."
1052+
1053+instance ToJSON NetworkID where
1054+ toJSON (NetworkID nid) = object ["Id" .= nid]
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"
7961061
7971062instance ToJSON PortType where
7981063 toJSON TCP = "tcp"
@@ -802,7 +1067,7 @@ instance FromJSON PortType where
8021067 parseJSON val = case val of
8031068 "tcp" -> return TCP
8041069 "udp" -> return UDP
805− _ -> fail "PortType: Invalid port type."
1070+ _ -> fail "PortType: Invalid port type."
8061071
8071072-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
8081073--
@@ -817,9 +1082,8 @@ instance FromJSON PortType where
8171082-- host system s that the service running in the container can be accessed from
8181083-- the outside world. We either map a port onto all interfaces (default) or onto a specific
8191084-- interface like `127.0.0.1`.
820−newtype PortBindings = PortBindings [PortBinding]
821− deriving (Eq, Show)
822−
1085+-- __NOTE__: We should disallow duplicate port bindings as the ToJSON
1086+-- instance will only send the last one.
8231087-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
8241088data PortBinding = PortBinding {
8251089 containerPort :: Port
@@ -827,17 +1091,65 @@ data PortBinding = PortBinding {
8271091 , hostPorts :: [HostPort]
8281092 } deriving (Eq, Show)
8291093
830−
8311094portAndType2Text :: Port -> PortType -> Text
8321095portAndType2Text p t = (T.pack $ show p) <> "/" <> (T.pack $ show t)
8331096
834−instance ToJSON PortBinding where
835− toJSON (PortBinding {..}) = object [portAndType2Text containerPort portType .= hostPorts]
836−
837−instance FromJSON PortBindings where
838− parseJSON (JSON.Object o) = do
839− PortBindings <$> HM.foldlWithKey' f (return []) o
8401097
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
8411153 where
8421154 f accM k v = case T.split (== '/') k of
8431155 [port', portType'] -> do
@@ -846,13 +1158,15 @@ instance FromJSON PortBindings where
8461158 acc <- accM
8471159 hps <- parseJSON v
8481160 return $ (PortBinding port portType hps):acc
849− _ ->
850− fail "Could not parse PortBindings"
1161+ _ -> fail "Could not parse PortBindings"
1162+ parseJSON (JSON.Null) = return []
8511163 parseJSON _ = fail "PortBindings is not an object"
8521164
853−instance ToJSON PortBindings where
854− toJSON (PortBindings []) = JSON.Object HM.empty
855− 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
8561170
8571171data HostPort = HostPort {
8581172 hostIp :: Text
@@ -870,24 +1184,6 @@ instance FromJSON HostPort where
8701184 return $ HostPort i p
8711185 parseJSON _ = fail "HostPort is not an object."
8721186
873−-- newtype HostPorts = HostPorts [HostPort]
874−-- deriving (Eq, Show)
875−--
876−-- instance ToJSON HostPorts where
877−-- toJSON (HostPorts hps) = toJSON hps
878−--
879−-- instance FromJSON HostPorts where
880−-- parseJSON (JSON.Object o) = do
881−-- HostPorts <$> HM.foldlWithKey' f (return []) o
882−--
883−-- where
884−-- f accM k v = do
885−-- acc <- accM
886−-- p' <- parseJSON v
887−-- p <- parseIntegerText p'
888−-- return $ (HostPort (NetworkInterface k) p):acc
889−-- parseJSON _ = fail $ "HostPorts is not an object"
890−
8911187-- { "Name": "on-failure" , "MaximumRetryCount": 2}
8921188type RetryCount = Integer
8931189data RestartPolicy = RestartAlways | RestartUnlessStopped | RestartOnFailure RetryCount | RestartOff deriving (Eq, Show)
@@ -901,7 +1197,7 @@ instance FromJSON RestartPolicy where
9011197 "on-failure" -> do
9021198 retry <- o .: "MaximumRetryCount"
9031199 return $ RestartOnFailure retry
904− "off" -> return RestartOff
1200+ "no" -> return RestartOff
9051201 _ -> fail "Could not parse RestartPolicy"
9061202 parseJSON _ = fail "RestartPolicy is not an object"
9071203
@@ -909,7 +1205,7 @@ instance ToJSON RestartPolicy where
9091205 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
9101206 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
9111207 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"]
9131209
9141210data Isolation = Default | Process | Hyperv deriving (Eq, Show)
9151211
@@ -919,11 +1215,11 @@ newtype UTSMode = UTSMode Text deriving (Eq, Show)
9191215-- TODO: Add UTSMode : UTS namespace to use for the container
9201216-- TODO: Sysctls map[string]string `json:",omitempty"` // List of Namespaced sysctls used for the container
9211217data HostConfig = HostConfig
922− { binds :: [Volume]
1218+ { binds :: [Bind]
9231219 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
9241220 , logConfig :: LogDriverConfig
9251221 , networkMode :: NetworkMode
926− , portBindings :: PortBindings
1222+ , portBindings :: [PortBinding]
9271223 , restartPolicy :: RestartPolicy
9281224 , volumeDriver :: Maybe Text
9291225 , volumesFrom :: [VolumeFrom]
@@ -1082,6 +1378,22 @@ instance ToJSON DeviceRate where
10821378 , "Rate" .= r
10831379 ]
10841380
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+
10851397data ContainerResources = ContainerResources {
10861398 cpuShares :: Maybe Integer
10871399 -- , cgroupParent :: Text -- 1.24: Missing from inspecting container details... Going to omit for now.
@@ -1097,12 +1409,12 @@ data ContainerResources = ContainerResources {
10971409 , cpusetMems :: Maybe Text
10981410 , devices :: [Device]
10991411 -- , diskQuota :: Integer -- Don't see this ins 1.24.
1100− , kernelMemory :: Maybe Integer
1101− , memory :: Maybe Integer
1102− , memoryReservation :: Maybe Integer
1103− , memorySwap :: Maybe Integer
1412+ , kernelMemory :: Maybe MemoryConstraint
1413+ , memory :: Maybe MemoryConstraint
1414+ , memoryReservation :: Maybe MemoryConstraint
1415+ , memorySwap :: Maybe MemoryConstraint
11041416 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1105− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
11061418 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
11071419 , ulimits :: [Ulimit]
11081420 -- TODO: Missing from 1.24
@@ -1140,41 +1452,59 @@ instance FromJSON EnvVar where
11401452 parseJSON _ = fail "EnvVar is not a string"
11411453
11421454instance ToJSON EnvVar where
1143− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
11441456
1145−-- | ExposedPorts represent a enumeraton of all the ports (and their type)
1457+-- | ExposedPort represents a port (and it's type)
11461458-- that a container should expose to other containers or the host system.
1147−-- `NOTE`: This does not automatically expose the ports onto the host
1148−-- 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
11491461-- the PublishAllPorts flag. It is also useful for
11501462-- the daemon to know which Environment variables to
11511463-- inject into a container linking to our container.
11521464-- Example linking a Postgres container named db would inject the following
11531465-- environment variables automatically if we set the corresponding
1154−-- ExposedPorts:
1466+--
1467+-- ExposedPort:
1468+--
1469+-- @
11551470-- DB_PORT_5432_TCP_PORT="5432"
11561471-- DB_PORT_5432_TCP_PROTO="tcp"
11571472-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
1158−newtype ExposedPorts = ExposedPorts (M.Map Port PortType) deriving (Eq, Show)
1159−-- JP: Should this be ExposedPorts [(Port, PortType)]?
1160−
1161−instance FromJSON ExposedPorts where
1162− parseJSON (JSON.Object o) = do
1163− ExposedPorts <$> HM.foldlWithKey' f (return M.empty) o
1473+-- @
1474+data ExposedPort = ExposedPort Port PortType deriving (Eq, Show)
11641475
1476+instance {-# OVERLAPPING #-} FromJSON [ExposedPort] where
1477+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
11651478 where
11661479 f accM k _ = case T.split (== '/') k of
11671480 [port', portType'] -> do
11681481 port <- parseIntegerText port'
11691482 portType <- parseJSON $ JSON.String portType'
11701483 acc <- accM
1171− return $ M.insert port portType acc
1172− _ ->
1173− fail "Could not parse ExposedPorts"
1174− 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 "/"
1494+
1495+data Entrypoint = Entrypoint [T.Text] deriving (Eq, Show, Generic)
11751496
1176−instance ToJSON ExposedPorts where
1177− toJSON (ExposedPorts kvs) = object [((T.pack $ show p) <> "/" <> (T.pack $ show t)) .= JSON.Object HM.empty | (p,t) <- (M.toList kvs)]
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"
11781508
11791509
11801510data ContainerConfig = ContainerConfig {
@@ -1184,7 +1514,7 @@ data ContainerConfig = ContainerConfig {
11841514 , attachStdin :: Bool
11851515 , attachStdout :: Bool
11861516 , attachStderr :: Bool
1187− , exposedPorts :: Maybe ExposedPorts -- Note: Should we expand the JSON instance and take away the Maybe?
1517+ , exposedPorts :: [ExposedPort]
11881518 -- , publishService :: Text -- Don't see this in 1.24
11891519 , tty :: Bool
11901520 , openStdin :: Bool
@@ -1193,27 +1523,70 @@ data ContainerConfig = ContainerConfig {
11931523 , cmd :: [Text]
11941524 -- , argsEscaped :: Bool -- Don't see this in 1.24
11951525 , image :: Text
1196− , volumes :: Maybe Volumes
1526+ , volumes :: [Volume]
11971527 , workingDir :: Maybe FilePath
1198− , entrypoint :: Maybe Text -- Can be null?
1528+ , entrypoint :: Entrypoint
11991529 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
12001530 , macAddress :: Maybe Text
12011531 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
1202− , labels :: Maybe Labels
1532+ , labels :: [Label]
12031533 , stopSignal :: Signal
12041534 } deriving (Eq, Show, Generic)
12051535
1536+
12061537instance ToJSON ContainerConfig where
12071538 toJSON = genericToJSON defaultOptions {
12081539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
12091540
12101541instance FromJSON ContainerConfig where
1211− parseJSON = genericParseJSON defaultOptions {
1212− 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."
12131566
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1569+#else
12141570parseIntegerText :: (Monad m) => Text -> m Integer
1571+#endif
12151572parseIntegerText t = case readMaybe $ T.unpack t of
12161573 Nothing ->
12171574 fail "Could not parse Integer"
12181575 Just i ->
12191576 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