@@ -11,9 +11,6 @@ module Docker.Client.Types (
1111 , ImageID
1212 , fromImageID
1313 , toImageID
14− , NetworkID
15− , fromNetworkID
16− , toNetworkID
1714 , Timeout(..)
1815 , StatusCode(..)
1916 , Signal(..)
@@ -26,12 +23,11 @@ module Docker.Client.Types (
2623 , ContainerPortInfo(..)
2724 , Container(..)
2825 , ContainerState(..)
29− , State(..)
26+ , Status(..)
3027 , Digest
3128 , Label(..)
3229 , Tag
3330 , Image(..)
34− , Entrypoint(..)
3531 , dropImagePrefix
3632 , CreateOpts(..)
3733 , BuildOpts(..)
@@ -40,16 +36,12 @@ module Docker.Client.Types (
4036 , DetachKeys(..)
4137 , StartOpts(..)
4238 , defaultStartOpts
43− , ContainerDeleteOpts(..)
44− , defaultContainerDeleteOpts
45− , ImageDeleteOpts(..)
46− , defaultImageDeleteOpts
39+ , DeleteOpts(..)
40+ , defaultDeleteOpts
4741 , Timestamp
4842 , TailLogOpt(..)
4943 , LogOpts(..)
5044 , defaultLogOpts
51− , CreateNetworkOpts(..)
52− , defaultCreateNetworkOpts
5345 , VolumePermission(..)
5446 , Bind(..)
5547 , Volume(..)
@@ -75,8 +67,6 @@ module Docker.Client.Types (
7567 , UTSMode(..)
7668 , HostConfig(..)
7769 , defaultHostConfig
78− , NetworkingConfig(..)
79− , EndpointConfig(..)
8070 , Ulimit(..)
8171 , ContainerResources(..)
8272 , defaultContainerResources
@@ -112,7 +102,6 @@ import Data.Scientific (floatingOrInteger)
112102import Data.Text (Text)
113103import qualified Data.Text as T
114104import Data.Time.Clock (UTCTime)
115−import qualified Data.Vector as V
116105import GHC.Generics (Generic)
117106import Prelude hiding (all, tail)
118107import Text.Read (readMaybe)
@@ -132,13 +121,10 @@ data Endpoint =
132121 | UnpauseContainerEndpoint ContainerID
133122 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
134123 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
135− | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
124+ | DeleteContainerEndpoint DeleteOpts ContainerID
136125 | InspectContainerEndpoint ContainerID
137126 | BuildImageEndpoint BuildOpts FilePath
138127 | 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
142128 deriving (Eq, Show)
143129
144130-- | We should newtype this
@@ -250,7 +236,7 @@ data ContainerDetails = ContainerDetails {
250236 , processLabel :: Text
251237 , resolveConfPath :: FilePath
252238 , restartCount :: Int
253− , containerDetailsState :: ContainerState
239+ , state :: ContainerState
254240 , mounts :: [Mount]
255241 }
256242 deriving (Eq, Show, Generic)
@@ -258,11 +244,11 @@ data ContainerDetails = ContainerDetails {
258244-- | Data type used for parsing the mount information from a container
259245-- list.
260246data Mount = Mount {
261− mountName :: Maybe Text -- this is optional
247+ mountName :: Text
262248 , mountSource :: FilePath
263249 , mountDestination :: FilePath
264− , mountDriver :: Maybe Text
265− -- , mountMode :: Maybe VolumePermission -- apparently this can be null
250+ , mountDriver :: Text
251+ , mountMode :: Maybe VolumePermission -- apparently this can be null
266252 , mountRW :: Bool
267253 , mountPropogation :: Text
268254 }
@@ -270,14 +256,14 @@ data Mount = Mount {
270256
271257instance FromJSON Mount where
272258 parseJSON (JSON.Object o) = do
273− name <- o .:? "Name"
259+ name <- o .: "Name"
274260 src <- o .: "Source"
275261 dest <- o .: "Destination"
276− driver <- o .:? "Driver"
277− -- mode <- o .: "Mode"
262+ driver <- o .: "Driver"
263+ mode <- o .: "Mode"
278264 rw <- o .: "RW"
279265 prop <- o .: "Propagation"
280− return $ Mount name src dest driver rw prop
266+ return $ Mount name src dest driver mode rw prop
281267 parseJSON _ = fail "Mount is not an object"
282268
283269-- | Data type used for parsing the container state from a list of
@@ -293,7 +279,7 @@ data ContainerState = ContainerState {
293279 , restarting :: Bool
294280 , running :: Bool
295281 , startedAt :: UTCTime
296− , state :: State
282+ , status :: Status
297283 }
298284 deriving (Eq, Show, Generic)
299285
@@ -523,8 +509,7 @@ data Container = Container
523509 , containerImageId :: ImageID
524510 , containerCommand :: Text
525511 , containerCreatedAt :: Int
526− , containerState :: State
527− , containerStatus :: Maybe Text
512+ , containerStatus :: Status
528513 , containerPorts :: [ContainerPortInfo]
529514 , containerLabels :: [Label]
530515 , containerNetworks :: [Network]
@@ -532,14 +517,13 @@ data Container = Container
532517 } deriving (Show, Eq)
533518
534519instance FromJSON Container where
535− parseJSON o@(JSON.Object v) =
536− Container <$> parseJSON o
520+ parseJSON (JSON.Object v) =
521+ Container <$> (v .: "Id")
537522 <*> (v .: "Names")
538523 <*> (v .: "Image")
539− <*> (v .: "ImageID") -- Doesn't exist anymore
540− <*> (v .: "Command") -- Doesn't exist anymore
524+ <*> (v .: "ImageID")
525+ <*> (v .: "Command")
541526 <*> (v .: "Created")
542− <*> (v .: "State")
543527 <*> (v .: "Status")
544528 <*> (v .: "Ports")
545529 <*> (v .: "Labels")
@@ -549,20 +533,21 @@ instance FromJSON Container where
549533 parseNetworks (JSON.Object v) =
550534 (v .: "Networks") >>= parseJSON
551535 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
536+
552537 parseJSON _ = fail "Container: Not a JSON object."
553538
554−-- | Represents the state of the container life cycle.
555−data State = Created | Restarting | Running | Paused | Exited | Dead
539+-- | Represents the status of the container life cycle.
540+data Status = Created | Restarting | Running | Paused | Exited | Dead
556541 deriving (Eq, Show, Generic)
557542
558−instance FromJSON State where
543+instance FromJSON Status where
559544 parseJSON (JSON.String "running") = return Running
560545 parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
561546 parseJSON (JSON.String "restarting") = return Restarting
562547 parseJSON (JSON.String "paused") = return Paused
563548 parseJSON (JSON.String "exited") = return Exited
564549 parseJSON (JSON.String "dead") = return Dead
565− parseJSON s = fail $ "Unknown Status: " ++ show s
550+ parseJSON _ = fail "Unknown Status"
566551
567552-- | Alias for representing a RepoDigest. We could newtype this and add
568553-- some validation.
@@ -623,46 +608,20 @@ instance FromJSON Image where
623608 return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
624609 parseJSON _ = fail "Failed to parse DockerImage."
625610
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− ]
649611
650612-- | Options used for creating a Container.
651613data CreateOpts = CreateOpts {
652− containerConfig :: ContainerConfig
653− , hostConfig :: HostConfig
654− , networkingConfig :: NetworkingConfig
614+ containerConfig :: ContainerConfig
615+ , hostConfig :: HostConfig
655616 } deriving (Eq, Show)
656617
657618instance ToJSON CreateOpts where
658− toJSON (CreateOpts cc hc nc) = do
619+ toJSON (CreateOpts cc hc) = do
659620 let ccJSON = toJSON cc
660621 let hcJSON = toJSON hc
661622 case ccJSON of
662623 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
663− let o1 = HM.insert "HostConfig" hcJSON o
664− let o2 = HM.insert "NetworkingConfig" (toJSON nc) o1
665− JSON.Object o2
624+ JSON.Object $ HM.insert "HostConfig" hcJSON o
666625 _ -> error "ContainerConfig is not an object." -- This should never happen.
667626
668627-- | Container configuration used for creating a container with sensible
@@ -684,7 +643,7 @@ defaultContainerConfig imageName = ContainerConfig {
684643 , cmd=[]
685644 , volumes=[]
686645 , workingDir=Nothing
687− , entrypoint=Entrypoint []
646+ , entrypoint=Nothing
688647 , networkDisabled=Nothing
689648 , macAddress=Nothing
690649 , labels=[]
@@ -697,7 +656,7 @@ defaultHostConfig = HostConfig {
697656 binds=[]
698657 , containerIDFile=Nothing
699658 , logConfig=LogDriverConfig JsonFile []
700− , networkMode=NetworkBridge
659+ , networkMode=Bridge
701660 , portBindings=[]
702661 , restartPolicy=RestartOff
703662 , volumeDriver=Nothing
@@ -737,18 +696,14 @@ defaultContainerResources = ContainerResources {
737696 , memory=Nothing
738697 , memoryReservation=Nothing
739698 , memorySwap=Nothing
740− , oomKillDisable=Just False
699+ , oomKillDisable=False
741700 , ulimits=[]
742701 }
743702
744703-- | Default create options when creating a container. You only need to
745704-- specify an image name and the rest is all sensible defaults.
746705defaultCreateOpts :: T.Text -> CreateOpts
747−defaultCreateOpts imageName = CreateOpts
748− { containerConfig = defaultContainerConfig imageName
749− , hostConfig = defaultHostConfig
750− , networkingConfig = NetworkingConfig HM.empty
751− }
706+defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
752707
753708-- | Override the key sequence for detaching a container.
754709-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
@@ -762,7 +717,7 @@ defaultStartOpts :: StartOpts
762717defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
763718
764719-- | Options for deleting a container.
765−data ContainerDeleteOpts = ContainerDeleteOpts {
720+data DeleteOpts = DeleteOpts {
766721 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
767722 , force :: Bool -- ^ If the container is still running force deletion anyway.
768723 } deriving (Eq, Show)
@@ -792,15 +747,8 @@ defaultBuildOpts nameTag = BuildOpts { buildImageName = nameTag
792747-- | Default options for deleting a container. Most of the time we DON'T
793748-- want to delete the container's volumes or force delete it if it's
794749-- running.
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
750+defaultDeleteOpts :: DeleteOpts
751+defaultDeleteOpts = DeleteOpts { deleteVolumes = False, force = False }
804752
805753-- | Timestamp alias.
806754type Timestamp = Integer
@@ -828,36 +776,6 @@ defaultLogOpts = LogOpts { stdout = True
828776 , tail = All
829777 }
830778
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−
861779-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
862780-- | Set permissions on volumes that you mount in the container.
863781data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
@@ -869,8 +787,6 @@ instance ToJSON VolumePermission where
869787instance FromJSON VolumePermission where
870788 parseJSON "rw" = return ReadWrite
871789 parseJSON "ro" = return ReadOnly
872− parseJSON "RW" = return ReadWrite
873− parseJSON "RO" = return ReadOnly
874790 parseJSON _ = fail "Failed to parse VolumePermission"
875791
876792-- | Used for marking a directory in the container as "exposed" hence
@@ -1017,41 +933,19 @@ instance FromJSON LogDriverConfig where
1017933 parseJSON _ = fail "LogDriverConfig is not an object"
1018934
1019935-- TODO: Add container:<name|id> mode
1020−data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
936+data NetworkMode = Bridge | Host | NetworkDisabled
1021937 deriving (Eq, Show, Ord)
1022938
1023939instance FromJSON NetworkMode where
1024− parseJSON (JSON.String "bridge") = return NetworkBridge
1025− parseJSON (JSON.String "host") = return NetworkHost -- Note: Guessing on these.
940+ parseJSON (JSON.String "bridge") = return Bridge
941+ parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
1026942 parseJSON (JSON.String "none") = return NetworkDisabled
1027− parseJSON (JSON.String n) = return $ NetworkNamed n
1028943 parseJSON _ = fail "Unknown NetworkMode"
1029944
1030945instance ToJSON NetworkMode where
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]
946+ toJSON Bridge = JSON.String "bridge"
947+ toJSON Host = JSON.String "host"
948+ toJSON NetworkDisabled = JSON.String "none"
1055949
1056950data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
1057951
@@ -1414,7 +1308,7 @@ data ContainerResources = ContainerResources {
14141308 , memoryReservation :: Maybe MemoryConstraint
14151309 , memorySwap :: Maybe MemoryConstraint
14161310 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1417− , oomKillDisable :: Maybe Bool
1311+ , oomKillDisable :: Bool
14181312 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
14191313 , ulimits :: [Ulimit]
14201314 -- TODO: Missing from 1.24
@@ -1452,7 +1346,7 @@ instance FromJSON EnvVar where
14521346 parseJSON _ = fail "EnvVar is not a string"
14531347
14541348instance ToJSON EnvVar where
1455− toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
1349+ toJSON (EnvVar n v) = object [n .= v]
14561350
14571351-- | ExposedPort represents a port (and it's type)
14581352-- that a container should expose to other containers or the host system.
@@ -1492,21 +1386,6 @@ instance {-# OVERLAPPING #-} ToJSON [ExposedPort] where
14921386 where key (ExposedPort p t) = show p <> slash <> show t
14931387 slash = T.unpack "/"
14941388
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−
15101389data ContainerConfig = ContainerConfig {
15111390 hostname :: Maybe Text
15121391 , domainname :: Maybe Text
@@ -1525,7 +1404,7 @@ data ContainerConfig = ContainerConfig {
15251404 , image :: Text
15261405 , volumes :: [Volume]
15271406 , workingDir :: Maybe FilePath
1528− , entrypoint :: Entrypoint
1407+ , entrypoint :: Maybe Text -- Can be null?
15291408 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
15301409 , macAddress :: Maybe Text
15311410 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
@@ -1533,7 +1412,6 @@ data ContainerConfig = ContainerConfig {
15331412 , stopSignal :: Signal
15341413 } deriving (Eq, Show, Generic)
15351414
1536−
15371415instance ToJSON ContainerConfig where
15381416 toJSON = genericToJSON defaultOptions {
15391417 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
@@ -1555,7 +1433,7 @@ instance FromJSON ContainerConfig where
15551433 image <- o .: "Image"
15561434 volumes <- o .: "Volumes"
15571435 workingDir <- o .:? "WorkingDir"
1558− entrypoint <- o .: "Entrypoint"
1436+ entrypoint <- o .:? "Entrypoint"
15591437 networkDisabled <- o .:? "networkDisabled"
15601438 macAddress <- o .:? "MacAddress"
15611439 labels <- o .:? "Labels" .!= []
@@ -1564,11 +1442,7 @@ instance FromJSON ContainerConfig where
15641442 macAddress labels stopSignal
15651443 parseJSON _ = fail "NetworkSettings is not an object."
15661444
1567−#if MIN_VERSION_base(4,13,0)
1568−parseIntegerText :: (MonadFail m) => Text -> m Integer
1569−#else
15701445parseIntegerText :: (Monad m) => Text -> m Integer
1571−#endif
15721446parseIntegerText t = case readMaybe $ T.unpack t of
15731447 Nothing ->
15741448 fail "Could not parse Integer"
@@ -1590,3 +1464,4 @@ toJsonKeyVal vs getKey getVal = JSON.Object $ foldl f HM.empty vs
15901464-- | Helper function that return an empty dictionary "{}"
15911465emptyJsonObject :: JSON.Value
15921466emptyJsonObject = JSON.Object HM.empty
1467+