c915d82 · docker-hs · git.iko.soy

git.iko.soy/docker-hs

on master help sign in

Docs fixes

c915d82Deni Bertovic10 years ago

src/Docker/Client/Api.hs+20−2

compare with master

unifiedsplit

@@ -19,9 +19,9 @@ module Docker.Client.Api (

19 -- * Images

20 , listImages

21 , buildImageFromDockerfile

22+ , pullImage

22 -- * Other

23 -- * Other

23 , getDockerVersion

24 , getDockerVersion

24− , pullImage

25 ) where

27import Control.Monad.Catch (MonadMask (..))

@@ -164,14 +164,30 @@ inspectContainer cid = requestHelper GET (InspectContainerEndpoint cid) >>= pars

164getContainerLogs :: forall m. (MonadIO m, MonadMask m) => LogOpts -> ContainerID -> DockerT m (Either DockerError BSL.ByteString)

165getContainerLogs logopts cid = requestHelper GET (ContainerLogsEndpoint logopts False cid)

166

167−-- | Continuosly gets the container's logs as a stream. Uses conduit.

167+{-| Continuously gets the container's logs as a stream. Uses conduit.

168+

169+__Example__:

170+

171+@

172+>>> import Docker.Client

173+>>> import Data.Maybe

174+>>> import Conduit

175+>>> h <- defaultHttpHanlder

176+>>> let cid = fromJust $ toContainerID "fee86e1d522b"

177+>>> runDockerT (defaultClientOpts, h) $ getContainerLogsStream defaultLogOpts cid stdoutC

178+@

179+

180+-}

168getContainerLogsStream :: forall m b . (MonadIO m, MonadMask m) => LogOpts -> ContainerID -> Sink BS.ByteString m b -> DockerT m (Either DockerError b)

181getContainerLogsStream :: forall m b . (MonadIO m, MonadMask m) => LogOpts -> ContainerID -> Sink BS.ByteString m b -> DockerT m (Either DockerError b)

169getContainerLogsStream logopts cid = requestHelper' GET (ContainerLogsEndpoint logopts True cid)

182getContainerLogsStream logopts cid = requestHelper' GET (ContainerLogsEndpoint logopts True cid)

170-- JP: Should the second (follow) argument be True? XXX

183-- JP: Should the second (follow) argument be True? XXX

171

184

172-- | Build an Image from a Dockerfile

185-- | Build an Image from a Dockerfile

186+--

173-- TODO: Add X-Registry-Config

187-- TODO: Add X-Registry-Config

188+--

174-- TODO: Add support for remote URLs to a Dockerfile

189-- TODO: Add support for remote URLs to a Dockerfile

190+--

175-- TODO: Clean up temp tar.gz file after the image is built

191-- TODO: Clean up temp tar.gz file after the image is built

176buildImageFromDockerfile :: forall m. (MonadIO m, MonadMask m) => BuildOpts -> FilePath -> DockerT m (Either DockerError ())

192buildImageFromDockerfile :: forall m. (MonadIO m, MonadMask m) => BuildOpts -> FilePath -> DockerT m (Either DockerError ())

177buildImageFromDockerfile opts base = do

193buildImageFromDockerfile opts base = do

@@ -181,8 +197,10 @@ buildImageFromDockerfile opts base = do

181 Right c -> requestUnit POST (BuildImageEndpoint opts c)

197 Right c -> requestUnit POST (BuildImageEndpoint opts c)

182

198

183-- | Pulls an image from Docker Hub (by default).

199-- | Pulls an image from Docker Hub (by default).

200+--

184-- TODO: Add support for X-Registry-Auth and pulling from private docker

201-- TODO: Add support for X-Registry-Auth and pulling from private docker

185-- registries.

202-- registries.

203+--

186-- TODO: Implement importImage function that uses he same

204-- TODO: Implement importImage function that uses he same

187-- CreateImageEndpoint but rather than pulling from docker hub it imports

205-- CreateImageEndpoint but rather than pulling from docker hub it imports

188-- the image from a tarball or a URL.

206-- the image from a tarball or a URL.