diff options
author | Jan Dittberner <jandd@cacert.org> | 2016-11-05 12:12:08 +0100 |
---|---|---|
committer | Jan Dittberner <jandd@cacert.org> | 2016-11-05 12:44:12 +0100 |
commit | 0cbb5132ec3cb0a875f2c04716199c61b04c9662 (patch) | |
tree | 48e7ee4bcf1e2dfd5da4da49bab447b97ba8bd99 /sitemodules/roles/README.md | |
parent | bef9c83e74228604c5e7ed46c3e308408b5f6ca6 (diff) | |
download | cacert-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/roles/README.md')
-rw-r--r-- | sitemodules/roles/README.md | 31 |
1 files changed, 31 insertions, 0 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/. |