document the ipsec::network and ipsec::peer manifests, change default address to...

[mirror/dsa-puppet.git] / modules / ipsec / manifests / peer.pp

diff --git a/modules/ipsec/manifests/peer.pp b/modules/ipsec/manifests/peer.pp
index fbbc8ac..0270f5e 100644 (file)
--- a/modules/ipsec/manifests/peer.pp
+++ b/modules/ipsec/manifests/peer.pp
@@ -1,4 +1,19 @@
 # an ipsec peer, another node to connect to
+#
+# This is the stored config part of ipsec::network.  Each node that
+# is part of a network stores an ipsec::peer entry for itself and
+# then collects all other nodes of that network, overwriting
+# the local_* variables for itself.
+#
+# @param network_name       name of this ipsec network clique
+# @param ipsec_conf_file    the target of the ipsec config file concat
+# @param ipsec_secrets_file the target of the ipsec secrets file concat
+# @param local_name         the name of this node (overwritten on collecting)
+# @param local_ipaddress    the ipsec endpoint address on this node (overwritten on collecting)
+# @param local_networks     a list of local networks (overwritten on collecting)
+# @param peer_name          the name of this peer
+# @param peer_ipaddress     the ipsec endpoint address of this peer
+# @param peer_networks      a list of networks behind or at this peer
 define ipsec::peer(
   $ipsec_conf_file,
   $ipsec_secrets_file,