@@ -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,40 @@ 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(..)
4737 , Timestamp
4838 , TailLogOpt(..)
4939 , LogOpts(..)
5040 , defaultLogOpts
51− , CreateNetworkOpts(..)
52− , defaultCreateNetworkOpts
5341 , VolumePermission(..)
54− , Bind(..)
5542 , Volume(..)
5643 , Device(..)
5744 , ContainerName
5845 , VolumeFrom(..)
5946 , Link(..)
6047 , LogDriverType(..)
61− , LogDriverOption(..)
48+ , LogDriverOptions(..)
6249 , LogDriverConfig(..)
6350 , NetworkMode(..)
6451 , PortType(..)
6552-- , NetworkInterface(..)
66− , Network(..)
53+ , Networks(..)
6754 , NetworkSettings(..)
6855 , NetworkOptions(..)
6956 , Mount(..)
7057 , PortBinding(..)
58+ , PortBindings(..)
7159 , HostPort(..)
7260 , RetryCount
7361 , RestartPolicy(..)
@@ -75,8 +63,6 @@ module Docker.Client.Types (
7563 , UTSMode(..)
7664 , HostConfig(..)
7765 , defaultHostConfig
78− , NetworkingConfig(..)
79− , EndpointConfig(..)
8066 , Ulimit(..)
8167 , ContainerResources(..)
8268 , defaultContainerResources
@@ -86,18 +72,9 @@ module Docker.Client.Types (
8672 , EnvVar(..)
8773 , ContainerConfig(..)
8874 , defaultContainerConfig
89− , ExposedPort(..)
75+ , ExposedPorts(..)
9076 , DeviceWeight(..)
9177 , DeviceRate(..)
92− , addPortBinding
93− , addExposedPort
94− , addBind
95− , setCmd
96− , addLink
97− , addVolume
98− , addVolumeFrom
99− , MemoryConstraint(..)
100− , MemoryConstraintSize(..)
10178 ) where
10279
10380import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
@@ -107,57 +84,40 @@ import qualified Data.Aeson as JSON
10784import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
10885import Data.Char (isAlphaNum, toUpper)
10986import qualified Data.HashMap.Strict as HM
87+import qualified Data.Map as M
11088import Data.Monoid ((<>))
111−import Data.Scientific (floatingOrInteger)
11289import Data.Text (Text)
11390import qualified Data.Text as T
11491import Data.Time.Clock (UTCTime)
115−import qualified Data.Vector as V
11692import GHC.Generics (Generic)
11793import Prelude hiding (all, tail)
11894import Text.Read (readMaybe)
11995
120−-- | List of Docker Engine API endpoints
12196data Endpoint =
12297 VersionEndpoint
12398 | ListContainersEndpoint ListOpts
12499 | ListImagesEndpoint ListOpts
125− | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
100+ | CreateContainerEndpoint CreateOpts
126101 | StartContainerEndpoint StartOpts ContainerID
127102 | StopContainerEndpoint Timeout ContainerID
128− | WaitContainerEndpoint ContainerID
129103 | KillContainerEndpoint Signal ContainerID
130104 | RestartContainerEndpoint Timeout ContainerID
131105 | PauseContainerEndpoint ContainerID
132106 | UnpauseContainerEndpoint ContainerID
133107 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
134− -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
135− | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
108+ -- See note in "getContainerLogs" for explanation why.
109+ | DeleteContainerEndpoint DeleteOpts ContainerID
136110 | 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
142111 deriving (Eq, Show)
143112
144−-- | We should newtype this
145113type URL = Text
146−
147−-- | We should newtype this
148114type ApiVersion = Text
149−
150−
151−-- | ID of a contianer
152115newtype ContainerID = ContainerID Text
153116 deriving (Eq, Show)
154117
155−-- | Used for extracting the id of the container from the newtype
156118fromContainerID :: ContainerID -> Text
157119fromContainerID (ContainerID t) = t
158120
159−-- | Used for parsing a Text value into a ContainerID. We apply some basic
160−-- validation here.
161121toContainerID :: Text -> Maybe ContainerID
162122toContainerID t =
163123 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
@@ -165,16 +125,12 @@ toContainerID t =
165125 else
166126 Nothing
167127
168−-- ID of an image.
169128newtype ImageID = ImageID Text
170129 deriving (Eq, Show)
171130
172−-- | Used for extracting the id of the image from the newtype.
173131fromImageID :: ImageID -> Text
174132fromImageID (ImageID t) = t
175133
176−-- | Helper function used for parsing a Text value into an ImageID. For now
177−-- just basic validation is used.
178134toImageID :: Text -> Maybe ImageID
179135toImageID t =
180136 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
@@ -182,26 +138,9 @@ toImageID t =
182138 else
183139 Nothing
184140
185−-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
186141data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
187142
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−
202143-- 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.
205144data Signal = SIGHUP
206145 | SIGINT
207146 | SIGQUIT
@@ -213,16 +152,16 @@ data Signal = SIGHUP
213152
214153instance FromJSON Signal where
215154 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
155+ parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
156+ parseJSON (JSON.String "SIGINT") = return SIGINT
218157 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
219158 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
220159 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
221− parseJSON _ = fail "Unknown Signal"
160+ parseJSON _ = fail "Unknown Signal"
222161
223162instance ToJSON Signal where
224− toJSON SIGHUP = "SIGHUP"
225− toJSON SIGINT = "SIGINT"
163+ toJSON SIGHUP = "SIGHUP"
164+ toJSON SIGINT = "SIGINT"
226165 toJSON SIGQUIT = "SIGQUIT"
227166 toJSON SIGSTOP = "SIGSTOP"
228167 toJSON SIGTERM = "SIGTERM"
@@ -250,19 +189,17 @@ data ContainerDetails = ContainerDetails {
250189 , processLabel :: Text
251190 , resolveConfPath :: FilePath
252191 , restartCount :: Int
253− , containerDetailsState :: ContainerState
192+ , state :: ContainerState
254193 , mounts :: [Mount]
255194 }
256195 deriving (Eq, Show, Generic)
257196
258−-- | Data type used for parsing the mount information from a container
259−-- list.
260197data Mount = Mount {
261− mountName :: Maybe Text -- this is optional
198+ mountName :: Text
262199 , mountSource :: FilePath
263200 , mountDestination :: FilePath
264− , mountDriver :: Maybe Text
265− -- , mountMode :: Maybe VolumePermission -- apparently this can be null
201+ , mountDriver :: Text
202+ , mountMode :: Text -- Note: Improve this?
266203 , mountRW :: Bool
267204 , mountPropogation :: Text
268205 }
@@ -270,18 +207,16 @@ data Mount = Mount {
270207
271208instance FromJSON Mount where
272209 parseJSON (JSON.Object o) = do
273− name <- o .:? "Name"
210+ name <- o .: "Name"
274211 src <- o .: "Source"
275212 dest <- o .: "Destination"
276− driver <- o .:? "Driver"
277− -- mode <- o .: "Mode"
213+ driver <- o .: "Driver"
214+ mode <- o .: "Mode"
278215 rw <- o .: "RW"
279216 prop <- o .: "Propagation"
280− return $ Mount name src dest driver rw prop
217+ return $ Mount name src dest driver mode rw prop
281218 parseJSON _ = fail "Mount is not an object"
282219
283−-- | Data type used for parsing the container state from a list of
284−-- containers.
285220data ContainerState = ContainerState {
286221 containerError :: Text
287222 , exitCode :: Int
@@ -293,7 +228,7 @@ data ContainerState = ContainerState {
293228 , restarting :: Bool
294229 , running :: Bool
295230 , startedAt :: UTCTime
296− , state :: State
231+ , status :: Status
297232 }
298233 deriving (Eq, Show, Generic)
299234
@@ -313,30 +248,23 @@ instance FromJSON ContainerState where
313248 return $ ContainerState err exit finished oomKilled dead paused pid restarting running started st
314249 parseJSON _ = fail "ContainerState is not an object"
315250
316−
317−-- | Client options used to configure the remote engine we're talking to
318251data DockerClientOpts = DockerClientOpts {
319252 apiVer :: ApiVersion
320253 , baseUrl :: URL
321254 }
322255 deriving (Eq, Show)
323256
324−-- | Default "DockerClientOpts" used for talking to the docker engine.
325257defaultClientOpts :: DockerClientOpts
326258defaultClientOpts = DockerClientOpts {
327259 apiVer = "v1.24"
328260 , baseUrl = "http://127.0.0.1:2375"
329261 }
330262
331−-- | List options used for filtering the list of container or images.
332263data ListOpts = ListOpts { all :: Bool } deriving (Eq, Show)
333264
334−-- | Default "ListOpts". Doesn't list stopped containers.
335265defaultListOpts :: ListOpts
336266defaultListOpts = ListOpts { all=False }
337267
338−-- | Data type used for represneting the version of the docker engine
339−-- remote API.
340268data DockerVersion = DockerVersion {
341269 version :: Text
342270 , apiVersion :: ApiVersion
@@ -406,8 +334,6 @@ instance FromJSON ImageID where
406334 return iid
407335 parseJSON _ = fail "ImageID is not an object."
408336
409−-- | Data type used for representing the information of various ports that
410−-- a contianer may expose.
411337data ContainerPortInfo = ContainerPortInfo {
412338 ipAddressInfo :: Maybe Text
413339 , privatePortInfo :: Port
@@ -424,8 +350,6 @@ instance FromJSON ContainerPortInfo where
424350 parseJSON _ = fail "ContainerPortInfo: Not a JSON object."
425351
426352-- For inspecting container details.
427−-- | Data type used for parsing the network information of each container
428−-- when listing them.
429353data NetworkOptions = NetworkOptions {
430354-- ipamConfig :: Maybe Text -- Don't see in 1.24
431355-- , links :: Maybe Text -- Don't see in 1.24
@@ -455,28 +379,29 @@ instance FromJSON NetworkOptions where
455379 return $ NetworkOptions networkId endpointId gateway ip ipLen ip6Gateway globalIP6 globalIP6Len mac
456380 parseJSON _ = fail "NetworkOptions is not an object"
457381
458−-- TODO: Not sure what this is used for anymore.
459−data Network = Network NetworkMode NetworkOptions
382+newtype Networks = Networks (M.Map NetworkMode NetworkOptions) -- Note: Is it ever possible that there will be duplicates of network modes?
460383 deriving (Eq, Show)
461384
462−instance {-# OVERLAPPING #-} FromJSON [Network] where
463− parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
385+instance FromJSON Networks where
386+ parseJSON (JSON.Object o) = do
387+ Networks <$> HM.foldlWithKey' f (return M.empty) o
388+
464389 where
465390 f accM k' v' = do
466391 acc <- accM
467392 k <- parseJSON $ JSON.String k'
468393 v <- parseJSON v'
469− return $ (Network k v):acc
394+ return $ M.insert k v acc
395+
470396 parseJSON _ = fail "Networks is not an object"
471397
472−-- | Data type reprsenting the various network settings a container can have.
473398data NetworkSettings = NetworkSettings {
474399 networkSettingsBridge :: Text
475400 , networkSettingsSandboxId :: Text
476401 , networkSettingsHairpinMode :: Bool
477402 , networkSettingsLinkLocalIPv6Address :: Text
478403 , networkSettingsLinkLocalIPv6PrefixLen :: Int
479− , networkSettingsPorts :: [PortBinding]
404+ , networkSettingsPorts :: PortBindings
480405 , networkSettingsSandboxKey :: Text
481406 , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
482407 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
@@ -488,7 +413,7 @@ data NetworkSettings = NetworkSettings {
488413 , networkSettingsIpPrefixLen :: Int
489414 , networkSettingsIpv6Gateway :: Text
490415 , networkSettingsMacAddress :: Text
491− , networkSettingsNetworks :: [Network]
416+ , networkSettingsNetworks :: Networks
492417 }
493418 deriving (Eq, Show)
494419
@@ -515,7 +440,6 @@ instance FromJSON NetworkSettings where
515440 return $ NetworkSettings bridge sandbox hairpin localIP6 localIP6Len ports sandboxKey secondaryIP secondayIP6 endpointID gateway globalIP6 globalIP6Len ip ipLen ip6Gateway mac networks
516441 parseJSON _ = fail "NetworkSettings is not an object."
517442
518−-- | Data type used for parsing a list of containers.
519443data Container = Container
520444 { containerId :: ContainerID
521445 , containerNames :: [Text]
@@ -523,23 +447,21 @@ data Container = Container
523447 , containerImageId :: ImageID
524448 , containerCommand :: Text
525449 , containerCreatedAt :: Int
526− , containerState :: State
527− , containerStatus :: Maybe Text
450+ , containerStatus :: Status
528451 , containerPorts :: [ContainerPortInfo]
529− , containerLabels :: [Label]
530− , containerNetworks :: [Network]
452+ , containerLabels :: Labels
453+ , containerNetworks :: Networks
531454 , containerMounts :: [Mount]
532455 } deriving (Show, Eq)
533456
534457instance FromJSON Container where
535− parseJSON o@(JSON.Object v) =
536− Container <$> parseJSON o
458+ parseJSON (JSON.Object v) =
459+ Container <$> (v .: "Id")
537460 <*> (v .: "Names")
538461 <*> (v .: "Image")
539− <*> (v .: "ImageID") -- Doesn't exist anymore
540− <*> (v .: "Command") -- Doesn't exist anymore
462+ <*> (v .: "ImageID")
463+ <*> (v .: "Command")
541464 <*> (v .: "Created")
542− <*> (v .: "State")
543465 <*> (v .: "Status")
544466 <*> (v .: "Ports")
545467 <*> (v .: "Labels")
@@ -549,124 +471,65 @@ instance FromJSON Container where
549471 parseNetworks (JSON.Object v) =
550472 (v .: "Networks") >>= parseJSON
551473 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
474+
552475 parseJSON _ = fail "Container: Not a JSON object."
553476
554−-- | Represents the state of the container life cycle.
555−data State = Created | Restarting | Running | Paused | Exited | Dead
477+data Status = Created | Restarting | Running | Paused | Exited | Dead
556478 deriving (Eq, Show, Generic)
557479
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.
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.
561483 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
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"
566488
567−-- | Alias for representing a RepoDigest. We could newtype this and add
568−-- some validation.
569489type Digest = Text
570490
571−-- | Container and Image Labels.
572−data Label = Label Name Value deriving (Eq, Show)
573−
491+newtype Labels = Labels (M.Map Name Value) deriving (Eq, Show)
574492
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
493+instance FromJSON Labels where
494+ parseJSON val = Labels <$> parseJSON val
582495
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."
496+instance ToJSON Labels where
497+ toJSON (Labels kvs) = object [k .= v | (k,v) <- (M.toList kvs)]
591498
592−-- | Alias for Tags.
593499type Tag = Text
594500
595−-- | Data type used for parsing information from a list of images.
596501data Image = DockerImage {
597502 imageId :: ImageID
598503 , imageCreated :: Integer
599504 , imageParentId :: Maybe ImageID
600505 , imageRepoTags :: [Tag]
601− , imageRepoDigests :: [Digest]
506+ , imageRepoDigests :: Maybe [Digest]
602507 , imageSize :: Integer
603508 , imageVirtualSize :: Integer
604− , imageLabels :: [Label]
509+ , imageLabels :: Maybe Labels
605510 } deriving (Show, Eq, Generic)
606511
607−-- | Helper function used for dropping the "image" prefix when serializing
608−-- the Image data type to and from json.
609512dropImagePrefix :: [a] -> [a]
610513dropImagePrefix = drop 5
611514
612−
613515instance 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.
516+ parseJSON = genericParseJSON defaultOptions {
517+ fieldLabelModifier = dropImagePrefix}
518+
651519data CreateOpts = CreateOpts {
652− containerConfig :: ContainerConfig
653− , hostConfig :: HostConfig
654− , networkingConfig :: NetworkingConfig
520+ containerConfig :: ContainerConfig
521+ , hostConfig :: HostConfig
655522 } deriving (Eq, Show)
656523
657524instance ToJSON CreateOpts where
658− toJSON (CreateOpts cc hc nc) = do
525+ toJSON (CreateOpts cc hc) = do
659526 let ccJSON = toJSON cc
660527 let hcJSON = toJSON hc
661528 case ccJSON of
662529 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
530+ JSON.Object $ HM.insert "HostConfig" hcJSON o
666531 _ -> error "ContainerConfig is not an object." -- This should never happen.
667532
668−-- | Container configuration used for creating a container with sensible
669−-- defaults.
670533defaultContainerConfig :: Text -> ContainerConfig
671534defaultContainerConfig imageName = ContainerConfig {
672535 hostname=Nothing
@@ -676,29 +539,28 @@ defaultContainerConfig imageName = ContainerConfig {
676539 , attachStdout=False
677540 , image=imageName
678541 , attachStderr=False
679− , exposedPorts=[]
542+ , exposedPorts=Nothing -- ExposedPorts M.empty
680543 , tty=False
681544 , openStdin=False
682545 , stdinOnce=False
683546 , env=[]
684547 , cmd=[]
685− , volumes=[]
548+ , volumes=Nothing
686549 , workingDir=Nothing
687− , entrypoint=Entrypoint []
550+ , entrypoint=Nothing
688551 , networkDisabled=Nothing
689552 , macAddress=Nothing
690− , labels=[]
553+ , labels=Nothing
691554 , stopSignal=SIGTERM
692555 }
693556
694−-- | Default host confiratuon used for creating a container.
695557defaultHostConfig :: HostConfig
696558defaultHostConfig = HostConfig {
697559 binds=[]
698560 , containerIDFile=Nothing
699− , logConfig=LogDriverConfig JsonFile []
700− , networkMode=NetworkBridge
701− , portBindings=[]
561+ , logConfig=LogDriverConfig JsonFile Nothing
562+ , networkMode=Bridge
563+ , portBindings=PortBindings []
702564 , restartPolicy=RestartOff
703565 , volumeDriver=Nothing
704566 , volumesFrom=[]
@@ -719,7 +581,6 @@ defaultHostConfig = HostConfig {
719581 , resources=defaultContainerResources
720582 }
721583
722−-- Default container resource contstraints (None).
723584defaultContainerResources :: ContainerResources
724585defaultContainerResources = ContainerResources {
725586 cpuShares=Nothing
@@ -737,80 +598,31 @@ defaultContainerResources = ContainerResources {
737598 , memory=Nothing
738599 , memoryReservation=Nothing
739600 , memorySwap=Nothing
740− , oomKillDisable=Just False
601+ , oomKillDisable=False
741602 , ulimits=[]
742603 }
743604
744−-- | Default create options when creating a container. You only need to
745−-- specify an image name and the rest is all sensible defaults.
605+
746606defaultCreateOpts :: T.Text -> CreateOpts
747−defaultCreateOpts imageName = CreateOpts
748− { containerConfig = defaultContainerConfig imageName
749− , hostConfig = defaultHostConfig
750− , networkingConfig = NetworkingConfig HM.empty
751− }
607+defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
752608
753−-- | Override the key sequence for detaching a container.
609+-- detachKeys – Override the key sequence for detaching a container.
754610-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
755611data DetachKeys = WithCtrl Char | WithoutCtrl Char | DefaultDetachKey deriving (Eq, Show)
756612
757−-- | Options for starting a container.
758613data StartOpts = StartOpts { detachKeys :: DetachKeys } deriving (Eq, Show)
759614
760−-- | Default options for staring a container.
761615defaultStartOpts :: StartOpts
762616defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
763617
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.
618+data DeleteOpts = DeleteOpts {
619+ deleteVolumes :: Bool
620+ , force :: Bool
768621 } deriving (Eq, Show)
769622
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.
806623type Timestamp = Integer
807−
808−-- | Used for requesting N number of lines when tailing a containers log
809−-- output.
810624data TailLogOpt = Tail Integer | All deriving (Eq, Show)
811625
812−
813−-- | Log options used when requesting the log output from a container.
814626data LogOpts = LogOpts {
815627 stdout :: Bool
816628 , stderr :: Bool
@@ -819,7 +631,6 @@ data LogOpts = LogOpts {
819631 , tail :: TailLogOpt
820632 } deriving (Eq, Show)
821633
822−-- | Sensible default for log options.
823634defaultLogOpts :: LogOpts
824635defaultLogOpts = LogOpts { stdout = True
825636 , stderr = True
@@ -828,87 +639,37 @@ defaultLogOpts = LogOpts { stdout = True
828639 , tail = All
829640 }
830641
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)
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"
904648
905−instance FromJSON Bind where
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)
665+
666+instance FromJSON Volume where
906667 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"
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"
912673
913674data Device = Device {
914675 pathOnHost :: FilePath
@@ -930,19 +691,19 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
930691
931692instance FromJSON VolumeFrom where
932693 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"
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"
937698 parseJSON _ = fail "VolumeFrom is not a string"
938699
939700instance ToJSON VolumeFrom where
940701 toJSON (VolumeFrom n p) = case p of
941− Nothing -> toJSON $ n <> ":" <> "rw"
702+ Nothing -> toJSON $ n <> ":" <> "rw"
942703 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
943704
944−instance ToJSON Bind where
945− toJSON (Bind src dest mode) = toJSON $ case mode of
705+instance ToJSON Volume where
706+ toJSON (Volume src dest mode) = toJSON $ case mode of
946707 Nothing -> T.concat[src, ":", dest]
947708 Just m -> T.concat[src, ":", dest, ":", (T.pack $ show m)]
948709
@@ -950,63 +711,63 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
950711
951712instance FromJSON Link where
952713 parseJSON (JSON.String t) = case T.split (== ':') t of
953− [f] -> return $ Link f Nothing
714+ [f] -> return $ Link f Nothing
954715 [f,s] -> return $ Link f $ Just s
955− _ -> fail "Could not parse Link"
716+ _ -> fail "Could not parse Link"
956717 parseJSON _ = fail "Link is not a string"
957718
958719instance ToJSON Link where
959720 toJSON (Link n1 n2) = toJSON $ case n2 of
960721 Nothing -> T.concat[n1, ":", n1] -- use same name in container
961− Just n -> T.concat[n1, ":", n] -- used specified name in container
722+ Just n -> T.concat[n1, ":", n] -- used specified name in container
962723
963724-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
964725data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
965726
966727instance FromJSON LogDriverType where
967728 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"
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"
977738
978739instance 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"
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"
987748 toJSON LoggingDisabled = JSON.String "none"
988749
989−data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
750+newtype LogDriverOptions = LogDriverOptions (M.Map Text Text) deriving (Eq, Show)
990751
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
752+instance FromJSON LogDriverOptions where
753+ parseJSON (JSON.Object o) = do
754+ LogDriverOptions <$> HM.foldlWithKey' f (return M.empty) o
996755
997−instance {-# OVERLAPPING #-} FromJSON [LogDriverOption] where
998− parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
999− where f accM k v = do
756+ where
757+ f accM k (JSON.String v) = do
1000758 acc <- accM
1001− value <- parseJSON v
1002− return $ (LogDriverOption k value):acc
1003− parseJSON JSON.Null = return []
1004− parseJSON _ = fail "Failed to parse LogDriverOptions"
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
1005767
1006−data LogDriverConfig = LogDriverConfig LogDriverType [LogDriverOption] deriving (Eq, Show)
768+data LogDriverConfig = LogDriverConfig LogDriverType (Maybe LogDriverOptions) deriving (Eq, Show)
1007769
1008770instance ToJSON LogDriverConfig where
1009− toJSON (LogDriverConfig driverType []) = object ["Type" .= driverType]
1010771 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
1011772
1012773instance FromJSON LogDriverConfig where
@@ -1017,47 +778,21 @@ instance FromJSON LogDriverConfig where
1017778 parseJSON _ = fail "LogDriverConfig is not an object"
1018779
1019780-- TODO: Add container:<name|id> mode
1020−data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
781+data NetworkMode = Bridge | Host | NetworkDisabled
1021782 deriving (Eq, Show, Ord)
1022783
1023784instance 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"
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"
1029789
1030790instance ToJSON NetworkMode where
1031− toJSON NetworkBridge = JSON.String "bridge"
1032− toJSON NetworkHost = JSON.String "host"
791+ toJSON Bridge = JSON.String "bridge"
792+ toJSON Host = JSON.String "host"
1033793 toJSON NetworkDisabled = JSON.String "none"
1034− toJSON (NetworkNamed n) = JSON.String n
1035794
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"
795+data PortType = TCP | UDP deriving (Eq, Show, Generic, Read, Ord)
1061796
1062797instance ToJSON PortType where
1063798 toJSON TCP = "tcp"
@@ -1067,7 +802,7 @@ instance FromJSON PortType where
1067802 parseJSON val = case val of
1068803 "tcp" -> return TCP
1069804 "udp" -> return UDP
1070− _ -> fail "PortType: Invalid port type."
805+ _ -> fail "PortType: Invalid port type."
1071806
1072807-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
1073808--
@@ -1082,8 +817,9 @@ instance FromJSON PortType where
1082817-- host system s that the service running in the container can be accessed from
1083818-- the outside world. We either map a port onto all interfaces (default) or onto a specific
1084819-- 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.
820+newtype PortBindings = PortBindings [PortBinding]
821+ deriving (Eq, Show)
822+
1087823-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
1088824data PortBinding = PortBinding {
1089825 containerPort :: Port
@@ -1091,65 +827,17 @@ data PortBinding = PortBinding {
1091827 , hostPorts :: [HostPort]
1092828 } deriving (Eq, Show)
1093829
830+
1094831portAndType2Text :: Port -> PortType -> Text
1095832portAndType2Text p t = (T.pack $ show p) <> "/" <> (T.pack $ show t)
1096833
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
1097840
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
1153841 where
1154842 f accM k v = case T.split (== '/') k of
1155843 [port', portType'] -> do
@@ -1158,15 +846,13 @@ instance {-# OVERLAPPING #-} FromJSON [PortBinding] where
1158846 acc <- accM
1159847 hps <- parseJSON v
1160848 return $ (PortBinding port portType hps):acc
1161− _ -> fail "Could not parse PortBindings"
1162− parseJSON (JSON.Null) = return []
849+ _ ->
850+ fail "Could not parse PortBindings"
1163851 parseJSON _ = fail "PortBindings is not an object"
1164852
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
853+instance ToJSON PortBindings where
854+ toJSON (PortBindings []) = JSON.Object HM.empty
855+ toJSON (PortBindings (p:ps)) = toJSON (p:ps)
1170856
1171857data HostPort = HostPort {
1172858 hostIp :: Text
@@ -1184,6 +870,24 @@ instance FromJSON HostPort where
1184870 return $ HostPort i p
1185871 parseJSON _ = fail "HostPort is not an object."
1186872
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+
1187891-- { "Name": "on-failure" , "MaximumRetryCount": 2}
1188892type RetryCount = Integer
1189893data RestartPolicy = RestartAlways | RestartUnlessStopped | RestartOnFailure RetryCount | RestartOff deriving (Eq, Show)
@@ -1197,7 +901,7 @@ instance FromJSON RestartPolicy where
1197901 "on-failure" -> do
1198902 retry <- o .: "MaximumRetryCount"
1199903 return $ RestartOnFailure retry
1200− "no" -> return RestartOff
904+ "off" -> return RestartOff
1201905 _ -> fail "Could not parse RestartPolicy"
1202906 parseJSON _ = fail "RestartPolicy is not an object"
1203907
@@ -1205,7 +909,7 @@ instance ToJSON RestartPolicy where
1205909 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
1206910 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
1207911 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1208− toJSON RestartOff = object ["Name" .= JSON.String "no"]
912+ toJSON RestartOff = object ["Name" .= JSON.String "off"]
1209913
1210914data Isolation = Default | Process | Hyperv deriving (Eq, Show)
1211915
@@ -1215,11 +919,11 @@ newtype UTSMode = UTSMode Text deriving (Eq, Show)
1215919-- TODO: Add UTSMode : UTS namespace to use for the container
1216920-- TODO: Sysctls map[string]string `json:",omitempty"` // List of Namespaced sysctls used for the container
1217921data HostConfig = HostConfig
1218− { binds :: [Bind]
922+ { binds :: [Volume]
1219923 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
1220924 , logConfig :: LogDriverConfig
1221925 , networkMode :: NetworkMode
1222− , portBindings :: [PortBinding]
926+ , portBindings :: PortBindings
1223927 , restartPolicy :: RestartPolicy
1224928 , volumeDriver :: Maybe Text
1225929 , volumesFrom :: [VolumeFrom]
@@ -1378,22 +1082,6 @@ instance ToJSON DeviceRate where
13781082 , "Rate" .= r
13791083 ]
13801084
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−
13971085data ContainerResources = ContainerResources {
13981086 cpuShares :: Maybe Integer
13991087 -- , cgroupParent :: Text -- 1.24: Missing from inspecting container details... Going to omit for now.
@@ -1409,12 +1097,12 @@ data ContainerResources = ContainerResources {
14091097 , cpusetMems :: Maybe Text
14101098 , devices :: [Device]
14111099 -- , 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
1100+ , kernelMemory :: Maybe Integer
1101+ , memory :: Maybe Integer
1102+ , memoryReservation :: Maybe Integer
1103+ , memorySwap :: Maybe Integer
14161104 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1417− , oomKillDisable :: Maybe Bool
1105+ , oomKillDisable :: Bool
14181106 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
14191107 , ulimits :: [Ulimit]
14201108 -- TODO: Missing from 1.24
@@ -1452,59 +1140,41 @@ instance FromJSON EnvVar where
14521140 parseJSON _ = fail "EnvVar is not a string"
14531141
14541142instance ToJSON EnvVar where
1455− toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
1143+ toJSON (EnvVar n v) = object [n .= v]
14561144
1457−-- | ExposedPort represents a port (and it's type)
1145+-- | ExposedPorts represent a enumeraton of all the ports (and their type)
14581146-- 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
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
14611149-- the PublishAllPorts flag. It is also useful for
14621150-- the daemon to know which Environment variables to
14631151-- inject into a container linking to our container.
14641152-- Example linking a Postgres container named db would inject the following
14651153-- environment variables automatically if we set the corresponding
1466−--
1467−-- ExposedPort:
1468−--
1469−-- @
1154+-- ExposedPorts:
14701155-- DB_PORT_5432_TCP_PORT="5432"
14711156-- DB_PORT_5432_TCP_PROTO="tcp"
14721157-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
1473−-- @
1474−data ExposedPort = ExposedPort Port PortType deriving (Eq, Show)
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
14751164
1476−instance {-# OVERLAPPING #-} FromJSON [ExposedPort] where
1477− parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
14781165 where
14791166 f accM k _ = case T.split (== '/') k of
14801167 [port', portType'] -> do
14811168 port <- parseIntegerText port'
14821169 portType <- parseJSON $ JSON.String portType'
14831170 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 "/"
1494−
1495−data Entrypoint = Entrypoint [T.Text] deriving (Eq, Show, Generic)
1171+ return $ M.insert port portType acc
1172+ _ ->
1173+ fail "Could not parse ExposedPorts"
1174+ parseJSON _ = fail "ExposedPorts is not an object."
14961175
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"
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)]
15081178
15091179
15101180data ContainerConfig = ContainerConfig {
@@ -1514,7 +1184,7 @@ data ContainerConfig = ContainerConfig {
15141184 , attachStdin :: Bool
15151185 , attachStdout :: Bool
15161186 , attachStderr :: Bool
1517− , exposedPorts :: [ExposedPort]
1187+ , exposedPorts :: Maybe ExposedPorts -- Note: Should we expand the JSON instance and take away the Maybe?
15181188 -- , publishService :: Text -- Don't see this in 1.24
15191189 , tty :: Bool
15201190 , openStdin :: Bool
@@ -1523,70 +1193,27 @@ data ContainerConfig = ContainerConfig {
15231193 , cmd :: [Text]
15241194 -- , argsEscaped :: Bool -- Don't see this in 1.24
15251195 , image :: Text
1526− , volumes :: [Volume]
1196+ , volumes :: Maybe Volumes
15271197 , workingDir :: Maybe FilePath
1528− , entrypoint :: Entrypoint
1198+ , entrypoint :: Maybe Text -- Can be null?
15291199 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
15301200 , macAddress :: Maybe Text
15311201 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
1532− , labels :: [Label]
1202+ , labels :: Maybe Labels
15331203 , stopSignal :: Signal
15341204 } deriving (Eq, Show, Generic)
15351205
1536−
15371206instance ToJSON ContainerConfig where
15381207 toJSON = genericToJSON defaultOptions {
15391208 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
15401209
15411210instance 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."
1211+ parseJSON = genericParseJSON defaultOptions {
1212+ fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
15661213
1567−#if MIN_VERSION_base(4,13,0)
1568−parseIntegerText :: (MonadFail m) => Text -> m Integer
1569−#else
15701214parseIntegerText :: (Monad m) => Text -> m Integer
1571−#endif
15721215parseIntegerText t = case readMaybe $ T.unpack t of
15731216 Nothing ->
15741217 fail "Could not parse Integer"
15751218 Just i ->
15761219 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