@@ -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(..)
4354 , Bind(..)
44− , Volumes(..)
55+ , Volume(..)
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,11 +86,18 @@ module Docker.Client.Types (
7486 , EnvVar(..)
7587 , ContainerConfig(..)
7688 , defaultContainerConfig
77− , ExposedPorts(..)
89+ , ExposedPort(..)
7890 , DeviceWeight(..)
7991 , DeviceRate(..)
8092 , addPortBinding
81− , addBinds
93+ , addExposedPort
94+ , addBind
95+ , setCmd
96+ , addLink
97+ , addVolume
98+ , addVolumeFrom
99+ , MemoryConstraint(..)
100+ , MemoryConstraintSize(..)
82101 ) where
83102
84103import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
@@ -88,11 +107,12 @@ import qualified Data.Aeson as JSON
88107import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
89108import Data.Char (isAlphaNum, toUpper)
90109import qualified Data.HashMap.Strict as HM
91−import qualified Data.Map as M
92110import Data.Monoid ((<>))
111+import Data.Scientific (floatingOrInteger)
93112import Data.Text (Text)
94113import qualified Data.Text as T
95114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
96116import GHC.Generics (Generic)
97117import Prelude hiding (all, tail)
98118import Text.Read (readMaybe)
@@ -102,17 +122,23 @@ data Endpoint =
102122 VersionEndpoint
103123 | ListContainersEndpoint ListOpts
104124 | ListImagesEndpoint ListOpts
105− | CreateContainerEndpoint CreateOpts
125+ | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
106126 | StartContainerEndpoint StartOpts ContainerID
107127 | StopContainerEndpoint Timeout ContainerID
128+ | WaitContainerEndpoint ContainerID
108129 | KillContainerEndpoint Signal ContainerID
109130 | RestartContainerEndpoint Timeout ContainerID
110131 | PauseContainerEndpoint ContainerID
111132 | UnpauseContainerEndpoint ContainerID
112133 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
113134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
114− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
115136 | 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
116142 deriving (Eq, Show)
117143
118144-- | We should newtype this
@@ -159,6 +185,20 @@ toImageID t =
159185-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
160186data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
161187
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+
162202-- TODO: Add more Signals or use an existing lib
163203-- | Signal used for sending to the process running in the container.
164204-- The default signal is SIGTERM.
@@ -173,16 +213,16 @@ data Signal = SIGHUP
173213
174214instance FromJSON Signal where
175215 parseJSON (JSON.String "SIGTERM") = return SIGTERM
176− parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
177− 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
178218 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
179219 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
180220 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
181− parseJSON _ = fail "Unknown Signal"
221+ parseJSON _ = fail "Unknown Signal"
182222
183223instance ToJSON Signal where
184− toJSON SIGHUP = "SIGHUP"
185− toJSON SIGINT = "SIGINT"
224+ toJSON SIGHUP = "SIGHUP"
225+ toJSON SIGINT = "SIGINT"
186226 toJSON SIGQUIT = "SIGQUIT"
187227 toJSON SIGSTOP = "SIGSTOP"
188228 toJSON SIGTERM = "SIGTERM"
@@ -210,7 +250,7 @@ data ContainerDetails = ContainerDetails {
210250 , processLabel :: Text
211251 , resolveConfPath :: FilePath
212252 , restartCount :: Int
213− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
214254 , mounts :: [Mount]
215255 }
216256 deriving (Eq, Show, Generic)
@@ -218,11 +258,11 @@ data ContainerDetails = ContainerDetails {
218258-- | Data type used for parsing the mount information from a container
219259-- list.
220260data Mount = Mount {
221− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
222262 , mountSource :: FilePath
223263 , mountDestination :: FilePath
224− , mountDriver :: Text
225− , mountMode :: Maybe VolumePermission -- apparently this can be null
264+ , mountDriver :: Maybe Text
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
226266 , mountRW :: Bool
227267 , mountPropogation :: Text
228268 }
@@ -230,14 +270,14 @@ data Mount = Mount {
230270
231271instance FromJSON Mount where
232272 parseJSON (JSON.Object o) = do
233− name <- o .: "Name"
273+ name <- o .:? "Name"
234274 src <- o .: "Source"
235275 dest <- o .: "Destination"
236− driver <- o .: "Driver"
237− mode <- o .: "Mode"
276+ driver <- o .:? "Driver"
277+ -- mode <- o .: "Mode"
238278 rw <- o .: "RW"
239279 prop <- o .: "Propagation"
240− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
241281 parseJSON _ = fail "Mount is not an object"
242282
243283-- | Data type used for parsing the container state from a list of
@@ -253,7 +293,7 @@ data ContainerState = ContainerState {
253293 , restarting :: Bool
254294 , running :: Bool
255295 , startedAt :: UTCTime
256− , status :: Status
296+ , state :: State
257297 }
258298 deriving (Eq, Show, Generic)
259299
@@ -416,20 +456,17 @@ instance FromJSON NetworkOptions where
416456 parseJSON _ = fail "NetworkOptions is not an object"
417457
418458-- TODO: Not sure what this is used for anymore.
419−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
420460 deriving (Eq, Show)
421461
422−instance FromJSON Networks where
423− parseJSON (JSON.Object o) = do
424− Networks <$> HM.foldlWithKey' f (return M.empty) o
425−
462+instance {-# OVERLAPPING #-} FromJSON [Network] where
463+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
426464 where
427465 f accM k' v' = do
428466 acc <- accM
429467 k <- parseJSON $ JSON.String k'
430468 v <- parseJSON v'
431− return $ M.insert k v acc
432−
469+ return $ (Network k v):acc
433470 parseJSON _ = fail "Networks is not an object"
434471
435472-- | Data type reprsenting the various network settings a container can have.
@@ -439,7 +476,7 @@ data NetworkSettings = NetworkSettings {
439476 , networkSettingsHairpinMode :: Bool
440477 , networkSettingsLinkLocalIPv6Address :: Text
441478 , networkSettingsLinkLocalIPv6PrefixLen :: Int
442− , networkSettingsPorts :: PortBindings
479+ , networkSettingsPorts :: [PortBinding]
443480 , networkSettingsSandboxKey :: Text
444481 , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
445482 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
@@ -451,7 +488,7 @@ data NetworkSettings = NetworkSettings {
451488 , networkSettingsIpPrefixLen :: Int
452489 , networkSettingsIpv6Gateway :: Text
453490 , networkSettingsMacAddress :: Text
454− , networkSettingsNetworks :: Networks
491+ , networkSettingsNetworks :: [Network]
455492 }
456493 deriving (Eq, Show)
457494
@@ -486,21 +523,23 @@ data Container = Container
486523 , containerImageId :: ImageID
487524 , containerCommand :: Text
488525 , containerCreatedAt :: Int
489− , containerStatus :: Status
526+ , containerState :: State
527+ , containerStatus :: Maybe Text
490528 , containerPorts :: [ContainerPortInfo]
491− , containerLabels :: Labels
492− , containerNetworks :: Networks
529+ , containerLabels :: [Label]
530+ , containerNetworks :: [Network]
493531 , containerMounts :: [Mount]
494532 } deriving (Show, Eq)
495533
496534instance FromJSON Container where
497− parseJSON (JSON.Object v) =
498− Container <$> (v .: "Id")
535+ parseJSON o@(JSON.Object v) =
536+ Container <$> parseJSON o
499537 <*> (v .: "Names")
500538 <*> (v .: "Image")
501− <*> (v .: "ImageID")
502− <*> (v .: "Command")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
540+ <*> (v .: "Command") -- Doesn't exist anymore
503541 <*> (v .: "Created")
542+ <*> (v .: "State")
504543 <*> (v .: "Status")
505544 <*> (v .: "Ports")
506545 <*> (v .: "Labels")
@@ -510,34 +549,45 @@ instance FromJSON Container where
510549 parseNetworks (JSON.Object v) =
511550 (v .: "Networks") >>= parseJSON
512551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
513−
514552 parseJSON _ = fail "Container: Not a JSON object."
515553
516−-- | Represents the status of the container life cycle.
517−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
518556 deriving (Eq, Show, Generic)
519557
520−instance FromJSON Status where
521− parseJSON (JSON.String "running") = return Running
522− 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.
523561 parseJSON (JSON.String "restarting") = return Restarting
524− parseJSON (JSON.String "paused") = return Paused
525− parseJSON (JSON.String "exited") = return Exited
526− parseJSON (JSON.String "dead") = return Dead
527− 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
528566
529567-- | Alias for representing a RepoDigest. We could newtype this and add
530568-- some validation.
531569type Digest = Text
532570
533571-- | Container and Image Labels.
534−newtype Labels = Labels (M.Map Name Value) deriving (Eq, Show)
572+data Label = Label Name Value deriving (Eq, Show)
535573
536−instance FromJSON Labels where
537− parseJSON val = Labels <$> parseJSON val
538574
539−instance ToJSON Labels where
540− 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."
541591
542592-- | Alias for Tags.
543593type Tag = Text
@@ -548,10 +598,10 @@ data Image = DockerImage {
548598 , imageCreated :: Integer
549599 , imageParentId :: Maybe ImageID
550600 , imageRepoTags :: [Tag]
551− , imageRepoDigests :: Maybe [Digest]
601+ , imageRepoDigests :: [Digest]
552602 , imageSize :: Integer
553603 , imageVirtualSize :: Integer
554− , imageLabels :: Maybe Labels
604+ , imageLabels :: [Label]
555605 } deriving (Show, Eq, Generic)
556606
557607-- | Helper function used for dropping the "image" prefix when serializing
@@ -559,23 +609,60 @@ data Image = DockerImage {
559609dropImagePrefix :: [a] -> [a]
560610dropImagePrefix = drop 5
561611
612+
562613instance FromJSON Image where
563− parseJSON = genericParseJSON defaultOptions {
564− 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+ ]
565649
566650-- | Options used for creating a Container.
567651data CreateOpts = CreateOpts {
568− containerConfig :: ContainerConfig
569− , hostConfig :: HostConfig
652+ containerConfig :: ContainerConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
570655 } deriving (Eq, Show)
571656
572657instance ToJSON CreateOpts where
573− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
574659 let ccJSON = toJSON cc
575660 let hcJSON = toJSON hc
576661 case ccJSON of
577662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
578− 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
579666 _ -> error "ContainerConfig is not an object." -- This should never happen.
580667
581668-- | Container configuration used for creating a container with sensible
@@ -589,18 +676,18 @@ defaultContainerConfig imageName = ContainerConfig {
589676 , attachStdout=False
590677 , image=imageName
591678 , attachStderr=False
592− , exposedPorts=Nothing -- ExposedPorts M.empty
679+ , exposedPorts=[]
593680 , tty=False
594681 , openStdin=False
595682 , stdinOnce=False
596683 , env=[]
597684 , cmd=[]
598− , volumes=Nothing
685+ , volumes=[]
599686 , workingDir=Nothing
600− , entrypoint=Nothing
687+ , entrypoint=Entrypoint []
601688 , networkDisabled=Nothing
602689 , macAddress=Nothing
603− , labels=Nothing
690+ , labels=[]
604691 , stopSignal=SIGTERM
605692 }
606693
@@ -609,9 +696,9 @@ defaultHostConfig :: HostConfig
609696defaultHostConfig = HostConfig {
610697 binds=[]
611698 , containerIDFile=Nothing
612− , logConfig=LogDriverConfig JsonFile Nothing
613− , networkMode=Bridge
614− , portBindings=PortBindings []
699+ , logConfig=LogDriverConfig JsonFile []
700+ , networkMode=NetworkBridge
701+ , portBindings=[]
615702 , restartPolicy=RestartOff
616703 , volumeDriver=Nothing
617704 , volumesFrom=[]
@@ -650,14 +737,18 @@ defaultContainerResources = ContainerResources {
650737 , memory=Nothing
651738 , memoryReservation=Nothing
652739 , memorySwap=Nothing
653− , oomKillDisable=False
740+ , oomKillDisable=Just False
654741 , ulimits=[]
655742 }
656743
657744-- | Default create options when creating a container. You only need to
658745-- specify an image name and the rest is all sensible defaults.
659746defaultCreateOpts :: T.Text -> CreateOpts
660−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+ }
661752
662753-- | Override the key sequence for detaching a container.
663754-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
@@ -671,16 +762,45 @@ defaultStartOpts :: StartOpts
671762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
672763
673764-- | Options for deleting a container.
674−data DeleteOpts = DeleteOpts {
765+data ContainerDeleteOpts = ContainerDeleteOpts {
675766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
676767 , force :: Bool -- ^ If the container is still running force deletion anyway.
677768 } deriving (Eq, Show)
678769
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+
679792-- | Default options for deleting a container. Most of the time we DON'T
680793-- want to delete the container's volumes or force delete it if it's
681794-- running.
682−defaultDeleteOpts :: DeleteOpts
683−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
684804
685805-- | Timestamp alias.
686806type Timestamp = Integer
@@ -708,18 +828,50 @@ defaultLogOpts = LogOpts { stdout = True
708828 , tail = All
709829 }
710830
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+
711861-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
712862-- | Set permissions on volumes that you mount in the container.
713863data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
714864
715865instance ToJSON VolumePermission where
716866 toJSON ReadWrite = "rw"
717− toJSON ReadOnly = "ro"
867+ toJSON ReadOnly = "ro"
718868
719869instance FromJSON VolumePermission where
720870 parseJSON "rw" = return ReadWrite
721871 parseJSON "ro" = return ReadOnly
722− parseJSON _ = fail "Failed to parse VolumePermission"
872+ parseJSON "RW" = return ReadWrite
873+ parseJSON "RO" = return ReadOnly
874+ parseJSON _ = fail "Failed to parse VolumePermission"
723875
724876-- | Used for marking a directory in the container as "exposed" hence
725877-- taking it outside of the COW filesystem and making it mountable
@@ -732,16 +884,18 @@ instance FromJSON VolumePermission where
732884-- docker run --name app -v \/opt\/data -it myapp:latest
733885-- docker run --name app2 --volumes-from app \/bin\/bash -c "ls -l \/opt\/data"
734886-- @
735−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
736893
737−instance FromJSON Volumes where
738− parseJSON (JSON.Object o) = return $ Volumes $ map T.unpack $ HM.keys o
739− 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"
740898
741−instance ToJSON Volumes where
742− toJSON (Volumes []) = JSON.Object HM.empty
743− toJSON (Volumes (v:vs)) = JSON.Object $ foldl f HM.empty (v:vs)
744− where f acc k = HM.insert (T.pack k) (JSON.Object HM.empty) acc
745899
746900data Bind = Bind { hostSrc :: Text
747901 , containerDest :: Text
@@ -750,10 +904,10 @@ data Bind = Bind { hostSrc :: Text
750904
751905instance FromJSON Bind where
752906 parseJSON (JSON.String t) = case T.split (== ':') t of
753− [src, dest] -> return $ Bind src dest Nothing
907+ [src, dest] -> return $ Bind src dest Nothing
754908 [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
755909 [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
756− _ -> fail "Could not parse Bind"
910+ _ -> fail "Could not parse Bind"
757911 parseJSON _ = fail "Bind is not a string"
758912
759913data Device = Device {
@@ -776,15 +930,15 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
776930
777931instance FromJSON VolumeFrom where
778932 parseJSON (JSON.String t) = case T.split (== ':') t of
779− [vol] -> return $ VolumeFrom vol Nothing
933+ [vol] -> return $ VolumeFrom vol Nothing
780934 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
781935 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
782− _ -> fail "Could not parse VolumeFrom"
936+ _ -> fail "Could not parse VolumeFrom"
783937 parseJSON _ = fail "VolumeFrom is not a string"
784938
785939instance ToJSON VolumeFrom where
786940 toJSON (VolumeFrom n p) = case p of
787− Nothing -> toJSON $ n <> ":" <> "rw"
941+ Nothing -> toJSON $ n <> ":" <> "rw"
788942 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
789943
790944instance ToJSON Bind where
@@ -796,63 +950,63 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
796950
797951instance FromJSON Link where
798952 parseJSON (JSON.String t) = case T.split (== ':') t of
799− [f] -> return $ Link f Nothing
953+ [f] -> return $ Link f Nothing
800954 [f,s] -> return $ Link f $ Just s
801− _ -> fail "Could not parse Link"
955+ _ -> fail "Could not parse Link"
802956 parseJSON _ = fail "Link is not a string"
803957
804958instance ToJSON Link where
805959 toJSON (Link n1 n2) = toJSON $ case n2 of
806960 Nothing -> T.concat[n1, ":", n1] -- use same name in container
807− Just n -> T.concat[n1, ":", n] -- used specified name in container
961+ Just n -> T.concat[n1, ":", n] -- used specified name in container
808962
809963-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
810964data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
811965
812966instance FromJSON LogDriverType where
813967 parseJSON (JSON.String "json-file") = return JsonFile
814− parseJSON (JSON.String "syslog") = return Syslog
815− parseJSON (JSON.String "journald") = return Journald
816− parseJSON (JSON.String "gelf") = return Gelf
817− parseJSON (JSON.String "fluentd") = return Fluentd
818− parseJSON (JSON.String "awslogs") = return AwsLogs
819− parseJSON (JSON.String "splunk") = return Splunk
820− parseJSON (JSON.String "etwlogs") = return Etwlogs
821− parseJSON (JSON.String "none") = return LoggingDisabled
822− 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"
823977
824978instance ToJSON LogDriverType where
825− toJSON JsonFile = JSON.String "json-file"
826− toJSON Syslog = JSON.String "syslog"
827− toJSON Journald = JSON.String "journald"
828− toJSON Gelf = JSON.String "gelf"
829− toJSON Fluentd = JSON.String "fluentd"
830− toJSON AwsLogs = JSON.String "awslogs"
831− toJSON Splunk = JSON.String "splunk"
832− 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"
833987 toJSON LoggingDisabled = JSON.String "none"
834988
835−newtype LogDriverOptions = LogDriverOptions (M.Map Text Text) deriving (Eq, Show)
989+data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
836990
837−instance FromJSON LogDriverOptions where
838− parseJSON (JSON.Object o) = do
839− 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
840996
841− where
842− 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
8431000 acc <- accM
844− return $ M.insert k v acc
845− f _ _ _ = fail "Value of LogDriverOptions is not a string"
846−
847− parseJSON JSON.Null = return $ LogDriverOptions M.empty
848− parseJSON _ = fail "LogDriverOptions is not an object"
1001+ value <- parseJSON v
1002+ return $ (LogDriverOption k value):acc
1003+ parseJSON JSON.Null = return []
1004+ parseJSON _ = fail "Failed to parse LogDriverOptions"
8491005
850−instance ToJSON LogDriverOptions where
851− toJSON (LogDriverOptions mp) = toJSON mp
852−
853−data LogDriverConfig = LogDriverConfig LogDriverType (Maybe LogDriverOptions) deriving (Eq, Show)
1006+data LogDriverConfig = LogDriverConfig LogDriverType [LogDriverOption] deriving (Eq, Show)
8541007
8551008instance ToJSON LogDriverConfig where
1009+ toJSON (LogDriverConfig driverType []) = object ["Type" .= driverType]
8561010 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
8571011
8581012instance FromJSON LogDriverConfig where
@@ -863,19 +1017,41 @@ instance FromJSON LogDriverConfig where
8631017 parseJSON _ = fail "LogDriverConfig is not an object"
8641018
8651019-- TODO: Add container:<name|id> mode
866−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
8671021 deriving (Eq, Show, Ord)
8681022
8691023instance FromJSON NetworkMode where
870− parseJSON (JSON.String "bridge") = return Bridge
871− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
872− parseJSON (JSON.String "none") = return NetworkDisabled
873− 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"
8741029
8751030instance ToJSON NetworkMode where
876− toJSON Bridge = JSON.String "bridge"
877− toJSON Host = JSON.String "host"
1031+ toJSON NetworkBridge = JSON.String "bridge"
1032+ toJSON NetworkHost = JSON.String "host"
8781033 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]
8791055
8801056data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
8811057
@@ -891,7 +1067,7 @@ instance FromJSON PortType where
8911067 parseJSON val = case val of
8921068 "tcp" -> return TCP
8931069 "udp" -> return UDP
894− _ -> fail "PortType: Invalid port type."
1070+ _ -> fail "PortType: Invalid port type."
8951071
8961072-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
8971073--
@@ -908,13 +1084,6 @@ instance FromJSON PortType where
9081084-- interface like `127.0.0.1`.
9091085-- __NOTE__: We should disallow duplicate port bindings as the ToJSON
9101086-- instance will only send the last one.
911−newtype PortBindings = PortBindings [PortBinding]
912− deriving (Eq, Show)
913−
914−instance Monoid PortBindings where
915− mempty = PortBindings []
916− mappend (PortBindings p1) (PortBindings p2) = PortBindings (p1 ++ p2)
917−
9181087-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
9191088data PortBinding = PortBinding {
9201089 containerPort :: Port
@@ -926,28 +1095,61 @@ portAndType2Text :: Port -> PortType -> Text
9261095portAndType2Text p t = (T.pack $ show p) <> "/" <> (T.pack $ show t)
9271096
9281097
929−addBinds :: [Bind] -> CreateOpts -> CreateOpts
930−addBinds bs c = c{hostConfig=hc{binds=bs}}
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]}}
9311115 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
9321131
9331132-- | A convenience function that adds PortBindings to and exiting
9341133-- "CreateOpts" record. Useful with 'defaultCreateOpts'
9351134-- Example:
9361135--
9371136-- >>> let pb = PortBinding 80 TCP [HostPort "0.0.0.0" 8000]
938−-- >>> addPortBinding (defaultCreateOpts "nginx:latest") pb
939−addPortBinding :: CreateOpts -> PortBinding -> CreateOpts
940−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]}}
9411140 where hc = hostConfig c
9421141 pbs = portBindings $ hostConfig c
9431142
944−instance ToJSON PortBinding where
945− 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
9461149
947−instance FromJSON PortBindings where
948− parseJSON (JSON.Object o) = do
949− PortBindings <$> HM.foldlWithKey' f (return []) o
9501150
1151+instance {-# OVERLAPPING #-} FromJSON [PortBinding] where
1152+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
9511153 where
9521154 f accM k v = case T.split (== '/') k of
9531155 [port', portType'] -> do
@@ -956,16 +1158,15 @@ instance FromJSON PortBindings where
9561158 acc <- accM
9571159 hps <- parseJSON v
9581160 return $ (PortBinding port portType hps):acc
959− _ ->
960− fail "Could not parse PortBindings"
1161+ _ -> fail "Could not parse PortBindings"
1162+ parseJSON (JSON.Null) = return []
9611163 parseJSON _ = fail "PortBindings is not an object"
9621164
963−instance ToJSON PortBindings where
964− toJSON (PortBindings []) = JSON.Object HM.empty
965− toJSON (PortBindings (p:ps)) = JSON.Object $ foldl f HM.empty (p:ps)
966− where mKey p = portAndType2Text (containerPort p) (portType p)
967− mVal p = toJSON $ hostPorts p
968− 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
9691170
9701171data HostPort = HostPort {
9711172 hostIp :: Text
@@ -996,7 +1197,7 @@ instance FromJSON RestartPolicy where
9961197 "on-failure" -> do
9971198 retry <- o .: "MaximumRetryCount"
9981199 return $ RestartOnFailure retry
999− "off" -> return RestartOff
1200+ "no" -> return RestartOff
10001201 _ -> fail "Could not parse RestartPolicy"
10011202 parseJSON _ = fail "RestartPolicy is not an object"
10021203
@@ -1004,7 +1205,7 @@ instance ToJSON RestartPolicy where
10041205 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
10051206 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
10061207 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1007− toJSON RestartOff = object ["Name" .= JSON.String "off"]
1208+ toJSON RestartOff = object ["Name" .= JSON.String "no"]
10081209
10091210data Isolation = Default | Process | Hyperv deriving (Eq, Show)
10101211
@@ -1018,7 +1219,7 @@ data HostConfig = HostConfig
10181219 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
10191220 , logConfig :: LogDriverConfig
10201221 , networkMode :: NetworkMode
1021− , portBindings :: PortBindings
1222+ , portBindings :: [PortBinding]
10221223 , restartPolicy :: RestartPolicy
10231224 , volumeDriver :: Maybe Text
10241225 , volumesFrom :: [VolumeFrom]
@@ -1177,6 +1378,22 @@ instance ToJSON DeviceRate where
11771378 , "Rate" .= r
11781379 ]
11791380
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+
11801397data ContainerResources = ContainerResources {
11811398 cpuShares :: Maybe Integer
11821399 -- , cgroupParent :: Text -- 1.24: Missing from inspecting container details... Going to omit for now.
@@ -1192,12 +1409,12 @@ data ContainerResources = ContainerResources {
11921409 , cpusetMems :: Maybe Text
11931410 , devices :: [Device]
11941411 -- , diskQuota :: Integer -- Don't see this ins 1.24.
1195− , kernelMemory :: Maybe Integer
1196− , memory :: Maybe Integer
1197− , memoryReservation :: Maybe Integer
1198− , memorySwap :: Maybe Integer
1412+ , kernelMemory :: Maybe MemoryConstraint
1413+ , memory :: Maybe MemoryConstraint
1414+ , memoryReservation :: Maybe MemoryConstraint
1415+ , memorySwap :: Maybe MemoryConstraint
11991416 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1200− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
12011418 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
12021419 , ulimits :: [Ulimit]
12031420 -- TODO: Missing from 1.24
@@ -1235,45 +1452,59 @@ instance FromJSON EnvVar where
12351452 parseJSON _ = fail "EnvVar is not a string"
12361453
12371454instance ToJSON EnvVar where
1238− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
12391456
1240−-- | ExposedPorts represent a enumeraton of all the ports (and their type)
1457+-- | ExposedPort represents a port (and it's type)
12411458-- that a container should expose to other containers or the host system.
1242−-- `NOTE`: This does not automatically expose the ports onto the host
1243−-- 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
12441461-- the PublishAllPorts flag. It is also useful for
12451462-- the daemon to know which Environment variables to
12461463-- inject into a container linking to our container.
12471464-- Example linking a Postgres container named db would inject the following
12481465-- environment variables automatically if we set the corresponding
12491466--
1250−-- ExposedPorts:
1467+-- ExposedPort:
12511468--
12521469-- @
12531470-- DB_PORT_5432_TCP_PORT="5432"
12541471-- DB_PORT_5432_TCP_PROTO="tcp"
12551472-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
12561473-- @
1257−newtype ExposedPorts = ExposedPorts (M.Map Port PortType) deriving (Eq, Show)
1258−-- JP: Should this be ExposedPorts [(Port, PortType)]?
1259−
1260−instance FromJSON ExposedPorts where
1261− parseJSON (JSON.Object o) = do
1262− ExposedPorts <$> HM.foldlWithKey' f (return M.empty) o
1474+data ExposedPort = ExposedPort Port PortType deriving (Eq, Show)
12631475
1476+instance {-# OVERLAPPING #-} FromJSON [ExposedPort] where
1477+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
12641478 where
12651479 f accM k _ = case T.split (== '/') k of
12661480 [port', portType'] -> do
12671481 port <- parseIntegerText port'
12681482 portType <- parseJSON $ JSON.String portType'
12691483 acc <- accM
1270− return $ M.insert port portType acc
1271− _ ->
1272− fail "Could not parse ExposedPorts"
1273− 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 "/"
12741494
1275−instance ToJSON ExposedPorts where
1276− toJSON (ExposedPorts kvs) = object [((T.pack $ show p) <> "/" <> (T.pack $ show t)) .= JSON.Object HM.empty | (p,t) <- (M.toList kvs)]
1495+data Entrypoint = Entrypoint [T.Text] deriving (Eq, Show, Generic)
1496+
1497+instance ToJSON Entrypoint where
1498+ toJSON (Entrypoint (e:es)) = toJSON (e:es)
1499+ toJSON (Entrypoint []) = JSON.Null
1500+
1501+instance FromJSON Entrypoint where
1502+ parseJSON (JSON.String e) = return $ Entrypoint [e]
1503+ parseJSON (JSON.Array ar) = do
1504+ arr <- mapM parseJSON (V.toList ar)
1505+ return $ Entrypoint arr
1506+ parseJSON JSON.Null = return $ Entrypoint []
1507+ parseJSON _ = fail "Failed to parse Entrypoint"
12771508
12781509
12791510data ContainerConfig = ContainerConfig {
@@ -1283,7 +1514,7 @@ data ContainerConfig = ContainerConfig {
12831514 , attachStdin :: Bool
12841515 , attachStdout :: Bool
12851516 , attachStderr :: Bool
1286− , exposedPorts :: Maybe ExposedPorts -- Note: Should we expand the JSON instance and take away the Maybe?
1517+ , exposedPorts :: [ExposedPort]
12871518 -- , publishService :: Text -- Don't see this in 1.24
12881519 , tty :: Bool
12891520 , openStdin :: Bool
@@ -1292,27 +1523,70 @@ data ContainerConfig = ContainerConfig {
12921523 , cmd :: [Text]
12931524 -- , argsEscaped :: Bool -- Don't see this in 1.24
12941525 , image :: Text
1295− , volumes :: Maybe Volumes
1526+ , volumes :: [Volume]
12961527 , workingDir :: Maybe FilePath
1297− , entrypoint :: Maybe Text -- Can be null?
1528+ , entrypoint :: Entrypoint
12981529 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
12991530 , macAddress :: Maybe Text
13001531 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
1301− , labels :: Maybe Labels
1532+ , labels :: [Label]
13021533 , stopSignal :: Signal
13031534 } deriving (Eq, Show, Generic)
13041535
1536+
13051537instance ToJSON ContainerConfig where
13061538 toJSON = genericToJSON defaultOptions {
13071539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
13081540
13091541instance FromJSON ContainerConfig where
1310− parseJSON = genericParseJSON defaultOptions {
1311− 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."
13121566
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1569+#else
13131570parseIntegerText :: (Monad m) => Text -> m Integer
1571+#endif
13141572parseIntegerText t = case readMaybe $ T.unpack t of
13151573 Nothing ->
13161574 fail "Could not parse Integer"
13171575 Just i ->
13181576 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