Skip to content

Commit

Permalink
Finalize RockyLinux 8 support (#63)
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-riddle authored Aug 1, 2023
1 parent fc2bd81 commit 8aca80a
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 45 deletions.
1 change: 1 addition & 0 deletions .github/workflows/pr_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ jobs:
puppet_version: '~> 8.0'
ruby_version: 3.1
experimental: true
fail-fast: false
env:
PUPPET_VERSION: ${{matrix.puppet.puppet_version}}
steps:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ dist
/junit
/log
/doc
/Gemfile.lock
1 change: 1 addition & 0 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,7 @@ pup7.pe-unit:
<<: *pup_7_pe
<<: *unit_tests

# Commenting until Puppet 8 is released
#pup8.x-unit:
# <<: *pup_8_x
# <<: *unit_tests
Expand Down
115 changes: 70 additions & 45 deletions REFERENCE.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,63 @@
# Reference

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

## Table of Contents

**Classes**
### Classes

* [`incron`](#incron): This class manages /etc/incron.allow and /etc/incron.deny and the incrond service.
* [`incron::service`](#incronservice): This class wraps the incrond service
* [`incron::service`](#incron--service): This class wraps the incrond service

**Defined types**
### Defined types

* [`incron::system_table`](#incronsystem_table): Add a system table $name to /etc/incron.d If multiple ``path`` and/or ``command`` options are specified, they will be expanded into all matc
* [`incron::user`](#incronuser): Add the user ``$name`` to ``/etc/incron.allow``
* [`incron::system_table`](#incron--system_table): Add a system table $name to /etc/incron.d If multiple ``path`` and/or ``command`` options are specified, they will be expanded into all matc
* [`incron::user`](#incron--user): Add the user ``$name`` to ``/etc/incron.allow``

**Resource types**
### Resource types

* [`incron_system_table`](#incron_system_table): Creates an 'incrond' compatible system table Line order will be preserved Any paths that contain globs '*' will be expanded into the approp

**Data types**
### Data types

* [`Incron::Mask`](#incronmask): Valid incron masks
* [`Incron::Mask`](#Incron--Mask): Valid incron masks

## Classes

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

This class manages /etc/incron.allow and /etc/incron.deny and the
incrond service.

#### Parameters

The following parameters are available in the `incron` class.
The following parameters are available in the `incron` class:

* [`package_ensure`](#-incron--package_ensure)
* [`users`](#-incron--users)
* [`max_open_files`](#-incron--max_open_files)
* [`system_table`](#-incron--system_table)
* [`purge`](#-incron--purge)

##### `package_ensure`
##### <a name="-incron--package_ensure"></a>`package_ensure`

Data type: `String`

The ``ensure`` parameter of ``Package`` resources in the ``incron``
namespace.

Default value: simplib::lookup('simp_options::package_ensure', { 'default_value' => 'installed' })
Default value: `simplib::lookup('simp_options::package_ensure', { 'default_value' => 'installed' })`

##### `users`
##### <a name="-incron--users"></a>`users`

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

An Array of additional incron users, using the defined type
incron::user.

Default value: []
Default value: `[]`

##### `max_open_files`
##### <a name="-incron--max_open_files"></a>`max_open_files`

Data type: `Variant[Enum['unlimited'],Integer[0]]`

Expand All @@ -61,31 +68,31 @@ The maximum open files limit that should be set for incrond
that it is simply overwhelming your system (and analyze your incrond
rules).

Default value: 'unlimited'
Default value: `'unlimited'`

##### `system_table`
##### <a name="-incron--system_table"></a>`system_table`

Data type: `Hash`

Create incron::system_table resources with hiera

Default value: {}
Default value: `{}`

##### `purge`
##### <a name="-incron--purge"></a>`purge`

Data type: `Boolean`

Whether or not to purge unknown incron tables

Default value: `false`

### incron::service
### <a name="incron--service"></a>`incron::service`

This class wraps the incrond service

## Defined types

### incron::system_table
### <a name="incron--system_table"></a>`incron::system_table`

Add a system table $name to /etc/incron.d

Expand Down Expand Up @@ -130,17 +137,23 @@ Results in /etc/incron.d/glob with contents:

#### Parameters

The following parameters are available in the `incron::system_table` defined type.
The following parameters are available in the `incron::system_table` defined type:

* [`enable`](#-incron--system_table--enable)
* [`path`](#-incron--system_table--path)
* [`mask`](#-incron--system_table--mask)
* [`command`](#-incron--system_table--command)
* [`custom_content`](#-incron--system_table--custom_content)

##### `enable`
##### <a name="-incron--system_table--enable"></a>`enable`

Data type: `Boolean`

Whether to enable or disable the table

Default value: `true`

##### `path`
##### <a name="-incron--system_table--path"></a>`path`

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

Expand All @@ -150,23 +163,23 @@ Filesystem path(s) to monitor

Default value: `undef`

##### `mask`
##### <a name="-incron--system_table--mask"></a>`mask`

Data type: `Array[String]`

Symbolic array or numeric mask for events

Default value: ['IN_MODIFY','IN_MOVE','IN_CREATE','IN_DELETE']
Default value: `['IN_MODIFY','IN_MOVE','IN_CREATE','IN_DELETE']`

##### `command`
##### <a name="-incron--system_table--command"></a>`command`

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

Command(s) to run on detection of event in $path

Default value: `undef`

##### `custom_content`
##### <a name="-incron--system_table--custom_content"></a>`custom_content`

Data type: `Optional[String]`

Expand All @@ -175,13 +188,13 @@ Defining this disables validation on the content and take priority.

Default value: `undef`

### incron::user
### <a name="incron--user"></a>`incron::user`

Add the user ``$name`` to ``/etc/incron.allow``

## Resource types

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

Creates an 'incrond' compatible system table

Expand All @@ -202,44 +215,56 @@ The following properties are available in the `incron_system_table` type.

##### `ensure`

Valid values: present, absent
Valid values: `present`, `absent`

The state that should be enforced for the table

Default value: present
Default value: `present`

#### Parameters

The following parameters are available in the `incron_system_table` type.

##### `name`
* [`command`](#-incron_system_table--command)
* [`content`](#-incron_system_table--content)
* [`mask`](#-incron_system_table--mask)
* [`name`](#-incron_system_table--name)
* [`path`](#-incron_system_table--path)
* [`provider`](#-incron_system_table--provider)

namevar
##### <a name="-incron_system_table--command"></a>`command`

The filename to use for the table - Non-word characters will be replaced
The command(s) to apply when the paths change

##### `path`
If multiple paths and commands are specified, they will create multiple
lines that contain all possible combinations

Path(s) to watch and apply the `command`
##### <a name="-incron_system_table--content"></a>`content`

Raw content to add to the file - Will be validated

##### `mask`
##### <a name="-incron_system_table--mask"></a>`mask`

The incron "masks" to apply

##### `command`
##### <a name="-incron_system_table--name"></a>`name`

The command(s) to apply when the paths change
namevar

If multiple paths and commands are specified, they will create multiple
lines that contain all possible combinations
The filename to use for the table - Non-word characters will be replaced

##### `content`
##### <a name="-incron_system_table--path"></a>`path`

Raw content to add to the file - Will be validated
Path(s) to watch and apply the `command`

##### <a name="-incron_system_table--provider"></a>`provider`

The specific backend to use for this `incron_system_table` resource. You will seldom need to specify this --- Puppet
will usually discover the appropriate provider for your platform.

## Data types

### Incron::Mask
### <a name="Incron--Mask"></a>`Incron::Mask`

Valid incron masks

Expand Down

0 comments on commit 8aca80a

Please sign in to comment.