@@ -11,6 +11,9 @@ module Docker.Client.Types (
1111 , ImageID
1212 , fromImageID
1313 , toImageID
14+ , NetworkID
15+ , fromNetworkID
16+ , toNetworkID
1417 , Timeout(..)
1518 , StatusCode(..)
1619 , Signal(..)
@@ -37,12 +40,16 @@ module Docker.Client.Types (
3740 , DetachKeys(..)
3841 , StartOpts(..)
3942 , defaultStartOpts
40− , DeleteOpts(..)
41− , defaultDeleteOpts
43+ , ContainerDeleteOpts(..)
44+ , defaultContainerDeleteOpts
45+ , ImageDeleteOpts(..)
46+ , defaultImageDeleteOpts
4247 , Timestamp
4348 , TailLogOpt(..)
4449 , LogOpts(..)
4550 , defaultLogOpts
51+ , CreateNetworkOpts(..)
52+ , defaultCreateNetworkOpts
4653 , VolumePermission(..)
4754 , Bind(..)
4855 , Volume(..)
@@ -68,6 +75,8 @@ module Docker.Client.Types (
6875 , UTSMode(..)
6976 , HostConfig(..)
7077 , defaultHostConfig
78+ , NetworkingConfig(..)
79+ , EndpointConfig(..)
7180 , Ulimit(..)
7281 , ContainerResources(..)
7382 , defaultContainerResources
@@ -123,10 +132,13 @@ data Endpoint =
123132 | UnpauseContainerEndpoint ContainerID
124133 | ContainerLogsEndpoint LogOpts Bool ContainerID -- ^ Second argument (Bool) is whether to follow which is currently hardcoded to False.
125134 -- See note in 'Docker.Client.Api.getContainerLogs' for explanation why.
126− | DeleteContainerEndpoint DeleteOpts ContainerID
135+ | DeleteContainerEndpoint ContainerDeleteOpts ContainerID
127136 | InspectContainerEndpoint ContainerID
128137 | BuildImageEndpoint BuildOpts FilePath
129138 | 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
130142 deriving (Eq, Show)
131143
132144-- | We should newtype this
@@ -611,20 +623,46 @@ instance FromJSON Image where
611623 return $ DockerImage imageId imageCreated imageParentId imageRepoTags imageRepoDigests imageSize imageVirtualSize imageLabels
612624 parseJSON _ = fail "Failed to parse DockerImage."
613625
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+ ]
614649
615650-- | Options used for creating a Container.
616651data CreateOpts = CreateOpts {
617− containerConfig :: ContainerConfig
618− , hostConfig :: HostConfig
652+ containerConfig :: ContainerConfig
653+ , hostConfig :: HostConfig
654+ , networkingConfig :: NetworkingConfig
619655 } deriving (Eq, Show)
620656
621657instance ToJSON CreateOpts where
622− toJSON (CreateOpts cc hc) = do
658+ toJSON (CreateOpts cc hc nc) = do
623659 let ccJSON = toJSON cc
624660 let hcJSON = toJSON hc
625661 case ccJSON of
626662 JSON.Object (o :: HM.HashMap T.Text JSON.Value) -> do
627− JSON.Object $ HM.insert "HostConfig" hcJSON o
663+ let o1 = HM.insert "HostConfig" hcJSON o
664+ let o2 = HM.insert "NetworkingConfig" (toJSON nc) o1
665+ JSON.Object o2
628666 _ -> error "ContainerConfig is not an object." -- This should never happen.
629667
630668-- | Container configuration used for creating a container with sensible
@@ -706,7 +744,11 @@ defaultContainerResources = ContainerResources {
706744-- | Default create options when creating a container. You only need to
707745-- specify an image name and the rest is all sensible defaults.
708746defaultCreateOpts :: T.Text -> CreateOpts
709−defaultCreateOpts imageName = CreateOpts { containerConfig = defaultContainerConfig imageName, hostConfig = defaultHostConfig }
747+defaultCreateOpts imageName = CreateOpts
748+ { containerConfig = defaultContainerConfig imageName
749+ , hostConfig = defaultHostConfig
750+ , networkingConfig = NetworkingConfig HM.empty
751+ }
710752
711753-- | Override the key sequence for detaching a container.
712754-- Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.
@@ -720,7 +762,7 @@ defaultStartOpts :: StartOpts
720762defaultStartOpts = StartOpts { detachKeys = DefaultDetachKey }
721763
722764-- | Options for deleting a container.
723−data DeleteOpts = DeleteOpts {
765+data ContainerDeleteOpts = ContainerDeleteOpts {
724766 deleteVolumes :: Bool -- ^ Automatically cleanup volumes that the container created as well.
725767 , force :: Bool -- ^ If the container is still running force deletion anyway.
726768 } deriving (Eq, Show)
@@ -750,8 +792,15 @@ defaultBuildOpts nameTag = BuildOpts { buildImageName = nameTag
750792-- | Default options for deleting a container. Most of the time we DON'T
751793-- want to delete the container's volumes or force delete it if it's
752794-- running.
753−defaultDeleteOpts :: DeleteOpts
754−defaultDeleteOpts = DeleteOpts { deleteVolumes = False, force = False }
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
755804
756805-- | Timestamp alias.
757806type Timestamp = Integer
@@ -779,6 +828,36 @@ defaultLogOpts = LogOpts { stdout = True
779828 , tail = All
780829 }
781830
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+
782861-- TOOD: Add support for SELinux Volume labels (eg. "ro,z" or "ro/Z")
783862-- | Set permissions on volumes that you mount in the container.
784863data VolumePermission = ReadWrite | ReadOnly deriving (Eq, Show, Generic)
@@ -954,6 +1033,26 @@ instance ToJSON NetworkMode where
9541033 toJSON NetworkDisabled = JSON.String "none"
9551034 toJSON (NetworkNamed n) = JSON.String n
9561035
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]
1055+
9571056data PortType = TCP | UDP deriving (Eq, Generic, Read, Ord)
9581057
9591058instance Show PortType where
@@ -1465,7 +1564,11 @@ instance FromJSON ContainerConfig where
14651564 macAddress labels stopSignal
14661565 parseJSON _ = fail "NetworkSettings is not an object."
14671566
1567+#if MIN_VERSION_base(4,13,0)
1568+parseIntegerText :: (MonadFail m) => Text -> m Integer
1569+#else
14681570parseIntegerText :: (Monad m) => Text -> m Integer
1571+#endif
14691572parseIntegerText t = case readMaybe $ T.unpack t of
14701573 Nothing ->
14711574 fail "Could not parse Integer"