Add metadata to roles module
[cacert-puppet.git] / sitemodules / roles / README.md
1 # roles
2
3 #### Table of Contents
4
5 1. [Description](#description)
6 1. [Usage - Configuration options and additional functionality](#usage)
7 1. [Reference](#reference)
8
9 ## Description
10
11 This module defines the CAcert specific host roles. Each role describes one
12 functionality. Hosts should have one role only.
13
14 ## Usage
15
16 Usage is very specific to the particular profile classes. See the class
17 documentation for the profiles you want to use.
18
19 ## Reference
20
21 ### Classes
22
23 #### Public classes
24
25 *[`roles::puppetmaster`](#roles-puppetmaster): Defines the puppetmaster role
26 *[`roles::svnserver`](#roles-svnserver): Defines the subversion server role
27
28 ## Limitations
29
30 This module is designed to be used on CAcert infrastructure only. It is not
31 designed for reuse anywhere else. The CAcert infrastructure is described at https://infradocs.cacert.org/.