https://github.com/pegasd/puppet-incron

Puppet module to manage incron and related resources
https://github.com/pegasd/puppet-incron

centos debian fedora incron incron-job incrontab inotify linux puppet redhat ubuntu

Last synced: about 2 months ago
JSON representation

Puppet module to manage incron and related resources

• Host: GitHub
• URL: https://github.com/pegasd/puppet-incron
• Owner: pegasd
• License: apache-2.0
• Created: 2017-02-07T22:21:08.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-09-18T07:27:30.000Z (over 5 years ago)
• Last Synced: 2024-11-15T00:38:38.899Z (2 months ago)
• Topics: centos, debian, fedora, incron, incron-job, incrontab, inotify, linux, puppet, redhat, ubuntu
• Language: Ruby
• Homepage: https://pegasd.github.io/puppet-incron/
• Size: 201 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Configure and manage incron jobs with focus on tidiness

[![Build Status](https://travis-ci.org/pegasd/puppet-incron.svg?branch=master)](https://travis-ci.org/pegasd/puppet-incron)

[![Puppet Forge](https://img.shields.io/puppetforge/v/pegas/incron.svg)](https://forge.puppetlabs.com/pegas/incron)

[![Puppet Forge - Downloads](https://img.shields.io/puppetforge/dt/pegas/incron.svg)](https://forge.puppetlabs.com/pegas/incron)

[![Puppet Forge - Score](https://img.shields.io/puppetforge/f/pegas/incron.svg)](https://forge.puppetlabs.com/pegas/incron)

## Table of Contents

1. [Description](#description)

2. [Setup - The basics of getting started with incron](#setup)

3. [Usage - Configuration options and additional functionality](#usage)

4. [Reference - An under-the-hood peek at what the module is doing and how](#reference)

5. [Limitations - OS compatibility, etc.](#limitations)

6. [Development - Guide for contributing to the module](#development)

## 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:

```puppet

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:

```puppet

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](REFERENCE.md) 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](https://github.com/pegasd/puppet-incron/issues) / [fire up a PR](https://github.com/pegasd/puppet-incron/pulls) / whatever.