@@ -11,7 +11,11 @@ module Docker.Client.Types (
12 , fromImageID
12 , fromImageID
13 , toImageID
13 , toImageID
14 , Timeout(..)
17 , Timeout(..)
15 , Signal(..)
19 , Signal(..)
16 , ContainerDetails(..)
20 , ContainerDetails(..)
17 , DockerClientOpts(..)
21 , DockerClientOpts(..)
@@ -22,42 +26,48 @@ module Docker.Client.Types (
22 , ContainerPortInfo(..)
26 , ContainerPortInfo(..)
23 , Container(..)
27 , Container(..)
24 , ContainerState(..)
28 , ContainerState(..)
25− , Status(..)
29+ , State(..)
27− , Labels(..)
31+ , Label(..)
29 , Image(..)
33 , Image(..)
30 , dropImagePrefix
35 , dropImagePrefix
31 , CreateOpts(..)
36 , CreateOpts(..)
32 , defaultCreateOpts
39 , defaultCreateOpts
33 , DetachKeys(..)
40 , DetachKeys(..)
34 , StartOpts(..)
41 , StartOpts(..)
35 , defaultStartOpts
42 , defaultStartOpts
36− , DeleteOpts(..)
43+ , ContainerDeleteOpts(..)
37− , defaultDeleteOpts
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
38 , Timestamp
47 , Timestamp
39 , TailLogOpt(..)
48 , TailLogOpt(..)
40 , LogOpts(..)
49 , LogOpts(..)
41 , defaultLogOpts
50 , defaultLogOpts
51+ , CreateNetworkOpts(..)
52+ , defaultCreateNetworkOpts
42 , VolumePermission(..)
53 , VolumePermission(..)
43 , Volume(..)
55 , Volume(..)
45 , Device(..)
56 , Device(..)
46 , ContainerName
57 , ContainerName
47 , VolumeFrom(..)
58 , VolumeFrom(..)
48 , Link(..)
59 , Link(..)
49 , LogDriverType(..)
60 , LogDriverType(..)
50− , LogDriverOptions(..)
61+ , LogDriverOption(..)
51 , LogDriverConfig(..)
62 , LogDriverConfig(..)
52 , NetworkMode(..)
63 , NetworkMode(..)
53 , PortType(..)
64 , PortType(..)
54-- , NetworkInterface(..)
65-- , NetworkInterface(..)
55− , Networks(..)
66+ , Network(..)
56 , NetworkSettings(..)
67 , NetworkSettings(..)
57 , NetworkOptions(..)
68 , NetworkOptions(..)
58 , Mount(..)
69 , Mount(..)
59 , PortBinding(..)
70 , PortBinding(..)
61 , HostPort(..)
71 , HostPort(..)
62 , RetryCount
72 , RetryCount
63 , RestartPolicy(..)
73 , RestartPolicy(..)
@@ -65,6 +75,8 @@ module Docker.Client.Types (
65 , UTSMode(..)
75 , UTSMode(..)
66 , HostConfig(..)
76 , HostConfig(..)
67 , defaultHostConfig
77 , defaultHostConfig
78+ , NetworkingConfig(..)
68 , Ulimit(..)
80 , Ulimit(..)
69 , ContainerResources(..)
81 , ContainerResources(..)
70 , defaultContainerResources
82 , defaultContainerResources
@@ -74,10 +86,18 @@ module Docker.Client.Types (
74 , EnvVar(..)
86 , EnvVar(..)
75 , ContainerConfig(..)
87 , ContainerConfig(..)
76 , defaultContainerConfig
88 , defaultContainerConfig
77− , ExposedPorts(..)
89+ , ExposedPort(..)
78 , DeviceWeight(..)
90 , DeviceWeight(..)
79 , DeviceRate(..)
91 , DeviceRate(..)
80 , addPortBinding
92 , addPortBinding
99+ , MemoryConstraint(..)
100+ , MemoryConstraintSize(..)
83import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
103import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
@@ -87,11 +107,12 @@ import qualified Data.Aeson as JSON
87import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
107import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
88import Data.Char (isAlphaNum, toUpper)
108import Data.Char (isAlphaNum, toUpper)
89import qualified Data.HashMap.Strict as HM
109import qualified Data.HashMap.Strict as HM
90−import qualified Data.Map as M
91import Data.Monoid ((<>))
110import Data.Monoid ((<>))
111+import Data.Scientific (floatingOrInteger)
92import Data.Text (Text)
112import Data.Text (Text)
93import qualified Data.Text as T
113import qualified Data.Text as T
94import Data.Time.Clock (UTCTime)
114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
95import GHC.Generics (Generic)
116import GHC.Generics (Generic)
96import Prelude hiding (all, tail)
117import Prelude hiding (all, tail)
97import Text.Read (readMaybe)
118import Text.Read (readMaybe)
@@ -101,17 +122,23 @@ data Endpoint =
101 VersionEndpoint
122 VersionEndpoint
102 | ListContainersEndpoint ListOpts
123 | ListContainersEndpoint ListOpts
103 | ListImagesEndpoint ListOpts
124 | ListImagesEndpoint ListOpts
104− | CreateContainerEndpoint CreateOpts
125+ | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
105 | StartContainerEndpoint StartOpts ContainerID
126 | StartContainerEndpoint StartOpts ContainerID
106 | StopContainerEndpoint Timeout ContainerID
127 | StopContainerEndpoint Timeout ContainerID
128+ | WaitContainerEndpoint ContainerID
107 | KillContainerEndpoint Signal ContainerID
129 | KillContainerEndpoint Signal ContainerID
108 | RestartContainerEndpoint Timeout ContainerID
130 | RestartContainerEndpoint Timeout ContainerID
109 | PauseContainerEndpoint ContainerID
131 | PauseContainerEndpoint ContainerID
110 | UnpauseContainerEndpoint ContainerID
132 | UnpauseContainerEndpoint ContainerID
111 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
133 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
112 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
113− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
114 | InspectContainerEndpoint ContainerID
136 | 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
115 deriving (Eq, Show)
142 deriving (Eq, Show)
117-- | We should newtype this
144-- | We should newtype this
@@ -158,6 +185,20 @@ toImageID t =
158-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
185-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
159data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
186data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
188+data StatusCode = StatusCode Int
190+instance ToJSON StatusCode where
191+ toJSON (StatusCode c) = object ["StatusCode" .= c]
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)
199+ fail "Unknown exit code"
200+ parseJSON _ = fail "Unknown exit code"
161-- TODO: Add more Signals or use an existing lib
202-- TODO: Add more Signals or use an existing lib
162-- | Signal used for sending to the process running in the container.
203-- | Signal used for sending to the process running in the container.
163-- The default signal is SIGTERM.
204-- The default signal is SIGTERM.
@@ -172,16 +213,16 @@ data Signal = SIGHUP
173instance FromJSON Signal where
214instance FromJSON Signal where
174 parseJSON (JSON.String "SIGTERM") = return SIGTERM
215 parseJSON (JSON.String "SIGTERM") = return SIGTERM
175− parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
216+ parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
176− parseJSON (JSON.String "SIGINT") = return SIGINT
217+ parseJSON (JSON.String "SIGINT") = return SIGINT
177 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
218 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
178 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
219 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
179 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
220 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
180− parseJSON _ = fail "Unknown Signal"
221+ parseJSON _ = fail "Unknown Signal"
182instance ToJSON Signal where
223instance ToJSON Signal where
183− toJSON SIGHUP = "SIGHUP"
224+ toJSON SIGHUP = "SIGHUP"
184− toJSON SIGINT = "SIGINT"
225+ toJSON SIGINT = "SIGINT"
185 toJSON SIGQUIT = "SIGQUIT"
226 toJSON SIGQUIT = "SIGQUIT"
186 toJSON SIGSTOP = "SIGSTOP"
227 toJSON SIGSTOP = "SIGSTOP"
187 toJSON SIGTERM = "SIGTERM"
228 toJSON SIGTERM = "SIGTERM"
@@ -209,7 +250,7 @@ data ContainerDetails = ContainerDetails {
209 , processLabel :: Text
250 , processLabel :: Text
210 , resolveConfPath :: FilePath
251 , resolveConfPath :: FilePath
211 , restartCount :: Int
252 , restartCount :: Int
212− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
213 , mounts :: [Mount]
254 , mounts :: [Mount]
215 deriving (Eq, Show, Generic)
256 deriving (Eq, Show, Generic)
@@ -217,11 +258,11 @@ data ContainerDetails = ContainerDetails {
217-- | Data type used for parsing the mount information from a container
258-- | Data type used for parsing the mount information from a container
219data Mount = Mount {
260data Mount = Mount {
220− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
221 , mountSource :: FilePath
262 , mountSource :: FilePath
222 , mountDestination :: FilePath
263 , mountDestination :: FilePath
223− , mountDriver :: Text
264+ , mountDriver :: Maybe Text
224− , mountMode :: Maybe VolumePermission -- apparently this can be null
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
225 , mountRW :: Bool
266 , mountRW :: Bool
226 , mountPropogation :: Text
267 , mountPropogation :: Text
@@ -229,14 +270,14 @@ data Mount = Mount {
230instance FromJSON Mount where
271instance FromJSON Mount where
231 parseJSON (JSON.Object o) = do
272 parseJSON (JSON.Object o) = do
232− name <- o .: "Name"
273+ name <- o .:? "Name"
233 src <- o .: "Source"
274 src <- o .: "Source"
234 dest <- o .: "Destination"
275 dest <- o .: "Destination"
235− driver <- o .: "Driver"
276+ driver <- o .:? "Driver"
236− mode <- o .: "Mode"
277+ -- mode <- o .: "Mode"
237 rw <- o .: "RW"
278 rw <- o .: "RW"
238 prop <- o .: "Propagation"
279 prop <- o .: "Propagation"
239− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
240 parseJSON _ = fail "Mount is not an object"
281 parseJSON _ = fail "Mount is not an object"
242-- | Data type used for parsing the container state from a list of
283-- | Data type used for parsing the container state from a list of
@@ -252,7 +293,7 @@ data ContainerState = ContainerState {
252 , restarting :: Bool
293 , restarting :: Bool
253 , running :: Bool
294 , running :: Bool
254 , startedAt :: UTCTime
295 , startedAt :: UTCTime
255− , status :: Status
296+ , state :: State
257 deriving (Eq, Show, Generic)
298 deriving (Eq, Show, Generic)
@@ -415,20 +456,17 @@ instance FromJSON NetworkOptions where
415 parseJSON _ = fail "NetworkOptions is not an object"
456 parseJSON _ = fail "NetworkOptions is not an object"
417-- TODO: Not sure what this is used for anymore.
458-- 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
419 deriving (Eq, Show)
460 deriving (Eq, Show)
421−instance FromJSON Networks where
462+instance {-# OVERLAPPING #-} FromJSON [Network] where
422− parseJSON (JSON.Object o) = do
463+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
423− Networks <$> HM.foldlWithKey' f (return M.empty) o
426 f accM k' v' = do
465 f accM k' v' = do
427 acc <- accM
466 acc <- accM
428 k <- parseJSON $ JSON.String k'
467 k <- parseJSON $ JSON.String k'
429 v <- parseJSON v'
468 v <- parseJSON v'
430− return $ M.insert k v acc
469+ return $ (Network k v):acc
432 parseJSON _ = fail "Networks is not an object"
470 parseJSON _ = fail "Networks is not an object"
434-- | Data type reprsenting the various network settings a container can have.
472-- | Data type reprsenting the various network settings a container can have.
@@ -438,7 +476,7 @@ data NetworkSettings = NetworkSettings {
438 , networkSettingsHairpinMode :: Bool
476 , networkSettingsHairpinMode :: Bool
439 , networkSettingsLinkLocalIPv6Address :: Text
477 , networkSettingsLinkLocalIPv6Address :: Text
440 , networkSettingsLinkLocalIPv6PrefixLen :: Int
478 , networkSettingsLinkLocalIPv6PrefixLen :: Int
441− , networkSettingsPorts :: PortBindings
479+ , networkSettingsPorts :: [PortBinding]
442 , networkSettingsSandboxKey :: Text
480 , networkSettingsSandboxKey :: Text
443 , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
481 , networkSettingsSecondaryIPAddresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
444 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
482 , networkSettingsSecondaryIPv6Addresses :: Maybe [Text] -- TODO: 1.24 spec is unclear
@@ -450,7 +488,7 @@ data NetworkSettings = NetworkSettings {
450 , networkSettingsIpPrefixLen :: Int
488 , networkSettingsIpPrefixLen :: Int
451 , networkSettingsIpv6Gateway :: Text
489 , networkSettingsIpv6Gateway :: Text
452 , networkSettingsMacAddress :: Text
490 , networkSettingsMacAddress :: Text
453− , networkSettingsNetworks :: Networks
491+ , networkSettingsNetworks :: [Network]
455 deriving (Eq, Show)
493 deriving (Eq, Show)
@@ -485,21 +523,23 @@ data Container = Container
485 , containerImageId :: ImageID
523 , containerImageId :: ImageID
486 , containerCommand :: Text
524 , containerCommand :: Text
487 , containerCreatedAt :: Int
525 , containerCreatedAt :: Int
526+ , containerState :: State
488− , containerStatus :: Status
527+ , containerStatus :: Maybe Text
489 , containerPorts :: [ContainerPortInfo]
528 , containerPorts :: [ContainerPortInfo]
490− , containerLabels :: Labels
529+ , containerLabels :: [Label]
491− , containerNetworks :: Networks
530+ , containerNetworks :: [Network]
492 , containerMounts :: [Mount]
531 , containerMounts :: [Mount]
493 } deriving (Show, Eq)
532 } deriving (Show, Eq)
495instance FromJSON Container where
534instance FromJSON Container where
496− parseJSON (JSON.Object v) =
535+ parseJSON o@(JSON.Object v) =
497− Container <$> (v .: "Id")
536+ Container <$> parseJSON o
498 <*> (v .: "Names")
537 <*> (v .: "Names")
499 <*> (v .: "Image")
538 <*> (v .: "Image")
500− <*> (v .: "ImageID")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
501− <*> (v .: "Command")
540+ <*> (v .: "Command") -- Doesn't exist anymore
502 <*> (v .: "Created")
541 <*> (v .: "Created")
503 <*> (v .: "Status")
543 <*> (v .: "Status")
504 <*> (v .: "Ports")
544 <*> (v .: "Ports")
505 <*> (v .: "Labels")
545 <*> (v .: "Labels")
@@ -509,34 +549,45 @@ instance FromJSON Container where
509 parseNetworks (JSON.Object v) =
549 parseNetworks (JSON.Object v) =
510 (v .: "Networks") >>= parseJSON
550 (v .: "Networks") >>= parseJSON
511 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
513 parseJSON _ = fail "Container: Not a JSON object."
552 parseJSON _ = fail "Container: Not a JSON object."
515−-- | Represents the status of the container life cycle.
554+-- | Represents the state of the container life cycle.
516−data Status = Created | Restarting | Running | Paused | Exited | Dead
555+data State = Created | Restarting | Running | Paused | Exited | Dead
517 deriving (Eq, Show, Generic)
556 deriving (Eq, Show, Generic)
519−instance FromJSON Status where
558+instance FromJSON State where
520− parseJSON (JSON.String "running") = return Running
559+ parseJSON (JSON.String "running") = return Running
521− parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
560+ parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
522 parseJSON (JSON.String "restarting") = return Restarting
561 parseJSON (JSON.String "restarting") = return Restarting
523− parseJSON (JSON.String "paused") = return Paused
562+ parseJSON (JSON.String "paused") = return Paused
524− parseJSON (JSON.String "exited") = return Exited
563+ parseJSON (JSON.String "exited") = return Exited
525− parseJSON (JSON.String "dead") = return Dead
564+ parseJSON (JSON.String "dead") = return Dead
526− parseJSON _ = fail "Unknown Status"
565+ parseJSON s = fail $ "Unknown Status: " ++ show s
528-- | Alias for representing a RepoDigest. We could newtype this and add
567-- | Alias for representing a RepoDigest. We could newtype this and add
529-- some validation.
568-- some validation.
530type Digest = Text
569type Digest = Text
532-- | Container and Image Labels.
571-- | Container and Image Labels.
533−newtype Labels = Labels (M.Map Name Value) deriving (Eq, Show)
572+data Label = Label Name Value deriving (Eq, Show)
535−instance FromJSON Labels where
536− parseJSON val = Labels <$> parseJSON val
575+-- If there are multiple lables with the same Name in the list
576+-- then the last one wins.
538−instance ToJSON Labels where
577+instance {-# OVERLAPPING #-} ToJSON [Label] where
539− toJSON (Labels kvs) = object [k .= v | (k,v) <- (M.toList kvs)]
578+ toJSON [] = emptyJsonObject
579+ toJSON (l:ls) = toJsonKeyVal (l:ls) key val
580+ where key (Label k _) = T.unpack k
583+instance {-# OVERLAPPING #-} FromJSON [Label] where
584+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
585+ where f accM k v = do
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."
541-- | Alias for Tags.
592-- | Alias for Tags.
542type Tag = Text
593type Tag = Text
@@ -547,10 +598,10 @@ data Image = DockerImage {
547 , imageCreated :: Integer
598 , imageCreated :: Integer
548 , imageParentId :: Maybe ImageID
599 , imageParentId :: Maybe ImageID
549 , imageRepoTags :: [Tag]
600 , imageRepoTags :: [Tag]
550− , imageRepoDigests :: Maybe [Digest]
601+ , imageRepoDigests :: [Digest]
551 , imageSize :: Integer
602 , imageSize :: Integer
552 , imageVirtualSize :: Integer
603 , imageVirtualSize :: Integer
553− , imageLabels :: Maybe Labels
604+ , imageLabels :: [Label]
554 } deriving (Show, Eq, Generic)
605 } deriving (Show, Eq, Generic)
556-- | Helper function used for dropping the "image" prefix when serializing
607-- | Helper function used for dropping the "image" prefix when serializing
@@ -558,23 +609,60 @@ data Image = DockerImage {
558dropImagePrefix :: [a] -> [a]
609dropImagePrefix :: [a] -> [a]
559dropImagePrefix = drop 5
610dropImagePrefix = drop 5
561instance FromJSON Image where
613instance FromJSON Image where
562− parseJSON = genericParseJSON defaultOptions {
614+ parseJSON (JSON.Object o) = do
563− fieldLabelModifier = dropImagePrefix}
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."
626+-- | Alias for Aliases.
629+-- | EndpointsConfig is container configuration for a specific network
630+newtype EndpointConfig = EndpointConfig [Alias] deriving (Eq, Show)
632+instance ToJSON EndpointConfig where
633+ toJSON (EndpointConfig aliases) = JSON.object
634+ [ "Aliases" .= aliases
637+-- | Alias for endpoint name
638+type EndpointName = Text
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)
645+instance ToJSON NetworkingConfig where
646+ toJSON (NetworkingConfig endpointsConfig) = JSON.object
647+ [ "EndpointsConfig" .= endpointsConfig
565-- | Options used for creating a Container.
650-- | Options used for creating a Container.
566data CreateOpts = CreateOpts {
651data CreateOpts = CreateOpts {
567− containerConfig :: ContainerConfig
652+ containerConfig :: ContainerConfig
568− , hostConfig :: HostConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
569 } deriving (Eq, Show)
655 } deriving (Eq, Show)
571instance ToJSON CreateOpts where
657instance ToJSON CreateOpts where
572− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
573 let ccJSON = toJSON cc
659 let ccJSON = toJSON cc
574 let hcJSON = toJSON hc
660 let hcJSON = toJSON hc
575 case ccJSON of
661 case ccJSON of
576 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
662 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
578 _ -> error "ContainerConfig is not an object." -- This should never happen.
666 _ -> error "ContainerConfig is not an object." -- This should never happen.
580-- | Container configuration used for creating a container with sensible
668-- | Container configuration used for creating a container with sensible
@@ -588,18 +676,18 @@ defaultContainerConfig imageName = ContainerConfig {
588 , attachStdout=False
676 , attachStdout=False
589 , image=imageName
677 , image=imageName
590 , attachStderr=False
678 , attachStderr=False
591− , exposedPorts=Nothing -- ExposedPorts M.empty
679+ , exposedPorts=[]
592 , tty=False
680 , tty=False
593 , openStdin=False
681 , openStdin=False
594 , stdinOnce=False
682 , stdinOnce=False
597− , volumes=Nothing
685+ , volumes=[]
598 , workingDir=Nothing
686 , workingDir=Nothing
599− , entrypoint=Nothing
687+ , entrypoint=Entrypoint []
600 , networkDisabled=Nothing
688 , networkDisabled=Nothing
601 , macAddress=Nothing
689 , macAddress=Nothing
602− , labels=Nothing
690+ , labels=[]
603 , stopSignal=SIGTERM
691 , stopSignal=SIGTERM
@@ -608,9 +696,9 @@ defaultHostConfig :: HostConfig
608defaultHostConfig = HostConfig {
696defaultHostConfig = HostConfig {
610 , containerIDFile=Nothing
698 , containerIDFile=Nothing
611− , logConfig=LogDriverConfig JsonFile Nothing
699+ , logConfig=LogDriverConfig JsonFile []
612− , networkMode=Bridge
700+ , networkMode=NetworkBridge
613− , portBindings=PortBindings []
701+ , portBindings=[]
614 , restartPolicy=RestartOff
702 , restartPolicy=RestartOff
615 , volumeDriver=Nothing
703 , volumeDriver=Nothing
616 , volumesFrom=[]
704 , volumesFrom=[]
@@ -649,14 +737,18 @@ defaultContainerResources = ContainerResources {
649 , memory=Nothing
737 , memory=Nothing
650 , memoryReservation=Nothing
738 , memoryReservation=Nothing
651 , memorySwap=Nothing
739 , memorySwap=Nothing
652− , oomKillDisable=False
740+ , oomKillDisable=Just False
653 , ulimits=[]
741 , ulimits=[]
656-- | Default create options when creating a container. You only need to
744-- | Default create options when creating a container. You only need to
657-- specify an image name and the rest is all sensible defaults.
745-- specify an image name and the rest is all sensible defaults.
658defaultCreateOpts :: T.Text -> CreateOpts
746defaultCreateOpts :: T.Text -> CreateOpts
747+defaultCreateOpts imageName = CreateOpts
659−defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
748+ { containerConfig = defaultContainerConfig imageName
749+ , hostConfig = defaultHostConfig
750+ , networkingConfig = NetworkingConfig HM.empty
661-- | Override the key sequence for detaching a container.
753-- | Override the key sequence for detaching a container.
662-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
754-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
@@ -670,16 +762,45 @@ defaultStartOpts :: StartOpts
670defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
672-- | Options for deleting a container.
764-- | Options for deleting a container.
673−data DeleteOpts = DeleteOpts {
765+data ContainerDeleteOpts = ContainerDeleteOpts {
674 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
675 , force :: Bool -- ^ If the container is still running force deletion anyway.
767 , force :: Bool -- ^ If the container is still running force deletion anyway.
676 } deriving (Eq, Show)
768 } deriving (Eq, Show)
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)
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
678-- | Default options for deleting a container. Most of the time we DON'T
792-- | Default options for deleting a container. Most of the time we DON'T
679-- want to delete the container's volumes or force delete it if it's
793-- want to delete the container's volumes or force delete it if it's
680-- running.
794-- running.
681−defaultDeleteOpts :: DeleteOpts
795+defaultContainerDeleteOpts :: ContainerDeleteOpts
682−defaultDeleteOpts = DeleteOpts { deleteVolumes = False, force = False }
796+defaultContainerDeleteOpts = ContainerDeleteOpts { deleteVolumes = False, force = False }
798+-- | Image delete opts
799+data ImageDeleteOpts = ImageDeleteOpts deriving (Eq, Show)
801+-- | Sane image deletion defaults
802+defaultImageDeleteOpts :: ImageDeleteOpts
803+defaultImageDeleteOpts = ImageDeleteOpts
684-- | Timestamp alias.
805-- | Timestamp alias.
685type Timestamp = Integer
806type Timestamp = Integer
@@ -707,18 +828,50 @@ defaultLogOpts = LogOpts { stdout = True
707 , tail = All
828 , tail = All
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)
840+-- | Sensible defalut for create network options
841+defaultCreateNetworkOpts :: Text -> CreateNetworkOpts
842+defaultCreateNetworkOpts name =
844+ { createNetworkName = name
845+ , createNetworkCheckDuplicate = False
846+ , createNetworkDriver = "bridge"
847+ , createNetworkInternal = True
848+ , createNetworkEnableIPv6 = False
851+instance ToJSON CreateNetworkOpts where
854+ [ "Name" .= createNetworkName opts
855+ , "CheckDuplicate" .= createNetworkCheckDuplicate opts
856+ , "Driver" .= createNetworkDriver opts
857+ , "Internal" .= createNetworkInternal opts
858+ , "EnableIPv6" .= createNetworkEnableIPv6 opts
710-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
861-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
711-- | Set permissions on volumes that you mount in the container.
862-- | Set permissions on volumes that you mount in the container.
712data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
863data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
714instance ToJSON VolumePermission where
865instance ToJSON VolumePermission where
715 toJSON ReadWrite = "rw"
866 toJSON ReadWrite = "rw"
716− toJSON ReadOnly = "ro"
867+ toJSON ReadOnly = "ro"
718instance FromJSON VolumePermission where
869instance FromJSON VolumePermission where
719 parseJSON "rw" = return ReadWrite
870 parseJSON "rw" = return ReadWrite
720 parseJSON "ro" = return ReadOnly
871 parseJSON "ro" = return ReadOnly
872+ parseJSON "RW" = return ReadWrite
873+ parseJSON "RO" = return ReadOnly
721− parseJSON _ = fail "Failed to parse VolumePermission"
874+ parseJSON _ = fail "Failed to parse VolumePermission"
723-- | Used for marking a directory in the container as "exposed" hence
876-- | Used for marking a directory in the container as "exposed" hence
724-- taking it outside of the COW filesystem and making it mountable
877-- taking it outside of the COW filesystem and making it mountable
@@ -731,29 +884,31 @@ instance FromJSON VolumePermission where
731-- docker run --name app -v \/opt\/data -it myapp:latest
884-- docker run --name app -v \/opt\/data -it myapp:latest
732-- docker run --name app2 --volumes-from app \/bin\/bash -c "ls -l \/opt\/data"
885-- docker run --name app2 --volumes-from app \/bin\/bash -c "ls -l \/opt\/data"
734−newtype Volumes = Volumes [FilePath] deriving (Eq, Show)
887+newtype Volume = Volume FilePath deriving (Eq, Show)
889+instance {-# OVERLAPPING #-} ToJSON [Volume] where
890+ toJSON [] = emptyJsonObject
891+ toJSON (v:vs) = toJsonKey (v:vs) getKey
892+ where getKey (Volume v) = v
736−instance FromJSON Volumes where
894+instance {-# OVERLAPPING #-} FromJSON [Volume] where
737− parseJSON (JSON.Object o) = return $ Volumes $ map T.unpack $ HM.keys o
895+ parseJSON (JSON.Object o) = return $ map (Volume . T.unpack) $ HM.keys o
896+ parseJSON (JSON.Null) = return []
738− parseJSON _ = fail "Volumes is not an object"
897+ parseJSON _ = fail "Volume is not an object"
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
745−data Volume = Volume { hostSrc :: Text
900+data Bind = Bind { hostSrc :: Text
746− , containerDest :: Text
901+ , containerDest :: Text
747− , volumePermission :: Maybe VolumePermission
902+ , volumePermission :: Maybe VolumePermission
748− } deriving (Eq, Show)
903+ } deriving (Eq, Show)
750−instance FromJSON Volume where
905+instance FromJSON Bind where
751 parseJSON (JSON.String t) = case T.split (== ':') t of
906 parseJSON (JSON.String t) = case T.split (== ':') t of
752− [src, dest] -> return $ Volume src dest Nothing
907+ [src, dest] -> return $ Bind src dest Nothing
753− [src, dest, "rw"] -> return $ Volume src dest $ Just ReadWrite
908+ [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
754− [src, dest, "ro"] -> return $ Volume src dest $ Just ReadOnly
909+ [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
755− _ -> fail "Could not parse Volume"
910+ _ -> fail "Could not parse Bind"
756− parseJSON _ = fail "Volume is not a string"
911+ parseJSON _ = fail "Bind is not a string"
758data Device = Device {
913data Device = Device {
759 pathOnHost :: FilePath
914 pathOnHost :: FilePath
@@ -775,19 +930,19 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
776instance FromJSON VolumeFrom where
931instance FromJSON VolumeFrom where
777 parseJSON (JSON.String t) = case T.split (== ':') t of
932 parseJSON (JSON.String t) = case T.split (== ':') t of
778− [vol] -> return $ VolumeFrom vol Nothing
933+ [vol] -> return $ VolumeFrom vol Nothing
779 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
934 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
780 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
935 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
781− _ -> fail "Could not parse VolumeFrom"
936+ _ -> fail "Could not parse VolumeFrom"
782 parseJSON _ = fail "VolumeFrom is not a string"
937 parseJSON _ = fail "VolumeFrom is not a string"
784instance ToJSON VolumeFrom where
939instance ToJSON VolumeFrom where
785 toJSON (VolumeFrom n p) = case p of
940 toJSON (VolumeFrom n p) = case p of
786− Nothing -> toJSON $ n <> ":" <> "rw"
941+ Nothing -> toJSON $ n <> ":" <> "rw"
787 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
942 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
789−instance ToJSON Volume where
944+instance ToJSON Bind where
790− toJSON (Volume src dest mode) = toJSON $ case mode of
945+ toJSON (Bind src dest mode) = toJSON $ case mode of
791 Nothing -> T.concat[src, ":", dest]
946 Nothing -> T.concat[src, ":", dest]
792 Just m -> T.concat[src, ":", dest, ":", (T.pack $ show m)]
947 Just m -> T.concat[src, ":", dest, ":", (T.pack $ show m)]
@@ -795,63 +950,63 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
796instance FromJSON Link where
951instance FromJSON Link where
797 parseJSON (JSON.String t) = case T.split (== ':') t of
952 parseJSON (JSON.String t) = case T.split (== ':') t of
798− [f] -> return $ Link f Nothing
953+ [f] -> return $ Link f Nothing
799 [f,s] -> return $ Link f $ Just s
954 [f,s] -> return $ Link f $ Just s
800− _ -> fail "Could not parse Link"
955+ _ -> fail "Could not parse Link"
801 parseJSON _ = fail "Link is not a string"
956 parseJSON _ = fail "Link is not a string"
803instance ToJSON Link where
958instance ToJSON Link where
804 toJSON (Link n1 n2) = toJSON $ case n2 of
959 toJSON (Link n1 n2) = toJSON $ case n2 of
805 Nothing -> T.concat[n1, ":", n1] -- use same name in container
960 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
808-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
963-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
809data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
964data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
811instance FromJSON LogDriverType where
966instance FromJSON LogDriverType where
812 parseJSON (JSON.String "json-file") = return JsonFile
967 parseJSON (JSON.String "json-file") = return JsonFile
813− parseJSON (JSON.String "syslog") = return Syslog
968+ parseJSON (JSON.String "syslog") = return Syslog
814− parseJSON (JSON.String "journald") = return Journald
969+ parseJSON (JSON.String "journald") = return Journald
815− parseJSON (JSON.String "gelf") = return Gelf
970+ parseJSON (JSON.String "gelf") = return Gelf
816− parseJSON (JSON.String "fluentd") = return Fluentd
971+ parseJSON (JSON.String "fluentd") = return Fluentd
817− parseJSON (JSON.String "awslogs") = return AwsLogs
972+ parseJSON (JSON.String "awslogs") = return AwsLogs
818− parseJSON (JSON.String "splunk") = return Splunk
973+ parseJSON (JSON.String "splunk") = return Splunk
819− parseJSON (JSON.String "etwlogs") = return Etwlogs
974+ parseJSON (JSON.String "etwlogs") = return Etwlogs
820− parseJSON (JSON.String "none") = return LoggingDisabled
975+ parseJSON (JSON.String "none") = return LoggingDisabled
821− parseJSON _ = fail "Unknown LogDriverType"
976+ parseJSON _ = fail "Unknown LogDriverType"
823instance ToJSON LogDriverType where
978instance ToJSON LogDriverType where
824− toJSON JsonFile = JSON.String "json-file"
979+ toJSON JsonFile = JSON.String "json-file"
825− toJSON Syslog = JSON.String "syslog"
980+ toJSON Syslog = JSON.String "syslog"
826− toJSON Journald = JSON.String "journald"
981+ toJSON Journald = JSON.String "journald"
827− toJSON Gelf = JSON.String "gelf"
982+ toJSON Gelf = JSON.String "gelf"
828− toJSON Fluentd = JSON.String "fluentd"
983+ toJSON Fluentd = JSON.String "fluentd"
829− toJSON AwsLogs = JSON.String "awslogs"
984+ toJSON AwsLogs = JSON.String "awslogs"
830− toJSON Splunk = JSON.String "splunk"
985+ toJSON Splunk = JSON.String "splunk"
831− toJSON Etwlogs = JSON.String "etwlogs"
986+ toJSON Etwlogs = JSON.String "etwlogs"
832 toJSON LoggingDisabled = JSON.String "none"
987 toJSON LoggingDisabled = JSON.String "none"
834−newtype LogDriverOptions = LogDriverOptions (M.Map Text Text) deriving (Eq, Show)
989+data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
836−instance FromJSON LogDriverOptions where
991+instance {-# OVERLAPPING #-} ToJSON [LogDriverOption] where
837− parseJSON (JSON.Object o) = do
992+ toJSON [] = emptyJsonObject
838− LogDriverOptions <$> HM.foldlWithKey' f (return M.empty) o
993+ toJSON (o:os) = toJsonKeyVal (o:os) key val
994+ where key (LogDriverOption n _) = T.unpack n
995+ val (LogDriverOption _ v) = v
840− where
997+instance {-# OVERLAPPING #-} FromJSON [LogDriverOption] where
998+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
841− f accM k (JSON.String v) = do
999+ where f accM k v = do
842 acc <- accM
1000 acc <- accM
843− return $ M.insert k v acc
1001+ value <- parseJSON v
844− f _ _ _ = fail "Value of LogDriverOptions is not a string"
1002+ return $ (LogDriverOption k value):acc
846− parseJSON JSON.Null = return $ LogDriverOptions M.empty
1003+ parseJSON JSON.Null = return []
847− parseJSON _ = fail "LogDriverOptions is not an object"
849−instance ToJSON LogDriverOptions where
850− toJSON (LogDriverOptions mp) = toJSON mp
1004+ parseJSON _ = fail "Failed to parse LogDriverOptions"
852−data LogDriverConfig = LogDriverConfig LogDriverType (Maybe LogDriverOptions) deriving (Eq, Show)
1006+data LogDriverConfig = LogDriverConfig LogDriverType [LogDriverOption] deriving (Eq, Show)
854instance ToJSON LogDriverConfig where
1008instance ToJSON LogDriverConfig where
1009+ toJSON (LogDriverConfig driverType []) = object ["Type" .= driverType]
855 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
1010 toJSON (LogDriverConfig driverType driverOptions) = object ["Type" .= driverType, "Config" .= driverOptions]
857instance FromJSON LogDriverConfig where
1012instance FromJSON LogDriverConfig where
@@ -862,19 +1017,41 @@ instance FromJSON LogDriverConfig where
862 parseJSON _ = fail "LogDriverConfig is not an object"
1017 parseJSON _ = fail "LogDriverConfig is not an object"
864-- TODO: Add container:<name|id> mode
1019-- TODO: Add container:<name|id> mode
865−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
866 deriving (Eq, Show, Ord)
1021 deriving (Eq, Show, Ord)
868instance FromJSON NetworkMode where
1023instance FromJSON NetworkMode where
869− parseJSON (JSON.String "bridge") = return Bridge
1024+ parseJSON (JSON.String "bridge") = return NetworkBridge
870− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
1025+ parseJSON (JSON.String "host") = return NetworkHost -- Note: Guessing on these.
871− parseJSON (JSON.String "none") = return NetworkDisabled
1026+ parseJSON (JSON.String "none") = return NetworkDisabled
1027+ parseJSON (JSON.String n) = return $ NetworkNamed n
872− parseJSON _ = fail "Unknown NetworkMode"
1028+ parseJSON _ = fail "Unknown NetworkMode"
874instance ToJSON NetworkMode where
1030instance ToJSON NetworkMode where
875− toJSON Bridge = JSON.String "bridge"
1031+ toJSON NetworkBridge = JSON.String "bridge"
876− toJSON Host = JSON.String "host"
1032+ toJSON NetworkHost = JSON.String "host"
877 toJSON NetworkDisabled = JSON.String "none"
1033 toJSON NetworkDisabled = JSON.String "none"
1034+ toJSON (NetworkNamed n) = JSON.String n
1036+newtype NetworkID = NetworkID Text
1037+ deriving (Eq, Show)
1039+-- | Used for extracting the id of the container from the newtype
1040+fromNetworkID :: NetworkID -> Text
1041+fromNetworkID (NetworkID t) = t
1043+-- | Used for parsing a Text value into a NetworkID.
1044+toNetworkID :: Text -> Maybe NetworkID
1045+toNetworkID t = Just $ NetworkID t
1047+instance FromJSON NetworkID where
1048+ parseJSON (JSON.Object o) = do
1050+ return $ NetworkID nid
1051+ parseJSON _ = fail "NetworkID is not an object."
1053+instance ToJSON NetworkID where
1054+ toJSON (NetworkID nid) = object ["Id" .= nid]
879data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
1056data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
@@ -890,7 +1067,7 @@ instance FromJSON PortType where
890 parseJSON val = case val of
1067 parseJSON val = case val of
891 "tcp" -> return TCP
1068 "tcp" -> return TCP
892 "udp" -> return UDP
1069 "udp" -> return UDP
893− _ -> fail "PortType: Invalid port type."
1070+ _ -> fail "PortType: Invalid port type."
895-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
1072-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
@@ -907,13 +1084,6 @@ instance FromJSON PortType where
907-- interface like `127.0.0.1`.
1084-- interface like `127.0.0.1`.
908-- __NOTE__: We should disallow duplicate port bindings as the ToJSON
1085-- __NOTE__: We should disallow duplicate port bindings as the ToJSON
909-- instance will only send the last one.
1086-- instance will only send the last one.
910−newtype PortBindings = PortBindings [PortBinding]
913−instance Monoid PortBindings where
914− mempty = PortBindings []
915− mappend (PortBindings p1) (PortBindings p2) = PortBindings (p1 ++ p2)
917-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
1087-- { <port>/<protocol>: [{ "HostPort": "<port>" }] }
918data PortBinding = PortBinding {
1088data PortBinding = PortBinding {
919 containerPort :: Port
1089 containerPort :: Port
@@ -924,24 +1094,62 @@ data PortBinding = PortBinding {
924portAndType2Text :: Port -> PortType -> Text
1094portAndType2Text :: Port -> PortType -> Text
925portAndType2Text p t = (T.pack $ show p) <> "/" <> (T.pack $ show t)
1095portAndType2Text p t = (T.pack $ show p) <> "/" <> (T.pack $ show t)
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
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
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
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
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
927-- | A convenience function that adds PortBindings to and exiting
1132-- | A convenience function that adds PortBindings to and exiting
928-- "CreateOpts" record. Useful with 'defaultCreateOpts'
1133-- "CreateOpts" record. Useful with 'defaultCreateOpts'
929-- Example:
1134-- Example:
931-- >>> let pb = PortBinding 80 TCP [HostPort "0.0.0.0" 8000]
1136-- >>> let pb = PortBinding 80 TCP [HostPort "0.0.0.0" 8000]
932−-- >>> addPortBinding (defaultCreateOpts "nginx:latest") pb
1137+-- >>> addPortBinding pb $ defaultCreateOpts "nginx:latest"
933−addPortBinding :: CreateOpts -> PortBinding -> CreateOpts
1138+addPortBinding :: PortBinding -> CreateOpts -> CreateOpts
934−addPortBinding c pb = c{hostConfig=hc{portBindings=pbs <> PortBindings [pb]}}
1139+addPortBinding pb c = c{hostConfig=hc{portBindings=pbs <> [pb]}}
935 where hc = hostConfig c
1140 where hc = hostConfig c
936 pbs = portBindings $ hostConfig c
1141 pbs = portBindings $ hostConfig c
938−instance ToJSON PortBinding where
1143+-- | Helper function for adding a "ExposedPort" to and existing
939− toJSON (PortBinding {..}) = object [portAndType2Text containerPort portType .= hostPorts]
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
941−instance FromJSON PortBindings where
942− parseJSON (JSON.Object o) = do
943− PortBindings <$> HM.foldlWithKey' f (return []) o
1151+instance {-# OVERLAPPING #-} FromJSON [PortBinding] where
1152+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
946 f accM k v = case T.split (== '/') k of
1154 f accM k v = case T.split (== '/') k of
947 [port', portType'] -> do
1155 [port', portType'] -> do
@@ -950,16 +1158,15 @@ instance FromJSON PortBindings where
950 acc <- accM
1158 acc <- accM
951 hps <- parseJSON v
1159 hps <- parseJSON v
952 return $ (PortBinding port portType hps):acc
1160 return $ (PortBinding port portType hps):acc
954− fail "Could not parse PortBindings"
1161+ _ -> fail "Could not parse PortBindings"
1162+ parseJSON (JSON.Null) = return []
955 parseJSON _ = fail "PortBindings is not an object"
1163 parseJSON _ = fail "PortBindings is not an object"
957−instance ToJSON PortBindings where
1165+instance {-# OVERLAPPING #-} ToJSON [PortBinding] where
958− toJSON (PortBindings []) = JSON.Object HM.empty
1166+ toJSON [] = emptyJsonObject
959− toJSON (PortBindings (p:ps)) = JSON.Object $ foldl f HM.empty (p:ps)
1167+ toJSON (p:ps) = toJsonKeyVal (p:ps) key val
960− where mKey p = portAndType2Text (containerPort p) (portType p)
1168+ where key p = T.unpack $ portAndType2Text (containerPort p) (portType p)
961− mVal p = toJSON $ hostPorts p
1169+ val p = hostPorts p
962− f acc p = HM.insert (mKey p) (mVal p) acc
964data HostPort = HostPort {
1171data HostPort = HostPort {
965 hostIp :: Text
1172 hostIp :: Text
@@ -990,7 +1197,7 @@ instance FromJSON RestartPolicy where
990 "on-failure" -> do
1197 "on-failure" -> do
991 retry <- o .: "MaximumRetryCount"
1198 retry <- o .: "MaximumRetryCount"
992 return $ RestartOnFailure retry
1199 return $ RestartOnFailure retry
993− "off" -> return RestartOff
1200+ "no" -> return RestartOff
994 _ -> fail "Could not parse RestartPolicy"
1201 _ -> fail "Could not parse RestartPolicy"
995 parseJSON _ = fail "RestartPolicy is not an object"
1202 parseJSON _ = fail "RestartPolicy is not an object"
@@ -998,7 +1205,7 @@ instance ToJSON RestartPolicy where
998 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
1205 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
999 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
1206 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
1000 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1207 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"]
1003data Isolation = Default | Process | Hyperv deriving (Eq, Show)
1210data Isolation = Default | Process | Hyperv deriving (Eq, Show)
@@ -1008,11 +1215,11 @@ newtype UTSMode = UTSMode Text deriving (Eq, Show)
1008-- TODO: Add UTSMode : UTS namespace to use for the container
1215-- TODO: Add UTSMode : UTS namespace to use for the container
1009-- TODO: Sysctls map[string]string `json:",omitempty"` // List of Namespaced sysctls used for the container
1216-- TODO: Sysctls map[string]string `json:",omitempty"` // List of Namespaced sysctls used for the container
1010data HostConfig = HostConfig
1217data HostConfig = HostConfig
1011− { binds :: [Volume]
1218+ { binds :: [Bind]
1012 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
1219 , containerIDFile :: Maybe FilePath -- 1.24: Only in responses, not create
1013 , logConfig :: LogDriverConfig
1220 , logConfig :: LogDriverConfig
1014 , networkMode :: NetworkMode
1221 , networkMode :: NetworkMode
1015− , portBindings :: PortBindings
1222+ , portBindings :: [PortBinding]
1016 , restartPolicy :: RestartPolicy
1223 , restartPolicy :: RestartPolicy
1017 , volumeDriver :: Maybe Text
1224 , volumeDriver :: Maybe Text
1018 , volumesFrom :: [VolumeFrom]
1225 , volumesFrom :: [VolumeFrom]
@@ -1171,6 +1378,22 @@ instance ToJSON DeviceRate where
1171 , "Rate" .= r
1378 , "Rate" .= r
1381+data MemoryConstraintSize = B | MB | GB deriving (Eq, Show)
1383+data MemoryConstraint = MemoryConstraint Integer MemoryConstraintSize deriving (Eq, Show)
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
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"
1174data ContainerResources = ContainerResources {
1397data ContainerResources = ContainerResources {
1175 cpuShares :: Maybe Integer
1398 cpuShares :: Maybe Integer
1176 -- , cgroupParent :: Text -- 1.24: Missing from inspecting container details... Going to omit for now.
1399 -- , cgroupParent :: Text -- 1.24: Missing from inspecting container details... Going to omit for now.
@@ -1186,12 +1409,12 @@ data ContainerResources = ContainerResources {
1186 , cpusetMems :: Maybe Text
1409 , cpusetMems :: Maybe Text
1187 , devices :: [Device]
1410 , devices :: [Device]
1188 -- , diskQuota :: Integer -- Don't see this ins 1.24.
1411 -- , diskQuota :: Integer -- Don't see this ins 1.24.
1189− , kernelMemory :: Maybe Integer
1412+ , kernelMemory :: Maybe MemoryConstraint
1190− , memory :: Maybe Integer
1413+ , memory :: Maybe MemoryConstraint
1191− , memoryReservation :: Maybe Integer
1414+ , memoryReservation :: Maybe MemoryConstraint
1192− , memorySwap :: Maybe Integer
1415+ , memorySwap :: Maybe MemoryConstraint
1193 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1416 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1194− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
1195 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1418 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1196 , ulimits :: [Ulimit]
1419 , ulimits :: [Ulimit]
1197 -- TODO: Missing from 1.24
1420 -- TODO: Missing from 1.24
@@ -1229,45 +1452,59 @@ instance FromJSON EnvVar where
1229 parseJSON _ = fail "EnvVar is not a string"
1452 parseJSON _ = fail "EnvVar is not a string"
1231instance ToJSON EnvVar where
1454instance ToJSON EnvVar where
1232− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
1234−-- | ExposedPorts represent a enumeraton of all the ports (and their type)
1457+-- | ExposedPort represents a port (and it's type)
1235-- that a container should expose to other containers or the host system.
1458-- that a container should expose to other containers or the host system.
1236−-- `NOTE`: This does not automatically expose the ports onto the host
1459+-- `NOTE`: This does not automatically expose the port onto the host
1237−-- system but rather it just tags them. It's best to be used with
1460+-- system but rather it just tags it. It's best to be used with
1238-- the PublishAllPorts flag. It is also useful for
1461-- the PublishAllPorts flag. It is also useful for
1239-- the daemon to know which Environment variables to
1462-- the daemon to know which Environment variables to
1240-- inject into a container linking to our container.
1463-- inject into a container linking to our container.
1241-- Example linking a Postgres container named db would inject the following
1464-- Example linking a Postgres container named db would inject the following
1242-- environment variables automatically if we set the corresponding
1465-- environment variables automatically if we set the corresponding
1244−-- ExposedPorts:
1467+-- ExposedPort:
1247-- DB_PORT_5432_TCP_PORT="5432"
1470-- DB_PORT_5432_TCP_PORT="5432"
1248-- DB_PORT_5432_TCP_PROTO="tcp"
1471-- DB_PORT_5432_TCP_PROTO="tcp"
1249-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
1472-- DB_PORT_5432_TCP="tcp://172.17.0.1:5432"
1251−newtype ExposedPorts = ExposedPorts (M.Map Port PortType) deriving (Eq, Show)
1474+data ExposedPort = ExposedPort Port PortType deriving (Eq, Show)
1252−-- JP: Should this be ExposedPorts [(Port, PortType)]?
1254−instance FromJSON ExposedPorts where
1255− parseJSON (JSON.Object o) = do
1256− ExposedPorts <$> HM.foldlWithKey' f (return M.empty) o
1476+instance {-# OVERLAPPING #-} FromJSON [ExposedPort] where
1477+ parseJSON (JSON.Object o) = HM.foldlWithKey' f (return []) o
1259 f accM k _ = case T.split (== '/') k of
1479 f accM k _ = case T.split (== '/') k of
1260 [port', portType'] -> do
1480 [port', portType'] -> do
1261 port <- parseIntegerText port'
1481 port <- parseIntegerText port'
1262 portType <- parseJSON $ JSON.String portType'
1482 portType <- parseJSON $ JSON.String portType'
1263 acc <- accM
1483 acc <- accM
1264− return $ M.insert port portType acc
1484+ return $ (ExposedPort port portType):acc
1266− fail "Could not parse ExposedPorts"
1485+ _ -> fail "Could not parse ExposedPorts"
1486+ parseJSON (JSON.Null) = return []
1267− parseJSON _ = fail "ExposedPorts is not an object."
1487+ parseJSON _ = fail "ExposedPorts is not an object"
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 "/"
1495+data Entrypoint = Entrypoint [T.Text] deriving (Eq, Show, Generic)
1497+instance ToJSON Entrypoint where
1498+ toJSON (Entrypoint (e:es)) = toJSON (e:es)
1499+ toJSON (Entrypoint []) = JSON.Null
1269−instance ToJSON ExposedPorts where
1501+instance FromJSON Entrypoint where
1270− toJSON (ExposedPorts kvs) = object [((T.pack $ show p) <> "/" <> (T.pack $ show t)) .= JSON.Object HM.empty | (p,t) <- (M.toList kvs)]
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"
1273data ContainerConfig = ContainerConfig {
1510data ContainerConfig = ContainerConfig {
@@ -1277,7 +1514,7 @@ data ContainerConfig = ContainerConfig {
1277 , attachStdin :: Bool
1514 , attachStdin :: Bool
1278 , attachStdout :: Bool
1515 , attachStdout :: Bool
1279 , attachStderr :: Bool
1516 , attachStderr :: Bool
1280− , exposedPorts :: Maybe ExposedPorts -- Note: Should we expand the JSON instance and take away the Maybe?
1517+ , exposedPorts :: [ExposedPort]
1281 -- , publishService :: Text -- Don't see this in 1.24
1518 -- , publishService :: Text -- Don't see this in 1.24
1282 , tty :: Bool
1519 , tty :: Bool
1283 , openStdin :: Bool
1520 , openStdin :: Bool
@@ -1286,27 +1523,70 @@ data ContainerConfig = ContainerConfig {
1286 , cmd :: [Text]
1523 , cmd :: [Text]
1287 -- , argsEscaped :: Bool -- Don't see this in 1.24
1524 -- , argsEscaped :: Bool -- Don't see this in 1.24
1288 , image :: Text
1525 , image :: Text
1289− , volumes :: Maybe Volumes
1526+ , volumes :: [Volume]
1290 , workingDir :: Maybe FilePath
1527 , workingDir :: Maybe FilePath
1291− , entrypoint :: Maybe Text -- Can be null?
1528+ , entrypoint :: Entrypoint
1292 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
1529 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
1293 , macAddress :: Maybe Text
1530 , macAddress :: Maybe Text
1294 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
1531 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
1295− , labels :: Maybe Labels
1532+ , labels :: [Label]
1296 , stopSignal :: Signal
1533 , stopSignal :: Signal
1297 } deriving (Eq, Show, Generic)
1534 } deriving (Eq, Show, Generic)
1299instance ToJSON ContainerConfig where
1537instance ToJSON ContainerConfig where
1300 toJSON = genericToJSON defaultOptions {
1538 toJSON = genericToJSON defaultOptions {
1301 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
1539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
1303instance FromJSON ContainerConfig where
1541instance FromJSON ContainerConfig where
1304− parseJSON = genericParseJSON defaultOptions {
1542+ parseJSON (JSON.Object o) = do
1305− fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
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" .!= []
1551+ openStdin <- o .: "OpenStdin"
1552+ stdinOnce <- o .: "StdinOnce"
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."
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1307parseIntegerText :: (Monad m) => Text -> m Integer
1570parseIntegerText :: (Monad m) => Text -> m Integer
1308parseIntegerText t = case readMaybe $ T.unpack t of
1572parseIntegerText t = case readMaybe $ T.unpack t of
1309 Nothing ->
1573 Nothing ->
1310 fail "Could not parse Integer"
1574 fail "Could not parse Integer"
1311 Just i ->
1575 Just i ->
1312 return i
1576 return i
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
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
1590+-- | Helper function that return an empty dictionary "{}"
1591+emptyJsonObject :: JSON.Value
1592+emptyJsonObject = JSON.Object HM.empty