@@ -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
@@ -106,13 +96,13 @@ import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
10696import qualified Data.Aeson as JSON
10797import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
10898import Data.Char (isAlphaNum, toUpper)
99+import Data.Foldable (asum)
109100import qualified Data.HashMap.Strict as HM
110101import Data.Monoid ((<>))
111102import Data.Scientific (floatingOrInteger)
112103import Data.Text (Text)
113104import qualified Data.Text as T
114105import Data.Time.Clock (UTCTime)
115−import qualified Data.Vector as V
116106import GHC.Generics (Generic)
117107import Prelude hiding (all, tail)
118108import Text.Read (readMaybe)
@@ -132,13 +122,10 @@ data Endpoint =
132122 | UnpauseContainerEndpoint ContainerID
133123 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
134124 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
135− | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
125+ | DeleteContainerEndpoint DeleteOpts ContainerID
136126 | InspectContainerEndpoint ContainerID
137127 | BuildImageEndpoint BuildOpts FilePath
138128 | 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
142129 deriving (Eq, Show)
143130
144131-- | We should newtype this
@@ -250,7 +237,7 @@ data ContainerDetails = ContainerDetails {
250237 , processLabel :: Text
251238 , resolveConfPath :: FilePath
252239 , restartCount :: Int
253− , containerDetailsState :: ContainerState
240+ , state :: ContainerState
254241 , mounts :: [Mount]
255242 }
256243 deriving (Eq, Show, Generic)
@@ -258,11 +245,11 @@ data ContainerDetails = ContainerDetails {
258245-- | Data type used for parsing the mount information from a container
259246-- list.
260247data Mount = Mount {
261− mountName :: Maybe Text -- this is optional
248+ mountName :: Text
262249 , mountSource :: FilePath
263250 , mountDestination :: FilePath
264− , mountDriver :: Maybe Text
265− -- , mountMode :: Maybe VolumePermission -- apparently this can be null
251+ , mountDriver :: Text
252+ , mountMode :: Maybe VolumePermission -- apparently this can be null
266253 , mountRW :: Bool
267254 , mountPropogation :: Text
268255 }
@@ -270,14 +257,14 @@ data Mount = Mount {
270257
271258instance FromJSON Mount where
272259 parseJSON (JSON.Object o) = do
273− name <- o .:? "Name"
260+ name <- o .: "Name"
274261 src <- o .: "Source"
275262 dest <- o .: "Destination"
276− driver <- o .:? "Driver"
277− -- mode <- o .: "Mode"
263+ driver <- o .: "Driver"
264+ mode <- o .: "Mode"
278265 rw <- o .: "RW"
279266 prop <- o .: "Propagation"
280− return $ Mount name src dest driver rw prop
267+ return $ Mount name src dest driver mode rw prop
281268 parseJSON _ = fail "Mount is not an object"
282269
283270-- | Data type used for parsing the container state from a list of
@@ -293,7 +280,7 @@ data ContainerState = ContainerState {
293280 , restarting :: Bool
294281 , running :: Bool
295282 , startedAt :: UTCTime
296− , state :: State
283+ , status :: Status
297284 }
298285 deriving (Eq, Show, Generic)
299286
@@ -523,8 +510,7 @@ data Container = Container
523510 , containerImageId :: ImageID
524511 , containerCommand :: Text
525512 , containerCreatedAt :: Int
526− , containerState :: State
527− , containerStatus :: Maybe Text
513+ , containerStatus :: Status
528514 , containerPorts :: [ContainerPortInfo]
529515 , containerLabels :: [Label]
530516 , containerNetworks :: [Network]
@@ -532,14 +518,13 @@ data Container = Container
532518 } deriving (Show, Eq)
533519
534520instance FromJSON Container where
535− parseJSON o@(JSON.Object v) =
536− Container <$> parseJSON o
521+ parseJSON (JSON.Object v) =
522+ Container <$> (v .: "Id")
537523 <*> (v .: "Names")
538524 <*> (v .: "Image")
539− <*> (v .: "ImageID") -- Doesn't exist anymore
540− <*> (v .: "Command") -- Doesn't exist anymore
525+ <*> (v .: "ImageID")
526+ <*> (v .: "Command")
541527 <*> (v .: "Created")
542− <*> (v .: "State")
543528 <*> (v .: "Status")
544529 <*> (v .: "Ports")
545530 <*> (v .: "Labels")
@@ -549,20 +534,21 @@ instance FromJSON Container where
549534 parseNetworks (JSON.Object v) =
550535 (v .: "Networks") >>= parseJSON
551536 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
537+
552538 parseJSON _ = fail "Container: Not a JSON object."
553539
554−-- | Represents the state of the container life cycle.
555−data State = Created | Restarting | Running | Paused | Exited | Dead
540+-- | Represents the status of the container life cycle.
541+data Status = Created | Restarting | Running | Paused | Exited | Dead
556542 deriving (Eq, Show, Generic)
557543
558−instance FromJSON State where
544+instance FromJSON Status where
559545 parseJSON (JSON.String "running") = return Running
560546 parseJSON (JSON.String "created") = return Created -- Note: Guessing on the string values of these.
561547 parseJSON (JSON.String "restarting") = return Restarting
562548 parseJSON (JSON.String "paused") = return Paused
563549 parseJSON (JSON.String "exited") = return Exited
564550 parseJSON (JSON.String "dead") = return Dead
565− parseJSON s = fail $ "Unknown Status: " ++ show s
551+ parseJSON _ = fail "Unknown Status"
566552
567553-- | Alias for representing a RepoDigest. We could newtype this and add
568554-- some validation.
@@ -623,46 +609,20 @@ instance FromJSON Image where
623609 return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
624610 parseJSON _ = fail "Failed to parse DockerImage."
625611
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− ]
649612
650613-- | Options used for creating a Container.
651614data CreateOpts = CreateOpts {
652− containerConfig :: ContainerConfig
653− , hostConfig :: HostConfig
654− , networkingConfig :: NetworkingConfig
615+ containerConfig :: ContainerConfig
616+ , hostConfig :: HostConfig
655617 } deriving (Eq, Show)
656618
657619instance ToJSON CreateOpts where
658− toJSON (CreateOpts cc hc nc) = do
620+ toJSON (CreateOpts cc hc) = do
659621 let ccJSON = toJSON cc
660622 let hcJSON = toJSON hc
661623 case ccJSON of
662624 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
625+ JSON.Object $ HM.insert "HostConfig" hcJSON o
666626 _ -> error "ContainerConfig is not an object." -- This should never happen.
667627
668628-- | Container configuration used for creating a container with sensible
@@ -684,7 +644,7 @@ defaultContainerConfig imageName = ContainerConfig {
684644 , cmd=[]
685645 , volumes=[]
686646 , workingDir=Nothing
687− , entrypoint=Entrypoint []
647+ , entrypoint=[]
688648 , networkDisabled=Nothing
689649 , macAddress=Nothing
690650 , labels=[]
@@ -697,7 +657,7 @@ defaultHostConfig = HostConfig {
697657 binds=[]
698658 , containerIDFile=Nothing
699659 , logConfig=LogDriverConfig JsonFile []
700− , networkMode=NetworkBridge
660+ , networkMode=Bridge
701661 , portBindings=[]
702662 , restartPolicy=RestartOff
703663 , volumeDriver=Nothing
@@ -737,18 +697,14 @@ defaultContainerResources = ContainerResources {
737697 , memory=Nothing
738698 , memoryReservation=Nothing
739699 , memorySwap=Nothing
740− , oomKillDisable=Just False
700+ , oomKillDisable=False
741701 , ulimits=[]
742702 }
743703
744704-- | Default create options when creating a container. You only need to
745705-- specify an image name and the rest is all sensible defaults.
746706defaultCreateOpts :: T.Text -> CreateOpts
747−defaultCreateOpts imageName = CreateOpts
748− { containerConfig = defaultContainerConfig imageName
749− , hostConfig = defaultHostConfig
750− , networkingConfig = NetworkingConfig HM.empty
751− }
707+defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
752708
753709-- | Override the key sequence for detaching a container.
754710-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
@@ -762,7 +718,7 @@ defaultStartOpts :: StartOpts
762718defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
763719
764720-- | Options for deleting a container.
765−data ContainerDeleteOpts = ContainerDeleteOpts {
721+data DeleteOpts = DeleteOpts {
766722 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
767723 , force :: Bool -- ^ If the container is still running force deletion anyway.
768724 } deriving (Eq, Show)
@@ -792,15 +748,8 @@ defaultBuildOpts nameTag = BuildOpts { buildImageName = nameTag
792748-- | Default options for deleting a container. Most of the time we DON'T
793749-- want to delete the container's volumes or force delete it if it's
794750-- 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
751+defaultDeleteOpts :: DeleteOpts
752+defaultDeleteOpts = DeleteOpts { deleteVolumes = False, force = False }
804753
805754-- | Timestamp alias.
806755type Timestamp = Integer
@@ -828,36 +777,6 @@ defaultLogOpts = LogOpts { stdout = True
828777 , tail = All
829778 }
830779
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−
861780-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
862781-- | Set permissions on volumes that you mount in the container.
863782data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
@@ -869,8 +788,6 @@ instance ToJSON VolumePermission where
869788instance FromJSON VolumePermission where
870789 parseJSON "rw" = return ReadWrite
871790 parseJSON "ro" = return ReadOnly
872− parseJSON "RW" = return ReadWrite
873− parseJSON "RO" = return ReadOnly
874791 parseJSON _ = fail "Failed to parse VolumePermission"
875792
876793-- | Used for marking a directory in the container as "exposed" hence
@@ -1017,41 +934,19 @@ instance FromJSON LogDriverConfig where
1017934 parseJSON _ = fail "LogDriverConfig is not an object"
1018935
1019936-- TODO: Add container:<name|id> mode
1020−data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
937+data NetworkMode = Bridge | Host | NetworkDisabled
1021938 deriving (Eq, Show, Ord)
1022939
1023940instance FromJSON NetworkMode where
1024− parseJSON (JSON.String "bridge") = return NetworkBridge
1025− parseJSON (JSON.String "host") = return NetworkHost -- Note: Guessing on these.
941+ parseJSON (JSON.String "bridge") = return Bridge
942+ parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
1026943 parseJSON (JSON.String "none") = return NetworkDisabled
1027− parseJSON (JSON.String n) = return $ NetworkNamed n
1028944 parseJSON _ = fail "Unknown NetworkMode"
1029945
1030946instance 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]
947+ toJSON Bridge = JSON.String "bridge"
948+ toJSON Host = JSON.String "host"
949+ toJSON NetworkDisabled = JSON.String "none"
1055950
1056951data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
1057952
@@ -1414,7 +1309,7 @@ data ContainerResources = ContainerResources {
14141309 , memoryReservation :: Maybe MemoryConstraint
14151310 , memorySwap :: Maybe MemoryConstraint
14161311 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1417− , oomKillDisable :: Maybe Bool
1312+ , oomKillDisable :: Bool
14181313 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
14191314 , ulimits :: [Ulimit]
14201315 -- TODO: Missing from 1.24
@@ -1452,7 +1347,7 @@ instance FromJSON EnvVar where
14521347 parseJSON _ = fail "EnvVar is not a string"
14531348
14541349instance ToJSON EnvVar where
1455− toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
1350+ toJSON (EnvVar n v) = object [n .= v]
14561351
14571352-- | ExposedPort represents a port (and it's type)
14581353-- that a container should expose to other containers or the host system.
@@ -1492,21 +1387,6 @@ instance {-# OVERLAPPING #-} ToJSON [ExposedPort] where
14921387 where key (ExposedPort p t) = show p <> slash <> show t
14931388 slash = T.unpack "/"
14941389
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−
15101390data ContainerConfig = ContainerConfig {
15111391 hostname :: Maybe Text
15121392 , domainname :: Maybe Text
@@ -1525,7 +1405,7 @@ data ContainerConfig = ContainerConfig {
15251405 , image :: Text
15261406 , volumes :: [Volume]
15271407 , workingDir :: Maybe FilePath
1528− , entrypoint :: Entrypoint
1408+ , entrypoint :: [Text]
15291409 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
15301410 , macAddress :: Maybe Text
15311411 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
@@ -1533,7 +1413,6 @@ data ContainerConfig = ContainerConfig {
15331413 , stopSignal :: Signal
15341414 } deriving (Eq, Show, Generic)
15351415
1536−
15371416instance ToJSON ContainerConfig where
15381417 toJSON = genericToJSON defaultOptions {
15391418 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
@@ -1555,7 +1434,9 @@ instance FromJSON ContainerConfig where
15551434 image <- o .: "Image"
15561435 volumes <- o .: "Volumes"
15571436 workingDir <- o .:? "WorkingDir"
1558− entrypoint <- o .: "Entrypoint"
1437+ entrypoint <- asum [ o .:? "Entrypoint" .!= []
1438+ , (:[]) <$> o .: "Entrypoint"
1439+ ]
15591440 networkDisabled <- o .:? "networkDisabled"
15601441 macAddress <- o .:? "MacAddress"
15611442 labels <- o .:? "Labels" .!= []
@@ -1564,11 +1445,7 @@ instance FromJSON ContainerConfig where
15641445 macAddress labels stopSignal
15651446 parseJSON _ = fail "NetworkSettings is not an object."
15661447
1567−#if MIN_VERSION_base(4,13,0)
1568−parseIntegerText :: (MonadFail m) => Text -> m Integer
1569−#else
15701448parseIntegerText :: (Monad m) => Text -> m Integer
1571−#endif
15721449parseIntegerText t = case readMaybe $ T.unpack t of
15731450 Nothing ->
15741451 fail "Could not parse Integer"