@@ -11,6 +11,9 @@ module Docker.Client.Types (
12 , fromImageID
12 , fromImageID
13 , toImageID
13 , toImageID
14 , Timeout(..)
17 , Timeout(..)
15 , StatusCode(..)
18 , StatusCode(..)
16 , Signal(..)
19 , Signal(..)
@@ -23,7 +26,7 @@ module Docker.Client.Types (
23 , ContainerPortInfo(..)
26 , ContainerPortInfo(..)
24 , Container(..)
27 , Container(..)
25 , ContainerState(..)
28 , ContainerState(..)
26− , Status(..)
29+ , State(..)
28 , Label(..)
31 , Label(..)
@@ -37,12 +40,16 @@ module Docker.Client.Types (
37 , DetachKeys(..)
40 , DetachKeys(..)
38 , StartOpts(..)
41 , StartOpts(..)
39 , defaultStartOpts
42 , defaultStartOpts
40− , DeleteOpts(..)
43+ , ContainerDeleteOpts(..)
41− , defaultDeleteOpts
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
42 , Timestamp
47 , Timestamp
43 , TailLogOpt(..)
48 , TailLogOpt(..)
44 , LogOpts(..)
49 , LogOpts(..)
45 , defaultLogOpts
50 , defaultLogOpts
51+ , CreateNetworkOpts(..)
52+ , defaultCreateNetworkOpts
46 , VolumePermission(..)
53 , VolumePermission(..)
47 , Bind(..)
54 , Bind(..)
48 , Volume(..)
55 , Volume(..)
@@ -68,6 +75,8 @@ module Docker.Client.Types (
68 , UTSMode(..)
75 , UTSMode(..)
69 , HostConfig(..)
76 , HostConfig(..)
70 , defaultHostConfig
77 , defaultHostConfig
78+ , NetworkingConfig(..)
71 , Ulimit(..)
80 , Ulimit(..)
72 , ContainerResources(..)
81 , ContainerResources(..)
73 , defaultContainerResources
82 , defaultContainerResources
@@ -123,10 +132,13 @@ data Endpoint =
123 | UnpauseContainerEndpoint ContainerID
132 | UnpauseContainerEndpoint ContainerID
124 | 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.
125 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
126− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
127 | InspectContainerEndpoint ContainerID
136 | InspectContainerEndpoint ContainerID
128 | BuildImageEndpoint BuildOpts FilePath
137 | BuildImageEndpoint BuildOpts FilePath
129 | CreateImageEndpoint T.Text Tag (Maybe T.Text) -- ^ Either pull an image from docker hub or imports an image from a tarball (or URL)
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
130 deriving (Eq, Show)
142 deriving (Eq, Show)
132-- | We should newtype this
144-- | We should newtype this
@@ -238,7 +250,7 @@ data ContainerDetails = ContainerDetails {
238 , processLabel :: Text
250 , processLabel :: Text
239 , resolveConfPath :: FilePath
251 , resolveConfPath :: FilePath
240 , restartCount :: Int
252 , restartCount :: Int
241− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
242 , mounts :: [Mount]
254 , mounts :: [Mount]
244 deriving (Eq, Show, Generic)
256 deriving (Eq, Show, Generic)
@@ -249,8 +261,8 @@ data Mount = Mount {
249 mountName :: Maybe Text -- this is optional
261 mountName :: Maybe Text -- this is optional
250 , mountSource :: FilePath
262 , mountSource :: FilePath
251 , mountDestination :: FilePath
263 , mountDestination :: FilePath
252− , mountDriver :: Text
264+ , mountDriver :: Maybe Text
253− , mountMode :: Maybe VolumePermission -- apparently this can be null
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
254 , mountRW :: Bool
266 , mountRW :: Bool
255 , mountPropogation :: Text
267 , mountPropogation :: Text
@@ -258,14 +270,14 @@ data Mount = Mount {
259instance FromJSON Mount where
271instance FromJSON Mount where
260 parseJSON (JSON.Object o) = do
272 parseJSON (JSON.Object o) = do
261− name <- o .: "Name"
273+ name <- o .:? "Name"
262 src <- o .: "Source"
274 src <- o .: "Source"
263 dest <- o .: "Destination"
275 dest <- o .: "Destination"
264− driver <- o .: "Driver"
276+ driver <- o .:? "Driver"
265− mode <- o .: "Mode"
277+ -- mode <- o .: "Mode"
266 rw <- o .: "RW"
278 rw <- o .: "RW"
267 prop <- o .: "Propagation"
279 prop <- o .: "Propagation"
268− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
269 parseJSON _ = fail "Mount is not an object"
281 parseJSON _ = fail "Mount is not an object"
271-- | 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
@@ -281,7 +293,7 @@ data ContainerState = ContainerState {
281 , restarting :: Bool
293 , restarting :: Bool
282 , running :: Bool
294 , running :: Bool
283 , startedAt :: UTCTime
295 , startedAt :: UTCTime
284− , status :: Status
296+ , state :: State
286 deriving (Eq, Show, Generic)
298 deriving (Eq, Show, Generic)
@@ -511,7 +523,8 @@ data Container = Container
511 , containerImageId :: ImageID
523 , containerImageId :: ImageID
512 , containerCommand :: Text
524 , containerCommand :: Text
513 , containerCreatedAt :: Int
525 , containerCreatedAt :: Int
526+ , containerState :: State
514− , containerStatus :: Status
527+ , containerStatus :: Maybe Text
515 , containerPorts :: [ContainerPortInfo]
528 , containerPorts :: [ContainerPortInfo]
516 , containerLabels :: [Label]
529 , containerLabels :: [Label]
517 , containerNetworks :: [Network]
530 , containerNetworks :: [Network]
@@ -523,10 +536,11 @@ instance FromJSON Container where
523 Container <$> parseJSON o
536 Container <$> parseJSON o
524 <*> (v .: "Names")
537 <*> (v .: "Names")
525 <*> (v .: "Image")
538 <*> (v .: "Image")
526− <*> (v .: "ImageID")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
527− <*> (v .: "Command")
540+ <*> (v .: "Command") -- Doesn't exist anymore
528 <*> (v .: "Created")
541 <*> (v .: "Created")
529 <*> (v .: "State")
542 <*> (v .: "State")
530 <*> (v .: "Ports")
544 <*> (v .: "Ports")
531 <*> (v .: "Labels")
545 <*> (v .: "Labels")
532 <*> (v .: "NetworkSettings" >>= parseNetworks)
546 <*> (v .: "NetworkSettings" >>= parseNetworks)
@@ -535,14 +549,13 @@ instance FromJSON Container where
535 parseNetworks (JSON.Object v) =
549 parseNetworks (JSON.Object v) =
536 (v .: "Networks") >>= parseJSON
550 (v .: "Networks") >>= parseJSON
537 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
539 parseJSON _ = fail "Container: Not a JSON object."
552 parseJSON _ = fail "Container: Not a JSON object."
541−-- | Represents the status of the container life cycle.
554+-- | Represents the state of the container life cycle.
542−data Status = Created | Restarting | Running | Paused | Exited | Dead
555+data State = Created | Restarting | Running | Paused | Exited | Dead
543 deriving (Eq, Show, Generic)
556 deriving (Eq, Show, Generic)
545−instance FromJSON Status where
558+instance FromJSON State where
546 parseJSON (JSON.String "running") = return Running
559 parseJSON (JSON.String "running") = return Running
547 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.
548 parseJSON (JSON.String "restarting") = return Restarting
561 parseJSON (JSON.String "restarting") = return Restarting
@@ -610,20 +623,46 @@ instance FromJSON Image where
610 return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
623 return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
611 parseJSON _ = fail "Failed to parse DockerImage."
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
614-- | Options used for creating a Container.
650-- | Options used for creating a Container.
615data CreateOpts = CreateOpts {
651data CreateOpts = CreateOpts {
616− containerConfig :: ContainerConfig
652+ containerConfig :: ContainerConfig
617− , hostConfig :: HostConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
618 } deriving (Eq, Show)
655 } deriving (Eq, Show)
620instance ToJSON CreateOpts where
657instance ToJSON CreateOpts where
621− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
622 let ccJSON = toJSON cc
659 let ccJSON = toJSON cc
623 let hcJSON = toJSON hc
660 let hcJSON = toJSON hc
624 case ccJSON of
661 case ccJSON of
625 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
626− JSON.Object $ HM.insert "HostConfig" hcJSON o
663+ let o1 = HM.insert "HostConfig" hcJSON o
664+ let o2 = HM.insert "NetworkingConfig" (toJSON nc) o1
627 _ -> error "ContainerConfig is not an object." -- This should never happen.
666 _ -> error "ContainerConfig is not an object." -- This should never happen.
629-- | Container configuration used for creating a container with sensible
668-- | Container configuration used for creating a container with sensible
@@ -658,7 +697,7 @@ defaultHostConfig = HostConfig {
659 , containerIDFile=Nothing
698 , containerIDFile=Nothing
660 , logConfig=LogDriverConfig JsonFile []
699 , logConfig=LogDriverConfig JsonFile []
661− , networkMode=Bridge
700+ , networkMode=NetworkBridge
662 , portBindings=[]
701 , portBindings=[]
663 , restartPolicy=RestartOff
702 , restartPolicy=RestartOff
664 , volumeDriver=Nothing
703 , volumeDriver=Nothing
@@ -705,7 +744,11 @@ defaultContainerResources = ContainerResources {
705-- | Default create options when creating a container. You only need to
744-- | Default create options when creating a container. You only need to
706-- specify an image name and the rest is all sensible defaults.
745-- specify an image name and the rest is all sensible defaults.
707defaultCreateOpts :: T.Text -> CreateOpts
746defaultCreateOpts :: T.Text -> CreateOpts
747+defaultCreateOpts imageName = CreateOpts
708−defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
748+ { containerConfig = defaultContainerConfig imageName
749+ , hostConfig = defaultHostConfig
750+ , networkingConfig = NetworkingConfig HM.empty
710-- | Override the key sequence for detaching a container.
753-- | Override the key sequence for detaching a container.
711-- 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 _.
@@ -719,7 +762,7 @@ defaultStartOpts :: StartOpts
719defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
721-- | Options for deleting a container.
764-- | Options for deleting a container.
722−data DeleteOpts = DeleteOpts {
765+data ContainerDeleteOpts = ContainerDeleteOpts {
723 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
724 , force :: Bool -- ^ If the container is still running force deletion anyway.
767 , force :: Bool -- ^ If the container is still running force deletion anyway.
725 } deriving (Eq, Show)
768 } deriving (Eq, Show)
@@ -749,8 +792,15 @@ defaultBuildOpts nameTag = BuildOpts { buildImageName = nameTag
749-- | 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
750-- 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
751-- running.
794-- running.
752−defaultDeleteOpts :: DeleteOpts
795+defaultContainerDeleteOpts :: ContainerDeleteOpts
753−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
755-- | Timestamp alias.
805-- | Timestamp alias.
756type Timestamp = Integer
806type Timestamp = Integer
@@ -778,6 +828,36 @@ defaultLogOpts = LogOpts { stdout = True
778 , 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
781-- 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")
782-- | Set permissions on volumes that you mount in the container.
862-- | Set permissions on volumes that you mount in the container.
783data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
863data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
@@ -789,6 +869,8 @@ instance ToJSON VolumePermission where
789instance FromJSON VolumePermission where
869instance FromJSON VolumePermission where
790 parseJSON "rw" = return ReadWrite
870 parseJSON "rw" = return ReadWrite
791 parseJSON "ro" = return ReadOnly
871 parseJSON "ro" = return ReadOnly
872+ parseJSON "RW" = return ReadWrite
873+ parseJSON "RO" = return ReadOnly
792 parseJSON _ = fail "Failed to parse VolumePermission"
874 parseJSON _ = fail "Failed to parse VolumePermission"
794-- | Used for marking a directory in the container as "exposed" hence
876-- | Used for marking a directory in the container as "exposed" hence
@@ -935,19 +1017,41 @@ instance FromJSON LogDriverConfig where
935 parseJSON _ = fail "LogDriverConfig is not an object"
1017 parseJSON _ = fail "LogDriverConfig is not an object"
937-- TODO: Add container:<name|id> mode
1019-- TODO: Add container:<name|id> mode
938−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
939 deriving (Eq, Show, Ord)
1021 deriving (Eq, Show, Ord)
941instance FromJSON NetworkMode where
1023instance FromJSON NetworkMode where
942− parseJSON (JSON.String "bridge") = return Bridge
1024+ parseJSON (JSON.String "bridge") = return NetworkBridge
943− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
1025+ parseJSON (JSON.String "host") = return NetworkHost -- Note: Guessing on these.
944 parseJSON (JSON.String "none") = return NetworkDisabled
1026 parseJSON (JSON.String "none") = return NetworkDisabled
1027+ parseJSON (JSON.String n) = return $ NetworkNamed n
945 parseJSON _ = fail "Unknown NetworkMode"
1028 parseJSON _ = fail "Unknown NetworkMode"
947instance ToJSON NetworkMode where
1030instance ToJSON NetworkMode where
948− toJSON Bridge = JSON.String "bridge"
1031+ toJSON NetworkBridge = JSON.String "bridge"
949− toJSON Host = JSON.String "host"
1032+ toJSON NetworkHost = JSON.String "host"
950− 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]
952data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
1056data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
@@ -1348,7 +1452,7 @@ instance FromJSON EnvVar where
1348 parseJSON _ = fail "EnvVar is not a string"
1452 parseJSON _ = fail "EnvVar is not a string"
1350instance ToJSON EnvVar where
1454instance ToJSON EnvVar where
1351− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
1353-- | ExposedPort represents a port (and it's type)
1457-- | ExposedPort represents a port (and it's type)
1354-- 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.
@@ -1460,7 +1564,11 @@ instance FromJSON ContainerConfig where
1460 macAddress labels stopSignal
1564 macAddress labels stopSignal
1461 parseJSON _ = fail "NetworkSettings is not an object."
1565 parseJSON _ = fail "NetworkSettings is not an object."
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1463parseIntegerText :: (Monad m) => Text -> m Integer
1570parseIntegerText :: (Monad m) => Text -> m Integer
1464parseIntegerText t = case readMaybe $ T.unpack t of
1572parseIntegerText t = case readMaybe $ T.unpack t of
1465 Nothing ->
1573 Nothing ->
1466 fail "Could not parse Integer"
1574 fail "Could not parse Integer"