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