summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJoey Hess2014-05-31 21:44:50 -0400
committerJoey Hess2014-05-31 21:44:50 -0400
commitb0f2478bcbfcf5adc2d6f1692d667d42b108ca04 (patch)
treef09be43225f7a7126cb4caf8a6198afe93676c59 /src
parent31d9dd297db1a27c121df484c8f71ccfb612f375 (diff)
docker haddock
Diffstat (limited to 'src')
-rw-r--r--src/Propellor/Property/Docker.hs24
1 files changed, 14 insertions, 10 deletions
diff --git a/src/Propellor/Property/Docker.hs b/src/Propellor/Property/Docker.hs
index b0af14c1..f23738b3 100644
--- a/src/Propellor/Property/Docker.hs
+++ b/src/Propellor/Property/Docker.hs
@@ -6,13 +6,14 @@
-- which propellor can set up. See config.hs for an example.
module Propellor.Property.Docker (
- Image,
- ContainerName,
- configured,
+ -- * Host properties
installed,
+ configured,
container,
docked,
garbageCollected,
+ Image,
+ ContainerName,
-- * Container configuration
dns,
hostname,
@@ -25,6 +26,7 @@ module Propellor.Property.Docker (
workdir,
memory,
link,
+ ContainerAlias,
-- * Internal use
chain,
) where
@@ -45,17 +47,17 @@ import Data.List
import Data.List.Utils
import qualified Data.Set as S
+installed :: Property
+installed = Apt.installed ["docker.io"]
+
-- | Configures docker with an authentication file, so that images can be
--- pushed to index.docker.io.
+-- pushed to index.docker.io. Optional.
configured :: Property
configured = property "docker configured" go `requires` installed
where
go = withPrivData DockerAuthentication $ \cfg -> ensureProperty $
"/root/.dockercfg" `File.hasContent` (lines cfg)
-installed :: Property
-installed = Apt.installed ["docker.io"]
-
-- | A short descriptive name for a container.
-- Should not contain whitespace or other unusual characters,
-- only [a-zA-Z0-9_-] are allowed
@@ -76,9 +78,11 @@ container cn image = Host hn [] attr
cn2hn :: ContainerName -> HostName
cn2hn cn = cn ++ ".docker"
--- | Ensures that a docker container is set up and running. The container
--- has its own Properties which are handled by running propellor
--- inside the container.
+-- | Ensures that a docker container is set up and running, finding
+-- its configuration in the passed list of hosts.
+--
+-- The container has its own Properties which are handled by running
+-- propellor inside the container.
--
-- Additionally, the container can have DNS attributes, such as a CNAME.
-- These become attributes of the host(s) it's docked in.