incron

Configure and manage incron jobs with focus on tidiness

Module Stats

22,806 downloads

10,750 latest version

5.0 quality score

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

released Sep 18th 2019

This version is compatible with:

Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
Puppet >= 4.10.0 < 7.0.0
, , , ,

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'pegas-incron', '0.7.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add pegas-incron

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install pegas-incron --version 0.7.0

Documentation

pegas/incron — version 0.7.0 Sep 18th 2019

Configure and manage incron jobs with focus on tidiness

Description
Setup - The basics of getting started with incron
Usage - Configuration options and additional functionality
Reference - An under-the-hood peek at what the module is doing and how
Limitations - OS compatibility, etc.
Development - Guide for contributing to the module

Description

This module is an interface for incron jobs with the main idea to be tidy. That means that any jobs that are not managed should not exist on the host.

Once you include incron, simply removing an incron::job from your manifests is sufficient for it to be cleaned up on your next agent run. No need to ensure => absent anymore. Enjoy!

Setup

Beginning with incron

To start out with incron:

include incron

This will install the required package, enable incron service and start managing /etc/incron.d directory.

Warning: all unmanaged files in /etc/incron.d will be removed at this point. Be careful!

Usage

All interactions with incron jobs should be done using incron::job resource.

It works with at least 3 parameters:

incron::job { 'upload_file':
  path    => '/watched_directory',
  event   => 'IN_CLOSE_WRITE',
  command => '/usr/local/bin/upload_file $#',
}

Reference

Type Aliases

Incron::Event - supported inotify events.

Full reference

Check out REFERENCE for up-to-date details.

Limitations

Acceptance suite is run on the following GNU/Linux distributions:
- Ubuntu 14.04
- Ubuntu 16.04
- Ubuntu 18.04
- Debian 8
- CentOS 7
- Fedora 30

Development

I'll be happy to know you're using this for one reason or the other. And if you want to contribute - even better. Feel free to submit an issue / fire up a PR / whatever.

Reference

Classes

Public Classes

incron: Main entry point for incron class which must be included in order to start managing all incron-related resources.

Private Classes

incron::config: This class handles incron configuration files.
incron::install: This class handles incron package.
incron::purge: Purge /etc/incron.d and /var/spool/incron directories.
incron::remove: This class handles removal of all incron-related resources.
incron::service: This class handles incron service.

Defined types

incron::job: Primary incron resource used to create incron jobs.
incron::whitelist: Use this to whitelist any system incron jobs you don't want to touch. This will make sure that /etc/incron.d/${title} won't get deleted nor

Data types

Incron::Event: inotify event type

Classes

incron

Main entry point for incron class which must be included in order to start managing all incron-related resources.

Examples

Installing incron

include incron

Uninstalling incron and all related resources

class { 'incron':
  ensure => absent,
}

Parameters

The following parameters are available in the incron class.

`ensure`

Data type: Enum[present, absent]

Whether to enable or disable incron on the system.

Default value: present

`package_version`

Data type: String[1]

Provide custom incron package version here.

Default value: installed

`allowed_users`

Data type: Array[String[1]]

List of users allowed to use incrontab(1). root will be added automatically.

Default value: [ ]

`denied_users`

Data type: Array[String[1]]

List of users specifically denied to use incrontab(1). Note: When this is not empty, all users except ones specified here will be able to use incrontab.

Default value: [ ]

`service_name`

Data type: String[1]

Incron service's name.

Default value: 'incrond'

`service_manage`

Data type: Boolean

Whether to manage incron service at all.

Default value: true

`service_ensure`

Data type: Enum[running, stopped]

Incron service's 'ensure' parameter.

Default value: running

`service_enable`

Data type: Boolean

Incron service's 'enable' parameter.

Default value: true

`purge_noop`

Data type: Boolean

Run purging in noop mode.

Default value: false

Defined types

incron::job

Primary incron resource used to create incron jobs.

Examples

Using incron::job resource

incron::job { 'process_file':
  path    => '/upload',
  event   => 'IN_CLOSE_WRITE',
  command => '/usr/bin/process_file $#',
}

Parameters

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

`command`

Data type: String[1]

Command to execute on triggered event.

`event`

Data type: Variant[Incron::Event, Array[Incron::Event, 2]]

inotify event (or an array of events).

`path`

Data type: Stdlib::Unixpath

Path to watched directory.

`user`

Data type: String[1]

User that owns incron job.

Default value: 'root'

incron::whitelist

Use this to whitelist any system incron jobs you don't want to touch. This will make sure that /etc/incron.d/${title} won't get deleted nor modified.

Examples

Using incron::whitelist resource

incron::whitelist { 'uploader': }

Data types

Incron::Event

inotify event type

Alias of Enum['IN_ALL_EVENTS', 'IN_ACCESS', 'IN_ATTRIB', 'IN_CLOSE_WRITE', 'IN_CLOSE_NOWRITE', 'IN_CREATE', 'IN_DELETE', 'IN_DELETE_SELF', 'IN_MODIFY', 'IN_MOVE_SELF', 'IN_MOVED_FROM', 'IN_MOVED_TO', 'IN_OPEN', 'IN_DONT_FOLLOW', 'IN_ONESHOT', 'IN_ONLYDIR', 'IN_NO_LOOP']

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[Unreleased]

[0.7.0] - 2019-09-18

Added

GH-11: Add Debian, RedHat, Fedora, and CentOS support:
- Add data in modules so that incron service name is different under various distributions
- Add acceptance testing for Debian 8, CentOS 7, and Fedora 30

Changed

Lower requirement for Puppet version is now bumped up to 4.10.0 as this is the lowest working version for Hiera 5.
Change testing matrix to only do acceptance testing on latest Puppet versions.
Stop managing group parameter for /var/spool/incron directory and all files that reside there.

[0.6.0] - 2019-08-08

Changed

GH-6: Update stdlib version requirements in metadata.json.
Update REFERENCE.md with data type since Puppet strings started supporting these.
PDK update.

[0.5.0] - 2019-04-09

Added

GH-4: Ability to specify user name for incron::job resource.
New dependency: puppetlabs/concat.
Puppet 6 support (no production code changes).

Changed

GH-4: incron::job now manages jobs through /var/spool/incron/${user} instead of /etc/incron.d/${title}.
Validation, Unit, and Acceptance stages now all include Puppet 6.
Run acceptance tests using new puppet and module install helpers.

Removed

GH-4: $mode parameter for incron::job has now been dropped since it is no longer applicable.

[0.4.0] - 2018-08-17

Added

The module is now PDK-compliant.

Changed

Moved reference to a standalone strings-generated REFERENCE.md.
rspec-puppet-facts started supporting Ubuntu 18.04, so we can use it now. Sweet!

Fixed

puppetlabs_spec_helper's mock_with deprecation warning.
Acceptance tests with latest beaker.

[0.3.0] - 2018-03-14

Added

$incron::purge_noop parameter to run purging in noop mode.
Manage allowed or denied users using $incron::allowed_users and $incron::denied_users.
Manage package version through $incron::package_version parameter.
The following parameters are now available to configure the incron service management:
- $incron::service_manage
- $incron::service_ensure
- $incron::service_enable
Acceptance tests for:
- incron::whitelist
- $incron::allowed_users

Changed

Split up purging into a separate incron::purge manifest.
'ensure => file' where applicable.

Fixed

/etc/incron.* configs now have mode => '0644'.

Removed

$incron::dir_mode parameter.

[0.2.0] - 2018-03-04

Added

Support for lots more inotify events.
Ability to specify an array of events for incron::job.
Acceptance tests.
This CHANGELOG.

Changed

Purge package @ incron::remove.
Manage service on systemd-based systems (Ubuntu 16.04, 18.04) @ incron::remove.

[0.1.0] - 2017-12-15

Added

Initial release.

                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "{}"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright {yyyy} {name of copyright owner}

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

incron

Support the Puppet Community by contributing to this module

Version information

This version is compatible with:

Start using this module

Documentation

Configure and manage incron jobs with focus on tidiness

Table of Contents

Description

Setup

Beginning with incron

Usage

Reference

Type Aliases

Full reference

Limitations

Development

Reference

Table of Contents

Classes

incron

Examples

Installing incron

Uninstalling incron and all related resources

Parameters

ensure

package_version

allowed_users

denied_users

service_name

service_manage

service_ensure

service_enable

purge_noop

Defined types

incron::job

Examples

Using incron::job resource

Parameters

command

event

path

user

incron::whitelist

Examples

Using incron::whitelist resource

Data types

Incron::Event

Changelog

[Unreleased]

[0.7.0] - 2019-09-18

Added

Changed

[0.6.0] - 2019-08-08

Changed

[0.5.0] - 2019-04-09

Added

Changed

Removed

[0.4.0] - 2018-08-17

Added

Changed

Fixed

[0.3.0] - 2018-03-14

Added

Changed

Fixed

Removed

[0.2.0] - 2018-03-04

Added

Changed

`ensure`

`package_version`

`allowed_users`

`denied_users`

`service_name`

`service_manage`

`service_ensure`

`service_enable`

`purge_noop`

`command`

`event`

`path`

`user`