summaryrefslogtreecommitdiff
path: root/src/Propellor/Info.hs
diff options
context:
space:
mode:
authorJoey Hess2015-01-01 13:57:13 -0400
committerJoey Hess2015-01-01 13:57:13 -0400
commitb50f33395edc55317d95c53e34c4d810a5e49041 (patch)
tree6c875bea90a37e6fcbef159e14dfbd02e7dba06f /src/Propellor/Info.hs
parentea07e3d70e06f29ea7f65f69ad5b2d3fa6208ae3 (diff)
update docs
Diffstat (limited to 'src/Propellor/Info.hs')
-rw-r--r--src/Propellor/Info.hs9
1 files changed, 7 insertions, 2 deletions
diff --git a/src/Propellor/Info.hs b/src/Propellor/Info.hs
index a91f69c8..0437f8ec 100644
--- a/src/Propellor/Info.hs
+++ b/src/Propellor/Info.hs
@@ -26,8 +26,13 @@ getOS = askInfo _os
-- | Indidate that a host has an A record in the DNS.
--
--- TODO check at run time if the host really has this address.
--- (Can't change the host's address, but as a sanity check.)
+-- When propellor is used to deploy a DNS server for a domain,
+-- the hosts in the domain are found by looking for these
+-- and similar properites.
+--
+-- When propellor --spin is used to deploy a host, it checks
+-- if the host's IP Property matches the DNS. If the DNS is missing or
+-- out of date, the host will instead be contacted directly by IP address.
ipv4 :: String -> Property
ipv4 = addDNS . Address . IPv4