@@ -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
@@ -96,13 +106,13 @@ import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
96106import qualified Data.Aeson as JSON
97107import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
98108import Data.Char (isAlphaNum, toUpper)
99−import Data.Foldable (asum)
100109import qualified Data.HashMap.Strict as HM
101110import Data.Monoid ((<>))
102111import Data.Scientific (floatingOrInteger)
103112import Data.Text (Text)
104113import qualified Data.Text as T
105114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
106116import GHC.Generics (Generic)
107117import Prelude hiding (all, tail)
108118import Text.Read (readMaybe)
@@ -122,10 +132,13 @@ data Endpoint =
122132 | UnpauseContainerEndpoint ContainerID
123133 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
124134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
125− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
126136 | InspectContainerEndpoint ContainerID
127137 | BuildImageEndpoint BuildOpts FilePath
128138 | 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
129142 deriving (Eq, Show)
130143
131144-- | We should newtype this
@@ -237,7 +250,7 @@ data ContainerDetails = ContainerDetails {
237250 , processLabel :: Text
238251 , resolveConfPath :: FilePath
239252 , restartCount :: Int
240− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
241254 , mounts :: [Mount]
242255 }
243256 deriving (Eq, Show, Generic)
@@ -245,11 +258,11 @@ data ContainerDetails = ContainerDetails {
245258-- | Data type used for parsing the mount information from a container
246259-- list.
247260data Mount = Mount {
248− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
249262 , mountSource :: FilePath
250263 , mountDestination :: FilePath
251− , mountDriver :: Text
252− , mountMode :: Maybe VolumePermission -- apparently this can be null
264+ , mountDriver :: Maybe Text
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
253266 , mountRW :: Bool
254267 , mountPropogation :: Text
255268 }
@@ -257,14 +270,14 @@ data Mount = Mount {
257270
258271instance FromJSON Mount where
259272 parseJSON (JSON.Object o) = do
260− name <- o .: "Name"
273+ name <- o .:? "Name"
261274 src <- o .: "Source"
262275 dest <- o .: "Destination"
263− driver <- o .: "Driver"
264− mode <- o .: "Mode"
276+ driver <- o .:? "Driver"
277+ -- mode <- o .: "Mode"
265278 rw <- o .: "RW"
266279 prop <- o .: "Propagation"
267− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
268281 parseJSON _ = fail "Mount is not an object"
269282
270283-- | Data type used for parsing the container state from a list of
@@ -280,7 +293,7 @@ data ContainerState = ContainerState {
280293 , restarting :: Bool
281294 , running :: Bool
282295 , startedAt :: UTCTime
283− , status :: Status
296+ , state :: State
284297 }
285298 deriving (Eq, Show, Generic)
286299
@@ -510,7 +523,8 @@ data Container = Container
510523 , containerImageId :: ImageID
511524 , containerCommand :: Text
512525 , containerCreatedAt :: Int
513− , containerStatus :: Status
526+ , containerState :: State
527+ , containerStatus :: Maybe Text
514528 , containerPorts :: [ContainerPortInfo]
515529 , containerLabels :: [Label]
516530 , containerNetworks :: [Network]
@@ -518,13 +532,14 @@ data Container = Container
518532 } deriving (Show, Eq)
519533
520534instance FromJSON Container where
521− parseJSON (JSON.Object v) =
522− Container <$> (v .: "Id")
535+ parseJSON o@(JSON.Object v) =
536+ Container <$> parseJSON o
523537 <*> (v .: "Names")
524538 <*> (v .: "Image")
525− <*> (v .: "ImageID")
526− <*> (v .: "Command")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
540+ <*> (v .: "Command") -- Doesn't exist anymore
527541 <*> (v .: "Created")
542+ <*> (v .: "State")
528543 <*> (v .: "Status")
529544 <*> (v .: "Ports")
530545 <*> (v .: "Labels")
@@ -534,21 +549,20 @@ instance FromJSON Container where
534549 parseNetworks (JSON.Object v) =
535550 (v .: "Networks") >>= parseJSON
536551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
537−
538552 parseJSON _ = fail "Container: Not a JSON object."
539553
540−-- | Represents the status of the container life cycle.
541−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
542556 deriving (Eq, Show, Generic)
543557
544−instance FromJSON Status where
558+instance FromJSON State where
545559 parseJSON (JSON.String "running") = return Running
546560 parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
547561 parseJSON (JSON.String "restarting") = return Restarting
548562 parseJSON (JSON.String "paused") = return Paused
549563 parseJSON (JSON.String "exited") = return Exited
550564 parseJSON (JSON.String "dead") = return Dead
551− parseJSON _ = fail "Unknown Status"
565+ parseJSON s = fail $ "Unknown Status: " ++ show s
552566
553567-- | Alias for representing a RepoDigest. We could newtype this and add
554568-- some validation.
@@ -609,20 +623,46 @@ instance FromJSON Image where
609623 return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
610624 parseJSON _ = fail "Failed to parse DockerImage."
611625
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+ ]
612649
613650-- | Options used for creating a Container.
614651data CreateOpts = CreateOpts {
615− containerConfig :: ContainerConfig
616− , hostConfig :: HostConfig
652+ containerConfig :: ContainerConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
617655 } deriving (Eq, Show)
618656
619657instance ToJSON CreateOpts where
620− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
621659 let ccJSON = toJSON cc
622660 let hcJSON = toJSON hc
623661 case ccJSON of
624662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
625− 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
626666 _ -> error "ContainerConfig is not an object." -- This should never happen.
627667
628668-- | Container configuration used for creating a container with sensible
@@ -644,7 +684,7 @@ defaultContainerConfig imageName = ContainerConfig {
644684 , cmd=[]
645685 , volumes=[]
646686 , workingDir=Nothing
647− , entrypoint=[]
687+ , entrypoint=Entrypoint []
648688 , networkDisabled=Nothing
649689 , macAddress=Nothing
650690 , labels=[]
@@ -657,7 +697,7 @@ defaultHostConfig = HostConfig {
657697 binds=[]
658698 , containerIDFile=Nothing
659699 , logConfig=LogDriverConfig JsonFile []
660− , networkMode=Bridge
700+ , networkMode=NetworkBridge
661701 , portBindings=[]
662702 , restartPolicy=RestartOff
663703 , volumeDriver=Nothing
@@ -697,14 +737,18 @@ defaultContainerResources = ContainerResources {
697737 , memory=Nothing
698738 , memoryReservation=Nothing
699739 , memorySwap=Nothing
700− , oomKillDisable=False
740+ , oomKillDisable=Just False
701741 , ulimits=[]
702742 }
703743
704744-- | Default create options when creating a container. You only need to
705745-- specify an image name and the rest is all sensible defaults.
706746defaultCreateOpts :: T.Text -> CreateOpts
707−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+ }
708752
709753-- | Override the key sequence for detaching a container.
710754-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
@@ -718,7 +762,7 @@ defaultStartOpts :: StartOpts
718762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
719763
720764-- | Options for deleting a container.
721−data DeleteOpts = DeleteOpts {
765+data ContainerDeleteOpts = ContainerDeleteOpts {
722766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
723767 , force :: Bool -- ^ If the container is still running force deletion anyway.
724768 } deriving (Eq, Show)
@@ -748,8 +792,15 @@ defaultBuildOpts nameTag = BuildOpts { buildImageName = nameTag
748792-- | Default options for deleting a container. Most of the time we DON'T
749793-- want to delete the container's volumes or force delete it if it's
750794-- running.
751−defaultDeleteOpts :: DeleteOpts
752−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
753804
754805-- | Timestamp alias.
755806type Timestamp = Integer
@@ -777,6 +828,36 @@ defaultLogOpts = LogOpts { stdout = True
777828 , tail = All
778829 }
779830
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+
780861-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
781862-- | Set permissions on volumes that you mount in the container.
782863data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
@@ -788,6 +869,8 @@ instance ToJSON VolumePermission where
788869instance FromJSON VolumePermission where
789870 parseJSON "rw" = return ReadWrite
790871 parseJSON "ro" = return ReadOnly
872+ parseJSON "RW" = return ReadWrite
873+ parseJSON "RO" = return ReadOnly
791874 parseJSON _ = fail "Failed to parse VolumePermission"
792875
793876-- | Used for marking a directory in the container as "exposed" hence
@@ -934,19 +1017,41 @@ instance FromJSON LogDriverConfig where
9341017 parseJSON _ = fail "LogDriverConfig is not an object"
9351018
9361019-- TODO: Add container:<name|id> mode
937−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
9381021 deriving (Eq, Show, Ord)
9391022
9401023instance FromJSON NetworkMode where
941− parseJSON (JSON.String "bridge") = return Bridge
942− 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.
9431026 parseJSON (JSON.String "none") = return NetworkDisabled
1027+ parseJSON (JSON.String n) = return $ NetworkNamed n
9441028 parseJSON _ = fail "Unknown NetworkMode"
9451029
9461030instance ToJSON NetworkMode where
947− toJSON Bridge = JSON.String "bridge"
948− toJSON Host = JSON.String "host"
949− 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]
9501055
9511056data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
9521057
@@ -1309,7 +1414,7 @@ data ContainerResources = ContainerResources {
13091414 , memoryReservation :: Maybe MemoryConstraint
13101415 , memorySwap :: Maybe MemoryConstraint
13111416 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1312− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
13131418 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
13141419 , ulimits :: [Ulimit]
13151420 -- TODO: Missing from 1.24
@@ -1347,7 +1452,7 @@ instance FromJSON EnvVar where
13471452 parseJSON _ = fail "EnvVar is not a string"
13481453
13491454instance ToJSON EnvVar where
1350− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
13511456
13521457-- | ExposedPort represents a port (and it's type)
13531458-- that a container should expose to other containers or the host system.
@@ -1387,6 +1492,21 @@ instance {-# OVERLAPPING #-} ToJSON [ExposedPort] where
13871492 where key (ExposedPort p t) = show p <> slash <> show t
13881493 slash = T.unpack "/"
13891494
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+
13901510data ContainerConfig = ContainerConfig {
13911511 hostname :: Maybe Text
13921512 , domainname :: Maybe Text
@@ -1405,7 +1525,7 @@ data ContainerConfig = ContainerConfig {
14051525 , image :: Text
14061526 , volumes :: [Volume]
14071527 , workingDir :: Maybe FilePath
1408− , entrypoint :: [Text]
1528+ , entrypoint :: Entrypoint
14091529 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
14101530 , macAddress :: Maybe Text
14111531 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
@@ -1413,6 +1533,7 @@ data ContainerConfig = ContainerConfig {
14131533 , stopSignal :: Signal
14141534 } deriving (Eq, Show, Generic)
14151535
1536+
14161537instance ToJSON ContainerConfig where
14171538 toJSON = genericToJSON defaultOptions {
14181539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
@@ -1434,9 +1555,7 @@ instance FromJSON ContainerConfig where
14341555 image <- o .: "Image"
14351556 volumes <- o .: "Volumes"
14361557 workingDir <- o .:? "WorkingDir"
1437− entrypoint <- asum [ o .:? "Entrypoint" .!= []
1438− , (:[]) <$> o .: "Entrypoint"
1439− ]
1558+ entrypoint <- o .: "Entrypoint"
14401559 networkDisabled <- o .:? "networkDisabled"
14411560 macAddress <- o .:? "MacAddress"
14421561 labels <- o .:? "Labels" .!= []
@@ -1445,7 +1564,11 @@ instance FromJSON ContainerConfig where
14451564 macAddress labels stopSignal
14461565 parseJSON _ = fail "NetworkSettings is not an object."
14471566
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1569+#else
14481570parseIntegerText :: (Monad m) => Text -> m Integer
1571+#endif
14491572parseIntegerText t = case readMaybe $ T.unpack t of
14501573 Nothing ->
14511574 fail "Could not parse Integer"