Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

regenerate REFERENCE.md / Add puppet-lint-param-docs linter #59

Merged
merged 2 commits into from
Oct 6, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions .sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@
- set: ubuntu1604-64
- set: ubuntu1804-64
- set: ubuntu2004-64
Gemfile:
optional:
':test':
- gem: puppet-lint-param-docs
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ group :test do
gem 'voxpupuli-test', '~> 2.0', :require => false
gem 'coveralls', :require => false
gem 'simplecov-console', :require => false
gem 'puppet-lint-param-docs', :require => false
end

group :development do
Expand Down
37 changes: 19 additions & 18 deletions REFERENCE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# Reference

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

## Table of Contents

**Classes**
### Classes

* [`bird`](#bird): Install and configure bird

## Classes

### bird
### `bird`

Install and configure bird

Expand Down Expand Up @@ -43,7 +44,7 @@ Data type: `Optional[Stdlib::Filesource]`

Bird configuration file for IPv4.

Default value: `undef`
Default value: ``undef``

##### `config_template_v4`

Expand All @@ -52,15 +53,15 @@ Data type: `Optional[String[1]]`
Bird configuration template for IPv4. This value is a template source, it
will be passed into the template() function.

Default value: `undef`
Default value: ``undef``

##### `daemon_name_v6`

Data type: `String[1]`

The service name used by puppet resource

Default value: 'bird6'
Default value: `'bird6'`

##### `package_name_v6`

Expand All @@ -74,15 +75,15 @@ Data type: `String[1]`

The service name used by puppet resource

Default value: 'bird'
Default value: `'bird'`

##### `package_name_v4`

Data type: `String[1]`

The package name used by puppet resource

Default value: 'bird'
Default value: `'bird'`

##### `config_path_v6`

Expand All @@ -108,55 +109,55 @@ Data type: `Boolean`

Boolean, global parameter to disable or enable mangagment of bird configuration files.

Default value: `false`
Default value: ``false``

##### `manage_service`

Data type: `Boolean`

Boolean, global parameter to disable or enable mangagment of bird service.

Default value: `false`
Default value: ``false``

##### `service_v6_ensure`

Data type: `Stdlib::Ensure::Service`

Bird IPv6 daemon ensure (shoud be running or stopped).

Default value: 'running'
Default value: `'running'`

##### `service_v6_enable`

Data type: `Boolean`

Boolean, enabled param of Bird IPv6 service (run at boot time).

Default value: `false`
Default value: ``false``

##### `service_v4_ensure`

Data type: `Stdlib::Ensure::Service`

Bird IPv4 daemon ensure (shoud be running or stopped).

Default value: 'running'
Default value: `'running'`

##### `service_v4_enable`

Data type: `Boolean`

Boolean, enabled param of Bird IPv4 service (run at boot time).

Default value: `false`
Default value: ``false``

##### `config_file_v6`

Data type: `Optional[Stdlib::Filesource]`

Bird configuration file for IPv6.

Default value: `undef`
Default value: ``undef``

##### `config_template_v6`

Expand All @@ -165,31 +166,31 @@ Data type: `Optional[String[1]]`
Bird configuration template for IPv6. This value is a template source, it
will be passed into the template() function.

Default value: `undef`
Default value: ``undef``

##### `manage_repo`

Data type: `Boolean`

Add the upstream repository from CZ.NIC. This is currently only supported for CentOS 7

Default value: `false`
Default value: ``false``

##### `config_content_v4`

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

A string that will be used for the bird config file

Default value: `undef`
Default value: ``undef``

##### `config_content_v6`

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

A string that will be used for the bird6 config file

Default value: `undef`
Default value: ``undef``

##### `v4_path`

Expand Down