Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
bastelfreak committed May 23, 2024
1 parent 4b4c88b commit dcb2dc8
Show file tree
Hide file tree
Showing 2 changed files with 154 additions and 1 deletion.
153 changes: 153 additions & 0 deletions REFERENCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
# Reference

<!-- DO NOT EDIT: This document was generated by Puppet Strings -->

## Table of Contents

### Classes

* [`bolt`](#bolt): installs bolt via yumrepo or release package

### Defined types

* [`bolt::project`](#bolt--project): creates required files for a bolt project. Will create one oneshot service for each plan

## Classes

### <a name="bolt"></a>`bolt`

installs bolt via yumrepo or release package

#### Parameters

The following parameters are available in the `bolt` class:

* [`version`](#-bolt--version)
* [`base_url`](#-bolt--base_url)
* [`gpgkey`](#-bolt--gpgkey)
* [`use_release_package`](#-bolt--use_release_package)
* [`release_package`](#-bolt--release_package)

##### <a name="-bolt--version"></a>`version`

Data type: `String[1]`



Default value: `'3.29.0'`

##### <a name="-bolt--base_url"></a>`base_url`

Data type: `Stdlib::HTTPSUrl`



Default value: `'https://yum.puppet.com/'`

##### <a name="-bolt--gpgkey"></a>`gpgkey`

Data type: `String[1]`



Default value: `'RPM-GPG-KEY-puppet-20250406'`

##### <a name="-bolt--use_release_package"></a>`use_release_package`

Data type: `Boolean`



Default value: `true`

##### <a name="-bolt--release_package"></a>`release_package`

Data type: `String[1]`



Default value: `"puppet-tools-release-el-${facts['os']['release']['major']}.noarch.rpm"`

## Defined types

### <a name="bolt--project"></a>`bolt::project`

creates required files for a bolt project. Will create one oneshot service for each plan

#### Parameters

The following parameters are available in the `bolt::project` defined type:

* [`basepath`](#-bolt--project--basepath)
* [`project`](#-bolt--project--project)
* [`owner`](#-bolt--project--owner)
* [`group`](#-bolt--project--group)
* [`manage_user`](#-bolt--project--manage_user)
* [`plans`](#-bolt--project--plans)
* [`environment`](#-bolt--project--environment)
* [`modulepaths`](#-bolt--project--modulepaths)

##### <a name="-bolt--project--basepath"></a>`basepath`

Data type: `Stdlib::Absolutepath`



Default value: `'/opt/'`

##### <a name="-bolt--project--project"></a>`project`

Data type: `String[1]`



Default value: `$name`

##### <a name="-bolt--project--owner"></a>`owner`

Data type: `String[1]`



Default value: `$project`

##### <a name="-bolt--project--group"></a>`group`

Data type: `String[1]`



Default value: `$project`

##### <a name="-bolt--project--manage_user"></a>`manage_user`

Data type: `Boolean`



Default value: `true`

##### <a name="-bolt--project--plans"></a>`plans`

Data type: `Array[String[1]]`



Default value: `[]`

##### <a name="-bolt--project--environment"></a>`environment`

Data type: `String[1]`



Default value: `'peadm'`

##### <a name="-bolt--project--modulepaths"></a>`modulepaths`

Data type: `Array[Stdlib::Absolutepath]`



Default value: `["/etc/puppetlabs/code/environments/${environment}/modules", "/etc/puppetlabs/code/environments/${environment}/site",]`

2 changes: 1 addition & 1 deletion manifests/project.pp
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
{
'name' => $facts['networking']['fqdn'],
'uri' => 'local://localhost',
},,
},
]
}
],
Expand Down

0 comments on commit dcb2dc8

Please sign in to comment.