Skip to content

Commit e687336

Browse files
author
Aaron Hicks
committed
Documentation for 1.3.0
1 parent eb115c7 commit e687336

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

README.markdown

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ The `puppet` class installs puppet from packages available to whichever reposito
4747
* **pluginsync**: If this is set to `true` then plugins from modules will be synchronised from the puppetmaster. The default value is `false`.
4848
* **showdiff**: If this is set to `true` file changes will be reported as diffs in the puppet agent reports. The default value is `false`. **WARNING**: Enabling this may expose sensitive information as clear text in puppet reports, this setting should only be used for debugging and testing purposes.
4949
* **environment**: This sets the environment in the agent block. The default value is the same as the `environment` fact provided by facter.
50+
* **dns_alt_names**: Expects an array of names to add to the puppet master's certificate as aliases. The default is undefined which leaves this unconfigured.
5051

5152
## `puppet::conf`
5253

@@ -94,6 +95,11 @@ This class installs a Puppetmaster on [Passenger](https://www.phusionpassenger.c
9495
* **storeconfigs**: If this is set to `true` the puppetmaster wills store all puppet clients' configuration, which allows exchanging resources between nodes (i.e. virtual and exported resources). The default value is `false`.
9596
* **storeconfigs_backend**: Setting this will configure the backend terminus for `storedconfigs`. The default omits the setting enabling the default ActiveRecord store. Setting this parameter automatically sets `storeconfigs` to `true.
9697
* **regenerate_certs**: When set to true the `puppet::master` class will regenerate the puppetmaster SSL certificates post install, which [can resolve some SSL issues](#Troubleshooting).
98+
* **environmentpath**: This sets the path to a directory containing a collection of [directory environments](https://docs.puppetlabs.com/puppet/latest/reference/environments_configuring.html). This can use the internal puppet variables like `$confdir`. The default is undefined and leaves this value unconfigured.
99+
* **default_manifest**: This sets the default main manifest for directory environments, any environment that does not set a manifest will use this manifest. The default is undefined, which will revert to the puppet default of `./manifests`.
100+
* **basemodulepaths**: This expects an array of paths for a Puppetmaster to look for Puppet Modules. This list must include `/usr/share/puppet/modules` and will append it if omitted. The default is undefined, which will revert to the puppet default.
101+
* **autosign**: This sets the path to either an `autosign.conf` whitelist of approved domain names and globs, or an executable that can verifiy host names for [policy based autosigning](https://docs.puppetlabs.com/puppet/latest/reference/ssl_autosign.html). The default is undefined, which will use the whitelist in `$confdir/autosign.conf` by default.
102+
* **autosign_conf_path**: This sets the path to the `autosign.conf` whitelist file if the default path of `$confdir/autosign.conf` is not desired.
97103

98104
**NOTE**: Setting the `http` report handler without providing a reporting URL to the `reporturl` parameter may lead to unexpected behaviour by the Puppetmaster.
99105

@@ -170,6 +176,17 @@ The `puppet::auth::header` resource inserts header comments into the `auth.conf`
170176
* **order** (required) : This sets the insert order of the header comment.
171177
* **content** (required) : This is the text for the header comment.
172178

179+
## `puppet::autosign`
180+
181+
The `puppet::autosign` resource inserts it's name as a whitelist entry into the `autosign.conf` file given by the `autosign_conf_path` paramter of the `puppet::master` class. This class has no parameters. This class performs a regular expression validation of the name which should be of the form of a fully qualified domain name, but can use a leading `*` prefix to as a glob matcher for sub-domains.
182+
183+
### Usage
184+
185+
```puppet
186+
puppet::autosign{'*.local': }
187+
puppet::autosign{'puppet.example.com': }
188+
```
189+
173190
## `puppet::fileserver`
174191

175192
The `puppet::fileserver` resource inserts fileserver declarations into the `fileserver.conf` file. By default these entries will be entered in alphabetical order by their name. More details on the the `fileserver.conf` file can be found in the [PuppetLabs Documentation](http://docs.puppetlabs.com/puppet/latest/reference/config_file_fileserver.html).

metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "Aethylred-puppet",
3-
"version": "1.2.3",
3+
"version": "1.3.0",
44
"author": "Aaron Hicks <aethylred@gmail.com>",
55
"license": "Licensed under GPL3",
66
"summary": "A Puppet module for installing, configuring and managing puppet, puppetmaster, and hiera.",

0 commit comments

Comments
 (0)