@@ -11,6 +11,9 @@ module Docker.Client.Types (
1111 , ImageID
1212 , fromImageID
1313 , toImageID
14+ , NetworkID
15+ , fromNetworkID
16+ , toNetworkID
1417 , Timeout(..)
1518 , StatusCode(..)
1619 , Signal(..)
@@ -23,11 +26,12 @@ module Docker.Client.Types (
2326 , ContainerPortInfo(..)
2427 , Container(..)
2528 , ContainerState(..)
26− , Status(..)
29+ , State(..)
2730 , Digest
2831 , Label(..)
2932 , Tag
3033 , Image(..)
34+ , Entrypoint(..)
3135 , dropImagePrefix
3236 , CreateOpts(..)
3337 , BuildOpts(..)
@@ -36,12 +40,16 @@ module Docker.Client.Types (
3640 , DetachKeys(..)
3741 , StartOpts(..)
3842 , defaultStartOpts
39− , DeleteOpts(..)
40− , defaultDeleteOpts
43+ , ContainerDeleteOpts(..)
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
4147 , Timestamp
4248 , TailLogOpt(..)
4349 , LogOpts(..)
4450 , defaultLogOpts
51+ , CreateNetworkOpts(..)
52+ , defaultCreateNetworkOpts
4553 , VolumePermission(..)
4654 , Bind(..)
4755 , Volume(..)
@@ -67,6 +75,8 @@ module Docker.Client.Types (
6775 , UTSMode(..)
6876 , HostConfig(..)
6977 , defaultHostConfig
78+ , NetworkingConfig(..)
79+ , EndpointConfig(..)
7080 , Ulimit(..)
7181 , ContainerResources(..)
7282 , defaultContainerResources
@@ -102,6 +112,7 @@ import Data.Scientific (floatingOrInteger)
102112import Data.Text (Text)
103113import qualified Data.Text as T
104114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
105116import GHC.Generics (Generic)
106117import Prelude hiding (all, tail)
107118import Text.Read (readMaybe)
@@ -121,10 +132,13 @@ data Endpoint =
121132 | UnpauseContainerEndpoint ContainerID
122133 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
123134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
124− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
125136 | InspectContainerEndpoint ContainerID
126137 | BuildImageEndpoint BuildOpts FilePath
127138 | 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
128142 deriving (Eq, Show)
129143
130144-- | We should newtype this
@@ -236,7 +250,7 @@ data ContainerDetails = ContainerDetails {
236250 , processLabel :: Text
237251 , resolveConfPath :: FilePath
238252 , restartCount :: Int
239− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
240254 , mounts :: [Mount]
241255 }
242256 deriving (Eq, Show, Generic)
@@ -244,11 +258,11 @@ data ContainerDetails = ContainerDetails {
244258-- | Data type used for parsing the mount information from a container
245259-- list.
246260data Mount = Mount {
247− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
248262 , mountSource :: FilePath
249263 , mountDestination :: FilePath
250− , mountDriver :: Text
251− , mountMode :: Maybe VolumePermission -- apparently this can be null
264+ , mountDriver :: Maybe Text
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
252266 , mountRW :: Bool
253267 , mountPropogation :: Text
254268 }
@@ -256,14 +270,14 @@ data Mount = Mount {
256270
257271instance FromJSON Mount where
258272 parseJSON (JSON.Object o) = do
259− name <- o .: "Name"
273+ name <- o .:? "Name"
260274 src <- o .: "Source"
261275 dest <- o .: "Destination"
262− driver <- o .: "Driver"
263− mode <- o .: "Mode"
276+ driver <- o .:? "Driver"
277+ -- mode <- o .: "Mode"
264278 rw <- o .: "RW"
265279 prop <- o .: "Propagation"
266− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
267281 parseJSON _ = fail "Mount is not an object"
268282
269283-- | Data type used for parsing the container state from a list of
@@ -279,7 +293,7 @@ data ContainerState = ContainerState {
279293 , restarting :: Bool
280294 , running :: Bool
281295 , startedAt :: UTCTime
282− , status :: Status
296+ , state :: State
283297 }
284298 deriving (Eq, Show, Generic)
285299
@@ -509,7 +523,8 @@ data Container = Container
509523 , containerImageId :: ImageID
510524 , containerCommand :: Text
511525 , containerCreatedAt :: Int
512− , containerStatus :: Status
526+ , containerState :: State
527+ , containerStatus :: Maybe Text
513528 , containerPorts :: [ContainerPortInfo]
514529 , containerLabels :: [Label]
515530 , containerNetworks :: [Network]
@@ -517,13 +532,14 @@ data Container = Container
517532 } deriving (Show, Eq)
518533
519534instance FromJSON Container where
520− parseJSON (JSON.Object v) =
521− Container <$> (v .: "Id")
535+ parseJSON o@(JSON.Object v) =
536+ Container <$> parseJSON o
522537 <*> (v .: "Names")
523538 <*> (v .: "Image")
524− <*> (v .: "ImageID")
525− <*> (v .: "Command")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
540+ <*> (v .: "Command") -- Doesn't exist anymore
526541 <*> (v .: "Created")
542+ <*> (v .: "State")
527543 <*> (v .: "Status")
528544 <*> (v .: "Ports")
529545 <*> (v .: "Labels")
@@ -533,21 +549,20 @@ instance FromJSON Container where
533549 parseNetworks (JSON.Object v) =
534550 (v .: "Networks") >>= parseJSON
535551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
536−
537552 parseJSON _ = fail "Container: Not a JSON object."
538553
539−-- | Represents the status of the container life cycle.
540−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
541556 deriving (Eq, Show, Generic)
542557
543−instance FromJSON Status where
558+instance FromJSON State where
544559 parseJSON (JSON.String "running") = return Running
545560 parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
546561 parseJSON (JSON.String "restarting") = return Restarting
547562 parseJSON (JSON.String "paused") = return Paused
548563 parseJSON (JSON.String "exited") = return Exited
549564 parseJSON (JSON.String "dead") = return Dead
550− parseJSON _ = fail "Unknown Status"
565+ parseJSON s = fail $ "Unknown Status: " ++ show s
551566
552567-- | Alias for representing a RepoDigest. We could newtype this and add
553568-- some validation.
@@ -608,20 +623,46 @@ instance FromJSON Image where
608623 return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
609624 parseJSON _ = fail "Failed to parse DockerImage."
610625
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+ ]
611649
612650-- | Options used for creating a Container.
613651data CreateOpts = CreateOpts {
614− containerConfig :: ContainerConfig
615− , hostConfig :: HostConfig
652+ containerConfig :: ContainerConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
616655 } deriving (Eq, Show)
617656
618657instance ToJSON CreateOpts where
619− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
620659 let ccJSON = toJSON cc
621660 let hcJSON = toJSON hc
622661 case ccJSON of
623662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
624− 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
625666 _ -> error "ContainerConfig is not an object." -- This should never happen.
626667
627668-- | Container configuration used for creating a container with sensible
@@ -643,7 +684,7 @@ defaultContainerConfig imageName = ContainerConfig {
643684 , cmd=[]
644685 , volumes=[]
645686 , workingDir=Nothing
646− , entrypoint=Nothing
687+ , entrypoint=Entrypoint []
647688 , networkDisabled=Nothing
648689 , macAddress=Nothing
649690 , labels=[]
@@ -656,7 +697,7 @@ defaultHostConfig = HostConfig {
656697 binds=[]
657698 , containerIDFile=Nothing
658699 , logConfig=LogDriverConfig JsonFile []
659− , networkMode=Bridge
700+ , networkMode=NetworkBridge
660701 , portBindings=[]
661702 , restartPolicy=RestartOff
662703 , volumeDriver=Nothing
@@ -696,14 +737,18 @@ defaultContainerResources = ContainerResources {
696737 , memory=Nothing
697738 , memoryReservation=Nothing
698739 , memorySwap=Nothing
699− , oomKillDisable=False
740+ , oomKillDisable=Just False
700741 , ulimits=[]
701742 }
702743
703744-- | Default create options when creating a container. You only need to
704745-- specify an image name and the rest is all sensible defaults.
705746defaultCreateOpts :: T.Text -> CreateOpts
706−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+ }
707752
708753-- | Override the key sequence for detaching a container.
709754-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
@@ -717,7 +762,7 @@ defaultStartOpts :: StartOpts
717762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
718763
719764-- | Options for deleting a container.
720−data DeleteOpts = DeleteOpts {
765+data ContainerDeleteOpts = ContainerDeleteOpts {
721766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
722767 , force :: Bool -- ^ If the container is still running force deletion anyway.
723768 } deriving (Eq, Show)
@@ -747,8 +792,15 @@ defaultBuildOpts nameTag = BuildOpts { buildImageName = nameTag
747792-- | Default options for deleting a container. Most of the time we DON'T
748793-- want to delete the container's volumes or force delete it if it's
749794-- running.
750−defaultDeleteOpts :: DeleteOpts
751−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
752804
753805-- | Timestamp alias.
754806type Timestamp = Integer
@@ -776,6 +828,36 @@ defaultLogOpts = LogOpts { stdout = True
776828 , tail = All
777829 }
778830
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+
779861-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
780862-- | Set permissions on volumes that you mount in the container.
781863data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
@@ -787,6 +869,8 @@ instance ToJSON VolumePermission where
787869instance FromJSON VolumePermission where
788870 parseJSON "rw" = return ReadWrite
789871 parseJSON "ro" = return ReadOnly
872+ parseJSON "RW" = return ReadWrite
873+ parseJSON "RO" = return ReadOnly
790874 parseJSON _ = fail "Failed to parse VolumePermission"
791875
792876-- | Used for marking a directory in the container as "exposed" hence
@@ -933,19 +1017,41 @@ instance FromJSON LogDriverConfig where
9331017 parseJSON _ = fail "LogDriverConfig is not an object"
9341018
9351019-- TODO: Add container:<name|id> mode
936−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
9371021 deriving (Eq, Show, Ord)
9381022
9391023instance FromJSON NetworkMode where
940− parseJSON (JSON.String "bridge") = return Bridge
941− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
1024+ parseJSON (JSON.String "bridge") = return NetworkBridge
1025+ parseJSON (JSON.String "host") = return NetworkHost -- Note: Guessing on these.
9421026 parseJSON (JSON.String "none") = return NetworkDisabled
1027+ parseJSON (JSON.String n) = return $ NetworkNamed n
9431028 parseJSON _ = fail "Unknown NetworkMode"
9441029
9451030instance ToJSON NetworkMode where
946− toJSON Bridge = JSON.String "bridge"
947− toJSON Host = JSON.String "host"
948− toJSON NetworkDisabled = JSON.String "none"
1031+ toJSON NetworkBridge = JSON.String "bridge"
1032+ toJSON NetworkHost = JSON.String "host"
1033+ 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]
9491055
9501056data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
9511057
@@ -1308,7 +1414,7 @@ data ContainerResources = ContainerResources {
13081414 , memoryReservation :: Maybe MemoryConstraint
13091415 , memorySwap :: Maybe MemoryConstraint
13101416 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1311− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
13121418 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
13131419 , ulimits :: [Ulimit]
13141420 -- TODO: Missing from 1.24
@@ -1346,7 +1452,7 @@ instance FromJSON EnvVar where
13461452 parseJSON _ = fail "EnvVar is not a string"
13471453
13481454instance ToJSON EnvVar where
1349− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
13501456
13511457-- | ExposedPort represents a port (and it's type)
13521458-- that a container should expose to other containers or the host system.
@@ -1386,6 +1492,21 @@ instance {-# OVERLAPPING #-} ToJSON [ExposedPort] where
13861492 where key (ExposedPort p t) = show p <> slash <> show t
13871493 slash = T.unpack "/"
13881494
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"
1508+
1509+
13891510data ContainerConfig = ContainerConfig {
13901511 hostname :: Maybe Text
13911512 , domainname :: Maybe Text
@@ -1404,7 +1525,7 @@ data ContainerConfig = ContainerConfig {
14041525 , image :: Text
14051526 , volumes :: [Volume]
14061527 , workingDir :: Maybe FilePath
1407− , entrypoint :: Maybe Text -- Can be null?
1528+ , entrypoint :: Entrypoint
14081529 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
14091530 , macAddress :: Maybe Text
14101531 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
@@ -1412,6 +1533,7 @@ data ContainerConfig = ContainerConfig {
14121533 , stopSignal :: Signal
14131534 } deriving (Eq, Show, Generic)
14141535
1536+
14151537instance ToJSON ContainerConfig where
14161538 toJSON = genericToJSON defaultOptions {
14171539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
@@ -1433,7 +1555,7 @@ instance FromJSON ContainerConfig where
14331555 image <- o .: "Image"
14341556 volumes <- o .: "Volumes"
14351557 workingDir <- o .:? "WorkingDir"
1436− entrypoint <- o .:? "Entrypoint"
1558+ entrypoint <- o .: "Entrypoint"
14371559 networkDisabled <- o .:? "networkDisabled"
14381560 macAddress <- o .:? "MacAddress"
14391561 labels <- o .:? "Labels" .!= []
@@ -1442,7 +1564,11 @@ instance FromJSON ContainerConfig where
14421564 macAddress labels stopSignal
14431565 parseJSON _ = fail "NetworkSettings is not an object."
14441566
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1569+#else
14451570parseIntegerText :: (Monad m) => Text -> m Integer
1571+#endif
14461572parseIntegerText t = case readMaybe $ T.unpack t of
14471573 Nothing ->
14481574 fail "Could not parse Integer"
@@ -1464,4 +1590,3 @@ toJsonKeyVal vs getKey getVal = JSON.Object $ foldl f HM.empty vs
14641590-- | Helper function that return an empty dictionary "{}"
14651591emptyJsonObject :: JSON.Value
14661592emptyJsonObject = JSON.Object HM.empty
1467−