Document the profiles module
[cacert-puppet.git] / sitemodules / profiles / README.md
1 # profiles
2
3 #### Table of Contents
4
5 1. [Description](#description)
6 1. [Setup - The basics of getting started with profiles](#setup)
7 * [Beginning with profiles](#beginning-with-profiles)
8 1. [Usage - Configuration options and additional functionality](#usage)
9 1. [Reference](#reference)
10 1. [Limitations - OS compatibility, etc.](#limitations)
11
12 ## Description
13
14 The profiles module defines functionality that is part of node roles. Profiles
15 should be assigned to nodes by including them in the node's role class.
16
17 ## Setup
18
19 ### Beginning with profiles
20
21 To use a profile you should define its required parameters in hiera data and
22 include the profile in the node's role class.
23
24 ## Usage
25
26 Usage is very specific to the particular profile classes. See the class
27 documentation for the profiles you want to use.
28
29 ## Reference
30
31 ### Classes
32
33 #### Public classes
34
35 *[`profiles::base`](#profiles-base): Setup the base functionality for a puppet managed node.
36
37 ## Limitations
38
39 This module is designed to be used on CAcert infrastructure only. It is not
40 designed for reuse anywhere else. The CAcert infrastructure is described at https://infradocs.cacert.org/.