@@ -11,7 +11,11 @@ module Docker.Client.Types (
1111 , ImageID
1212 , fromImageID
1313 , toImageID
14+ , NetworkID
15+ , fromNetworkID
16+ , toNetworkID
1417 , Timeout(..)
18+ , StatusCode(..)
1519 , Signal(..)
1620 , ContainerDetails(..)
1721 , DockerClientOpts(..)
@@ -22,42 +26,48 @@ module Docker.Client.Types (
2226 , ContainerPortInfo(..)
2327 , Container(..)
2428 , ContainerState(..)
25− , Status(..)
29+ , State(..)
2630 , Digest
27− , Labels(..)
31+ , Label(..)
2832 , Tag
2933 , Image(..)
34+ , Entrypoint(..)
3035 , dropImagePrefix
3136 , CreateOpts(..)
37+ , BuildOpts(..)
38+ , defaultBuildOpts
3239 , defaultCreateOpts
3340 , DetachKeys(..)
3441 , StartOpts(..)
3542 , defaultStartOpts
36− , DeleteOpts(..)
37− , defaultDeleteOpts
43+ , ContainerDeleteOpts(..)
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
3847 , Timestamp
3948 , TailLogOpt(..)
4049 , LogOpts(..)
4150 , defaultLogOpts
51+ , CreateNetworkOpts(..)
52+ , defaultCreateNetworkOpts
4253 , VolumePermission(..)
54+ , Bind(..)
4355 , Volume(..)
44− , Volumes(..)
4556 , Device(..)
4657 , ContainerName
4758 , VolumeFrom(..)
4859 , Link(..)
4960 , LogDriverType(..)
50− , LogDriverOptions(..)
61+ , LogDriverOption(..)
5162 , LogDriverConfig(..)
5263 , NetworkMode(..)
5364 , PortType(..)
5465-- , NetworkInterface(..)
55− , Networks(..)
66+ , Network(..)
5667 , NetworkSettings(..)
5768 , NetworkOptions(..)
5869 , Mount(..)
5970 , PortBinding(..)
60− , PortBindings(..)
6171 , HostPort(..)
6272 , RetryCount
6373 , RestartPolicy(..)
@@ -65,6 +75,8 @@ module Docker.Client.Types (
6575 , UTSMode(..)
6676 , HostConfig(..)
6777 , defaultHostConfig
78+ , NetworkingConfig(..)
79+ , EndpointConfig(..)
6880 , Ulimit(..)
6981 , ContainerResources(..)
7082 , defaultContainerResources
@@ -74,10 +86,18 @@ module Docker.Client.Types (
7486 , EnvVar(..)
7587 , ContainerConfig(..)
7688 , defaultContainerConfig
77− , ExposedPorts(..)
89+ , ExposedPort(..)
7890 , DeviceWeight(..)
7991 , DeviceRate(..)
8092 , addPortBinding
93+ , addExposedPort
94+ , addBind
95+ , setCmd
96+ , addLink
97+ , addVolume
98+ , addVolumeFrom
99+ , MemoryConstraint(..)
100+ , MemoryConstraintSize(..)
81101 ) where
82102
83103import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
@@ -87,11 +107,12 @@ import qualified Data.Aeson as JSON
87107import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
88108import Data.Char (isAlphaNum, toUpper)
89109import qualified Data.HashMap.Strict as HM
90−import qualified Data.Map as M
91110import Data.Monoid ((<>))
111+import Data.Scientific (floatingOrInteger)
92112import Data.Text (Text)
93113import qualified Data.Text as T
94114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
95116import GHC.Generics (Generic)
96117import Prelude hiding (all, tail)
97118import Text.Read (readMaybe)
@@ -101,17 +122,23 @@ data Endpoint =
101122 VersionEndpoint
102123 | ListContainersEndpoint ListOpts
103124 | ListImagesEndpoint ListOpts
104− | CreateContainerEndpoint CreateOpts
125+ | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
105126 | StartContainerEndpoint StartOpts ContainerID
106127 | StopContainerEndpoint Timeout ContainerID
128+ | WaitContainerEndpoint ContainerID
107129 | KillContainerEndpoint Signal ContainerID
108130 | RestartContainerEndpoint Timeout ContainerID
109131 | PauseContainerEndpoint ContainerID
110132 | UnpauseContainerEndpoint ContainerID
111133 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
112134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
113− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
114136 | 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
115142 deriving (Eq, Show)
116143
117144-- | We should newtype this
@@ -158,6 +185,20 @@ toImageID t =
158185-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
159186data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
160187
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+
161202-- TODO: Add more Signals or use an existing lib
162203-- | Signal used for sending to the process running in the container.
163204-- The default signal is SIGTERM.
@@ -172,16 +213,16 @@ data Signal = SIGHUP
172213
173214instance FromJSON Signal where
174215 parseJSON (JSON.String "SIGTERM") = return SIGTERM
175− parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
176− parseJSON (JSON.String "SIGINT") = return SIGINT
216+ parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
217+ parseJSON (JSON.String "SIGINT") = return SIGINT
177218 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
178219 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
179220 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
180− parseJSON _ = fail "Unknown Signal"
221+ parseJSON _ = fail "Unknown Signal"
181222
182223instance ToJSON Signal where
183− toJSON SIGHUP = "SIGHUP"
184− toJSON SIGINT = "SIGINT"
224+ toJSON SIGHUP = "SIGHUP"
225+ toJSON SIGINT = "SIGINT"
185226 toJSON SIGQUIT = "SIGQUIT"
186227 toJSON SIGSTOP = "SIGSTOP"
187228 toJSON SIGTERM = "SIGTERM"
@@ -209,7 +250,7 @@ data ContainerDetails = ContainerDetails {
209250 , processLabel :: Text
210251 , resolveConfPath :: FilePath
211252 , restartCount :: Int
212− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
213254 , mounts :: [Mount]
214255 }
215256 deriving (Eq, Show, Generic)
@@ -217,11 +258,11 @@ data ContainerDetails = ContainerDetails {
217258-- | Data type used for parsing the mount information from a container
218259-- list.
219260data Mount = Mount {
220− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
221262 , mountSource :: FilePath
222263 , mountDestination :: FilePath
223− , mountDriver :: Text
224− , mountMode :: Maybe VolumePermission -- apparently this can be null
264+ , mountDriver :: Maybe Text
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
225266 , mountRW :: Bool
226267 , mountPropogation :: Text
227268 }
@@ -229,14 +270,14 @@ data Mount = Mount {
229270
230271instance FromJSON Mount where
231272 parseJSON (JSON.Object o) = do
232− name <- o .: "Name"
273+ name <- o .:? "Name"
233274 src <- o .: "Source"
234275 dest <- o .: "Destination"
235− driver <- o .: "Driver"
236− mode <- o .: "Mode"
276+ driver <- o .:? "Driver"
277+ -- mode <- o .: "Mode"
237278 rw <- o .: "RW"
238279 prop <- o .: "Propagation"
239− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
240281 parseJSON _ = fail "Mount is not an object"
241282
242283-- | Data type used for parsing the container state from a list of
@@ -252,7 +293,7 @@ data ContainerState = ContainerState {
252293 , restarting :: Bool
253294 , running :: Bool
254295 , startedAt :: UTCTime
255− , status :: Status
296+ , state :: State
256297 }
257298 deriving (Eq, Show, Generic)
258299
@@ -415,20 +456,17 @@ instance FromJSON NetworkOptions where
415456 parseJSON _ = fail "NetworkOptions is not an object"
416457
417458-- TODO: Not sure what this is used for anymore.
418−newtype Networks = Networks (M.Map NetworkMode NetworkOptions) -- Note: Is it ever possible that there will be duplicates of network modes?
459+data Network = Network NetworkMode NetworkOptions
419460 deriving (Eq, Show)
420461
421−instance FromJSON Networks where
422− parseJSON (JSON.Object o) = do
423− Networks <$> HM.foldlWithKey' f (return M.empty) o
424−
462+instance {-# OVERLAPPING #-} FromJSON [Network] where
463+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
425464 where
426465 f accM k' v' = do
427466 acc <- accM
428467 k <- parseJSON $ JSON.String k'
429468 v <- parseJSON v'
430− return $ M.insert k v acc
431−
469+ return $ (Network k v):acc
432470 parseJSON _ = fail "Networks is not an object"
433471
434472-- | Data type reprsenting the various network settings a container can have.
@@ -438,7 +476,7 @@ data NetworkSettings = NetworkSettings {
438476 , networkSettingsHairpinMode :: Bool
439477 , networkSettingsLinkLocalIPv6Address :: Text
440478 , networkSettingsLinkLocalIPv6PrefixLen :: Int
441− , networkSettingsPorts :: PortBindings
479+ , networkSettingsPorts :: [PortBinding]
442480 , networkSettingsSandboxKey :: Text
443481 , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
444482 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
@@ -450,7 +488,7 @@ data NetworkSettings = NetworkSettings {
450488 , networkSettingsIpPrefixLen :: Int
451489 , networkSettingsIpv6Gateway :: Text
452490 , networkSettingsMacAddress :: Text
453− , networkSettingsNetworks :: Networks
491+ , networkSettingsNetworks :: [Network]
454492 }
455493 deriving (Eq, Show)
456494
@@ -485,21 +523,23 @@ data Container = Container
485523 , containerImageId :: ImageID
486524 , containerCommand :: Text
487525 , containerCreatedAt :: Int
488− , containerStatus :: Status
526+ , containerState :: State
527+ , containerStatus :: Maybe Text
489528 , containerPorts :: [ContainerPortInfo]
490− , containerLabels :: Labels
491− , containerNetworks :: Networks
529+ , containerLabels :: [Label]
530+ , containerNetworks :: [Network]
492531 , containerMounts :: [Mount]
493532 } deriving (Show, Eq)
494533
495534instance FromJSON Container where
496− parseJSON (JSON.Object v) =
497− Container <$> (v .: "Id")
535+ parseJSON o@(JSON.Object v) =
536+ Container <$> parseJSON o
498537 <*> (v .: "Names")
499538 <*> (v .: "Image")
500− <*> (v .: "ImageID")
501− <*> (v .: "Command")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
540+ <*> (v .: "Command") -- Doesn't exist anymore
502541 <*> (v .: "Created")
542+ <*> (v .: "State")
503543 <*> (v .: "Status")
504544 <*> (v .: "Ports")
505545 <*> (v .: "Labels")
@@ -509,34 +549,45 @@ instance FromJSON Container where
509549 parseNetworks (JSON.Object v) =
510550 (v .: "Networks") >>= parseJSON
511551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
512−
513552 parseJSON _ = fail "Container: Not a JSON object."
514553
515−-- | Represents the status of the container life cycle.
516−data Status = Created | Restarting | Running | Paused | Exited | Dead
554+-- | Represents the state of the container life cycle.
555+data State = Created | Restarting | Running | Paused | Exited | Dead
517556 deriving (Eq, Show, Generic)
518557
519−instance FromJSON Status where
520− parseJSON (JSON.String "running") = return Running
521− parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
558+instance FromJSON State where
559+ parseJSON (JSON.String "running") = return Running
560+ parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
522561 parseJSON (JSON.String "restarting") = return Restarting
523− parseJSON (JSON.String "paused") = return Paused
524− parseJSON (JSON.String "exited") = return Exited
525− parseJSON (JSON.String "dead") = return Dead
526− parseJSON _ = fail "Unknown Status"
562+ parseJSON (JSON.String "paused") = return Paused
563+ parseJSON (JSON.String "exited") = return Exited
564+ parseJSON (JSON.String "dead") = return Dead
565+ parseJSON s = fail $ "Unknown Status: " ++ show s
527566
528567-- | Alias for representing a RepoDigest. We could newtype this and add
529568-- some validation.
530569type Digest = Text
531570
532571-- | Container and Image Labels.
533−newtype Labels = Labels (M.Map Name Value) deriving (Eq, Show)
572+data Label = Label Name Value deriving (Eq, Show)
534573
535−instance FromJSON Labels where
536− parseJSON val = Labels <$> parseJSON val
537574
538−instance ToJSON Labels where
539− toJSON (Labels kvs) = object [k .= v | (k,v) <- (M.toList kvs)]
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
582+
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."
540591
541592-- | Alias for Tags.
542593type Tag = Text
@@ -547,10 +598,10 @@ data Image = DockerImage {
547598 , imageCreated :: Integer
548599 , imageParentId :: Maybe ImageID
549600 , imageRepoTags :: [Tag]
550− , imageRepoDigests :: Maybe [Digest]
601+ , imageRepoDigests :: [Digest]
551602 , imageSize :: Integer
552603 , imageVirtualSize :: Integer
553− , imageLabels :: Maybe Labels
604+ , imageLabels :: [Label]
554605 } deriving (Show, Eq, Generic)
555606
556607-- | Helper function used for dropping the "image" prefix when serializing
@@ -558,23 +609,60 @@ data Image = DockerImage {
558609dropImagePrefix :: [a] -> [a]
559610dropImagePrefix = drop 5
560611
612+
561613instance FromJSON Image where
562− parseJSON = genericParseJSON defaultOptions {
563− fieldLabelModifier = dropImagePrefix}
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+ ]
564649
565650-- | Options used for creating a Container.
566651data CreateOpts = CreateOpts {
567− containerConfig :: ContainerConfig
568− , hostConfig :: HostConfig
652+ containerConfig :: ContainerConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
569655 } deriving (Eq, Show)
570656
571657instance ToJSON CreateOpts where
572− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
573659 let ccJSON = toJSON cc
574660 let hcJSON = toJSON hc
575661 case ccJSON of
576662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
577− JSON.Object $ HM.insert "HostConfig" hcJSON o
663+ let o1 = HM.insert "HostConfig" hcJSON o
664+ let o2 = HM.insert "NetworkingConfig" (toJSON nc) o1
665+ JSON.Object o2
578666 _ -> error "ContainerConfig is not an object." -- This should never happen.
579667
580668-- | Container configuration used for creating a container with sensible
@@ -588,18 +676,18 @@ defaultContainerConfig imageName = ContainerConfig {
588676 , attachStdout=False
589677 , image=imageName
590678 , attachStderr=False
591− , exposedPorts=Nothing -- ExposedPorts M.empty
679+ , exposedPorts=[]
592680 , tty=False
593681 , openStdin=False
594682 , stdinOnce=False
595683 , env=[]
596684 , cmd=[]
597− , volumes=Nothing
685+ , volumes=[]
598686 , workingDir=Nothing
599− , entrypoint=Nothing
687+ , entrypoint=Entrypoint []
600688 , networkDisabled=Nothing
601689 , macAddress=Nothing
602− , labels=Nothing
690+ , labels=[]
603691 , stopSignal=SIGTERM
604692 }
605693
@@ -608,9 +696,9 @@ defaultHostConfig :: HostConfig
608696defaultHostConfig = HostConfig {
609697 binds=[]
610698 , containerIDFile=Nothing
611− , logConfig=LogDriverConfig JsonFile Nothing
612− , networkMode=Bridge
613− , portBindings=PortBindings []
699+ , logConfig=LogDriverConfig JsonFile []
700+ , networkMode=NetworkBridge
701+ , portBindings=[]
614702 , restartPolicy=RestartOff
615703 , volumeDriver=Nothing
616704 , volumesFrom=[]
@@ -649,14 +737,18 @@ defaultContainerResources = ContainerResources {
649737 , memory=Nothing
650738 , memoryReservation=Nothing
651739 , memorySwap=Nothing
652− , oomKillDisable=False
740+ , oomKillDisable=Just False
653741 , ulimits=[]
654742 }
655743
656744-- | Default create options when creating a container. You only need to
657745-- specify an image name and the rest is all sensible defaults.
658746defaultCreateOpts :: T.Text -> CreateOpts
659−defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
747+defaultCreateOpts imageName = CreateOpts
748+ { containerConfig = defaultContainerConfig imageName
749+ , hostConfig = defaultHostConfig
750+ , networkingConfig = NetworkingConfig HM.empty
751+ }
660752
661753-- | Override the key sequence for detaching a container.
662754-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
@@ -670,16 +762,45 @@ defaultStartOpts :: StartOpts
670762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
671763
672764-- | Options for deleting a container.
673−data DeleteOpts = DeleteOpts {
765+data ContainerDeleteOpts = ContainerDeleteOpts {
674766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
675767 , force :: Bool -- ^ If the container is still running force deletion anyway.
676768 } deriving (Eq, Show)
677769
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+
678792-- | Default options for deleting a container. Most of the time we DON'T
679793-- want to delete the container's volumes or force delete it if it's
680794-- running.
681−defaultDeleteOpts :: DeleteOpts
682−defaultDeleteOpts = DeleteOpts { deleteVolumes = False, force = False }
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
683804
684805-- | Timestamp alias.
685806type Timestamp = Integer
@@ -707,18 +828,50 @@ defaultLogOpts = LogOpts { stdout = True
707828 , tail = All
708829 }
709830
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+
710861-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
711862-- | Set permissions on volumes that you mount in the container.
712863data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
713864
714865instance ToJSON VolumePermission where
715866 toJSON ReadWrite = "rw"
716− toJSON ReadOnly = "ro"
867+ toJSON ReadOnly = "ro"
717868
718869instance FromJSON VolumePermission where
719870 parseJSON "rw" = return ReadWrite
720871 parseJSON "ro" = return ReadOnly
721− parseJSON _ = fail "Failed to parse VolumePermission"
872+ parseJSON "RW" = return ReadWrite
873+ parseJSON "RO" = return ReadOnly
874+ parseJSON _ = fail "Failed to parse VolumePermission"
722875
723876-- | Used for marking a directory in the container as "exposed" hence
724877-- taking it outside of the COW filesystem and making it mountable
@@ -731,29 +884,31 @@ instance FromJSON VolumePermission where
731884-- docker run --name app -v \/opt\/data -it myapp:latest
732885-- docker run --name app2 --volumes-from app \/bin\/bash -c "ls -l \/opt\/data"
733886-- @
734−newtype Volumes = Volumes [FilePath] deriving (Eq, Show)
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
735893
736−instance FromJSON Volumes where
737− parseJSON (JSON.Object o) = return $ Volumes $ map T.unpack $ HM.keys o
738− parseJSON _ = fail "Volumes is not an object"
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"
739898
740−instance ToJSON Volumes where
741− toJSON (Volumes []) = JSON.Object HM.empty
742− toJSON (Volumes (v:vs)) = JSON.Object $ foldl f HM.empty (v:vs)
743− where f acc k = HM.insert (T.pack k) (JSON.Object HM.empty) acc
744899
745−data Volume = Volume { hostSrc :: Text
746− , containerDest :: Text
747− , volumePermission :: Maybe VolumePermission
748− } deriving (Eq, Show)
900+data Bind = Bind { hostSrc :: Text
901+ , containerDest :: Text
902+ , volumePermission :: Maybe VolumePermission
903+ } deriving (Eq, Show)
749904
750−instance FromJSON Volume where
905+instance FromJSON Bind where
751906 parseJSON (JSON.String t) = case T.split (== ':') t of
752− [src, dest] -> return $ Volume src dest Nothing
753− [src, dest, "rw"] -> return $ Volume src dest $ Just ReadWrite
754− [src, dest, "ro"] -> return $ Volume src dest $ Just ReadOnly
755− _ -> fail "Could not parse Volume"
756− parseJSON _ = fail "Volume is not a string"
907+ [src, dest] -> return $ Bind src dest Nothing
908+ [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
909+ [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
910+ _ -> fail "Could not parse Bind"
911+ parseJSON _ = fail "Bind is not a string"
757912
758913data Device = Device {
759914 pathOnHost :: FilePath
@@ -775,19 +930,19 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
775930
776931instance FromJSON VolumeFrom where
777932 parseJSON (JSON.String t) = case T.split (== ':') t of
778− [vol] -> return $ VolumeFrom vol Nothing
933+ [vol] -> return $ VolumeFrom vol Nothing
779934 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
780935 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
781− _ -> fail "Could not parse VolumeFrom"
936+ _ -> fail "Could not parse VolumeFrom"
782937 parseJSON _ = fail "VolumeFrom is not a string"
783938
784939instance ToJSON VolumeFrom where
785940 toJSON (VolumeFrom n p) = case p of
786− Nothing -> toJSON $ n <> ":" <> "rw"
941+ Nothing -> toJSON $ n <> ":" <> "rw"
787942 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
788943
789−instance ToJSON Volume where
790− toJSON (Volume src dest mode) = toJSON $ case mode of
944+instance ToJSON Bind where
945+ toJSON (Bind src dest mode) = toJSON $ case mode of
791946 Nothing -> T.concat[src, ":", dest]
792947 Just m -> T.concat[src, ":", dest, ":", (T.pack $ show m)]
793948
@@ -795,63 +950,63 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
795950
796951instance FromJSON Link where
797952 parseJSON (JSON.String t) = case T.split (== ':') t of
798− [f] -> return $ Link f Nothing
953+ [f] -> return $ Link f Nothing
799954 [f,s] -> return $ Link f $ Just s
800− _ -> fail "Could not parse Link"
955+ _ -> fail "Could not parse Link"
801956 parseJSON _ = fail "Link is not a string"
802957
803958instance ToJSON Link where
804959 toJSON (Link n1 n2) = toJSON $ case n2 of
805960 Nothing -> T.concat[n1, ":", n1] -- use same name in container
806− Just n -> T.concat[n1, ":", n] -- used specified name in container
961+ Just n -> T.concat[n1, ":", n] -- used specified name in container
807962
808963-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
809964data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
810965
811966instance FromJSON LogDriverType where
812967 parseJSON (JSON.String "json-file") = return JsonFile
813− parseJSON (JSON.String "syslog") = return Syslog
814− parseJSON (JSON.String "journald") = return Journald
815− parseJSON (JSON.String "gelf") = return Gelf
816− parseJSON (JSON.String "fluentd") = return Fluentd
817− parseJSON (JSON.String "awslogs") = return AwsLogs
818− parseJSON (JSON.String "splunk") = return Splunk
819− parseJSON (JSON.String "etwlogs") = return Etwlogs
820− parseJSON (JSON.String "none") = return LoggingDisabled
821− parseJSON _ = fail "Unknown LogDriverType"
968+ parseJSON (JSON.String "syslog") = return Syslog
969+ parseJSON (JSON.String "journald") = return Journald
970+ parseJSON (JSON.String "gelf") = return Gelf
971+ parseJSON (JSON.String "fluentd") = return Fluentd
972+ parseJSON (JSON.String "awslogs") = return AwsLogs
973+ parseJSON (JSON.String "splunk") = return Splunk
974+ parseJSON (JSON.String "etwlogs") = return Etwlogs
975+ parseJSON (JSON.String "none") = return LoggingDisabled
976+ parseJSON _ = fail "Unknown LogDriverType"
822977
823978instance ToJSON LogDriverType where
824− toJSON JsonFile = JSON.String "json-file"
825− toJSON Syslog = JSON.String "syslog"
826− toJSON Journald = JSON.String "journald"
827− toJSON Gelf = JSON.String "gelf"
828− toJSON Fluentd = JSON.String "fluentd"
829− toJSON AwsLogs = JSON.String "awslogs"
830− toJSON Splunk = JSON.String "splunk"
831− toJSON Etwlogs = JSON.String "etwlogs"
979+ toJSON JsonFile = JSON.String "json-file"
980+ toJSON Syslog = JSON.String "syslog"
981+ toJSON Journald = JSON.String "journald"
982+ toJSON Gelf = JSON.String "gelf"
983+ toJSON Fluentd = JSON.String "fluentd"
984+ toJSON AwsLogs = JSON.String "awslogs"
985+ toJSON Splunk = JSON.String "splunk"
986+ toJSON Etwlogs = JSON.String "etwlogs"
832987 toJSON LoggingDisabled = JSON.String "none"
833988
834−newtype LogDriverOptions = LogDriverOptions (M.Map Text Text) deriving (Eq, Show)
989+data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
835990
836−instance FromJSON LogDriverOptions where
837− parseJSON (JSON.Object o) = do
838− LogDriverOptions <$> HM.foldlWithKey' f (return M.empty) o
991+instance {-# OVERLAPPING #-} ToJSON [LogDriverOption] where
992+ toJSON [] = emptyJsonObject
993+ toJSON (o:os) = toJsonKeyVal (o:os) key val
994+ where key (LogDriverOption n _) = T.unpack n
995+ val (LogDriverOption _ v) = v
839996
840− where
841− f accM k (JSON.String v) = do
997+instance {-# OVERLAPPING #-} FromJSON [LogDriverOption] where
998+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
999+ where f accM k v = do
8421000 acc <- accM
843− return $ M.insert k v acc
844− f _ _ _ = fail "Value of LogDriverOptions is not a string"
845−
846− parseJSON JSON.Null = return $ LogDriverOptions M.empty
847− parseJSON _ = fail "LogDriverOptions is not an object"
848−
849−instance ToJSON LogDriverOptions where
850− toJSON (LogDriverOptions mp) = toJSON mp
1001+ value <- parseJSON v
1002+ return $ (LogDriverOption k value):acc
1003+ parseJSON JSON.Null = return []
1004+ parseJSON _ = fail "Failed to parse LogDriverOptions"
8511005
852−data LogDriverConfig = LogDriverConfig LogDriverType (Maybe LogDriverOptions) deriving (Eq, Show)
1006+data LogDriverConfig = LogDriverConfig LogDriverType [LogDriverOption] deriving (Eq, Show)
8531007
8541008instance ToJSON LogDriverConfig where
1009+ toJSON (LogDriverConfig driverType []) = object ["Type" .= driverType]
8551010 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
8561011
8571012instance FromJSON LogDriverConfig where
@@ -862,19 +1017,41 @@ instance FromJSON LogDriverConfig where
8621017 parseJSON _ = fail "LogDriverConfig is not an object"
8631018
8641019-- TODO: Add container:<name|id> mode
865−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
8661021 deriving (Eq, Show, Ord)
8671022
8681023instance FromJSON NetworkMode where
869− parseJSON (JSON.String "bridge") = return Bridge
870− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
871− parseJSON (JSON.String "none") = return NetworkDisabled
872− parseJSON _ = fail "Unknown NetworkMode"
1024+ parseJSON (JSON.String "bridge") = return NetworkBridge
1025+ parseJSON (JSON.String "host") = return NetworkHost -- Note: Guessing on these.
1026+ parseJSON (JSON.String "none") = return NetworkDisabled
1027+ parseJSON (JSON.String n) = return $ NetworkNamed n
1028+ parseJSON _ = fail "Unknown NetworkMode"
8731029
8741030instance ToJSON NetworkMode where
875− toJSON Bridge = JSON.String "bridge"
876− toJSON Host = JSON.String "host"
1031+ toJSON NetworkBridge = JSON.String "bridge"
1032+ toJSON NetworkHost = JSON.String "host"
8771033 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]
8781055
8791056data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
8801057
@@ -890,7 +1067,7 @@ instance FromJSON PortType where
8901067 parseJSON val = case val of
8911068 "tcp" -> return TCP
8921069 "udp" -> return UDP
893− _ -> fail "PortType: Invalid port type."
1070+ _ -> fail "PortType: Invalid port type."
8941071
8951072-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
8961073--
@@ -907,13 +1084,6 @@ instance FromJSON PortType where
9071084-- interface like `127.0.0.1`.
9081085-- __NOTE__: We should disallow duplicate port bindings as the ToJSON
9091086-- instance will only send the last one.
910−newtype PortBindings = PortBindings [PortBinding]
911− deriving (Eq, Show)
912−
913−instance Monoid PortBindings where
914− mempty = PortBindings []
915− mappend (PortBindings p1) (PortBindings p2) = PortBindings (p1 ++ p2)
916−
9171087-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
9181088data PortBinding = PortBinding {
9191089 containerPort :: Port
@@ -924,24 +1094,62 @@ data PortBinding = PortBinding {
9241094portAndType2Text :: Port -> PortType -> Text
9251095portAndType2Text p t = (T.pack $ show p) <> "/" <> (T.pack $ show t)
9261096
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+
9271132-- | A convenience function that adds PortBindings to and exiting
9281133-- "CreateOpts" record. Useful with 'defaultCreateOpts'
9291134-- Example:
9301135--
9311136-- >>> let pb = PortBinding 80 TCP [HostPort "0.0.0.0" 8000]
932−-- >>> addPortBinding (defaultCreateOpts "nginx:latest") pb
933−addPortBinding :: CreateOpts -> PortBinding -> CreateOpts
934−addPortBinding c pb = c{hostConfig=hc{portBindings=pbs <> PortBindings [pb]}}
1137+-- >>> addPortBinding pb $ defaultCreateOpts "nginx:latest"
1138+addPortBinding :: PortBinding -> CreateOpts -> CreateOpts
1139+addPortBinding pb c = c{hostConfig=hc{portBindings=pbs <> [pb]}}
9351140 where hc = hostConfig c
9361141 pbs = portBindings $ hostConfig c
9371142
938−instance ToJSON PortBinding where
939− toJSON (PortBinding {..}) = object [portAndType2Text containerPort portType .= hostPorts]
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
9401149
941−instance FromJSON PortBindings where
942− parseJSON (JSON.Object o) = do
943− PortBindings <$> HM.foldlWithKey' f (return []) o
9441150
1151+instance {-# OVERLAPPING #-} FromJSON [PortBinding] where
1152+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
9451153 where
9461154 f accM k v = case T.split (== '/') k of
9471155 [port', portType'] -> do
@@ -950,16 +1158,15 @@ instance FromJSON PortBindings where
9501158 acc <- accM
9511159 hps <- parseJSON v
9521160 return $ (PortBinding port portType hps):acc
953− _ ->
954− fail "Could not parse PortBindings"
1161+ _ -> fail "Could not parse PortBindings"
1162+ parseJSON (JSON.Null) = return []
9551163 parseJSON _ = fail "PortBindings is not an object"
9561164
957−instance ToJSON PortBindings where
958− toJSON (PortBindings []) = JSON.Object HM.empty
959− toJSON (PortBindings (p:ps)) = JSON.Object $ foldl f HM.empty (p:ps)
960− where mKey p = portAndType2Text (containerPort p) (portType p)
961− mVal p = toJSON $ hostPorts p
962− f acc p = HM.insert (mKey p) (mVal p) acc
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
9631170
9641171data HostPort = HostPort {
9651172 hostIp :: Text
@@ -990,7 +1197,7 @@ instance FromJSON RestartPolicy where
9901197 "on-failure" -> do
9911198 retry <- o .: "MaximumRetryCount"
9921199 return $ RestartOnFailure retry
993− "off" -> return RestartOff
1200+ "no" -> return RestartOff
9941201 _ -> fail "Could not parse RestartPolicy"
9951202 parseJSON _ = fail "RestartPolicy is not an object"
9961203
@@ -998,7 +1205,7 @@ instance ToJSON RestartPolicy where
9981205 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
9991206 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
10001207 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1001− toJSON RestartOff = object ["Name" .= JSON.String "off"]
1208+ toJSON RestartOff = object ["Name" .= JSON.String "no"]
10021209
10031210data Isolation = Default | Process | Hyperv deriving (Eq, Show)
10041211
@@ -1008,11 +1215,11 @@ newtype UTSMode = UTSMode Text deriving (Eq, Show)
10081215-- TODO: Add UTSMode : UTS namespace to use for the container
10091216-- TODO: Sysctls map[string]string `json:",omitempty"` // List of Namespaced sysctls used for the container
10101217data HostConfig = HostConfig
1011− { binds :: [Volume]
1218+ { binds :: [Bind]
10121219 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
10131220 , logConfig :: LogDriverConfig
10141221 , networkMode :: NetworkMode
1015− , portBindings :: PortBindings
1222+ , portBindings :: [PortBinding]
10161223 , restartPolicy :: RestartPolicy
10171224 , volumeDriver :: Maybe Text
10181225 , volumesFrom :: [VolumeFrom]
@@ -1171,6 +1378,22 @@ instance ToJSON DeviceRate where
11711378 , "Rate" .= r
11721379 ]
11731380
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+
11741397data ContainerResources = ContainerResources {
11751398 cpuShares :: Maybe Integer
11761399 -- , cgroupParent :: Text -- 1.24: Missing from inspecting container details... Going to omit for now.
@@ -1186,12 +1409,12 @@ data ContainerResources = ContainerResources {
11861409 , cpusetMems :: Maybe Text
11871410 , devices :: [Device]
11881411 -- , diskQuota :: Integer -- Don't see this ins 1.24.
1189− , kernelMemory :: Maybe Integer
1190− , memory :: Maybe Integer
1191− , memoryReservation :: Maybe Integer
1192− , memorySwap :: Maybe Integer
1412+ , kernelMemory :: Maybe MemoryConstraint
1413+ , memory :: Maybe MemoryConstraint
1414+ , memoryReservation :: Maybe MemoryConstraint
1415+ , memorySwap :: Maybe MemoryConstraint
11931416 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1194− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
11951418 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
11961419 , ulimits :: [Ulimit]
11971420 -- TODO: Missing from 1.24
@@ -1229,45 +1452,59 @@ instance FromJSON EnvVar where
12291452 parseJSON _ = fail "EnvVar is not a string"
12301453
12311454instance ToJSON EnvVar where
1232− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
12331456
1234−-- | ExposedPorts represent a enumeraton of all the ports (and their type)
1457+-- | ExposedPort represents a port (and it's type)
12351458-- that a container should expose to other containers or the host system.
1236−-- `NOTE`: This does not automatically expose the ports onto the host
1237−-- system but rather it just tags them. It's best to be used with
1459+-- `NOTE`: This does not automatically expose the port onto the host
1460+-- system but rather it just tags it. It's best to be used with
12381461-- the PublishAllPorts flag. It is also useful for
12391462-- the daemon to know which Environment variables to
12401463-- inject into a container linking to our container.
12411464-- Example linking a Postgres container named db would inject the following
12421465-- environment variables automatically if we set the corresponding
12431466--
1244−-- ExposedPorts:
1467+-- ExposedPort:
12451468--
12461469-- @
12471470-- DB_PORT_5432_TCP_PORT="5432"
12481471-- DB_PORT_5432_TCP_PROTO="tcp"
12491472-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
12501473-- @
1251−newtype ExposedPorts = ExposedPorts (M.Map Port PortType) deriving (Eq, Show)
1252−-- JP: Should this be ExposedPorts [(Port, PortType)]?
1253−
1254−instance FromJSON ExposedPorts where
1255− parseJSON (JSON.Object o) = do
1256− ExposedPorts <$> HM.foldlWithKey' f (return M.empty) o
1474+data ExposedPort = ExposedPort Port PortType deriving (Eq, Show)
12571475
1476+instance {-# OVERLAPPING #-} FromJSON [ExposedPort] where
1477+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
12581478 where
12591479 f accM k _ = case T.split (== '/') k of
12601480 [port', portType'] -> do
12611481 port <- parseIntegerText port'
12621482 portType <- parseJSON $ JSON.String portType'
12631483 acc <- accM
1264− return $ M.insert port portType acc
1265− _ ->
1266− fail "Could not parse ExposedPorts"
1267− parseJSON _ = fail "ExposedPorts is not an object."
1484+ return $ (ExposedPort port portType):acc
1485+ _ -> fail "Could not parse ExposedPorts"
1486+ parseJSON (JSON.Null) = return []
1487+ parseJSON _ = fail "ExposedPorts is not an object"
1488+
1489+instance {-# OVERLAPPING #-} ToJSON [ExposedPort] where
1490+ toJSON [] = emptyJsonObject
1491+ toJSON (p:ps) = toJsonKey (p:ps) key
1492+ where key (ExposedPort p t) = show p <> slash <> show t
1493+ slash = T.unpack "/"
1494+
1495+data Entrypoint = Entrypoint [T.Text] deriving (Eq, Show, Generic)
1496+
1497+instance ToJSON Entrypoint where
1498+ toJSON (Entrypoint (e:es)) = toJSON (e:es)
1499+ toJSON (Entrypoint []) = JSON.Null
12681500
1269−instance ToJSON ExposedPorts where
1270− toJSON (ExposedPorts kvs) = object [((T.pack $ show p) <> "/" <> (T.pack $ show t)) .= JSON.Object HM.empty | (p,t) <- (M.toList kvs)]
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"
12711508
12721509
12731510data ContainerConfig = ContainerConfig {
@@ -1277,7 +1514,7 @@ data ContainerConfig = ContainerConfig {
12771514 , attachStdin :: Bool
12781515 , attachStdout :: Bool
12791516 , attachStderr :: Bool
1280− , exposedPorts :: Maybe ExposedPorts -- Note: Should we expand the JSON instance and take away the Maybe?
1517+ , exposedPorts :: [ExposedPort]
12811518 -- , publishService :: Text -- Don't see this in 1.24
12821519 , tty :: Bool
12831520 , openStdin :: Bool
@@ -1286,27 +1523,70 @@ data ContainerConfig = ContainerConfig {
12861523 , cmd :: [Text]
12871524 -- , argsEscaped :: Bool -- Don't see this in 1.24
12881525 , image :: Text
1289− , volumes :: Maybe Volumes
1526+ , volumes :: [Volume]
12901527 , workingDir :: Maybe FilePath
1291− , entrypoint :: Maybe Text -- Can be null?
1528+ , entrypoint :: Entrypoint
12921529 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
12931530 , macAddress :: Maybe Text
12941531 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
1295− , labels :: Maybe Labels
1532+ , labels :: [Label]
12961533 , stopSignal :: Signal
12971534 } deriving (Eq, Show, Generic)
12981535
1536+
12991537instance ToJSON ContainerConfig where
13001538 toJSON = genericToJSON defaultOptions {
13011539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
13021540
13031541instance FromJSON ContainerConfig where
1304− parseJSON = genericParseJSON defaultOptions {
1305− fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
1542+ parseJSON (JSON.Object o) = do
1543+ hostname <- o .:? "Hostname"
1544+ domainname <- o .:? "Domainname"
1545+ user <- o .:? "User"
1546+ attachStdin <- o .: "AttachStdin"
1547+ attachStdout <- o .: "AttachStdout"
1548+ attachStderr <- o .: "AttachStderr"
1549+ exposedPorts <- o .:? "ExposedPorts" .!= []
1550+ tty <- o .: "Tty"
1551+ openStdin <- o .: "OpenStdin"
1552+ stdinOnce <- o .: "StdinOnce"
1553+ env <- o .: "Env"
1554+ cmd <- o .: "Cmd"
1555+ image <- o .: "Image"
1556+ volumes <- o .: "Volumes"
1557+ workingDir <- o .:? "WorkingDir"
1558+ entrypoint <- o .: "Entrypoint"
1559+ networkDisabled <- o .:? "networkDisabled"
1560+ macAddress <- o .:? "MacAddress"
1561+ labels <- o .:? "Labels" .!= []
1562+ stopSignal <- o .: "StopSignal"
1563+ return $ ContainerConfig hostname domainname user attachStdin attachStdout attachStderr exposedPorts tty openStdin stdinOnce env cmd image volumes workingDir entrypoint networkDisabled
1564+ macAddress labels stopSignal
1565+ parseJSON _ = fail "NetworkSettings is not an object."
13061566
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1569+#else
13071570parseIntegerText :: (Monad m) => Text -> m Integer
1571+#endif
13081572parseIntegerText t = case readMaybe $ T.unpack t of
13091573 Nothing ->
13101574 fail "Could not parse Integer"
13111575 Just i ->
13121576 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