@@ -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,42 @@ 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(..)
44+ , Volumes(..)
5645 , Device(..)
5746 , ContainerName
5847 , VolumeFrom(..)
5948 , Link(..)
6049 , LogDriverType(..)
61− , LogDriverOption(..)
50+ , LogDriverOptions(..)
6251 , LogDriverConfig(..)
6352 , NetworkMode(..)
6453 , PortType(..)
6554-- , NetworkInterface(..)
66− , Network(..)
55+ , Networks(..)
6756 , NetworkSettings(..)
6857 , NetworkOptions(..)
6958 , Mount(..)
7059 , PortBinding(..)
60+ , PortBindings(..)
7161 , HostPort(..)
7262 , RetryCount
7363 , RestartPolicy(..)
@@ -75,8 +65,6 @@ module Docker.Client.Types (
7565 , UTSMode(..)
7666 , HostConfig(..)
7767 , defaultHostConfig
78− , NetworkingConfig(..)
79− , EndpointConfig(..)
8068 , Ulimit(..)
8169 , ContainerResources(..)
8270 , defaultContainerResources
@@ -86,18 +74,10 @@ module Docker.Client.Types (
8674 , EnvVar(..)
8775 , ContainerConfig(..)
8876 , defaultContainerConfig
89− , ExposedPort(..)
77+ , ExposedPorts(..)
9078 , DeviceWeight(..)
9179 , DeviceRate(..)
9280 , addPortBinding
93− , addExposedPort
94− , addBind
95− , setCmd
96− , addLink
97− , addVolume
98− , addVolumeFrom
99− , MemoryConstraint(..)
100− , MemoryConstraintSize(..)
10181 ) where
10282
10383import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
@@ -107,57 +87,40 @@ import qualified Data.Aeson as JSON
10787import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
10888import Data.Char (isAlphaNum, toUpper)
10989import qualified Data.HashMap.Strict as HM
90+import qualified Data.Map as M
11091import Data.Monoid ((<>))
111−import Data.Scientific (floatingOrInteger)
11292import Data.Text (Text)
11393import qualified Data.Text as T
11494import Data.Time.Clock (UTCTime)
115−import qualified Data.Vector as V
11695import GHC.Generics (Generic)
11796import Prelude hiding (all, tail)
11897import Text.Read (readMaybe)
11998
120−-- | List of Docker Engine API endpoints
12199data Endpoint =
122100 VersionEndpoint
123101 | ListContainersEndpoint ListOpts
124102 | ListImagesEndpoint ListOpts
125− | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
103+ | CreateContainerEndpoint CreateOpts
126104 | StartContainerEndpoint StartOpts ContainerID
127105 | StopContainerEndpoint Timeout ContainerID
128− | WaitContainerEndpoint ContainerID
129106 | KillContainerEndpoint Signal ContainerID
130107 | RestartContainerEndpoint Timeout ContainerID
131108 | PauseContainerEndpoint ContainerID
132109 | UnpauseContainerEndpoint ContainerID
133110 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
134111 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
135− | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
112+ | DeleteContainerEndpoint DeleteOpts ContainerID
136113 | 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
142114 deriving (Eq, Show)
143115
144−-- | We should newtype this
145116type URL = Text
146−
147−-- | We should newtype this
148117type ApiVersion = Text
149−
150−
151−-- | ID of a contianer
152118newtype ContainerID = ContainerID Text
153119 deriving (Eq, Show)
154120
155−-- | Used for extracting the id of the container from the newtype
156121fromContainerID :: ContainerID -> Text
157122fromContainerID (ContainerID t) = t
158123
159−-- | Used for parsing a Text value into a ContainerID. We apply some basic
160−-- validation here.
161124toContainerID :: Text -> Maybe ContainerID
162125toContainerID t =
163126 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
@@ -165,16 +128,12 @@ toContainerID t =
165128 else
166129 Nothing
167130
168−-- ID of an image.
169131newtype ImageID = ImageID Text
170132 deriving (Eq, Show)
171133
172−-- | Used for extracting the id of the image from the newtype.
173134fromImageID :: ImageID -> Text
174135fromImageID (ImageID t) = t
175136
176−-- | Helper function used for parsing a Text value into an ImageID. For now
177−-- just basic validation is used.
178137toImageID :: Text -> Maybe ImageID
179138toImageID t =
180139 if T.all (\c -> isAlphaNum c || c == ':') t then -- Note: Can we improve this whitelist?
@@ -182,26 +141,9 @@ toImageID t =
182141 else
183142 Nothing
184143
185−-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
186144data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
187145
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−
202146-- 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.
205147data Signal = SIGHUP
206148 | SIGINT
207149 | SIGQUIT
@@ -213,16 +155,16 @@ data Signal = SIGHUP
213155
214156instance FromJSON Signal where
215157 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
158+ parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
159+ parseJSON (JSON.String "SIGINT") = return SIGINT
218160 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
219161 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
220162 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
221− parseJSON _ = fail "Unknown Signal"
163+ parseJSON _ = fail "Unknown Signal"
222164
223165instance ToJSON Signal where
224− toJSON SIGHUP = "SIGHUP"
225− toJSON SIGINT = "SIGINT"
166+ toJSON SIGHUP = "SIGHUP"
167+ toJSON SIGINT = "SIGINT"
226168 toJSON SIGQUIT = "SIGQUIT"
227169 toJSON SIGSTOP = "SIGSTOP"
228170 toJSON SIGTERM = "SIGTERM"
@@ -250,19 +192,17 @@ data ContainerDetails = ContainerDetails {
250192 , processLabel :: Text
251193 , resolveConfPath :: FilePath
252194 , restartCount :: Int
253− , containerDetailsState :: ContainerState
195+ , state :: ContainerState
254196 , mounts :: [Mount]
255197 }
256198 deriving (Eq, Show, Generic)
257199
258−-- | Data type used for parsing the mount information from a container
259−-- list.
260200data Mount = Mount {
261− mountName :: Maybe Text -- this is optional
201+ mountName :: Text
262202 , mountSource :: FilePath
263203 , mountDestination :: FilePath
264− , mountDriver :: Maybe Text
265− -- , mountMode :: Maybe VolumePermission -- apparently this can be null
204+ , mountDriver :: Text
205+ , mountMode :: Maybe VolumePermission -- apparently this can be null
266206 , mountRW :: Bool
267207 , mountPropogation :: Text
268208 }
@@ -270,18 +210,16 @@ data Mount = Mount {
270210
271211instance FromJSON Mount where
272212 parseJSON (JSON.Object o) = do
273− name <- o .:? "Name"
213+ name <- o .: "Name"
274214 src <- o .: "Source"
275215 dest <- o .: "Destination"
276− driver <- o .:? "Driver"
277− -- mode <- o .: "Mode"
216+ driver <- o .: "Driver"
217+ mode <- o .: "Mode"
278218 rw <- o .: "RW"
279219 prop <- o .: "Propagation"
280− return $ Mount name src dest driver rw prop
220+ return $ Mount name src dest driver mode rw prop
281221 parseJSON _ = fail "Mount is not an object"
282222
283−-- | Data type used for parsing the container state from a list of
284−-- containers.
285223data ContainerState = ContainerState {
286224 containerError :: Text
287225 , exitCode :: Int
@@ -293,7 +231,7 @@ data ContainerState = ContainerState {
293231 , restarting :: Bool
294232 , running :: Bool
295233 , startedAt :: UTCTime
296− , state :: State
234+ , status :: Status
297235 }
298236 deriving (Eq, Show, Generic)
299237
@@ -313,30 +251,23 @@ instance FromJSON ContainerState where
313251 return $ ContainerState err exit finished oomKilled dead paused pid restarting running started st
314252 parseJSON _ = fail "ContainerState is not an object"
315253
316−
317−-- | Client options used to configure the remote engine we're talking to
318254data DockerClientOpts = DockerClientOpts {
319255 apiVer :: ApiVersion
320256 , baseUrl :: URL
321257 }
322258 deriving (Eq, Show)
323259
324−-- | Default "DockerClientOpts" used for talking to the docker engine.
325260defaultClientOpts :: DockerClientOpts
326261defaultClientOpts = DockerClientOpts {
327262 apiVer = "v1.24"
328263 , baseUrl = "http://127.0.0.1:2375"
329264 }
330265
331−-- | List options used for filtering the list of container or images.
332266data ListOpts = ListOpts { all :: Bool } deriving (Eq, Show)
333267
334−-- | Default "ListOpts". Doesn't list stopped containers.
335268defaultListOpts :: ListOpts
336269defaultListOpts = ListOpts { all=False }
337270
338−-- | Data type used for represneting the version of the docker engine
339−-- remote API.
340271data DockerVersion = DockerVersion {
341272 version :: Text
342273 , apiVersion :: ApiVersion
@@ -406,8 +337,6 @@ instance FromJSON ImageID where
406337 return iid
407338 parseJSON _ = fail "ImageID is not an object."
408339
409−-- | Data type used for representing the information of various ports that
410−-- a contianer may expose.
411340data ContainerPortInfo = ContainerPortInfo {
412341 ipAddressInfo :: Maybe Text
413342 , privatePortInfo :: Port
@@ -424,8 +353,6 @@ instance FromJSON ContainerPortInfo where
424353 parseJSON _ = fail "ContainerPortInfo: Not a JSON object."
425354
426355-- For inspecting container details.
427−-- | Data type used for parsing the network information of each container
428−-- when listing them.
429356data NetworkOptions = NetworkOptions {
430357-- ipamConfig :: Maybe Text -- Don't see in 1.24
431358-- , links :: Maybe Text -- Don't see in 1.24
@@ -455,28 +382,29 @@ instance FromJSON NetworkOptions where
455382 return $ NetworkOptions networkId endpointId gateway ip ipLen ip6Gateway globalIP6 globalIP6Len mac
456383 parseJSON _ = fail "NetworkOptions is not an object"
457384
458−-- TODO: Not sure what this is used for anymore.
459−data Network = Network NetworkMode NetworkOptions
385+newtype Networks = Networks (M.Map NetworkMode NetworkOptions) -- Note: Is it ever possible that there will be duplicates of network modes?
460386 deriving (Eq, Show)
461387
462−instance {-# OVERLAPPING #-} FromJSON [Network] where
463− parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
388+instance FromJSON Networks where
389+ parseJSON (JSON.Object o) = do
390+ Networks <$> HM.foldlWithKey' f (return M.empty) o
391+
464392 where
465393 f accM k' v' = do
466394 acc <- accM
467395 k <- parseJSON $ JSON.String k'
468396 v <- parseJSON v'
469− return $ (Network k v):acc
397+ return $ M.insert k v acc
398+
470399 parseJSON _ = fail "Networks is not an object"
471400
472−-- | Data type reprsenting the various network settings a container can have.
473401data NetworkSettings = NetworkSettings {
474402 networkSettingsBridge :: Text
475403 , networkSettingsSandboxId :: Text
476404 , networkSettingsHairpinMode :: Bool
477405 , networkSettingsLinkLocalIPv6Address :: Text
478406 , networkSettingsLinkLocalIPv6PrefixLen :: Int
479− , networkSettingsPorts :: [PortBinding]
407+ , networkSettingsPorts :: PortBindings
480408 , networkSettingsSandboxKey :: Text
481409 , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
482410 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
@@ -488,7 +416,7 @@ data NetworkSettings = NetworkSettings {
488416 , networkSettingsIpPrefixLen :: Int
489417 , networkSettingsIpv6Gateway :: Text
490418 , networkSettingsMacAddress :: Text
491− , networkSettingsNetworks :: [Network]
419+ , networkSettingsNetworks :: Networks
492420 }
493421 deriving (Eq, Show)
494422
@@ -515,7 +443,6 @@ instance FromJSON NetworkSettings where
515443 return $ NetworkSettings bridge sandbox hairpin localIP6 localIP6Len ports sandboxKey secondaryIP secondayIP6 endpointID gateway globalIP6 globalIP6Len ip ipLen ip6Gateway mac networks
516444 parseJSON _ = fail "NetworkSettings is not an object."
517445
518−-- | Data type used for parsing a list of containers.
519446data Container = Container
520447 { containerId :: ContainerID
521448 , containerNames :: [Text]
@@ -523,23 +450,21 @@ data Container = Container
523450 , containerImageId :: ImageID
524451 , containerCommand :: Text
525452 , containerCreatedAt :: Int
526− , containerState :: State
527− , containerStatus :: Maybe Text
453+ , containerStatus :: Status
528454 , containerPorts :: [ContainerPortInfo]
529− , containerLabels :: [Label]
530− , containerNetworks :: [Network]
455+ , containerLabels :: Labels
456+ , containerNetworks :: Networks
531457 , containerMounts :: [Mount]
532458 } deriving (Show, Eq)
533459
534460instance FromJSON Container where
535− parseJSON o@(JSON.Object v) =
536− Container <$> parseJSON o
461+ parseJSON (JSON.Object v) =
462+ Container <$> (v .: "Id")
537463 <*> (v .: "Names")
538464 <*> (v .: "Image")
539− <*> (v .: "ImageID") -- Doesn't exist anymore
540− <*> (v .: "Command") -- Doesn't exist anymore
465+ <*> (v .: "ImageID")
466+ <*> (v .: "Command")
541467 <*> (v .: "Created")
542− <*> (v .: "State")
543468 <*> (v .: "Status")
544469 <*> (v .: "Ports")
545470 <*> (v .: "Labels")
@@ -549,124 +474,65 @@ instance FromJSON Container where
549474 parseNetworks (JSON.Object v) =
550475 (v .: "Networks") >>= parseJSON
551476 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
477+
552478 parseJSON _ = fail "Container: Not a JSON object."
553479
554−-- | Represents the state of the container life cycle.
555−data State = Created | Restarting | Running | Paused | Exited | Dead
480+data Status = Created | Restarting | Running | Paused | Exited | Dead
556481 deriving (Eq, Show, Generic)
557482
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.
483+instance FromJSON Status where
484+ parseJSON (JSON.String "running") = return Running
485+ parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
561486 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
487+ parseJSON (JSON.String "paused") = return Paused
488+ parseJSON (JSON.String "exited") = return Exited
489+ parseJSON (JSON.String "dead") = return Dead
490+ parseJSON _ = fail "Unknown Status"
566491
567−-- | Alias for representing a RepoDigest. We could newtype this and add
568−-- some validation.
569492type Digest = Text
570493
571−-- | Container and Image Labels.
572−data Label = Label Name Value deriving (Eq, Show)
573−
494+newtype Labels = Labels (M.Map Name Value) deriving (Eq, Show)
574495
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
496+instance FromJSON Labels where
497+ parseJSON val = Labels <$> parseJSON val
582498
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."
499+instance ToJSON Labels where
500+ toJSON (Labels kvs) = object [k .= v | (k,v) <- (M.toList kvs)]
591501
592−-- | Alias for Tags.
593502type Tag = Text
594503
595−-- | Data type used for parsing information from a list of images.
596504data Image = DockerImage {
597505 imageId :: ImageID
598506 , imageCreated :: Integer
599507 , imageParentId :: Maybe ImageID
600508 , imageRepoTags :: [Tag]
601− , imageRepoDigests :: [Digest]
509+ , imageRepoDigests :: Maybe [Digest]
602510 , imageSize :: Integer
603511 , imageVirtualSize :: Integer
604− , imageLabels :: [Label]
512+ , imageLabels :: Maybe Labels
605513 } deriving (Show, Eq, Generic)
606514
607−-- | Helper function used for dropping the "image" prefix when serializing
608−-- the Image data type to and from json.
609515dropImagePrefix :: [a] -> [a]
610516dropImagePrefix = drop 5
611517
612−
613518instance 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.
519+ parseJSON = genericParseJSON defaultOptions {
520+ fieldLabelModifier = dropImagePrefix}
521+
651522data CreateOpts = CreateOpts {
652− containerConfig :: ContainerConfig
653− , hostConfig :: HostConfig
654− , networkingConfig :: NetworkingConfig
523+ containerConfig :: ContainerConfig
524+ , hostConfig :: HostConfig
655525 } deriving (Eq, Show)
656526
657527instance ToJSON CreateOpts where
658− toJSON (CreateOpts cc hc nc) = do
528+ toJSON (CreateOpts cc hc) = do
659529 let ccJSON = toJSON cc
660530 let hcJSON = toJSON hc
661531 case ccJSON of
662532 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
533+ JSON.Object $ HM.insert "HostConfig" hcJSON o
666534 _ -> error "ContainerConfig is not an object." -- This should never happen.
667535
668−-- | Container configuration used for creating a container with sensible
669−-- defaults.
670536defaultContainerConfig :: Text -> ContainerConfig
671537defaultContainerConfig imageName = ContainerConfig {
672538 hostname=Nothing
@@ -676,29 +542,28 @@ defaultContainerConfig imageName = ContainerConfig {
676542 , attachStdout=False
677543 , image=imageName
678544 , attachStderr=False
679− , exposedPorts=[]
545+ , exposedPorts=Nothing -- ExposedPorts M.empty
680546 , tty=False
681547 , openStdin=False
682548 , stdinOnce=False
683549 , env=[]
684550 , cmd=[]
685− , volumes=[]
551+ , volumes=Nothing
686552 , workingDir=Nothing
687− , entrypoint=Entrypoint []
553+ , entrypoint=Nothing
688554 , networkDisabled=Nothing
689555 , macAddress=Nothing
690− , labels=[]
556+ , labels=Nothing
691557 , stopSignal=SIGTERM
692558 }
693559
694−-- | Default host confiratuon used for creating a container.
695560defaultHostConfig :: HostConfig
696561defaultHostConfig = HostConfig {
697562 binds=[]
698563 , containerIDFile=Nothing
699− , logConfig=LogDriverConfig JsonFile []
700− , networkMode=NetworkBridge
701− , portBindings=[]
564+ , logConfig=LogDriverConfig JsonFile Nothing
565+ , networkMode=Bridge
566+ , portBindings=PortBindings []
702567 , restartPolicy=RestartOff
703568 , volumeDriver=Nothing
704569 , volumesFrom=[]
@@ -719,7 +584,6 @@ defaultHostConfig = HostConfig {
719584 , resources=defaultContainerResources
720585 }
721586
722−-- Default container resource contstraints (None).
723587defaultContainerResources :: ContainerResources
724588defaultContainerResources = ContainerResources {
725589 cpuShares=Nothing
@@ -737,80 +601,34 @@ defaultContainerResources = ContainerResources {
737601 , memory=Nothing
738602 , memoryReservation=Nothing
739603 , memorySwap=Nothing
740− , oomKillDisable=Just False
604+ , oomKillDisable=False
741605 , ulimits=[]
742606 }
743607
744−-- | Default create options when creating a container. You only need to
745−-- specify an image name and the rest is all sensible defaults.
608+
746609defaultCreateOpts :: T.Text -> CreateOpts
747−defaultCreateOpts imageName = CreateOpts
748− { containerConfig = defaultContainerConfig imageName
749− , hostConfig = defaultHostConfig
750− , networkingConfig = NetworkingConfig HM.empty
751− }
610+defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
752611
753−-- | Override the key sequence for detaching a container.
612+-- detachKeys – Override the key sequence for detaching a container.
754613-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
755614data DetachKeys = WithCtrl Char | WithoutCtrl Char | DefaultDetachKey deriving (Eq, Show)
756615
757−-- | Options for starting a container.
758616data StartOpts = StartOpts { detachKeys :: DetachKeys } deriving (Eq, Show)
759617
760−-- | Default options for staring a container.
761618defaultStartOpts :: StartOpts
762619defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
763620
764−-- | Options for deleting a container.
765−data ContainerDeleteOpts = ContainerDeleteOpts {
621+data DeleteOpts = DeleteOpts {
766622 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
767623 , force :: Bool -- ^ If the container is still running force deletion anyway.
768624 } deriving (Eq, Show)
769625
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
626+defaultDeleteOpts :: DeleteOpts
627+defaultDeleteOpts = DeleteOpts { deleteVolumes = False, force = False }
807628
808−-- | Used for requesting N number of lines when tailing a containers log
809−-- output.
629+type Timestamp = Integer
810630data TailLogOpt = Tail Integer | All deriving (Eq, Show)
811631
812−
813−-- | Log options used when requesting the log output from a container.
814632data LogOpts = LogOpts {
815633 stdout :: Bool
816634 , stderr :: Bool
@@ -819,7 +637,6 @@ data LogOpts = LogOpts {
819637 , tail :: TailLogOpt
820638 } deriving (Eq, Show)
821639
822−-- | Sensible default for log options.
823640defaultLogOpts :: LogOpts
824641defaultLogOpts = LogOpts { stdout = True
825642 , stderr = True
@@ -828,50 +645,18 @@ defaultLogOpts = LogOpts { stdout = True
828645 , tail = All
829646 }
830647
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−
861648-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
862649-- | Set permissions on volumes that you mount in the container.
863650data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
864651
865652instance ToJSON VolumePermission where
866653 toJSON ReadWrite = "rw"
867− toJSON ReadOnly = "ro"
654+ toJSON ReadOnly = "ro"
868655
869656instance FromJSON VolumePermission where
870657 parseJSON "rw" = return ReadWrite
871658 parseJSON "ro" = return ReadOnly
872− parseJSON "RW" = return ReadWrite
873− parseJSON "RO" = return ReadOnly
874− parseJSON _ = fail "Failed to parse VolumePermission"
659+ parseJSON _ = fail "Failed to parse VolumePermission"
875660
876661-- | Used for marking a directory in the container as "exposed" hence
877662-- taking it outside of the COW filesystem and making it mountable
@@ -884,31 +669,29 @@ instance FromJSON VolumePermission where
884669-- docker run --name app -v \/opt\/data -it myapp:latest
885670-- docker run --name app2 --volumes-from app \/bin\/bash -c "ls -l \/opt\/data"
886671-- @
887−newtype Volume = Volume FilePath deriving (Eq, Show)
672+newtype Volumes = Volumes [FilePath] deriving (Eq, Show)
888673
889−instance {-# OVERLAPPING #-} ToJSON [Volume] where
890− toJSON [] = emptyJsonObject
891− toJSON (v:vs) = toJsonKey (v:vs) getKey
892− where getKey (Volume v) = v
674+instance FromJSON Volumes where
675+ parseJSON (JSON.Object o) = return $ Volumes $ map T.unpack $ HM.keys o
676+ parseJSON _ = fail "Volumes is not an object"
893677
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"
678+instance ToJSON Volumes where
679+ toJSON (Volumes []) = JSON.Object HM.empty
680+ toJSON (Volumes (v:vs)) = JSON.Object $ foldl f HM.empty (v:vs)
681+ where f acc k = HM.insert (T.pack k) (JSON.Object HM.empty) acc
898682
683+data Volume = Volume { hostSrc :: Text
684+ , containerDest :: Text
685+ , volumePermission :: Maybe VolumePermission
686+ } deriving (Eq, Show)
899687
900−data Bind = Bind { hostSrc :: Text
901− , containerDest :: Text
902− , volumePermission :: Maybe VolumePermission
903− } deriving (Eq, Show)
904−
905−instance FromJSON Bind where
688+instance FromJSON Volume where
906689 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"
690+ [src, dest] -> return $ Volume src dest Nothing
691+ [src, dest, "rw"] -> return $ Volume src dest $ Just ReadWrite
692+ [src, dest, "ro"] -> return $ Volume src dest $ Just ReadOnly
693+ _ -> fail "Could not parse Volume"
694+ parseJSON _ = fail "Volume is not a string"
912695
913696data Device = Device {
914697 pathOnHost :: FilePath
@@ -930,19 +713,19 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
930713
931714instance FromJSON VolumeFrom where
932715 parseJSON (JSON.String t) = case T.split (== ':') t of
933− [vol] -> return $ VolumeFrom vol Nothing
716+ [vol] -> return $ VolumeFrom vol Nothing
934717 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
935718 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
936− _ -> fail "Could not parse VolumeFrom"
719+ _ -> fail "Could not parse VolumeFrom"
937720 parseJSON _ = fail "VolumeFrom is not a string"
938721
939722instance ToJSON VolumeFrom where
940723 toJSON (VolumeFrom n p) = case p of
941− Nothing -> toJSON $ n <> ":" <> "rw"
724+ Nothing -> toJSON $ n <> ":" <> "rw"
942725 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
943726
944−instance ToJSON Bind where
945− toJSON (Bind src dest mode) = toJSON $ case mode of
727+instance ToJSON Volume where
728+ toJSON (Volume src dest mode) = toJSON $ case mode of
946729 Nothing -> T.concat[src, ":", dest]
947730 Just m -> T.concat[src, ":", dest, ":", (T.pack $ show m)]
948731
@@ -950,63 +733,63 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
950733
951734instance FromJSON Link where
952735 parseJSON (JSON.String t) = case T.split (== ':') t of
953− [f] -> return $ Link f Nothing
736+ [f] -> return $ Link f Nothing
954737 [f,s] -> return $ Link f $ Just s
955− _ -> fail "Could not parse Link"
738+ _ -> fail "Could not parse Link"
956739 parseJSON _ = fail "Link is not a string"
957740
958741instance ToJSON Link where
959742 toJSON (Link n1 n2) = toJSON $ case n2 of
960743 Nothing -> T.concat[n1, ":", n1] -- use same name in container
961− Just n -> T.concat[n1, ":", n] -- used specified name in container
744+ Just n -> T.concat[n1, ":", n] -- used specified name in container
962745
963746-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
964747data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
965748
966749instance FromJSON LogDriverType where
967750 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"
751+ parseJSON (JSON.String "syslog") = return Syslog
752+ parseJSON (JSON.String "journald") = return Journald
753+ parseJSON (JSON.String "gelf") = return Gelf
754+ parseJSON (JSON.String "fluentd") = return Fluentd
755+ parseJSON (JSON.String "awslogs") = return AwsLogs
756+ parseJSON (JSON.String "splunk") = return Splunk
757+ parseJSON (JSON.String "etwlogs") = return Etwlogs
758+ parseJSON (JSON.String "none") = return LoggingDisabled
759+ parseJSON _ = fail "Unknown LogDriverType"
977760
978761instance 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"
762+ toJSON JsonFile = JSON.String "json-file"
763+ toJSON Syslog = JSON.String "syslog"
764+ toJSON Journald = JSON.String "journald"
765+ toJSON Gelf = JSON.String "gelf"
766+ toJSON Fluentd = JSON.String "fluentd"
767+ toJSON AwsLogs = JSON.String "awslogs"
768+ toJSON Splunk = JSON.String "splunk"
769+ toJSON Etwlogs = JSON.String "etwlogs"
987770 toJSON LoggingDisabled = JSON.String "none"
988771
989−data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
772+newtype LogDriverOptions = LogDriverOptions (M.Map Text Text) deriving (Eq, Show)
990773
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
774+instance FromJSON LogDriverOptions where
775+ parseJSON (JSON.Object o) = do
776+ LogDriverOptions <$> HM.foldlWithKey' f (return M.empty) o
996777
997−instance {-# OVERLAPPING #-} FromJSON [LogDriverOption] where
998− parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
999− where f accM k v = do
778+ where
779+ f accM k (JSON.String v) = do
1000780 acc <- accM
1001− value <- parseJSON v
1002− return $ (LogDriverOption k value):acc
1003− parseJSON JSON.Null = return []
1004− parseJSON _ = fail "Failed to parse LogDriverOptions"
781+ return $ M.insert k v acc
782+ f _ _ _ = fail "Value of LogDriverOptions is not a string"
783+
784+ parseJSON JSON.Null = return $ LogDriverOptions M.empty
785+ parseJSON _ = fail "LogDriverOptions is not an object"
786+
787+instance ToJSON LogDriverOptions where
788+ toJSON (LogDriverOptions mp) = toJSON mp
1005789
1006−data LogDriverConfig = LogDriverConfig LogDriverType [LogDriverOption] deriving (Eq, Show)
790+data LogDriverConfig = LogDriverConfig LogDriverType (Maybe LogDriverOptions) deriving (Eq, Show)
1007791
1008792instance ToJSON LogDriverConfig where
1009− toJSON (LogDriverConfig driverType []) = object ["Type" .= driverType]
1010793 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
1011794
1012795instance FromJSON LogDriverConfig where
@@ -1017,41 +800,19 @@ instance FromJSON LogDriverConfig where
1017800 parseJSON _ = fail "LogDriverConfig is not an object"
1018801
1019802-- TODO: Add container:<name|id> mode
1020−data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
803+data NetworkMode = Bridge | Host | NetworkDisabled
1021804 deriving (Eq, Show, Ord)
1022805
1023806instance 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"
807+ parseJSON (JSON.String "bridge") = return Bridge
808+ parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
809+ parseJSON (JSON.String "none") = return NetworkDisabled
810+ parseJSON _ = fail "Unknown NetworkMode"
1029811
1030812instance ToJSON NetworkMode where
1031− toJSON NetworkBridge = JSON.String "bridge"
1032− toJSON NetworkHost = JSON.String "host"
813+ toJSON Bridge = JSON.String "bridge"
814+ toJSON Host = JSON.String "host"
1033815 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
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]
1055816
1056817data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
1057818
@@ -1067,7 +828,7 @@ instance FromJSON PortType where
1067828 parseJSON val = case val of
1068829 "tcp" -> return TCP
1069830 "udp" -> return UDP
1070− _ -> fail "PortType: Invalid port type."
831+ _ -> fail "PortType: Invalid port type."
1071832
1072833-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
1073834--
@@ -1084,6 +845,13 @@ instance FromJSON PortType where
1084845-- interface like `127.0.0.1`.
1085846-- __NOTE__: We should disallow duplicate port bindings as the ToJSON
1086847-- instance will only send the last one.
848+newtype PortBindings = PortBindings [PortBinding]
849+ deriving (Eq, Show)
850+
851+instance Monoid PortBindings where
852+ mempty = PortBindings []
853+ mappend (PortBindings p1) (PortBindings p2) = PortBindings (p1 ++ p2)
854+
1087855-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
1088856data PortBinding = PortBinding {
1089857 containerPort :: Port
@@ -1094,62 +862,24 @@ data PortBinding = PortBinding {
1094862portAndType2Text :: Port -> PortType -> Text
1095863portAndType2Text p t = (T.pack $ show p) <> "/" <> (T.pack $ show t)
1096864
1097−
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−
1132865-- | A convenience function that adds PortBindings to and exiting
1133866-- "CreateOpts" record. Useful with 'defaultCreateOpts'
1134867-- Example:
1135868--
1136869-- >>> 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]}}
870+-- >>> addPortBinding (defaultCreateOpts "nginx:latest") pb
871+addPortBinding :: CreateOpts -> PortBinding -> CreateOpts
872+addPortBinding c pb = c{hostConfig=hc{portBindings=pbs <> PortBindings [pb]}}
1140873 where hc = hostConfig c
1141874 pbs = portBindings $ hostConfig c
1142875
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
876+instance ToJSON PortBinding where
877+ toJSON (PortBinding {..}) = object [portAndType2Text containerPort portType .= hostPorts]
1149878
879+instance FromJSON PortBindings where
880+ parseJSON (JSON.Object o) = do
881+ PortBindings <$> HM.foldlWithKey' f (return []) o
1150882
1151−instance {-# OVERLAPPING #-} FromJSON [PortBinding] where
1152− parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
1153883 where
1154884 f accM k v = case T.split (== '/') k of
1155885 [port', portType'] -> do
@@ -1158,15 +888,16 @@ instance {-# OVERLAPPING #-} FromJSON [PortBinding] where
1158888 acc <- accM
1159889 hps <- parseJSON v
1160890 return $ (PortBinding port portType hps):acc
1161− _ -> fail "Could not parse PortBindings"
1162− parseJSON (JSON.Null) = return []
891+ _ ->
892+ fail "Could not parse PortBindings"
1163893 parseJSON _ = fail "PortBindings is not an object"
1164894
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
895+instance ToJSON PortBindings where
896+ toJSON (PortBindings []) = JSON.Object HM.empty
897+ toJSON (PortBindings (p:ps)) = JSON.Object $ foldl f HM.empty (p:ps)
898+ where mKey p = portAndType2Text (containerPort p) (portType p)
899+ mVal p = toJSON $ hostPorts p
900+ f acc p = HM.insert (mKey p) (mVal p) acc
1170901
1171902data HostPort = HostPort {
1172903 hostIp :: Text
@@ -1197,7 +928,7 @@ instance FromJSON RestartPolicy where
1197928 "on-failure" -> do
1198929 retry <- o .: "MaximumRetryCount"
1199930 return $ RestartOnFailure retry
1200− "no" -> return RestartOff
931+ "off" -> return RestartOff
1201932 _ -> fail "Could not parse RestartPolicy"
1202933 parseJSON _ = fail "RestartPolicy is not an object"
1203934
@@ -1205,7 +936,7 @@ instance ToJSON RestartPolicy where
1205936 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
1206937 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
1207938 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1208− toJSON RestartOff = object ["Name" .= JSON.String "no"]
939+ toJSON RestartOff = object ["Name" .= JSON.String "off"]
1209940
1210941data Isolation = Default | Process | Hyperv deriving (Eq, Show)
1211942
@@ -1215,11 +946,11 @@ newtype UTSMode = UTSMode Text deriving (Eq, Show)
1215946-- TODO: Add UTSMode : UTS namespace to use for the container
1216947-- TODO: Sysctls map[string]string `json:",omitempty"` // List of Namespaced sysctls used for the container
1217948data HostConfig = HostConfig
1218− { binds :: [Bind]
949+ { binds :: [Volume]
1219950 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
1220951 , logConfig :: LogDriverConfig
1221952 , networkMode :: NetworkMode
1222− , portBindings :: [PortBinding]
953+ , portBindings :: PortBindings
1223954 , restartPolicy :: RestartPolicy
1224955 , volumeDriver :: Maybe Text
1225956 , volumesFrom :: [VolumeFrom]
@@ -1378,22 +1109,6 @@ instance ToJSON DeviceRate where
13781109 , "Rate" .= r
13791110 ]
13801111
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−
13971112data ContainerResources = ContainerResources {
13981113 cpuShares :: Maybe Integer
13991114 -- , cgroupParent :: Text -- 1.24: Missing from inspecting container details... Going to omit for now.
@@ -1409,12 +1124,12 @@ data ContainerResources = ContainerResources {
14091124 , cpusetMems :: Maybe Text
14101125 , devices :: [Device]
14111126 -- , 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
1127+ , kernelMemory :: Maybe Integer
1128+ , memory :: Maybe Integer
1129+ , memoryReservation :: Maybe Integer
1130+ , memorySwap :: Maybe Integer
14161131 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1417− , oomKillDisable :: Maybe Bool
1132+ , oomKillDisable :: Bool
14181133 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
14191134 , ulimits :: [Ulimit]
14201135 -- TODO: Missing from 1.24
@@ -1452,59 +1167,45 @@ instance FromJSON EnvVar where
14521167 parseJSON _ = fail "EnvVar is not a string"
14531168
14541169instance ToJSON EnvVar where
1455− toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
1170+ toJSON (EnvVar n v) = object [n .= v]
14561171
1457−-- | ExposedPort represents a port (and it's type)
1172+-- | ExposedPorts represent a enumeraton of all the ports (and their type)
14581173-- 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
1174+-- `NOTE`: This does not automatically expose the ports onto the host
1175+-- system but rather it just tags them. It's best to be used with
14611176-- the PublishAllPorts flag. It is also useful for
14621177-- the daemon to know which Environment variables to
14631178-- inject into a container linking to our container.
14641179-- Example linking a Postgres container named db would inject the following
14651180-- environment variables automatically if we set the corresponding
14661181--
1467−-- ExposedPort:
1182+-- ExposedPorts:
14681183--
14691184-- @
14701185-- DB_PORT_5432_TCP_PORT="5432"
14711186-- DB_PORT_5432_TCP_PROTO="tcp"
14721187-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
14731188-- @
1474−data ExposedPort = ExposedPort Port PortType deriving (Eq, Show)
1189+newtype ExposedPorts = ExposedPorts (M.Map Port PortType) deriving (Eq, Show)
1190+-- JP: Should this be ExposedPorts [(Port, PortType)]?
1191+
1192+instance FromJSON ExposedPorts where
1193+ parseJSON (JSON.Object o) = do
1194+ ExposedPorts <$> HM.foldlWithKey' f (return M.empty) o
14751195
1476−instance {-# OVERLAPPING #-} FromJSON [ExposedPort] where
1477− parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
14781196 where
14791197 f accM k _ = case T.split (== '/') k of
14801198 [port', portType'] -> do
14811199 port <- parseIntegerText port'
14821200 portType <- parseJSON $ JSON.String portType'
14831201 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)
1496−
1497−instance ToJSON Entrypoint where
1498− toJSON (Entrypoint (e:es)) = toJSON (e:es)
1499− toJSON (Entrypoint []) = JSON.Null
1202+ return $ M.insert port portType acc
1203+ _ ->
1204+ fail "Could not parse ExposedPorts"
1205+ parseJSON _ = fail "ExposedPorts is not an object."
15001206
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"
1207+instance ToJSON ExposedPorts where
1208+ toJSON (ExposedPorts kvs) = object [((T.pack $ show p) <> "/" <> (T.pack $ show t)) .= JSON.Object HM.empty | (p,t) <- (M.toList kvs)]
15081209
15091210
15101211data ContainerConfig = ContainerConfig {
@@ -1514,7 +1215,7 @@ data ContainerConfig = ContainerConfig {
15141215 , attachStdin :: Bool
15151216 , attachStdout :: Bool
15161217 , attachStderr :: Bool
1517− , exposedPorts :: [ExposedPort]
1218+ , exposedPorts :: Maybe ExposedPorts -- Note: Should we expand the JSON instance and take away the Maybe?
15181219 -- , publishService :: Text -- Don't see this in 1.24
15191220 , tty :: Bool
15201221 , openStdin :: Bool
@@ -1523,70 +1224,27 @@ data ContainerConfig = ContainerConfig {
15231224 , cmd :: [Text]
15241225 -- , argsEscaped :: Bool -- Don't see this in 1.24
15251226 , image :: Text
1526− , volumes :: [Volume]
1227+ , volumes :: Maybe Volumes
15271228 , workingDir :: Maybe FilePath
1528− , entrypoint :: Entrypoint
1229+ , entrypoint :: Maybe Text -- Can be null?
15291230 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
15301231 , macAddress :: Maybe Text
15311232 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
1532− , labels :: [Label]
1233+ , labels :: Maybe Labels
15331234 , stopSignal :: Signal
15341235 } deriving (Eq, Show, Generic)
15351236
1536−
15371237instance ToJSON ContainerConfig where
15381238 toJSON = genericToJSON defaultOptions {
15391239 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
15401240
15411241instance 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."
1242+ parseJSON = genericParseJSON defaultOptions {
1243+ fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
15661244
1567−#if MIN_VERSION_base(4,13,0)
1568−parseIntegerText :: (MonadFail m) => Text -> m Integer
1569−#else
15701245parseIntegerText :: (Monad m) => Text -> m Integer
1571−#endif
15721246parseIntegerText t = case readMaybe $ T.unpack t of
15731247 Nothing ->
15741248 fail "Could not parse Integer"
15751249 Just i ->
15761250 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