cron_core

Table of Contents

1. Description
2. Reference
3. Limitations - OS compatibility, etc.
4. Development - Guide for contributing to the module

Description

Install and manage cron resources.

Reference

Please see REFERENCE.md for the reference documentation.

This module is documented using Puppet Strings.

For a quick primer on how Strings works, please see this blog post or the README.md for Puppet Strings.

To generate documentation locally, run:

bundle install
bundle exec puppet strings generate ./lib/**/*.rb

This command will create a browsable _index.html file in the doc directory. The references available here are all generated from YARD-style comments embedded in the code base. When any development happens on this module, the impacted documentation should also be updated.

Limitations

cron is not compatible Windows or Fedora 28.

Development

Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.

We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

For more information, see our module contribution guide.

Reference

Table of Contents

Resource types

• cron: Installs and manages cron jobs. Every cron resource created by Puppet requires a command and at least one periodic attribute (hour, minute, m

Resource types

cron

Installs and manages cron jobs. Every cron resource created by Puppet requires a command and at least one periodic attribute (hour, minute, month, monthday, weekday, or special). While the name of the cron job is not part of the actual job, the name is stored in a comment beginning with # Puppet Name: . These comments are used to match crontab entries created by Puppet with cron resources.

If an existing crontab entry happens to match the scheduling and command of a cron resource that has never been synced, Puppet defers to the existing crontab entry and does not create a new entry tagged with the # Puppet Name: comment.

Example:

cron { 'logrotate':
  command => '/usr/sbin/logrotate',
  user    => 'root',
  hour    => 2,
  minute  => 0,
}

Note that all periodic attributes can be specified as an array of values:

cron { 'logrotate':
  command => '/usr/sbin/logrotate',
  user    => 'root',
  hour    => [2, 4],
}

...or using ranges or the step syntax */2 (although there's no guarantee that your cron daemon supports these):

cron { 'logrotate':
  command => '/usr/sbin/logrotate',
  user    => 'root',
  hour    => ['2-4'],
  minute  => '*/10',
}

Important: The Cron type will not reset parameters that are removed from a manifest. For example, removing a minute => 10 parameter will not reset the minute component of the associated cronjob to *. These changes must be expressed by setting the parameter to minute => absent because Puppet only manages parameters that are out of sync with manifest entries.

Autorequires: If Puppet is managing the user account specified by the user property of a cron resource, then the cron resource will autorequire that user.

Properties

The following properties are available in the cron type.

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

command

The command to execute in the cron job. The environment provided to the command varies by local system rules, and it is best to always provide a fully qualified command. The user's profile is not sourced when the command is run, so if the user's environment is desired it should be sourced manually.

All cron parameters support absent as a value; this will remove any existing values for that field.

special

A special value such as 'reboot' or 'annually'. Only available on supported systems such as Vixie Cron. Overrides more specific time of day/week settings. Set to 'absent' to make puppet revert to a plain numeric schedule.

minute

The minute at which to run the cron job. Optional; if specified, must be between 0 and 59, inclusive.

hour

The hour at which to run the cron job. Optional; if specified, must be between 0 and 23, inclusive.

weekday

The weekday on which to run the command. Optional; if specified, must be either:

• A number between 0 and 7, inclusive, with 0 or 7 being Sunday
• The name of the day, such as 'Tuesday'.

month

The month of the year. Optional; if specified, must be either:

• A number between 1 and 12, inclusive, with 1 being January
• The name of the month, such as 'December'.

monthday

The day of the month on which to run the command. Optional; if specified, must be between 1 and 31.

environment

Any environment settings associated with this cron job. They will be stored between the header and the job in the crontab. There can be no guarantees that other, earlier settings will not also affect a given cron job.

Also, Puppet cannot automatically determine whether an existing, unmanaged environment setting is associated with a given cron job. If you already have cron jobs with environment settings, then Puppet will keep those settings in the same place in the file, but will not associate them with a specific job.

Settings should be specified exactly as they should appear in the crontab, like PATH=/bin:/usr/bin:/usr/sbin.

user

The user who owns the cron job. This user must be allowed to run cron jobs, which is not currently checked by Puppet.

This property defaults to the user running Puppet or root.

The default crontab provider executes the system crontab using the user account specified by this property.

target

The name of the crontab file in which the cron job should be stored.

This property defaults to the value of the user property if set, the user running Puppet or root.

For the default crontab provider, this property is functionally equivalent to the user property and should be avoided. In particular, setting both user and target to different values will result in undefined behavior.

Parameters

The following parameters are available in the cron type.

name

namevar

The symbolic name of the cron job. This name is used for human reference only and is generated automatically for cron jobs found on the system. This generally won't matter, as Puppet will do its best to match existing cron jobs against specified jobs (and Puppet adds a comment to cron jobs it adds), but it is at least possible that converting from unmanaged jobs to managed jobs might require manual intervention.

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.

Release 1.0.0 2018-08-30

Summary This is the initial release of the extracted cron module.