summaryrefslogtreecommitdiff
path: root/sitemodules
diff options
context:
space:
mode:
authorJan Dittberner <jandd@cacert.org>2016-11-05 12:12:08 +0100
committerJan Dittberner <jandd@cacert.org>2016-11-05 12:44:12 +0100
commit0cbb5132ec3cb0a875f2c04716199c61b04c9662 (patch)
tree48e7ee4bcf1e2dfd5da4da49bab447b97ba8bd99 /sitemodules
parentbef9c83e74228604c5e7ed46c3e308408b5f6ca6 (diff)
downloadcacert-puppet-0cbb5132ec3cb0a875f2c04716199c61b04c9662.tar.gz
cacert-puppet-0cbb5132ec3cb0a875f2c04716199c61b04c9662.tar.xz
cacert-puppet-0cbb5132ec3cb0a875f2c04716199c61b04c9662.zip
Add metadata to roles module
This commit adds a README.md, metadata.json and class documentation to the roles module.
Diffstat (limited to 'sitemodules')
-rw-r--r--sitemodules/roles/README.md31
-rw-r--r--sitemodules/roles/manifests/init.pp19
-rw-r--r--sitemodules/roles/manifests/puppetmaster.pp25
-rw-r--r--sitemodules/roles/manifests/svnserver.pp25
-rw-r--r--sitemodules/roles/metadata.json14
5 files changed, 108 insertions, 6 deletions
diff --git a/sitemodules/roles/README.md b/sitemodules/roles/README.md
new file mode 100644
index 0000000..a5fbc27
--- /dev/null
+++ b/sitemodules/roles/README.md
@@ -0,0 +1,31 @@
+# roles
+
+#### Table of Contents
+
+1. [Description](#description)
+1. [Usage - Configuration options and additional functionality](#usage)
+1. [Reference](#reference)
+
+## Description
+
+This module defines the CAcert specific host roles. Each role describes one
+functionality. Hosts should have one role only.
+
+## Usage
+
+Usage is very specific to the particular profile classes. See the class
+documentation for the profiles you want to use.
+
+## Reference
+
+### Classes
+
+#### Public classes
+
+*[`roles::puppetmaster`](#roles-puppetmaster): Defines the puppetmaster role
+*[`roles::svnserver`](#roles-svnserver): Defines the subversion server role
+
+## Limitations
+
+This module is designed to be used on CAcert infrastructure only. It is not
+designed for reuse anywhere else. The CAcert infrastructure is described at https://infradocs.cacert.org/.
diff --git a/sitemodules/roles/manifests/init.pp b/sitemodules/roles/manifests/init.pp
index 0b8b1a7..055d4c1 100644
--- a/sitemodules/roles/manifests/init.pp
+++ b/sitemodules/roles/manifests/init.pp
@@ -1,3 +1,18 @@
-class roles (
-) {
+# Class: roles
+# ===========================
+#
+# This is just the empty roles class. Specific roles are defined in other
+# classes in this module.
+#
+# Authors
+# -------
+#
+# Jan Dittberner <jandd@cacert.org>
+#
+# Copyright
+# ---------
+#
+# Copyright 2016 Jan Dittberner
+#
+class roles {
}
diff --git a/sitemodules/roles/manifests/puppetmaster.pp b/sitemodules/roles/manifests/puppetmaster.pp
index 9cdc95d..c1b8e1e 100644
--- a/sitemodules/roles/manifests/puppetmaster.pp
+++ b/sitemodules/roles/manifests/puppetmaster.pp
@@ -1,4 +1,25 @@
-class roles::puppetmaster (
-) {
+# Class: roles::puppetmaster
+# ==========================
+#
+# This class defines the puppetmaster role for the CAcert puppet master. You
+# should assign this class using hiera or via an ENC.
+#
+# Examples
+# --------
+#
+# @example
+# class { 'roles::puppetmaster': }
+#
+# Authors
+# -------
+#
+# Jan Dittberner <jandd@cacert.org>
+#
+# Copyright
+# ---------
+#
+# Copyright 2016 Jan Dittberner
+#
+class roles::puppetmaster {
include profiles::base
}
diff --git a/sitemodules/roles/manifests/svnserver.pp b/sitemodules/roles/manifests/svnserver.pp
index f744651..64d4508 100644
--- a/sitemodules/roles/manifests/svnserver.pp
+++ b/sitemodules/roles/manifests/svnserver.pp
@@ -1,4 +1,25 @@
-class roles::svnserver (
-) {
+# Class: roles::svnserver
+# =======================
+#
+# This class defines the svnserver role for Subversion servers. You should
+# assign this class using hiera or via an ENC.
+#
+# Examples
+# --------
+#
+# @example
+# class { 'roles::svnserver': }
+#
+# Authors
+# -------
+#
+# Jan Dittberner <jandd@cacert.org>
+#
+# Copyright
+# ---------
+#
+# Copyright 2016 Jan Dittberner
+#
+class roles::svnserver {
include profiles::base
}
diff --git a/sitemodules/roles/metadata.json b/sitemodules/roles/metadata.json
new file mode 100644
index 0000000..2d0ad90
--- /dev/null
+++ b/sitemodules/roles/metadata.json
@@ -0,0 +1,14 @@
+{
+ "name": "cacert/roles",
+ "version": "0.1.0",
+ "author": "Jan Dittberner",
+ "summary": "This module defines the roles that can be assigned to CAcert hosts.",
+ "license": "GPL-3.0+",
+ "source": "git://git.cacert.org/cacert-puppet.git",
+ "project_page": "https://infradocs.cacert.org/",
+ "issues_url": null,
+ "dependencies": [
+ ],
+ "data_provider": "hiera"
+}
+