moving parameters into appropriate place, adding meaning unit test, first pass on reference file, expanding acceptance test to include meaningful example

using codename as release
This commit is contained in:
Bram Vogelaar 2021-01-13 17:07:37 +01:00
parent 46678ae310
commit ea3e115bd0
No known key found for this signature in database
GPG key ID: 02374F82C00E4984
6 changed files with 108 additions and 12 deletions

74
REFERENCE.md Normal file
View file

@ -0,0 +1,74 @@
# Reference
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
## Table of Contents
### Classes
* [`hashi_stack::repo`](#hashi_stackrepo): Set up the package repository for the HashiCorp Stack components
## Classes
### `hashi_stack::repo`
This class installs the hashicorp repository
#### Examples
#####
```puppet
include hashi_stack::repo
```
#####
```puppet
class { 'hashi_stack::repo': } -> package { 'packer': ensure => installed }
```
#### Parameters
The following parameters are available in the `hashi_stack::repo` class.
##### `priority`
Data type: `Optional[Integer]`
A numeric priority for the repo, passed to the package management system
Default value: ``undef``
##### `proxy`
Data type: `String`
The URL of a HTTP proxy to use for package downloads (YUM only)
Default value: `'absent'`
##### `key_id`
Data type: `String`
GPG key to authenticate Apt package signatures.
Default value: `'E8A032E094D8EB4EA189D270DA418C88A3219F7B'`
##### `key_source`
Data type: `Stdlib::HTTPSUrl`
The location of an existing GPG key file to copy.
Default value: `'https://apt.releases.hashicorp.com/gpg'`
##### `description`
Data type: `String`
Repository description
Default value: `'HashiCorp package repository.'`