Skip to content

Fix puppet-strings documentation #1363

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 23, 2022
Merged

Fix puppet-strings documentation #1363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 33 additions & 3 deletions REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@

#### Private Classes

* `postgresql::backup::pg_dump`: "Provider" for pg_dump backup
* `postgresql::dnfmodule`: Manage the DNF module
* `postgresql::params`
* `postgresql::repo`
Expand Down Expand Up @@ -858,6 +859,9 @@ The following parameters are available in the `postgresql::server` class:
* [`roles`](#roles)
* [`config_entries`](#config_entries)
* [`pg_hba_rules`](#pg_hba_rules)
* [`backup_enable`](#backup_enable)
* [`backup_options`](#backup_options)
* [`backup_provider`](#backup_provider)
* [`version`](#version)
* [`extra_systemd_config`](#extra_systemd_config)
* [`manage_selinux`](#manage_selinux)
Expand Down Expand Up @@ -1286,6 +1290,30 @@ Specifies a hash from which to generate postgresql::server::pg_hba_rule resource

Default value: `{}`

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

Data type: `Boolean`

Whether a backup job should be enabled.

Default value: `$postgresql::params::backup_enable`

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

Data type: `Hash`

A hash of options that should be passed through to the backup provider.

Default value: `{}`

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

Data type: `Enum['pg_dump']`

Specifies the backup provider to use.

Default value: `$postgresql::params::backup_provider`

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

Data type: `Any`
Expand Down Expand Up @@ -1644,13 +1672,15 @@ The following parameters are available in the `postgresql::server::db` defined t

Data type: `Any`

User to create and assign access to the database upon creation. Mandatory.
User to assign access to the database upon creation (will be created if not defined elsewhere). Mandatory.

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

Data type: `Variant[String, Sensitive[String]]`
Data type: `Optional[Variant[String, Sensitive[String]]]`

Sets the password for the created user (if a user is created).

Required Sets the password for the created user.
Default value: ``undef``

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

Expand Down
2 changes: 1 addition & 1 deletion manifests/server.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
# @param roles Specifies a hash from which to generate postgresql::server::role resources.
# @param config_entries Specifies a hash from which to generate postgresql::server::config_entry resources.
# @param pg_hba_rules Specifies a hash from which to generate postgresql::server::pg_hba_rule resources.

#
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interestingly enough, this is why we have https://github.com/voxpupuli/puppet-lint-param-docs. However, it's disabled here and somehow doesn't catch it. That's a bug.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing @ekohl thanks for this find!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the most common mistake I've seen with puppet-strings. When things disappear, look for empty lines.

# @param backup_enable Whether a backup job should be enabled.
# @param backup_options A hash of options that should be passed through to the backup provider.
# @param backup_provider Specifies the backup provider to use.
Expand Down