@@ -11,7 +11,11 @@ module Docker.Client.Types (
12 , fromImageID
12 , fromImageID
13 , toImageID
13 , toImageID
14 , Timeout(..)
17 , Timeout(..)
15 , Signal(..)
19 , Signal(..)
16 , ContainerDetails(..)
20 , ContainerDetails(..)
17 , DockerClientOpts(..)
21 , DockerClientOpts(..)
@@ -22,23 +26,30 @@ module Docker.Client.Types (
22 , ContainerPortInfo(..)
26 , ContainerPortInfo(..)
23 , Container(..)
27 , Container(..)
24 , ContainerState(..)
28 , ContainerState(..)
25− , Status(..)
29+ , State(..)
27 , Label(..)
31 , Label(..)
29 , Image(..)
33 , Image(..)
30 , dropImagePrefix
35 , dropImagePrefix
31 , CreateOpts(..)
36 , CreateOpts(..)
32 , defaultCreateOpts
39 , defaultCreateOpts
33 , DetachKeys(..)
40 , DetachKeys(..)
34 , StartOpts(..)
41 , StartOpts(..)
35 , defaultStartOpts
42 , defaultStartOpts
36− , DeleteOpts(..)
43+ , ContainerDeleteOpts(..)
37− , defaultDeleteOpts
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
38 , Timestamp
47 , Timestamp
39 , TailLogOpt(..)
48 , TailLogOpt(..)
40 , LogOpts(..)
49 , LogOpts(..)
41 , defaultLogOpts
50 , defaultLogOpts
51+ , CreateNetworkOpts(..)
52+ , defaultCreateNetworkOpts
42 , VolumePermission(..)
53 , VolumePermission(..)
43 , Bind(..)
54 , Bind(..)
44 , Volume(..)
55 , Volume(..)
@@ -64,6 +75,8 @@ module Docker.Client.Types (
64 , UTSMode(..)
75 , UTSMode(..)
65 , HostConfig(..)
76 , HostConfig(..)
66 , defaultHostConfig
77 , defaultHostConfig
78+ , NetworkingConfig(..)
67 , Ulimit(..)
80 , Ulimit(..)
68 , ContainerResources(..)
81 , ContainerResources(..)
69 , defaultContainerResources
82 , defaultContainerResources
@@ -93,13 +106,13 @@ import Data.Aeson (FromJSON, ToJSON, genericParseJSON,
93import qualified Data.Aeson as JSON
106import qualified Data.Aeson as JSON
94import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
107import Data.Aeson.Types (defaultOptions, fieldLabelModifier)
95import Data.Char (isAlphaNum, toUpper)
108import Data.Char (isAlphaNum, toUpper)
96−import Data.Foldable (asum)
97import qualified Data.HashMap.Strict as HM
109import qualified Data.HashMap.Strict as HM
98import Data.Monoid ((<>))
110import Data.Monoid ((<>))
99import Data.Scientific (floatingOrInteger)
111import Data.Scientific (floatingOrInteger)
100import Data.Text (Text)
112import Data.Text (Text)
101import qualified Data.Text as T
113import qualified Data.Text as T
102import Data.Time.Clock (UTCTime)
114import Data.Time.Clock (UTCTime)
115+import qualified Data.Vector as V
103import GHC.Generics (Generic)
116import GHC.Generics (Generic)
104import Prelude hiding (all, tail)
117import Prelude hiding (all, tail)
105import Text.Read (readMaybe)
118import Text.Read (readMaybe)
@@ -112,14 +125,20 @@ data Endpoint =
112 | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
125 | CreateContainerEndpoint CreateOpts (Maybe ContainerName)
113 | StartContainerEndpoint StartOpts ContainerID
126 | StartContainerEndpoint StartOpts ContainerID
114 | StopContainerEndpoint Timeout ContainerID
127 | StopContainerEndpoint Timeout ContainerID
128+ | WaitContainerEndpoint ContainerID
115 | KillContainerEndpoint Signal ContainerID
129 | KillContainerEndpoint Signal ContainerID
116 | RestartContainerEndpoint Timeout ContainerID
130 | RestartContainerEndpoint Timeout ContainerID
117 | PauseContainerEndpoint ContainerID
131 | PauseContainerEndpoint ContainerID
118 | UnpauseContainerEndpoint ContainerID
132 | UnpauseContainerEndpoint ContainerID
119 | 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.
120 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
121− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
122 | InspectContainerEndpoint ContainerID
136 | InspectContainerEndpoint ContainerID
137+ | 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)
139+ | DeleteImageEndpoint ImageDeleteOpts ImageID
140+ | CreateNetworkEndpoint CreateNetworkOpts
141+ | RemoveNetworkEndpoint NetworkID
123 deriving (Eq, Show)
142 deriving (Eq, Show)
125-- | We should newtype this
144-- | We should newtype this
@@ -166,6 +185,20 @@ toImageID t =
166-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
185-- | Timeout used for stopping a container. DefaultTimeout is 10 seconds.
167data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
186data Timeout = Timeout Integer | DefaultTimeout deriving (Eq, Show)
188+data StatusCode = StatusCode Int
190+instance ToJSON StatusCode where
191+ toJSON (StatusCode c) = object ["StatusCode" .= c]
193+instance FromJSON StatusCode where
194+ parseJSON (JSON.Object o) = do
195+ c <- o .: "StatusCode"
196+ if c >= 0 && c <= 255 then
197+ return (StatusCode c)
199+ fail "Unknown exit code"
200+ parseJSON _ = fail "Unknown exit code"
169-- TODO: Add more Signals or use an existing lib
202-- TODO: Add more Signals or use an existing lib
170-- | Signal used for sending to the process running in the container.
203-- | Signal used for sending to the process running in the container.
171-- The default signal is SIGTERM.
204-- The default signal is SIGTERM.
@@ -180,16 +213,16 @@ data Signal = SIGHUP
181instance FromJSON Signal where
214instance FromJSON Signal where
182 parseJSON (JSON.String "SIGTERM") = return SIGTERM
215 parseJSON (JSON.String "SIGTERM") = return SIGTERM
183− parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
216+ parseJSON (JSON.String "SIGHUP") = return SIGHUP -- Note: Guessing on the string values for these.
184− parseJSON (JSON.String "SIGINT") = return SIGINT
217+ parseJSON (JSON.String "SIGINT") = return SIGINT
185 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
218 parseJSON (JSON.String "SIGQUIT") = return SIGQUIT
186 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
219 parseJSON (JSON.String "SIGSTOP") = return SIGSTOP
187 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
220 parseJSON (JSON.String "SIGUSR1") = return SIGUSR1
188− parseJSON _ = fail "Unknown Signal"
221+ parseJSON _ = fail "Unknown Signal"
190instance ToJSON Signal where
223instance ToJSON Signal where
191− toJSON SIGHUP = "SIGHUP"
224+ toJSON SIGHUP = "SIGHUP"
192− toJSON SIGINT = "SIGINT"
225+ toJSON SIGINT = "SIGINT"
193 toJSON SIGQUIT = "SIGQUIT"
226 toJSON SIGQUIT = "SIGQUIT"
194 toJSON SIGSTOP = "SIGSTOP"
227 toJSON SIGSTOP = "SIGSTOP"
195 toJSON SIGTERM = "SIGTERM"
228 toJSON SIGTERM = "SIGTERM"
@@ -217,7 +250,7 @@ data ContainerDetails = ContainerDetails {
217 , processLabel :: Text
250 , processLabel :: Text
218 , resolveConfPath :: FilePath
251 , resolveConfPath :: FilePath
219 , restartCount :: Int
252 , restartCount :: Int
220− , state :: ContainerState
253+ , containerDetailsState :: ContainerState
221 , mounts :: [Mount]
254 , mounts :: [Mount]
223 deriving (Eq, Show, Generic)
256 deriving (Eq, Show, Generic)
@@ -225,11 +258,11 @@ data ContainerDetails = ContainerDetails {
225-- | Data type used for parsing the mount information from a container
258-- | Data type used for parsing the mount information from a container
227data Mount = Mount {
260data Mount = Mount {
228− mountName :: Text
261+ mountName :: Maybe Text -- this is optional
229 , mountSource :: FilePath
262 , mountSource :: FilePath
230 , mountDestination :: FilePath
263 , mountDestination :: FilePath
231− , mountDriver :: Text
264+ , mountDriver :: Maybe Text
232− , mountMode :: Maybe VolumePermission -- apparently this can be null
265+ -- , mountMode :: Maybe VolumePermission -- apparently this can be null
233 , mountRW :: Bool
266 , mountRW :: Bool
234 , mountPropogation :: Text
267 , mountPropogation :: Text
@@ -237,14 +270,14 @@ data Mount = Mount {
238instance FromJSON Mount where
271instance FromJSON Mount where
239 parseJSON (JSON.Object o) = do
272 parseJSON (JSON.Object o) = do
240− name <- o .: "Name"
273+ name <- o .:? "Name"
241 src <- o .: "Source"
274 src <- o .: "Source"
242 dest <- o .: "Destination"
275 dest <- o .: "Destination"
243− driver <- o .: "Driver"
276+ driver <- o .:? "Driver"
244− mode <- o .: "Mode"
277+ -- mode <- o .: "Mode"
245 rw <- o .: "RW"
278 rw <- o .: "RW"
246 prop <- o .: "Propagation"
279 prop <- o .: "Propagation"
247− return $ Mount name src dest driver mode rw prop
280+ return $ Mount name src dest driver rw prop
248 parseJSON _ = fail "Mount is not an object"
281 parseJSON _ = fail "Mount is not an object"
250-- | 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
@@ -260,7 +293,7 @@ data ContainerState = ContainerState {
260 , restarting :: Bool
293 , restarting :: Bool
261 , running :: Bool
294 , running :: Bool
262 , startedAt :: UTCTime
295 , startedAt :: UTCTime
263− , status :: Status
296+ , state :: State
265 deriving (Eq, Show, Generic)
298 deriving (Eq, Show, Generic)
@@ -490,7 +523,8 @@ data Container = Container
490 , containerImageId :: ImageID
523 , containerImageId :: ImageID
491 , containerCommand :: Text
524 , containerCommand :: Text
492 , containerCreatedAt :: Int
525 , containerCreatedAt :: Int
526+ , containerState :: State
493− , containerStatus :: Status
527+ , containerStatus :: Maybe Text
494 , containerPorts :: [ContainerPortInfo]
528 , containerPorts :: [ContainerPortInfo]
495 , containerLabels :: [Label]
529 , containerLabels :: [Label]
496 , containerNetworks :: [Network]
530 , containerNetworks :: [Network]
@@ -498,13 +532,14 @@ data Container = Container
498 } deriving (Show, Eq)
532 } deriving (Show, Eq)
500instance FromJSON Container where
534instance FromJSON Container where
501− parseJSON (JSON.Object v) =
535+ parseJSON o@(JSON.Object v) =
502− Container <$> (v .: "Id")
536+ Container <$> parseJSON o
503 <*> (v .: "Names")
537 <*> (v .: "Names")
504 <*> (v .: "Image")
538 <*> (v .: "Image")
505− <*> (v .: "ImageID")
539+ <*> (v .: "ImageID") -- Doesn't exist anymore
506− <*> (v .: "Command")
540+ <*> (v .: "Command") -- Doesn't exist anymore
507 <*> (v .: "Created")
541 <*> (v .: "Created")
508 <*> (v .: "Status")
543 <*> (v .: "Status")
509 <*> (v .: "Ports")
544 <*> (v .: "Ports")
510 <*> (v .: "Labels")
545 <*> (v .: "Labels")
@@ -514,21 +549,20 @@ instance FromJSON Container where
514 parseNetworks (JSON.Object v) =
549 parseNetworks (JSON.Object v) =
515 (v .: "Networks") >>= parseJSON
550 (v .: "Networks") >>= parseJSON
516 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
551 parseNetworks _ = fail "Container NetworkSettings: Not a JSON object."
518 parseJSON _ = fail "Container: Not a JSON object."
552 parseJSON _ = fail "Container: Not a JSON object."
520−-- | Represents the status of the container life cycle.
554+-- | Represents the state of the container life cycle.
521−data Status = Created | Restarting | Running | Paused | Exited | Dead
555+data State = Created | Restarting | Running | Paused | Exited | Dead
522 deriving (Eq, Show, Generic)
556 deriving (Eq, Show, Generic)
524−instance FromJSON Status where
558+instance FromJSON State where
525− parseJSON (JSON.String "running") = return Running
559+ parseJSON (JSON.String "running") = return Running
526− 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.
527 parseJSON (JSON.String "restarting") = return Restarting
561 parseJSON (JSON.String "restarting") = return Restarting
528− parseJSON (JSON.String "paused") = return Paused
562+ parseJSON (JSON.String "paused") = return Paused
529− parseJSON (JSON.String "exited") = return Exited
563+ parseJSON (JSON.String "exited") = return Exited
530− parseJSON (JSON.String "dead") = return Dead
564+ parseJSON (JSON.String "dead") = return Dead
531− parseJSON _ = fail "Unknown Status"
565+ parseJSON s = fail $ "Unknown Status: " ++ show s
533-- | Alias for representing a RepoDigest. We could newtype this and add
567-- | Alias for representing a RepoDigest. We could newtype this and add
534-- some validation.
568-- some validation.
@@ -589,20 +623,46 @@ instance FromJSON Image where
589 return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
623 return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
590 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
593-- | Options used for creating a Container.
650-- | Options used for creating a Container.
594data CreateOpts = CreateOpts {
651data CreateOpts = CreateOpts {
595− containerConfig :: ContainerConfig
652+ containerConfig :: ContainerConfig
596− , hostConfig :: HostConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
597 } deriving (Eq, Show)
655 } deriving (Eq, Show)
599instance ToJSON CreateOpts where
657instance ToJSON CreateOpts where
600− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
601 let ccJSON = toJSON cc
659 let ccJSON = toJSON cc
602 let hcJSON = toJSON hc
660 let hcJSON = toJSON hc
603 case ccJSON of
661 case ccJSON of
604 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
605− JSON.Object $ HM.insert "HostConfig" hcJSON o
663+ let o1 = HM.insert "HostConfig" hcJSON o
664+ let o2 = HM.insert "NetworkingConfig" (toJSON nc) o1
606 _ -> error "ContainerConfig is not an object." -- This should never happen.
666 _ -> error "ContainerConfig is not an object." -- This should never happen.
608-- | Container configuration used for creating a container with sensible
668-- | Container configuration used for creating a container with sensible
@@ -624,7 +684,7 @@ defaultContainerConfig imageName = ContainerConfig {
625 , volumes=[]
685 , volumes=[]
626 , workingDir=Nothing
686 , workingDir=Nothing
627− , entrypoint=[]
687+ , entrypoint=Entrypoint []
628 , networkDisabled=Nothing
688 , networkDisabled=Nothing
629 , macAddress=Nothing
689 , macAddress=Nothing
630 , labels=[]
690 , labels=[]
@@ -637,7 +697,7 @@ defaultHostConfig = HostConfig {
638 , containerIDFile=Nothing
698 , containerIDFile=Nothing
639 , logConfig=LogDriverConfig JsonFile []
699 , logConfig=LogDriverConfig JsonFile []
640− , networkMode=Bridge
700+ , networkMode=NetworkBridge
641 , portBindings=[]
701 , portBindings=[]
642 , restartPolicy=RestartOff
702 , restartPolicy=RestartOff
643 , volumeDriver=Nothing
703 , volumeDriver=Nothing
@@ -677,14 +737,18 @@ defaultContainerResources = ContainerResources {
677 , memory=Nothing
737 , memory=Nothing
678 , memoryReservation=Nothing
738 , memoryReservation=Nothing
679 , memorySwap=Nothing
739 , memorySwap=Nothing
680− , oomKillDisable=False
740+ , oomKillDisable=Just False
681 , ulimits=[]
741 , ulimits=[]
684-- | Default create options when creating a container. You only need to
744-- | Default create options when creating a container. You only need to
685-- specify an image name and the rest is all sensible defaults.
745-- specify an image name and the rest is all sensible defaults.
686defaultCreateOpts :: T.Text -> CreateOpts
746defaultCreateOpts :: T.Text -> CreateOpts
747+defaultCreateOpts imageName = CreateOpts
687−defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
748+ { containerConfig = defaultContainerConfig imageName
749+ , hostConfig = defaultHostConfig
750+ , networkingConfig = NetworkingConfig HM.empty
689-- | Override the key sequence for detaching a container.
753-- | Override the key sequence for detaching a container.
690-- 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 _.
@@ -698,16 +762,45 @@ defaultStartOpts :: StartOpts
698defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
700-- | Options for deleting a container.
764-- | Options for deleting a container.
701−data DeleteOpts = DeleteOpts {
765+data ContainerDeleteOpts = ContainerDeleteOpts {
702 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
703 , force :: Bool -- ^ If the container is still running force deletion anyway.
767 , force :: Bool -- ^ If the container is still running force deletion anyway.
704 } deriving (Eq, Show)
768 } deriving (Eq, Show)
770+-- TODO: Add support for container build constraints
771+-- | Options for when building images from a Dockerfile
772+data BuildOpts = BuildOpts {
773+ buildImageName :: Text -- ^ Image name in the form of name:tag; ie. myimage:latest.:w
774+ , buildDockerfileName :: Text -- ^ Name of dockerfile (default: Dockerfile)
775+ , buildQuiet :: Bool
776+ , buildNoCache :: Bool -- ^ Do not use cache when building the image.
777+ , buildRemoveItermediate :: Bool -- ^ Remove intermediate containers after a successful build (default true).
778+ , buildForceRemoveIntermediate :: Bool -- ^ Always remove intermediate containers.
779+ , buildPullParent :: Bool -- ^ Always attempt to pull a newer version of the *parent* image (ie. FROM debian:jessie).
780+ } deriving (Eq, Show)
782+defaultBuildOpts :: Text -> BuildOpts
783+defaultBuildOpts nameTag = BuildOpts { buildImageName = nameTag
784+ , buildDockerfileName = "Dockerfile"
785+ , buildQuiet = False
786+ , buildNoCache = False
787+ , buildRemoveItermediate = True
788+ , buildForceRemoveIntermediate = False
789+ , buildPullParent = False
706-- | 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
707-- 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
708-- running.
794-- running.
709−defaultDeleteOpts :: DeleteOpts
795+defaultContainerDeleteOpts :: ContainerDeleteOpts
710−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
712-- | Timestamp alias.
805-- | Timestamp alias.
713type Timestamp = Integer
806type Timestamp = Integer
@@ -735,18 +828,50 @@ defaultLogOpts = LogOpts { stdout = True
735 , 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
738-- 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")
739-- | Set permissions on volumes that you mount in the container.
862-- | Set permissions on volumes that you mount in the container.
740data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
863data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
742instance ToJSON VolumePermission where
865instance ToJSON VolumePermission where
743 toJSON ReadWrite = "rw"
866 toJSON ReadWrite = "rw"
744− toJSON ReadOnly = "ro"
867+ toJSON ReadOnly = "ro"
746instance FromJSON VolumePermission where
869instance FromJSON VolumePermission where
747 parseJSON "rw" = return ReadWrite
870 parseJSON "rw" = return ReadWrite
748 parseJSON "ro" = return ReadOnly
871 parseJSON "ro" = return ReadOnly
872+ parseJSON "RW" = return ReadWrite
873+ parseJSON "RO" = return ReadOnly
749− parseJSON _ = fail "Failed to parse VolumePermission"
874+ parseJSON _ = fail "Failed to parse VolumePermission"
751-- | Used for marking a directory in the container as "exposed" hence
876-- | Used for marking a directory in the container as "exposed" hence
752-- taking it outside of the COW filesystem and making it mountable
877-- taking it outside of the COW filesystem and making it mountable
@@ -768,8 +893,8 @@ instance {-# OVERLAPPING #-} ToJSON [Volume] where
769instance {-# OVERLAPPING #-} FromJSON [Volume] where
894instance {-# OVERLAPPING #-} FromJSON [Volume] where
770 parseJSON (JSON.Object o) = return $ map (Volume . T.unpack) $ HM.keys o
895 parseJSON (JSON.Object o) = return $ map (Volume . T.unpack) $ HM.keys o
771− parseJSON (JSON.Null) = return []
896+ parseJSON (JSON.Null) = return []
772− parseJSON _ = fail "Volume is not an object"
897+ parseJSON _ = fail "Volume is not an object"
775data Bind = Bind { hostSrc :: Text
900data Bind = Bind { hostSrc :: Text
@@ -779,10 +904,10 @@ data Bind = Bind { hostSrc :: Text
780instance FromJSON Bind where
905instance FromJSON Bind where
781 parseJSON (JSON.String t) = case T.split (== ':') t of
906 parseJSON (JSON.String t) = case T.split (== ':') t of
782− [src, dest] -> return $ Bind src dest Nothing
907+ [src, dest] -> return $ Bind src dest Nothing
783 [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
908 [src, dest, "rw"] -> return $ Bind src dest $ Just ReadWrite
784 [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
909 [src, dest, "ro"] -> return $ Bind src dest $ Just ReadOnly
785− _ -> fail "Could not parse Bind"
910+ _ -> fail "Could not parse Bind"
786 parseJSON _ = fail "Bind is not a string"
911 parseJSON _ = fail "Bind is not a string"
788data Device = Device {
913data Device = Device {
@@ -805,15 +930,15 @@ data VolumeFrom = VolumeFrom ContainerName (Maybe VolumePermission) deriving (Eq
806instance FromJSON VolumeFrom where
931instance FromJSON VolumeFrom where
807 parseJSON (JSON.String t) = case T.split (== ':') t of
932 parseJSON (JSON.String t) = case T.split (== ':') t of
808− [vol] -> return $ VolumeFrom vol Nothing
933+ [vol] -> return $ VolumeFrom vol Nothing
809 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
934 [vol, "rw"] -> return $ VolumeFrom vol $ Just ReadWrite
810 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
935 [vol, "ro"] -> return $ VolumeFrom vol $ Just ReadOnly
811− _ -> fail "Could not parse VolumeFrom"
936+ _ -> fail "Could not parse VolumeFrom"
812 parseJSON _ = fail "VolumeFrom is not a string"
937 parseJSON _ = fail "VolumeFrom is not a string"
814instance ToJSON VolumeFrom where
939instance ToJSON VolumeFrom where
815 toJSON (VolumeFrom n p) = case p of
940 toJSON (VolumeFrom n p) = case p of
816− Nothing -> toJSON $ n <> ":" <> "rw"
941+ Nothing -> toJSON $ n <> ":" <> "rw"
817 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
942 Just per -> toJSON $ n <> ":" <> (T.pack $ show per)
819instance ToJSON Bind where
944instance ToJSON Bind where
@@ -825,40 +950,40 @@ data Link = Link Text (Maybe Text) deriving (Eq, Show)
826instance FromJSON Link where
951instance FromJSON Link where
827 parseJSON (JSON.String t) = case T.split (== ':') t of
952 parseJSON (JSON.String t) = case T.split (== ':') t of
828− [f] -> return $ Link f Nothing
953+ [f] -> return $ Link f Nothing
829 [f,s] -> return $ Link f $ Just s
954 [f,s] -> return $ Link f $ Just s
830− _ -> fail "Could not parse Link"
955+ _ -> fail "Could not parse Link"
831 parseJSON _ = fail "Link is not a string"
956 parseJSON _ = fail "Link is not a string"
833instance ToJSON Link where
958instance ToJSON Link where
834 toJSON (Link n1 n2) = toJSON $ case n2 of
959 toJSON (Link n1 n2) = toJSON $ case n2 of
835 Nothing -> T.concat[n1, ":", n1] -- use same name in container
960 Nothing -> T.concat[n1, ":", n1] -- use same name in container
836− Just n -> T.concat[n1, ":", n] -- used specified name in container
961+ Just n -> T.concat[n1, ":", n] -- used specified name in container
838-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
963-- { "Type": "<driver_name>", "Config": {"key1": "val1"} }
839data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
964data LogDriverType = JsonFile | Syslog | Journald | Gelf | Fluentd | AwsLogs | Splunk | Etwlogs | LoggingDisabled deriving (Eq, Show)
841instance FromJSON LogDriverType where
966instance FromJSON LogDriverType where
842 parseJSON (JSON.String "json-file") = return JsonFile
967 parseJSON (JSON.String "json-file") = return JsonFile
843− parseJSON (JSON.String "syslog") = return Syslog
968+ parseJSON (JSON.String "syslog") = return Syslog
844− parseJSON (JSON.String "journald") = return Journald
969+ parseJSON (JSON.String "journald") = return Journald
845− parseJSON (JSON.String "gelf") = return Gelf
970+ parseJSON (JSON.String "gelf") = return Gelf
846− parseJSON (JSON.String "fluentd") = return Fluentd
971+ parseJSON (JSON.String "fluentd") = return Fluentd
847− parseJSON (JSON.String "awslogs") = return AwsLogs
972+ parseJSON (JSON.String "awslogs") = return AwsLogs
848− parseJSON (JSON.String "splunk") = return Splunk
973+ parseJSON (JSON.String "splunk") = return Splunk
849− parseJSON (JSON.String "etwlogs") = return Etwlogs
974+ parseJSON (JSON.String "etwlogs") = return Etwlogs
850− parseJSON (JSON.String "none") = return LoggingDisabled
975+ parseJSON (JSON.String "none") = return LoggingDisabled
851− parseJSON _ = fail "Unknown LogDriverType"
976+ parseJSON _ = fail "Unknown LogDriverType"
853instance ToJSON LogDriverType where
978instance ToJSON LogDriverType where
854− toJSON JsonFile = JSON.String "json-file"
979+ toJSON JsonFile = JSON.String "json-file"
855− toJSON Syslog = JSON.String "syslog"
980+ toJSON Syslog = JSON.String "syslog"
856− toJSON Journald = JSON.String "journald"
981+ toJSON Journald = JSON.String "journald"
857− toJSON Gelf = JSON.String "gelf"
982+ toJSON Gelf = JSON.String "gelf"
858− toJSON Fluentd = JSON.String "fluentd"
983+ toJSON Fluentd = JSON.String "fluentd"
859− toJSON AwsLogs = JSON.String "awslogs"
984+ toJSON AwsLogs = JSON.String "awslogs"
860− toJSON Splunk = JSON.String "splunk"
985+ toJSON Splunk = JSON.String "splunk"
861− toJSON Etwlogs = JSON.String "etwlogs"
986+ toJSON Etwlogs = JSON.String "etwlogs"
862 toJSON LoggingDisabled = JSON.String "none"
987 toJSON LoggingDisabled = JSON.String "none"
864data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
989data LogDriverOption = LogDriverOption Name Value deriving (Eq, Show)
@@ -892,19 +1017,41 @@ instance FromJSON LogDriverConfig where
892 parseJSON _ = fail "LogDriverConfig is not an object"
1017 parseJSON _ = fail "LogDriverConfig is not an object"
894-- TODO: Add container:<name|id> mode
1019-- TODO: Add container:<name|id> mode
895−data NetworkMode = Bridge | Host | NetworkDisabled
1020+data NetworkMode = NetworkBridge | NetworkHost | NetworkDisabled | NetworkNamed Text
896 deriving (Eq, Show, Ord)
1021 deriving (Eq, Show, Ord)
898instance FromJSON NetworkMode where
1023instance FromJSON NetworkMode where
899− parseJSON (JSON.String "bridge") = return Bridge
1024+ parseJSON (JSON.String "bridge") = return NetworkBridge
900− parseJSON (JSON.String "host") = return Host -- Note: Guessing on these.
1025+ parseJSON (JSON.String "host") = return NetworkHost -- Note: Guessing on these.
901− parseJSON (JSON.String "none") = return NetworkDisabled
1026+ parseJSON (JSON.String "none") = return NetworkDisabled
1027+ parseJSON (JSON.String n) = return $ NetworkNamed n
902− parseJSON _ = fail "Unknown NetworkMode"
1028+ parseJSON _ = fail "Unknown NetworkMode"
904instance ToJSON NetworkMode where
1030instance ToJSON NetworkMode where
905− toJSON Bridge = JSON.String "bridge"
1031+ toJSON NetworkBridge = JSON.String "bridge"
906− toJSON Host = JSON.String "host"
1032+ toJSON NetworkHost = JSON.String "host"
907 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]
909data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
1056data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
@@ -920,7 +1067,7 @@ instance FromJSON PortType where
920 parseJSON val = case val of
1067 parseJSON val = case val of
921 "tcp" -> return TCP
1068 "tcp" -> return TCP
922 "udp" -> return UDP
1069 "udp" -> return UDP
923− _ -> fail "PortType: Invalid port type."
1070+ _ -> fail "PortType: Invalid port type."
925-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
1072-- newtype NetworkInterface = NetworkInterface Text deriving (Eq, Show)
@@ -1050,7 +1197,7 @@ instance FromJSON RestartPolicy where
1050 "on-failure" -> do
1197 "on-failure" -> do
1051 retry <- o .: "MaximumRetryCount"
1198 retry <- o .: "MaximumRetryCount"
1052 return $ RestartOnFailure retry
1199 return $ RestartOnFailure retry
1053− "off" -> return RestartOff
1200+ "no" -> return RestartOff
1054 _ -> fail "Could not parse RestartPolicy"
1201 _ -> fail "Could not parse RestartPolicy"
1055 parseJSON _ = fail "RestartPolicy is not an object"
1202 parseJSON _ = fail "RestartPolicy is not an object"
@@ -1058,7 +1205,7 @@ instance ToJSON RestartPolicy where
1058 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
1205 toJSON RestartAlways = object ["Name" .= JSON.String "always"]
1059 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
1206 toJSON RestartUnlessStopped = object ["Name" .= JSON.String "unless-stopped"]
1060 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1207 toJSON (RestartOnFailure c) = object ["Name" .= JSON.String "on-failure", "MaximumRetryCount" .= c]
1061− toJSON RestartOff = object ["Name" .= JSON.String "off"]
1208+ toJSON RestartOff = object ["Name" .= JSON.String "no"]
1063data Isolation = Default | Process | Hyperv deriving (Eq, Show)
1210data Isolation = Default | Process | Hyperv deriving (Eq, Show)
@@ -1236,7 +1383,7 @@ data MemoryConstraintSize = B | MB | GB deriving (Eq, Show)
1236data MemoryConstraint = MemoryConstraint Integer MemoryConstraintSize deriving (Eq, Show)
1383data MemoryConstraint = MemoryConstraint Integer MemoryConstraintSize deriving (Eq, Show)
1238instance ToJSON MemoryConstraint where
1385instance ToJSON MemoryConstraint where
1239− toJSON (MemoryConstraint x B) = toJSON x
1386+ toJSON (MemoryConstraint x B) = toJSON x
1240 toJSON (MemoryConstraint x MB) = toJSON $ x * 1024 * 1024
1387 toJSON (MemoryConstraint x MB) = toJSON $ x * 1024 * 1024
1241 toJSON (MemoryConstraint x GB) = toJSON $ x * 1024 * 1024 * 1024
1388 toJSON (MemoryConstraint x GB) = toJSON $ x * 1024 * 1024 * 1024
@@ -1267,7 +1414,7 @@ data ContainerResources = ContainerResources {
1267 , memoryReservation :: Maybe MemoryConstraint
1414 , memoryReservation :: Maybe MemoryConstraint
1268 , memorySwap :: Maybe MemoryConstraint
1415 , memorySwap :: Maybe MemoryConstraint
1269 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1416 -- , memorySwappiness :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1270− , oomKillDisable :: Bool
1417+ , oomKillDisable :: Maybe Bool
1271 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1418 -- , pidsLimit :: Integer -- 1.24: Missing from inspecting container details... Going to omit for now.
1272 , ulimits :: [Ulimit]
1419 , ulimits :: [Ulimit]
1273 -- TODO: Missing from 1.24
1420 -- TODO: Missing from 1.24
@@ -1305,7 +1452,7 @@ instance FromJSON EnvVar where
1305 parseJSON _ = fail "EnvVar is not a string"
1452 parseJSON _ = fail "EnvVar is not a string"
1307instance ToJSON EnvVar where
1454instance ToJSON EnvVar where
1308− toJSON (EnvVar n v) = object [n .= v]
1455+ toJSON (EnvVar n v) = JSON.String $ n <> T.pack "=" <> v
1310-- | ExposedPort represents a port (and it's type)
1457-- | ExposedPort represents a port (and it's type)
1311-- 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.
@@ -1345,6 +1492,21 @@ instance {-# OVERLAPPING #-} ToJSON [ExposedPort] where
1345 where key (ExposedPort p t) = show p <> slash <> show t
1492 where key (ExposedPort p t) = show p <> slash <> show t
1346 slash = T.unpack "/"
1493 slash = T.unpack "/"
1495+data Entrypoint = Entrypoint [T.Text] deriving (Eq, Show, Generic)
1497+instance ToJSON Entrypoint where
1498+ toJSON (Entrypoint (e:es)) = toJSON (e:es)
1499+ toJSON (Entrypoint []) = JSON.Null
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"
1348data ContainerConfig = ContainerConfig {
1510data ContainerConfig = ContainerConfig {
1349 hostname :: Maybe Text
1511 hostname :: Maybe Text
1350 , domainname :: Maybe Text
1512 , domainname :: Maybe Text
@@ -1363,7 +1525,7 @@ data ContainerConfig = ContainerConfig {
1363 , image :: Text
1525 , image :: Text
1364 , volumes :: [Volume]
1526 , volumes :: [Volume]
1365 , workingDir :: Maybe FilePath
1527 , workingDir :: Maybe FilePath
1366− , entrypoint :: [Text]
1528+ , entrypoint :: Entrypoint
1367 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
1529 , networkDisabled :: Maybe Bool -- Note: Should we expand the JSON instance and take away the Maybe? Null is False?
1368 , macAddress :: Maybe Text
1530 , macAddress :: Maybe Text
1369 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
1531 -- , onBuild :: Maybe Text -- For 1.24, only see this in the inspect response.
@@ -1371,6 +1533,7 @@ data ContainerConfig = ContainerConfig {
1371 , stopSignal :: Signal
1533 , stopSignal :: Signal
1372 } deriving (Eq, Show, Generic)
1534 } deriving (Eq, Show, Generic)
1374instance ToJSON ContainerConfig where
1537instance ToJSON ContainerConfig where
1375 toJSON = genericToJSON defaultOptions {
1538 toJSON = genericToJSON defaultOptions {
1376 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
1539 fieldLabelModifier = (\(x:xs) -> toUpper x : xs)}
@@ -1392,9 +1555,7 @@ instance FromJSON ContainerConfig where
1392 image <- o .: "Image"
1555 image <- o .: "Image"
1393 volumes <- o .: "Volumes"
1556 volumes <- o .: "Volumes"
1394 workingDir <- o .:? "WorkingDir"
1557 workingDir <- o .:? "WorkingDir"
1395− entrypoint <- asum [ o .:? "Entrypoint" .!= []
1396− , (:[]) <$> o .: "Entrypoint"
1558+ entrypoint <- o .: "Entrypoint"
1398 networkDisabled <- o .:? "networkDisabled"
1559 networkDisabled <- o .:? "networkDisabled"
1399 macAddress <- o .:? "MacAddress"
1560 macAddress <- o .:? "MacAddress"
1400 labels <- o .:? "Labels" .!= []
1561 labels <- o .:? "Labels" .!= []
@@ -1403,7 +1564,11 @@ instance FromJSON ContainerConfig where
1403 macAddress labels stopSignal
1564 macAddress labels stopSignal
1404 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
1406parseIntegerText :: (Monad m) => Text -> m Integer
1570parseIntegerText :: (Monad m) => Text -> m Integer
1407parseIntegerText t = case readMaybe $ T.unpack t of
1572parseIntegerText t = case readMaybe $ T.unpack t of
1408 Nothing ->
1573 Nothing ->
1409 fail "Could not parse Integer"
1574 fail "Could not parse Integer"