From 0cbb5132ec3cb0a875f2c04716199c61b04c9662 Mon Sep 17 00:00:00 2001 From: Jan Dittberner Date: Sat, 5 Nov 2016 12:12:08 +0100 Subject: Add metadata to roles module This commit adds a README.md, metadata.json and class documentation to the roles module. --- sitemodules/roles/README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 sitemodules/roles/README.md (limited to 'sitemodules/roles/README.md') 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/. -- cgit v1.2.1