@@ -11,11 +11,7 @@ module Docker.Client.Types (
1111 , ImageID
1212 , fromImageID
1313 , toImageID
14− , NetworkID
15− , fromNetworkID
16− , toNetworkID
1714 , Timeout(..)
18− , StatusCode(..)
1915 , Signal(..)
2016 , ContainerDetails(..)
2117 , DockerClientOpts(..)
@@ -26,48 +22,41 @@ module Docker.Client.Types (
2622 , ContainerPortInfo(..)
2723 , Container(..)
2824 , ContainerState(..)
29− , State(..)
25+ , Status(..)
3026 , Digest
31− , Label(..)
27+ , Labels(..)
3228 , Tag
3329 , Image(..)
34− , Entrypoint(..)
3530 , dropImagePrefix
3631 , CreateOpts(..)
37− , BuildOpts(..)
38− , defaultBuildOpts
3932 , defaultCreateOpts
4033 , DetachKeys(..)
4134 , StartOpts(..)
4235 , defaultStartOpts
43− , ContainerDeleteOpts(..)
44− , defaultContainerDeleteOpts
45− , ImageDeleteOpts(..)
46− , defaultImageDeleteOpts
36+ , DeleteOpts(..)
37+ , defaultDeleteOpts
4738 , Timestamp
4839 , TailLogOpt(..)
4940 , LogOpts(..)
5041 , defaultLogOpts
51− , CreateNetworkOpts(..)
52− , defaultCreateNetworkOpts
5342 , VolumePermission(..)
54− , Bind(..)
5543 , Volume(..)
5644 , Device(..)
5745 , ContainerName
5846 , VolumeFrom(..)
5947 , Link(..)
6048 , LogDriverType(..)
61− , LogDriverOption(..)
49+ , LogDriverOptions(..)
6250 , LogDriverConfig(..)
6351 , NetworkMode(..)
6452 , PortType(..)
6553-- , NetworkInterface(..)
66− , Network(..)
54+ , Networks(..)
6755 , NetworkSettings(..)
6856 , NetworkOptions(..)
6957 , Mount(..)
7058 , PortBinding(..)
59+ , PortBindings(..)
7160 , HostPort(..)
7261 , RetryCount
7362 , RestartPolicy(..)
@@ -75,8 +64,6 @@ module Docker.Client.Types (
7564 , UTSMode(..)
7665 , HostConfig(..)
7766 , defaultHostConfig
78− , NetworkingConfig(..)
79− , EndpointConfig(..)
8067 , Ulimit(..)
8168 , ContainerResources(..)
8269 , defaultContainerResources
@@ -86,18 +73,9 @@ module Docker.Client.Types (
8673 , EnvVar(..)
8774 , ContainerConfig(..)
8875 , defaultContainerConfig
89− , ExposedPort(..)
76+ , ExposedPorts(..)
9077 , DeviceWeight(..)
9178 , DeviceRate(..)
92− , addPortBinding
93− , addExposedPort
94− , addBind
95− , setCmd
96− , addLink
97− , addVolume
98− , addVolumeFrom
99− , MemoryConstraint(..)
100− , MemoryConstraintSize(..)
10179 ) where
10280
10381import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
@@ -107,57 +85,40 @@ import qualified Data.Aeson as JSON
10785import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
10886import Data.Char (isAlphaNum, toUpper)
10987import qualified Data.HashMap.Strict as HM
88+import qualified Data.Map as M
11089import Data.Monoid ((<>))
111−import Data.Scientific (floatingOrInteger)
11290import Data.Text (Text)
11391import qualified Data.Text as T
11492import Data.Time.Clock (UTCTime)
115−import qualified Data.Vector as V
11693import GHC.Generics (Generic)
11794import Prelude hiding (all, tail)
11895import Text.Read (readMaybe)
11996
120−-- | List of Docker Engine API endpoints
12197data Endpoint =
12298 VersionEndpoint
12399 | ListContainersEndpoint ListOpts
124100 | ListImagesEndpoint ListOpts
125− | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
101+ | CreateContainerEndpoint CreateOpts
126102 | StartContainerEndpoint StartOpts ContainerID
127103 | StopContainerEndpoint Timeout ContainerID
128− | WaitContainerEndpoint ContainerID
129104 | KillContainerEndpoint Signal ContainerID
130105 | RestartContainerEndpoint Timeout ContainerID
131106 | PauseContainerEndpoint ContainerID
132107 | UnpauseContainerEndpoint ContainerID
133108 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
134109 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
135− | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
110+ | DeleteContainerEndpoint DeleteOpts ContainerID
136111 | 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
142112 deriving (Eq, Show)
143113
144−-- | We should newtype this
145114type URL = Text
146−
147−-- | We should newtype this
148115type ApiVersion = Text
149−
150−
151−-- | ID of a contianer
152116newtype ContainerID = ContainerID Text
153117 deriving (Eq, Show)
154118
155−-- | Used for extracting the id of the container from the newtype
156119fromContainerID :: ContainerID -> Text
157120fromContainerID (ContainerID t) = t
158121
159−-- | Used for parsing a Text value into a ContainerID. We apply some basic
160−-- validation here.
161122toContainerID :: Text -> Maybe ContainerID
162123toContainerID t =
163124 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
@@ -165,16 +126,12 @@ toContainerID t =
165126 else
166127 Nothing
167128
168−-- ID of an image.
169129newtype ImageID = ImageID Text
170130 deriving (Eq, Show)
171131
172−-- | Used for extracting the id of the image from the newtype.
173132fromImageID :: ImageID -> Text
174133fromImageID (ImageID t) = t
175134
176−-- | Helper function used for parsing a Text value into an ImageID. For now
177−-- just basic validation is used.
178135toImageID :: Text -> Maybe ImageID
179136toImageID t =
180137 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
@@ -182,26 +139,9 @@ toImageID t =
182139 else
183140 Nothing
184141
185−-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
186142data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
187143
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−
202144-- 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.
205145data Signal = SIGHUP
206146 | SIGINT
207147 | SIGQUIT
@@ -213,16 +153,16 @@ data Signal = SIGHUP
213153
214154instance FromJSON Signal where
215155 parseJSON (JSON.String "SIGTERM") = return SIGTERM
216− parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
217− parseJSON (JSON.String "SIGINT") = return SIGINT
156+ parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
157+ parseJSON (JSON.String "SIGINT") = return SIGINT
218158 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
219159 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
220160 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
221− parseJSON _ = fail "Unknown Signal"
161+ parseJSON _ = fail "Unknown Signal"
222162
223163instance ToJSON Signal where
224− toJSON SIGHUP = "SIGHUP"
225− toJSON SIGINT = "SIGINT"
164+ toJSON SIGHUP = "SIGHUP"
165+ toJSON SIGINT = "SIGINT"
226166 toJSON SIGQUIT = "SIGQUIT"
227167 toJSON SIGSTOP = "SIGSTOP"
228168 toJSON SIGTERM = "SIGTERM"
@@ -250,19 +190,17 @@ data ContainerDetails = ContainerDetails {
250190 , processLabel :: Text
251191 , resolveConfPath :: FilePath
252192 , restartCount :: Int
253− , containerDetailsState :: ContainerState
193+ , state :: ContainerState
254194 , mounts :: [Mount]
255195 }
256196 deriving (Eq, Show, Generic)
257197
258−-- | Data type used for parsing the mount information from a container
259−-- list.
260198data Mount = Mount {
261− mountName :: Maybe Text -- this is optional
199+ mountName :: Text
262200 , mountSource :: FilePath
263201 , mountDestination :: FilePath
264− , mountDriver :: Maybe Text
265− -- , mountMode :: Maybe VolumePermission -- apparently this can be null
202+ , mountDriver :: Text
203+ , mountMode :: Text -- Note: Improve this?
266204 , mountRW :: Bool
267205 , mountPropogation :: Text
268206 }
@@ -270,18 +208,16 @@ data Mount = Mount {
270208
271209instance FromJSON Mount where
272210 parseJSON (JSON.Object o) = do
273− name <- o .:? "Name"
211+ name <- o .: "Name"
274212 src <- o .: "Source"
275213 dest <- o .: "Destination"
276− driver <- o .:? "Driver"
277− -- mode <- o .: "Mode"
214+ driver <- o .: "Driver"
215+ mode <- o .: "Mode"
278216 rw <- o .: "RW"
279217 prop <- o .: "Propagation"
280− return $ Mount name src dest driver rw prop
218+ return $ Mount name src dest driver mode rw prop
281219 parseJSON _ = fail "Mount is not an object"
282220
283−-- | Data type used for parsing the container state from a list of
284−-- containers.
285221data ContainerState = ContainerState {
286222 containerError :: Text
287223 , exitCode :: Int
@@ -293,7 +229,7 @@ data ContainerState = ContainerState {
293229 , restarting :: Bool
294230 , running :: Bool
295231 , startedAt :: UTCTime
296− , state :: State
232+ , status :: Status
297233 }
298234 deriving (Eq, Show, Generic)
299235
@@ -313,30 +249,23 @@ instance FromJSON ContainerState where
313249 return $ ContainerState err exit finished oomKilled dead paused pid restarting running started st
314250 parseJSON _ = fail "ContainerState is not an object"
315251
316−
317−-- | Client options used to configure the remote engine we're talking to
318252data DockerClientOpts = DockerClientOpts {
319253 apiVer :: ApiVersion
320254 , baseUrl :: URL
321255 }
322256 deriving (Eq, Show)
323257
324−-- | Default "DockerClientOpts" used for talking to the docker engine.
325258defaultClientOpts :: DockerClientOpts
326259defaultClientOpts = DockerClientOpts {
327260 apiVer = "v1.24"
328261 , baseUrl = "http://127.0.0.1:2375"
329262 }
330263
331−-- | List options used for filtering the list of container or images.
332264data ListOpts = ListOpts { all :: Bool } deriving (Eq, Show)
333265
334−-- | Default "ListOpts". Doesn't list stopped containers.
335266defaultListOpts :: ListOpts
336267defaultListOpts = ListOpts { all=False }
337268
338−-- | Data type used for represneting the version of the docker engine
339−-- remote API.
340269data DockerVersion = DockerVersion {
341270 version :: Text
342271 , apiVersion :: ApiVersion
@@ -406,8 +335,6 @@ instance FromJSON ImageID where
406335 return iid
407336 parseJSON _ = fail "ImageID is not an object."
408337
409−-- | Data type used for representing the information of various ports that
410−-- a contianer may expose.
411338data ContainerPortInfo = ContainerPortInfo {
412339 ipAddressInfo :: Maybe Text
413340 , privatePortInfo :: Port
@@ -424,8 +351,6 @@ instance FromJSON ContainerPortInfo where
424351 parseJSON _ = fail "ContainerPortInfo: Not a JSON object."
425352
426353-- For inspecting container details.
427−-- | Data type used for parsing the network information of each container
428−-- when listing them.
429354data NetworkOptions = NetworkOptions {
430355-- ipamConfig :: Maybe Text -- Don't see in 1.24
431356-- , links :: Maybe Text -- Don't see in 1.24
@@ -455,28 +380,29 @@ instance FromJSON NetworkOptions where
455380 return $ NetworkOptions networkId endpointId gateway ip ipLen ip6Gateway globalIP6 globalIP6Len mac
456381 parseJSON _ = fail "NetworkOptions is not an object"
457382
458−-- TODO: Not sure what this is used for anymore.
459−data Network = Network NetworkMode NetworkOptions
383+newtype Networks = Networks (M.Map NetworkMode NetworkOptions) -- Note: Is it ever possible that there will be duplicates of network modes?
460384 deriving (Eq, Show)
461385
462−instance {-# OVERLAPPING #-} FromJSON [Network] where
463− parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
386+instance FromJSON Networks where
387+ parseJSON (JSON.Object o) = do
388+ Networks <$> HM.foldlWithKey' f (return M.empty) o
389+
464390 where
465391 f accM k' v' = do
466392 acc <- accM
467393 k <- parseJSON $ JSON.String k'
468394 v <- parseJSON v'
469− return $ (Network k v):acc
395+ return $ M.insert k v acc
396+
470397 parseJSON _ = fail "Networks is not an object"
471398
472−-- | Data type reprsenting the various network settings a container can have.
473399data NetworkSettings = NetworkSettings {
474400 networkSettingsBridge :: Text
475401 , networkSettingsSandboxId :: Text
476402 , networkSettingsHairpinMode :: Bool
477403 , networkSettingsLinkLocalIPv6Address :: Text
478404 , networkSettingsLinkLocalIPv6PrefixLen :: Int
479− , networkSettingsPorts :: [PortBinding]
405+ , networkSettingsPorts :: PortBindings
480406 , networkSettingsSandboxKey :: Text
481407 , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
482408 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
@@ -488,7 +414,7 @@ data NetworkSettings = NetworkSettings {
488414 , networkSettingsIpPrefixLen :: Int
489415 , networkSettingsIpv6Gateway :: Text
490416 , networkSettingsMacAddress :: Text
491− , networkSettingsNetworks :: [Network]
417+ , networkSettingsNetworks :: Networks
492418 }
493419 deriving (Eq, Show)
494420
@@ -515,7 +441,6 @@ instance FromJSON NetworkSettings where
515441 return $ NetworkSettings bridge sandbox hairpin localIP6 localIP6Len ports sandboxKey secondaryIP secondayIP6 endpointID gateway globalIP6 globalIP6Len ip ipLen ip6Gateway mac networks
516442 parseJSON _ = fail "NetworkSettings is not an object."
517443
518−-- | Data type used for parsing a list of containers.
519444data Container = Container
520445 { containerId :: ContainerID
521446 , containerNames :: [Text]
@@ -523,23 +448,21 @@ data Container = Container
523448 , containerImageId :: ImageID
524449 , containerCommand :: Text
525450 , containerCreatedAt :: Int
526− , containerState :: State
527− , containerStatus :: Maybe Text
451+ , containerStatus :: Status
528452 , containerPorts :: [ContainerPortInfo]
529− , containerLabels :: [Label]
530− , containerNetworks :: [Network]
453+ , containerLabels :: Labels
454+ , containerNetworks :: Networks
531455 , containerMounts :: [Mount]
532456 } deriving (Show, Eq)
533457
534458instance FromJSON Container where
535− parseJSON o@(JSON.Object v) =
536− Container <$> parseJSON o
459+ parseJSON (JSON.Object v) =
460+ Container <$> (v .: "Id")
537461 <*> (v .: "Names")
538462 <*> (v .: "Image")
539− <*> (v .: "ImageID") -- Doesn't exist anymore
540− <*> (v .: "Command") -- Doesn't exist anymore
463+ <*> (v .: "ImageID")
464+ <*> (v .: "Command")
541465 <*> (v .: "Created")
542− <*> (v .: "State")
543466 <*> (v .: "Status")
544467 <*> (v .: "Ports")
545468 <*> (v .: "Labels")
@@ -549,124 +472,65 @@ instance FromJSON Container where
549472 parseNetworks (JSON.Object v) =
550473 (v .: "Networks") >>= parseJSON
551474 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
475+
552476 parseJSON _ = fail "Container: Not a JSON object."
553477
554−-- | Represents the state of the container life cycle.
555−data State = Created | Restarting | Running | Paused | Exited | Dead
478+data Status = Created | Restarting | Running | Paused | Exited | Dead
556479 deriving (Eq, Show, Generic)
557480
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.
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.
561484 parseJSON (JSON.String "restarting") = return Restarting
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
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"
566489
567−-- | Alias for representing a RepoDigest. We could newtype this and add
568−-- some validation.
569490type Digest = Text
570491
571−-- | Container and Image Labels.
572−data Label = Label Name Value deriving (Eq, Show)
573−
492+newtype Labels = Labels (M.Map Name Value) deriving (Eq, Show)
574493
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
494+instance FromJSON Labels where
495+ parseJSON val = Labels <$> parseJSON val
582496
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."
497+instance ToJSON Labels where
498+ toJSON (Labels kvs) = object [k .= v | (k,v) <- (M.toList kvs)]
591499
592−-- | Alias for Tags.
593500type Tag = Text
594501
595−-- | Data type used for parsing information from a list of images.
596502data Image = DockerImage {
597503 imageId :: ImageID
598504 , imageCreated :: Integer
599505 , imageParentId :: Maybe ImageID
600506 , imageRepoTags :: [Tag]
601− , imageRepoDigests :: [Digest]
507+ , imageRepoDigests :: Maybe [Digest]
602508 , imageSize :: Integer
603509 , imageVirtualSize :: Integer
604− , imageLabels :: [Label]
510+ , imageLabels :: Maybe Labels
605511 } deriving (Show, Eq, Generic)
606512
607−-- | Helper function used for dropping the "image" prefix when serializing
608−-- the Image data type to and from json.
609513dropImagePrefix :: [a] -> [a]
610514dropImagePrefix = drop 5
611515
612−
613516instance 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.
517+ parseJSON = genericParseJSON defaultOptions {
518+ fieldLabelModifier = dropImagePrefix}
519+
651520data CreateOpts = CreateOpts {
652− containerConfig :: ContainerConfig
653− , hostConfig :: HostConfig
654− , networkingConfig :: NetworkingConfig
521+ containerConfig :: ContainerConfig
522+ , hostConfig :: HostConfig
655523 } deriving (Eq, Show)
656524
657525instance ToJSON CreateOpts where
658− toJSON (CreateOpts cc hc nc) = do
526+ toJSON (CreateOpts cc hc) = do
659527 let ccJSON = toJSON cc
660528 let hcJSON = toJSON hc
661529 case ccJSON of
662530 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
663− let o1 = HM.insert "HostConfig" hcJSON o
664− let o2 = HM.insert "NetworkingConfig" (toJSON nc) o1
665− JSON.Object o2
531+ JSON.Object $ HM.insert "HostConfig" hcJSON o
666532 _ -> error "ContainerConfig is not an object." -- This should never happen.
667533
668−-- | Container configuration used for creating a container with sensible
669−-- defaults.
670534defaultContainerConfig :: Text -> ContainerConfig
671535defaultContainerConfig imageName = ContainerConfig {
672536 hostname=Nothing
@@ -676,29 +540,28 @@ defaultContainerConfig imageName = ContainerConfig {
676540 , attachStdout=False
677541 , image=imageName
678542 , attachStderr=False
679− , exposedPorts=[]
543+ , exposedPorts=Nothing -- ExposedPorts M.empty
680544 , tty=False
681545 , openStdin=False
682546 , stdinOnce=False
683547 , env=[]
684548 , cmd=[]
685− , volumes=[]
549+ , volumes=Nothing
686550 , workingDir=Nothing
687− , entrypoint=Entrypoint []
551+ , entrypoint=Nothing
688552 , networkDisabled=Nothing
689553 , macAddress=Nothing
690− , labels=[]
554+ , labels=Nothing
691555 , stopSignal=SIGTERM
692556 }
693557
694−-- | Default host confiratuon used for creating a container.
695558defaultHostConfig :: HostConfig
696559defaultHostConfig = HostConfig {
697560 binds=[]
698561 , containerIDFile=Nothing
699− , logConfig=LogDriverConfig JsonFile []
700− , networkMode=NetworkBridge
701− , portBindings=[]
562+ , logConfig=LogDriverConfig JsonFile Nothing
563+ , networkMode=Bridge
564+ , portBindings=PortBindings []
702565 , restartPolicy=RestartOff
703566 , volumeDriver=Nothing
704567 , volumesFrom=[]
@@ -719,7 +582,6 @@ defaultHostConfig = HostConfig {
719582 , resources=defaultContainerResources
720583 }
721584
722−-- Default container resource contstraints (None).
723585defaultContainerResources :: ContainerResources
724586defaultContainerResources = ContainerResources {
725587 cpuShares=Nothing
@@ -737,80 +599,34 @@ defaultContainerResources = ContainerResources {
737599 , memory=Nothing
738600 , memoryReservation=Nothing
739601 , memorySwap=Nothing
740− , oomKillDisable=Just False
602+ , oomKillDisable=False
741603 , ulimits=[]
742604 }
743605
744−-- | Default create options when creating a container. You only need to
745−-- specify an image name and the rest is all sensible defaults.
606+
746607defaultCreateOpts :: T.Text -> CreateOpts
747−defaultCreateOpts imageName = CreateOpts
748− { containerConfig = defaultContainerConfig imageName
749− , hostConfig = defaultHostConfig
750− , networkingConfig = NetworkingConfig HM.empty
751− }
608+defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
752609
753−-- | Override the key sequence for detaching a container.
610+-- detachKeys – Override the key sequence for detaching a container.
754611-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
755612data DetachKeys = WithCtrl Char | WithoutCtrl Char | DefaultDetachKey deriving (Eq, Show)
756613
757−-- | Options for starting a container.
758614data StartOpts = StartOpts { detachKeys :: DetachKeys } deriving (Eq, Show)
759615
760−-- | Default options for staring a container.
761616defaultStartOpts :: StartOpts
762617defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
763618
764−-- | Options for deleting a container.
765−data ContainerDeleteOpts = ContainerDeleteOpts {
619+data DeleteOpts = DeleteOpts {
766620 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
767621 , force :: Bool -- ^ If the container is still running force deletion anyway.
768622 } deriving (Eq, Show)
769623
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.
806−type Timestamp = Integer
624+defaultDeleteOpts :: DeleteOpts
625+defaultDeleteOpts = DeleteOpts { deleteVolumes = False, force = False }
807626
808−-- | Used for requesting N number of lines when tailing a containers log
809−-- output.
627+type Timestamp = Integer
810628data TailLogOpt = Tail Integer | All deriving (Eq, Show)
811629
812−
813−-- | Log options used when requesting the log output from a container.
814630data LogOpts = LogOpts {
815631 stdout :: Bool
816632 , stderr :: Bool
@@ -819,7 +635,6 @@ data LogOpts = LogOpts {
819635 , tail :: TailLogOpt
820636 } deriving (Eq, Show)
821637
822−-- | Sensible default for log options.
823638defaultLogOpts :: LogOpts
824639defaultLogOpts = LogOpts { stdout = True
825640 , stderr = True
@@ -828,87 +643,37 @@ defaultLogOpts = LogOpts { stdout = True
828643 , tail = All
829644 }
830645
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)
646+data VolumePermission = Rw | Ro deriving (Eq, Show, Generic)
904647
905−instance FromJSON Bind where
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)
669+
670+instance FromJSON Volume where
906671 parseJSON (JSON.String t) = case T.split (== ':') t of
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"
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"
912677
913678data Device = Device {
914679 pathOnHost :: FilePath
@@ -930,19 +695,19 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
930695
931696instance FromJSON VolumeFrom where
932697 parseJSON (JSON.String t) = case T.split (== ':') t of
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"
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"
937702 parseJSON _ = fail "VolumeFrom is not a string"
938703
939704instance ToJSON VolumeFrom where
940705 toJSON (VolumeFrom n p) = case p of
941− Nothing -> toJSON $ n <> ":" <> "rw"
706+ Nothing -> toJSON $ n <> ":" <> "rw"
942707 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
943708
944−instance ToJSON Bind where
945− toJSON (Bind src dest mode) = toJSON $ case mode of
709+instance ToJSON Volume where
710+ toJSON (Volume src dest mode) = toJSON $ case mode of
946711 Nothing -> T.concat[src, ":", dest]
947712 Just m -> T.concat[src, ":", dest, ":", (T.pack $ show m)]
948713
@@ -950,63 +715,63 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
950715
951716instance FromJSON Link where
952717 parseJSON (JSON.String t) = case T.split (== ':') t of
953− [f] -> return $ Link f Nothing
718+ [f] -> return $ Link f Nothing
954719 [f,s] -> return $ Link f $ Just s
955− _ -> fail "Could not parse Link"
720+ _ -> fail "Could not parse Link"
956721 parseJSON _ = fail "Link is not a string"
957722
958723instance ToJSON Link where
959724 toJSON (Link n1 n2) = toJSON $ case n2 of
960725 Nothing -> T.concat[n1, ":", n1] -- use same name in container
961− Just n -> T.concat[n1, ":", n] -- used specified name in container
726+ Just n -> T.concat[n1, ":", n] -- used specified name in container
962727
963728-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
964729data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
965730
966731instance FromJSON LogDriverType where
967732 parseJSON (JSON.String "json-file") = return JsonFile
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"
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"
977742
978743instance ToJSON LogDriverType where
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"
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"
987752 toJSON LoggingDisabled = JSON.String "none"
988753
989−data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
754+newtype LogDriverOptions = LogDriverOptions (M.Map Text Text) deriving (Eq, Show)
990755
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
756+instance FromJSON LogDriverOptions where
757+ parseJSON (JSON.Object o) = do
758+ LogDriverOptions <$> HM.foldlWithKey' f (return M.empty) o
996759
997−instance {-# OVERLAPPING #-} FromJSON [LogDriverOption] where
998− parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
999− where f accM k v = do
760+ where
761+ f accM k (JSON.String v) = do
1000762 acc <- accM
1001− value <- parseJSON v
1002− return $ (LogDriverOption k value):acc
1003− parseJSON JSON.Null = return []
1004− parseJSON _ = fail "Failed to parse LogDriverOptions"
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"
1005768
1006−data LogDriverConfig = LogDriverConfig LogDriverType [LogDriverOption] deriving (Eq, Show)
769+instance ToJSON LogDriverOptions where
770+ toJSON (LogDriverOptions mp) = toJSON mp
771+
772+data LogDriverConfig = LogDriverConfig LogDriverType (Maybe LogDriverOptions) deriving (Eq, Show)
1007773
1008774instance ToJSON LogDriverConfig where
1009− toJSON (LogDriverConfig driverType []) = object ["Type" .= driverType]
1010775 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
1011776
1012777instance FromJSON LogDriverConfig where
@@ -1017,47 +782,21 @@ instance FromJSON LogDriverConfig where
1017782 parseJSON _ = fail "LogDriverConfig is not an object"
1018783
1019784-- TODO: Add container:<name|id> mode
1020−data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
785+data NetworkMode = Bridge | Host | NetworkDisabled
1021786 deriving (Eq, Show, Ord)
1022787
1023788instance FromJSON NetworkMode where
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"
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"
1029793
1030794instance ToJSON NetworkMode where
1031− toJSON NetworkBridge = JSON.String "bridge"
1032− toJSON NetworkHost = JSON.String "host"
795+ toJSON Bridge = JSON.String "bridge"
796+ toJSON Host = JSON.String "host"
1033797 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
1046798
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"
799+data PortType = TCP | UDP deriving (Eq, Show, Generic, Read, Ord)
1061800
1062801instance ToJSON PortType where
1063802 toJSON TCP = "tcp"
@@ -1067,7 +806,7 @@ instance FromJSON PortType where
1067806 parseJSON val = case val of
1068807 "tcp" -> return TCP
1069808 "udp" -> return UDP
1070− _ -> fail "PortType: Invalid port type."
809+ _ -> fail "PortType: Invalid port type."
1071810
1072811-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
1073812--
@@ -1082,8 +821,9 @@ instance FromJSON PortType where
1082821-- host system s that the service running in the container can be accessed from
1083822-- the outside world. We either map a port onto all interfaces (default) or onto a specific
1084823-- interface like `127.0.0.1`.
1085−-- __NOTE__: We should disallow duplicate port bindings as the ToJSON
1086−-- instance will only send the last one.
824+newtype PortBindings = PortBindings [PortBinding]
825+ deriving (Eq, Show)
826+
1087827-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
1088828data PortBinding = PortBinding {
1089829 containerPort :: Port
@@ -1091,65 +831,17 @@ data PortBinding = PortBinding {
1091831 , hostPorts :: [HostPort]
1092832 } deriving (Eq, Show)
1093833
834+
1094835portAndType2Text :: Port -> PortType -> Text
1095836portAndType2Text p t = (T.pack $ show p) <> "/" <> (T.pack $ show t)
1096837
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
1097844
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
1153845 where
1154846 f accM k v = case T.split (== '/') k of
1155847 [port', portType'] -> do
@@ -1158,15 +850,13 @@ instance {-# OVERLAPPING #-} FromJSON [PortBinding] where
1158850 acc <- accM
1159851 hps <- parseJSON v
1160852 return $ (PortBinding port portType hps):acc
1161− _ -> fail "Could not parse PortBindings"
1162− parseJSON (JSON.Null) = return []
853+ _ ->
854+ fail "Could not parse PortBindings"
1163855 parseJSON _ = fail "PortBindings is not an object"
1164856
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
857+instance ToJSON PortBindings where
858+ toJSON (PortBindings []) = JSON.Object HM.empty
859+ toJSON (PortBindings (p:ps)) = toJSON (p:ps)
1170860
1171861data HostPort = HostPort {
1172862 hostIp :: Text
@@ -1184,6 +874,24 @@ instance FromJSON HostPort where
1184874 return $ HostPort i p
1185875 parseJSON _ = fail "HostPort is not an object."
1186876
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+
1187895-- { "Name": "on-failure" , "MaximumRetryCount": 2}
1188896type RetryCount = Integer
1189897data RestartPolicy = RestartAlways | RestartUnlessStopped | RestartOnFailure RetryCount | RestartOff deriving (Eq, Show)
@@ -1197,7 +905,7 @@ instance FromJSON RestartPolicy where
1197905 "on-failure" -> do
1198906 retry <- o .: "MaximumRetryCount"
1199907 return $ RestartOnFailure retry
1200− "no" -> return RestartOff
908+ "off" -> return RestartOff
1201909 _ -> fail "Could not parse RestartPolicy"
1202910 parseJSON _ = fail "RestartPolicy is not an object"
1203911
@@ -1205,7 +913,7 @@ instance ToJSON RestartPolicy where
1205913 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
1206914 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
1207915 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1208− toJSON RestartOff = object ["Name" .= JSON.String "no"]
916+ toJSON RestartOff = object ["Name" .= JSON.String "off"]
1209917
1210918data Isolation = Default | Process | Hyperv deriving (Eq, Show)
1211919
@@ -1215,11 +923,11 @@ newtype UTSMode = UTSMode Text deriving (Eq, Show)
1215923-- TODO: Add UTSMode : UTS namespace to use for the container
1216924-- TODO: Sysctls map[string]string `json:",omitempty"` // List of Namespaced sysctls used for the container
1217925data HostConfig = HostConfig
1218− { binds :: [Bind]
926+ { binds :: [Volume]
1219927 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
1220928 , logConfig :: LogDriverConfig
1221929 , networkMode :: NetworkMode
1222− , portBindings :: [PortBinding]
930+ , portBindings :: PortBindings
1223931 , restartPolicy :: RestartPolicy
1224932 , volumeDriver :: Maybe Text
1225933 , volumesFrom :: [VolumeFrom]
@@ -1378,22 +1086,6 @@ instance ToJSON DeviceRate where
13781086 , "Rate" .= r
13791087 ]
13801088
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−
13971089data ContainerResources = ContainerResources {
13981090 cpuShares :: Maybe Integer
13991091 -- , cgroupParent :: Text -- 1.24: Missing from inspecting container details... Going to omit for now.
@@ -1409,12 +1101,12 @@ data ContainerResources = ContainerResources {
14091101 , cpusetMems :: Maybe Text
14101102 , devices :: [Device]
14111103 -- , diskQuota :: Integer -- Don't see this ins 1.24.
1412− , kernelMemory :: Maybe MemoryConstraint
1413− , memory :: Maybe MemoryConstraint
1414− , memoryReservation :: Maybe MemoryConstraint
1415− , memorySwap :: Maybe MemoryConstraint
1104+ , kernelMemory :: Maybe Integer
1105+ , memory :: Maybe Integer
1106+ , memoryReservation :: Maybe Integer
1107+ , memorySwap :: Maybe Integer
14161108 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1417− , oomKillDisable :: Maybe Bool
1109+ , oomKillDisable :: Bool
14181110 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
14191111 , ulimits :: [Ulimit]
14201112 -- TODO: Missing from 1.24
@@ -1452,59 +1144,41 @@ instance FromJSON EnvVar where
14521144 parseJSON _ = fail "EnvVar is not a string"
14531145
14541146instance ToJSON EnvVar where
1455− toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
1147+ toJSON (EnvVar n v) = object [n .= v]
14561148
1457−-- | ExposedPort represents a port (and it's type)
1149+-- | ExposedPorts represent a enumeraton of all the ports (and their type)
14581150-- that a container should expose to other containers or the host system.
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
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
14611153-- the PublishAllPorts flag. It is also useful for
14621154-- the daemon to know which Environment variables to
14631155-- inject into a container linking to our container.
14641156-- Example linking a Postgres container named db would inject the following
14651157-- environment variables automatically if we set the corresponding
1466−--
1467−-- ExposedPort:
1468−--
1469−-- @
1158+-- ExposedPorts:
14701159-- DB_PORT_5432_TCP_PORT="5432"
14711160-- DB_PORT_5432_TCP_PROTO="tcp"
14721161-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
1473−-- @
1474−data ExposedPort = ExposedPort Port PortType deriving (Eq, Show)
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
14751168
1476−instance {-# OVERLAPPING #-} FromJSON [ExposedPort] where
1477− parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
14781169 where
14791170 f accM k _ = case T.split (== '/') k of
14801171 [port', portType'] -> do
14811172 port <- parseIntegerText port'
14821173 portType <- parseJSON $ JSON.String portType'
14831174 acc <- accM
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 "/"
1175+ return $ M.insert port portType acc
1176+ _ ->
1177+ fail "Could not parse ExposedPorts"
1178+ parseJSON _ = fail "ExposedPorts is not an object."
14941179
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"
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)]
15081182
15091183
15101184data ContainerConfig = ContainerConfig {
@@ -1514,7 +1188,7 @@ data ContainerConfig = ContainerConfig {
15141188 , attachStdin :: Bool
15151189 , attachStdout :: Bool
15161190 , attachStderr :: Bool
1517− , exposedPorts :: [ExposedPort]
1191+ , exposedPorts :: Maybe ExposedPorts -- Note: Should we expand the JSON instance and take away the Maybe?
15181192 -- , publishService :: Text -- Don't see this in 1.24
15191193 , tty :: Bool
15201194 , openStdin :: Bool
@@ -1523,70 +1197,27 @@ data ContainerConfig = ContainerConfig {
15231197 , cmd :: [Text]
15241198 -- , argsEscaped :: Bool -- Don't see this in 1.24
15251199 , image :: Text
1526− , volumes :: [Volume]
1200+ , volumes :: Maybe Volumes
15271201 , workingDir :: Maybe FilePath
1528− , entrypoint :: Entrypoint
1202+ , entrypoint :: Maybe Text -- Can be null?
15291203 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
15301204 , macAddress :: Maybe Text
15311205 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
1532− , labels :: [Label]
1206+ , labels :: Maybe Labels
15331207 , stopSignal :: Signal
15341208 } deriving (Eq, Show, Generic)
15351209
1536−
15371210instance ToJSON ContainerConfig where
15381211 toJSON = genericToJSON defaultOptions {
15391212 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
15401213
15411214instance FromJSON ContainerConfig where
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."
1215+ parseJSON = genericParseJSON defaultOptions {
1216+ fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
15661217
1567−#if MIN_VERSION_base(4,13,0)
1568−parseIntegerText :: (MonadFail m) => Text -> m Integer
1569−#else
15701218parseIntegerText :: (Monad m) => Text -> m Integer
1571−#endif
15721219parseIntegerText t = case readMaybe $ T.unpack t of
15731220 Nothing ->
15741221 fail "Could not parse Integer"
15751222 Just i ->
15761223 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