summaryrefslogtreecommitdiff
path: root/sitemodules/profiles/README.md
blob: e1b9b813481b68b49b6935c5e3ecaec6206feca3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# profiles

#### Table of Contents

1. [Description](#description)
1. [Setup - The basics of getting started with profiles](#setup)
    * [Beginning with profiles](#beginning-with-profiles)
1. [Usage - Configuration options and additional functionality](#usage)
1. [Reference](#reference)
1. [Limitations - OS compatibility, etc.](#limitations)

## Description

The profiles module defines functionality that is part of node roles. Profiles
should be assigned to nodes by including them in the node's role class.

## Setup

### Beginning with profiles

To use a profile you should define its required parameters in hiera data and
include the profile in the node's role class.

## 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

*[`profiles::base`](#profiles-base): Setup the base functionality for a puppet managed node.

## 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/.