Document the profiles module
[cacert-puppet.git] / sitemodules / profiles / manifests / base.pp
index bd0a428..961cbb8 100644 (file)
@@ -1,6 +1,38 @@
+# Class: profiles::base
+# =====================
+#
+# This class defines the base profile that is valid for all puppet managed
+# CAcert hosts and should therefore be included in any host role class in the
+# roles module.
+#
+# Parameters
+# ----------
+#
+# @param admins a list of admin users for the node
+#
+# @param users a hash containing user information
+#
+# Examples
+# --------
+#
+# @example
+#   class roles::myhost {
+#     include profiles::base
+#   }
+#
+# Authors
+# -------
+#
+# Jan Dittberner <jandd@cacert.org>
+#
+# Copyright
+# ---------
+#
+# Copyright 2016 Jan Dittberner
+#
 class profiles::base (
-  $admins = [],
-  $users = {},
+  Array[String] $admins = [],
+  Hash[String, Data] $users = {},
 ) {
   # ensure admin users for this container
   $admins.each |String $username| {