Puppet Cron Module

Notes

This module manages cronjobs by placing files in /etc/cron.d. rmueller-cron was a detached fork of torrancew/puppet-cron After v1.0.0, the module was migrated to Vox Pupuli where it is now maintained and released under the puppet namespace.

The current version (starting with v1.0.0) of this module requires Puppet 4.9.1 or greater. If you are using an older version of Puppet you can pin the version to v0.2.1 which was still compatible with much older Puppet versions. You can browse the documentation of that version in the v0.2.x branch here.

This module supports configuration of cronjobs via Hiera as well. For that you need to declare the cron class.

This module defines the following types:

• cron::job - basic job resource
• cron::job::multiple - basic job resource for multiple jobs per file
• cron::hourly - wrapper for hourly jobs
• cron::daily - wrapper for daily jobs
• cron::weekly - wrapper for weekly jobs
• cron::monthly - wrapper for monthly jobs

Installation

As usual use puppet module install puppet-cron to install it.

Usage

The title of the job (e.g. cron::job { 'title':) is completely arbitrary. However, there can only be one cron job by that name. The file in /etc/cron.d/ will be created with the $title as the file name. Keep that in mind when choosing the name to avoid overwriting existing system cronjobs and use characters that don't cause problems when used in filenames.

cron

If you want the class to automatically install the correct cron package you can declare the cron class. By default it will then install the right package. If you want to use Hiera to configure your cronjobs, you must declare the cron class.

You can disable the management of the cron package by setting the manage_package parameter to false.

You can also specify a different cron package name via package_name. By default we try to select the right one for your distribution. But in some cases (e.g. Gentoo) you might want to overwrite it here.

Examples:

  include cron

or:

  class { 'cron':
    manage_package => false,
  }

Add custom crontab run-parts

class { 'cron':
  manage_crontab    => true,
  crontab_run_parts => {'5min' => { 'user' => 'root', 'minute' => '*/5' }},
}

cron::job

cron::job creates generic jobs in /etc/cron.d. It allows specifying the following parameters:

• ensure - optional - defaults to "present"
• command - required - the command to execute
• minute - optional - defaults to "*"
• hour - optional - defaults to "*"
• date - optional - defaults to "*"
• month - optional - defaults to "*"
• weekday - optional - defaults to "*"
• special - optional - defaults to undef
• user - optional - defaults to "root"
• environment - optional - defaults to ""
• mode - optional - defaults to "0600"
• description - optional - defaults to undef

Example: This would create the file /etc/cron.d/mysqlbackup and run the command mysqldump -u root mydb as root at 2:40 AM every day:

  cron::job { 'mysqlbackup':
    minute      => '40',
    hour        => '2',
    date        => '*',
    month       => '*',
    weekday     => '*',
    user        => 'root',
    command     => 'mysqldump -u root mydb',
    environment => [ 'MAILTO=root', 'PATH="/usr/bin:/bin"', ],
    description => 'Mysql backup',
  }

Hiera example:

---
cron::job:
  'mysqlbackup':
    command: 'mysqldump -u root mydb'
    minute: 0
    hour: 0
    date: '*'
    month: '*'
    weekday: '*'
    user: root
    environment:
      - 'MAILTO=root'
      - 'PATH="/usr/bin:/bin"'
    description: 'Mysql backup'

cron::job::multiple

cron:job::multiple creates a file in /etc/cron.d with multiple cron jobs configured in it. It allows specifying the following parameters:

• ensure - optional - defaults to "present"
• jobs - required - an array of hashes of multiple cron jobs using a similar structure as cron::job-parameters
• environment - optional - defaults to ""
• mode - optional - defaults to "0600"

And the keys of the jobs hash are:

• command - required - the command to execute
• minute - optional - defaults to "*"
• hour - optional - defaults to "*"
• date - optional - defaults to "*"
• month - optional - defaults to "*"
• weekday - optional - defaults to "*"
• special - optional - defaults to undef
• user - optional - defaults to "root"
• description - optional - defaults to undef

Example:

cron::job::multiple { 'test_cron_job_multiple':
  jobs => [
    {
      minute      => '55',
      hour        => '5',
      date        => '*',
      month       => '*',
      weekday     => '*',
      user        => 'rmueller',
      command     => '/usr/bin/uname',
      description => 'print system information',
    },
    {
      command     => '/usr/bin/sleep 1',
      description => 'Sleeping',
    },
    {
      command     => '/usr/bin/sleep 10',
      special     => 'reboot',
    },
  ],
  environment => [ 'PATH="/usr/sbin:/usr/bin:/sbin:/bin"' ],
}

Hiera example:

---
cron::job::multiple:
  'test_cron_job_multiple':
    jobs:
      - {
          minute: 55,
          hour: 5,
          date: '*',
          month: '*',
          weekday: '*',
          user: rmueller,
          command: '/usr/bin/uname',
          description: 'print system information',
        }
      - {
          command: '/usr/bin/sleep 1',
          description: 'Sleeping',
        }
      - {
          command: '/usr/bin/sleep 10',
          special: 'reboot',
        }

    environment:
      - 'PATH="/usr/sbin:/usr/bin:/sbin:/bin"'

That will generate the file /etc/cron.d/test_cron_job_multiple with essentially this content:

PATH="/usr/sbin:/usr/bin:/sbin:/bin"

55 5 * * *  rmueller  /usr/bin/uname
* * * * *  root  /usr/bin/sleep 1
@reboot  root  /usr/bin/sleep 10

cron::hourly

cron::hourly creates jobs in /etc/cron.d that run once per hour. It allows specifying the following parameters:

• ensure - optional - defaults to "present"
• command - required - the command to execute
• minute - optional - defaults to "0"
• user - optional - defaults to "root"
• environment - optional - defaults to ""
• mode - optional - defaults to "0600"
• description - optional - defaults to undef

Example: This would create the file /etc/cron.d/mysqlbackup_hourly and run the command mysqldump -u root mydb as root on the 20th minute of every hour:

  cron::hourly { 'mysqlbackup_hourly':
    minute      => '20',
    user        => 'root',
    command     => 'mysqldump -u root mydb',
    environment => [ 'MAILTO=root', 'PATH="/usr/bin:/bin"', ],
  }

Hiera example:

---
cron::hourly:
  'mysqlbackup_hourly':
    minute: 20
    user: root
    command: 'mysqldump -u root mydb'
    environment:
      - 'MAILTO=root'
      - 'PATH="/usr/bin:/bin"'

cron::daily

cron::daily creates jobs in /etc/cron.d that run once per day. It allows specifying the following parameters:

• ensure - optional - defaults to "present"
• command - required - the command to execute
• minute - optional - defaults to "0"
• hour - optional - defaults to "0"
• user - optional - defaults to "root"
• environment - optional - defaults to ""
• mode - optional - defaults to "0600"
• description - optional - defaults to undef

Example: This would create the file /etc/cron.d/mysqlbackup_daily and run the command mysqldump -u root mydb as root at 2:40 AM every day, like the above generic example:

  cron::daily { 'mysqlbackup_daily':
    minute  => '40',
    hour    => '2',
    user    => 'root',
    command => 'mysqldump -u root mydb',
  }

Hiera example:

---
cron::daily:
  'mysqlbackup_daily':
    minute: 40
    hour: 2
    user: root
    command: 'mysqldump -u root mydb'

cron::weekly

cron::weekly creates jobs in /etc/cron.d that run once per week. It allows specifying the following parameters:

• ensure - optional - defaults to "present"
• command - required - the command to execute
• minute - optional - defaults to "0"
• hour - optional - defaults to "0"
• weekday - optional - defaults to "0"
• user - optional - defaults to "root"
• environment - optional - defaults to ""
• mode - optional - defaults to "0600"
• description - optional - defaults to undef

Example: This would create the file /etc/cron.d/mysqlbackup_weekly and run the command mysqldump -u root mydb as root at 4:40 AM every Sunday, like the above generic example:

  cron::weekly { 'mysqlbackup_weekly':
    minute  => '40',
    hour    => '4',
    weekday => '0',
    user    => 'root',
    command => 'mysqldump -u root mydb',
  }

Hiera example:

---
cron::weekly:
  'mysqlbackup_weekly':
    minute: 40
    hour: 4
    weekday: 0
    user: root
    command: 'mysqldump -u root mydb'

cron::monthly

cron::monthly creates jobs in /etc/cron.d that run once per month. It allows specifying the following parameters:

• ensure - optional - defaults to "present"
• command - required - the command to execute
• minute - optional - defaults to "0"
• hour - optional - defaults to "0"
• date - optional - defaults to "1"
• user - optional - defaults to "root"
• environment - optional - defaults to ""
• mode - optional - defaults to "0600"
• description - optional - defaults to undef

Example: This would create the file /etc/cron.d/mysqlbackup_monthly and run the command mysqldump -u root mydb as root at 3:40 AM the 1st of every month, like the above generic example:

  cron::monthly { 'mysqlbackup_monthly':
    minute  => '40',
    hour    => '3',
    date    => '1',
    user    => 'root',
    command => 'mysqldump -u root mydb',
  }

Hiera example:

---
cron::monthly:
  'mysqlbackup_monthly':
    minute: 40
    hour: 3
    date: 1
    user: root
    command: 'mysqldump -u root mydb'

Contributors

• Kevin Goess (@kgoess) - Environment variable support + fixes
• Andy Shinn (@andyshinn) - RedHat derivatives package name fix
• Chris Weyl (@RsrchBoy) - Fixed Puppet 3.2 deprecation warnings
• Mathew Archibald (@mattyindustries) - Fixed file ownership issues
• The Community - Continued improvement of this module via bugs and patches

Reference

Table of Contents

Classes

• cron: This class wraps cron::install for ease of use
• cron::install: This class ensures that the distro-appropriate cron package is installed. This class should not be used directly under normal circumstances. Instead, use the cron class.
• cron::service: This class managed the cron service. This class should not be used directly under normal circumstances. Instead, use the cron class.

Defined types

• cron::daily: This type creates a daily cron job via a file in /etc/cron.d
• cron::hourly: This type creates an hourly cron job via a file in /etc/cron.d
• cron::job: This type creates a cron job via a file in /etc/cron.d
• cron::job::multiple: This type creates multiple cron jobs via a single file in /etc/cron.d/
• cron::monthly: This type creates a monthly cron job via a file in /etc/cron.d
• cron::weekly: This type creates a cron job via a file in /etc/cron.d

Data types

• Cron::Date: Valid $date (day of month) parameter to Cron::Job.
• Cron::Deb_version: Valid .deb version string. See https://www.debian.org/doc/debian-policy/#s-f-version
• Cron::Environment: Valid $environment parameter to Cron::Job.
• Cron::Hour: Valid $hour parameter to Cron::Job.
• Cron::Job_ensure: Valid $ensure parameter to Cron::Job.
• Cron::Jobname: Valid $title parameter to Cron::Job. This is the name of the /etc/cron.d/ file. The Ubuntu run-parts manpage specifies (^[a-zA-Z0-9_-]+$). Fo
• Cron::Minute: Valid $minute parameter to Cron::Job.
• Cron::Month: Valid $month parameter to Cron::Job.
• Cron::Monthname: Short-names for each month.
• Cron::Package_ensure: Valid $service_ensure parameter to Cron.
• Cron::Package_state: Valid $ensure parameter to Package resource. Excludes version numbers.
• Cron::Rpm_version: Valid .rpm version string. See http://www.perlmonks.org/?node_id=237724
• Cron::Run_parts: Valid element of $crontab_run_parts parameter to Class['cron'].
• Cron::Second: Valid $second parameter to Cron::Job.
• Cron::Service_Enable: Valid $service_enable parameter to Cron.
• Cron::Service_ensure: Valid $service_ensure parameter to Cron.
• Cron::Special: Valid $special parameter to Cron::Job.
• Cron::User: Valid $user parameter to Cron::Job.
• Cron::Weekday: Valid $weekday parameter to Cron::Job.
• Cron::Weekdayname: Short names for each day of the week.

Classes

cron

This class wraps cron::install for ease of use

Examples

simply include the module

include cron

include it but don't manage the cron package

class { 'cron':
  manage_package => false,
}

Parameters

The following parameters are available in the cron class:

• service_name
• package_name
• manage_package
• manage_service
• service_ensure
• service_enable
• users_allow
• users_deny
• manage_users_allow
• manage_users_deny
• allow_deny_mode
• merge
• manage_crontab
• crontab_shell
• crontab_path
• crontab_mailto
• crontab_home
• crontab_run_parts
• file_mode
• dir_mode
• package_ensure

service_name

Data type: String[1]

Can be set to define a different cron service name.

package_name

Data type: String[1]

Can be set to install a different cron package.

manage_package

Data type: Boolean

Can be set to disable package installation.

Default value: true

manage_service

Data type: Boolean

Defines if puppet should manage the service.

Default value: true

service_ensure

Data type: Cron::Service_ensure

Defines if the service should be running.

Default value: 'running'

service_enable

Data type: Cron::Service_enable

Defines if the service should be enabled at boot.

Default value: true

users_allow

Data type: Array[Cron::User]

A list of users which are exclusively able to create, edit, display, or remove crontab files. Only used if manage_users_allow == true.

Default value: []

users_deny

Data type: Array[Cron::User]

A list of users which are prohibited from create, edit, display, or remove crontab files. Only used if manage_users_deny == true.

Default value: []

manage_users_allow

Data type: Boolean

If the /etc/cron.allow should be managed.

Default value: false

manage_users_deny

Data type: Boolean

If the /etc/cron.deny should be managed.

Default value: false

allow_deny_mode

Data type: Stdlib::Filemode

Specify the cron.allow/deny file mode.

Default value: '0644'

merge

Data type: Enum['deep', 'first', 'hash', 'unique']

The lookup() merge method to use with cron job hiera lookups.

Default value: 'hash'

manage_crontab

Data type: Boolean

Whether to manage /etc/crontab

Default value: false

crontab_shell

Data type: Stdlib::Absolutepath

The value for SHELL in /etc/crontab

Default value: '/bin/bash'

crontab_path

Data type: String[1]

The value for PATH in /etc/crontab

Default value: '/sbin:/bin:/usr/sbin:/usr/bin'

crontab_mailto

Data type: String[1]

The value for MAILTO in /etc/crontab

Default value: 'root'

crontab_home

Data type: Optional[Stdlib::Absolutepath]

The value for HOME in /etc/crontab

Default value: undef

crontab_run_parts

Data type: Cron::Run_parts

Define sadditional cron::run_parts resources

Default value: {}

file_mode

Data type: Stdlib::Filemode

The file mode for the system crontab file

Default value: '0644'

dir_mode

Data type: Stdlib::Filemode

The file mode for the cron directories

Default value: '0755'

package_ensure

Data type: Cron::Package_ensure

Default value: 'installed'

cron::install

This class ensures that the distro-appropriate cron package is installed. This class should not be used directly under normal circumstances. Instead, use the cron class.

cron::service

This class managed the cron service. This class should not be used directly under normal circumstances. Instead, use the cron class.

Defined types

cron::daily

This type creates a daily cron job via a file in /etc/cron.d

Examples

create a daily cron job with custom PATH environment variable

cron::daily { 'mysql_backup':
  minute      => '1',
  hour        => '3',
  environment => [ 'PATH="/usr/sbin:/usr/bin:/sbin:/bin"' ],
  command     => 'mysqldump -u root my_db >/backups/my_db.sql',
}

Parameters

The following parameters are available in the cron::daily defined type:

• command
• ensure
• minute
• hour
• environment
• user
• mode
• description

command

Data type: Optional[String[1]]

The command to execute.

Default value: undef

ensure

Data type: Cron::Job_ensure

The state to ensure this resource exists in. Can be absent, present.

Default value: 'present'

minute

Data type: Cron::Minute

The minute the cron job should fire on. Can be any valid cron.

Default value: 0

hour

Data type: Cron::Hour

The hour the cron job should fire on. Can be any valid cron hour value.

Default value: 0

environment

Data type: Cron::Environment

An array of environment variable settings.

Default value: []

user

Data type: Cron::User

The user the cron job should be executed as.

Default value: 'root'

mode

Data type: Stdlib::Filemode

The mode to set on the created job file.

Default value: '0600'

description

Data type: Optional[String]

Optional short description, which will be included in the cron job file.

Default value: undef

cron::hourly

This type creates an hourly cron job via a file in /etc/cron.d

Examples

create a daily cron job with custom PATH environment variable

cron::hourly { 'generate_puppetdoc':
  minute      => '1',
  environment => [ 'PATH="/usr/sbin:/usr/bin:/sbin:/bin"' ],
  command     => 'puppet doc >/var/www/puppet_docs.mkd',
}

Parameters

The following parameters are available in the cron::hourly defined type:

• command
• ensure
• minute
• environment
• user
• mode
• description

command

Data type: Optional[String[1]]

The command to execute.

Default value: undef

ensure

Data type: Cron::Job_ensure

The state to ensure this resource exists in. Can be absent, present.

Default value: 'present'

minute

Data type: Cron::Minute

The minute the cron job should fire on. Can be any valid cron.

Default value: 0

environment

Data type: Cron::Environment

An array of environment variable settings.

Default value: []

user

Data type: Cron::User

The user the cron job should be executed as.

Default value: 'root'

mode

Data type: Stdlib::Filemode

The mode to set on the created job file.

Default value: '0600'

description

Data type: Optional[String]

Optional short description, which will be included in the cron job file.

Default value: undef

cron::job

This type creates a cron job via a file in /etc/cron.d

Examples

create a cron job

cron::job { 'generate_puppetdoc':
  minute      => '01',
  environment => [ 'PATH="/usr/sbin:/usr/bin:/sbin:/bin"' ],
  command     => 'puppet doc /etc/puppet/modules >/var/www/puppet_docs.mkd',
}

Parameters

The following parameters are available in the cron::job defined type:

• command
• ensure
• minute
• hour
• date
• month
• weekday
• special
• environment
• user
• group
• mode
• description

command

Data type: Optional[String[1]]

The command to execute.

Default value: undef

ensure

Data type: Cron::Job_ensure

The state to ensure this resource exists in. Can be absent, present.

Default value: 'present'

minute

Data type: Cron::Minute

The minute the cron job should fire on. Can be any valid cron.

Default value: '*'

hour

Data type: Cron::Hour

The hour the cron job should fire on. Can be any valid cron hour.

Default value: '*'

date

Data type: Cron::Date

The date the cron job should fire on. Can be any valid cron date.

Default value: '*'

month

Data type: Cron::Month

The month the cron job should fire on. Can be any valid cron month.

Default value: '*'

weekday

Data type: Cron::Weekday

The day of the week the cron job should fire on. Can be any valid cron weekday value.

Default value: '*'

special

Data type: Cron::Special

A crontab specific keyword like 'reboot'.

Default value: undef

environment

Data type: Cron::Environment

An array of environment variable settings.

Default value: []

user

Data type: Cron::User

The user the cron job should be executed as.

Default value: 'root'

group

Data type: Variant[String[1],Integer[0]]

the group the cron job file should by owned by.

Default value: 0

mode

Data type: Stdlib::Filemode

The mode to set on the created job file.

Default value: '0600'

description

Data type: Optional[String]

Optional short description, which will be included in the cron job file.

Default value: undef

cron::job::multiple

This type creates multiple cron jobs via a single file in /etc/cron.d/

Examples

create multiple cron jobs at once

cron::job::multiple { 'test':
  jobs => [
    {
      minute      => '55',
      hour        => '5',
      date        => '*',
      month       => '*',
      weekday     => '*',
      user        => 'rmueller',
      command     => '/usr/bin/uname',
    },
    {
      command     => '/usr/bin/sleep 1',
    },
    {
      command     => '/usr/bin/sleep 10',
      special     => 'reboot',
    },
  ],
  environment => [ 'PATH="/usr/sbin:/usr/bin:/sbin:/bin"' ],
}

Parameters

The following parameters are available in the cron::job::multiple defined type:

• jobs
• ensure
• environment
• mode

jobs

Data type:

Array[Struct[{
        Optional['command']     => String[1],
        Optional['minute']      => Cron::Minute,
        Optional['hour']        => Cron::Hour,
        Optional['date']        => Cron::Date,
        Optional['month']       => Cron::Month,
        Optional['weekday']     => Cron::Weekday,
        Optional['special']     => Cron::Special,
        Optional['user']        => Cron::User,
        Optional['description'] => String,
  }]]

A hash of multiple cron jobs using the same structure as cron::job and using the same defaults for each parameter.

ensure

Data type: Cron::Job_ensure

The state to ensure this resource exists in. Can be absent, present.

Default value: 'present'

environment

Data type: Cron::Environment

An array of environment variable settings.

Default value: []

mode

Data type: Stdlib::Filemode

The mode to set on the created job file.

Default value: '0600'

cron::monthly

This type creates a monthly cron job via a file in /etc/cron.d

Examples

create a cron job that runs monthly on a 28. day at 7 am and 1 minute

cron::monthly { 'delete_old_log_files':
  minute      => '1',
  hour        => '7',
  date        => '28',
  environment => [ 'MAILTO="admin@example.com"' ],
  command     => 'find /var/log -type f -ctime +30 -delete',
}

Parameters

The following parameters are available in the cron::monthly defined type:

• command
• ensure
• minute
• hour
• date
• environment
• user
• mode
• description

command

Data type: Optional[String[1]]

The command to execute.

Default value: undef

ensure

Data type: Cron::Job_ensure

The state to ensure this resource exists in. Can be absent, present.

Default value: 'present'

minute

Data type: Cron::Minute

The minute the cron job should fire on. Can be any valid cron value.

Default value: 0

hour

Data type: Cron::Hour

The hour the cron job should fire on. Can be any valid cron hour value.

Default value: 0

date

Data type: Cron::Date

The date the cron job should fire on. Can be any valid cron date value.

Default value: 1

environment

Data type: Cron::Environment

An array of environment variable settings.

Default value: []

user

Data type: Cron::User

The user the cron job should be executed as.

Default value: 'root'

mode

Data type: Stdlib::Filemode

The mode to set on the created job file.

Default value: '0600'

description

Data type: Optional[String]

Optional short description, which will be included in the cron job file.

Default value: undef

cron::weekly

This type creates a cron job via a file in /etc/cron.d

Examples

create a weekly cron that runs on the 7th day at 4 am and 1 minute

cron::weekly { 'delete_old_temp_files':
  minute      => '1',
  hour        => '4',
  weekday     => '7',
  environment => [ 'MAILTO="admin@example.com"' ],
  command     => 'find /tmp -type f -ctime +7 -delete',
}

Parameters

The following parameters are available in the cron::weekly defined type:

• command
• ensure
• minute
• hour
• weekday
• user
• mode
• environment
• description

command

Data type: Optional[String[1]]

The command to execute.

Default value: undef

ensure

Data type: Cron::Job_ensure

The state to ensure this resource exists in. Can be absent, present.

Default value: 'present'

minute

Data type: Cron::Minute

The minute the cron job should fire on. Can be any valid cron.

Default value: 0

hour

Data type: Cron::Hour

The hour the cron job should fire on. Can be any valid cron hour value.

Default value: 0

weekday

Data type: Cron::Weekday

The day of the week the cron job should fire on. Can be any valid cron weekday value.

Default value: 0

user

Data type: Cron::User

The user the cron job should be executed as.

Default value: 'root'

mode

Data type: Stdlib::Filemode

The mode to set on the created job file.

Default value: '0600'

environment

Data type: Cron::Environment

An array of environment variable settings.

Default value: []

description

Data type: Optional[String]

Optional short description, which will be included in the cron job file.

Default value: undef

Data types

Cron::Date

Valid $date (day of month) parameter to Cron::Job.

Alias of

Variant[Integer[1,31], Pattern[/(?x)\A(
    \* ( \/ ( [12][0-9]?|3[01]?|[4-9] ) )?
    |       ( [12][0-9]?|3[01]?|[4-9] ) ( - ( [12][0-9]?|3[01]?|[4-9] ) ( \/ ( [12][0-9]?|3[01]?|[4-9] ) )? )?
       ( ,  ( [12][0-9]?|3[01]?|[4-9] ) ( - ( [12][0-9]?|3[01]?|[4-9] ) ( \/ ( [12][0-9]?|3[01]?|[4-9] ) )? )? )*
  )\z/]]

Cron::Deb_version

Valid .deb version string. See https://www.debian.org/doc/debian-policy/#s-f-version

Alias of Pattern[/(?i:\A(((0|[1-9][0-9]*):)?[0-9]([a-z0-9.+-~]*|[a-z0-9.+~]*-[a-z0-9+.~]+))\z)/]

Cron::Environment

Valid $environment parameter to Cron::Job.

Alias of Array[Variant[Pattern[/(?i:\A[a-z_][a-z0-9_]*=[^\0]*\z)/],Sensitive[Pattern[/(?i:\A[a-z_][a-z0-9_]*=[^\0]*\z)/]]]]

Cron::Hour

Valid $hour parameter to Cron::Job.

Alias of

Variant[Integer[0,23], Pattern[/(?x)\A(
    \* ( \/ ( 1[0-9]|2[0-3]|[1-9] ) )?
    |       ( 1?[0-9]|2[0-3] ) ( - ( 1?[0-9]|2[0-3] ) ( \/ ( 1[0-9]|2[0-3]|[1-9] ) )? )?
        ( , ( 1?[0-9]|2[0-3] ) ( - ( 1?[0-9]|2[0-3] ) ( \/ ( 1[0-9]|2[0-3]|[1-9] ) )? )? )*
  )\z/]]

Cron::Job_ensure

Valid $ensure parameter to Cron::Job.

Alias of Enum['absent', 'present']

Cron::Jobname

Valid $title parameter to Cron::Job. This is the name of the /etc/cron.d/ file. The Ubuntu run-parts manpage specifies (^[a-zA-Z0-9_-]+$). For Cronie, the documentation is (unfortunately) in the code:

• Ignore files starting with "." or "#"
• Ignore the CRON_HOSTNAME file (default ".cron.hostname").
• Ignore files whose length is zero or greater than NAME_MAX (default 255).
• Ignore files whose name ends in "~".
• Ignore files whose name ends in ".rpmsave", ".rpmorig", or ".rpmnew". We will use the most restrictive combination. See http://manpages.ubuntu.com/manpages/zesty/en/man8/run-parts.8.html See https://github.com/cronie-crond/cronie/blob/master/src/database.c#L625

Alias of Pattern[/(?i:\A[a-z0-9_-]{1,255}\z)/]

Cron::Minute

Valid $minute parameter to Cron::Job.

Alias of

Variant[Integer[0,59], Pattern[/(?x)\A(
    \* ( \/ ( [1-5][0-9]?|[6-9] ) )?
    |         [1-5]?[0-9] ( - [1-5]?[0-9] ( \/ ( [1-5][0-9]?|[6-9] ) )? )?
        ( ,   [1-5]?[0-9] ( - [1-5]?[0-9] ( \/ ( [1-5][0-9]?|[6-9] ) )? )? )*
  )\z/]]

Cron::Month

Valid $month parameter to Cron::Job.

Alias of

Variant[Cron::Monthname, Integer[1,12], Pattern[/(?x)\A(
    \* ( \/ ( 1[012]?|[2-9] ) )?
    |       ( 1[012]?|[2-9] ) ( - ( 1[012]?|[2-9] ) ( \/ ( 1[012]?|[2-9] ) )? )?
        ( , ( 1[012]?|[2-9] ) ( - ( 1[012]?|[2-9] ) ( \/ ( 1[012]?|[2-9] ) )? )? )*
  )\z/]]

Cron::Monthname

Short-names for each month.

Alias of Enum['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']

Cron::Package_ensure

Valid $service_ensure parameter to Cron.

Alias of Variant[Cron::Package_state, Cron::Deb_version, Cron::Rpm_version]

Cron::Package_state

Valid $ensure parameter to Package resource. Excludes version numbers.

Alias of Enum['absent', 'installed', 'held', 'latest', 'present', 'purged']

Cron::Rpm_version

Valid .rpm version string. See http://www.perlmonks.org/?node_id=237724

Alias of Pattern[/\A[^-]+(-[^-])?\z/]

Cron::Run_parts

Valid element of $crontab_run_parts parameter to Class['cron'].

Alias of

Hash[Cron::Jobname, Struct[{
    NotUndef['user']       => Cron::User,
    Optional['minute']     => Cron::Minute,
    Optional['hour']       => Cron::Hour,
    Optional['dayofmonth'] => Cron::Date,
    Optional['month']      => Cron::Month,
    Optional['dayofweek']  => Cron::Weekday,
  }]]

Cron::Second

Valid $second parameter to Cron::Job.

Alias of Cron::Minute

Cron::Service_Enable

Valid $service_enable parameter to Cron.

Alias of Variant[Boolean, Enum['manual','mask']]

Cron::Service_ensure

Valid $service_ensure parameter to Cron.

Alias of Variant[Boolean, Enum['running','stopped']]

Cron::Special

Valid $special parameter to Cron::Job.

Alias of

Optional[Enum['annually',
    'daily',
    'hourly',
    'midnight',
    'monthly',
    'reboot',
    'weekly',
    'yearly',
  ]]

Cron::User

Valid $user parameter to Cron::Job.

Alias of Pattern[/(?i:\A\w[a-z0-9_\.-]{0,30}[a-z0-9_$-]\z)/]

Cron::Weekday

Valid $weekday parameter to Cron::Job.

Alias of

Variant[Cron::Weekdayname, Integer[0,7], Pattern[/(?x)\A(
    \* ( \/ [1-7] )?
    |       [0-7] ( - [0-7] ( \/ [1-7] )? )?
        ( , [0-7] ( - [0-7] ( \/ [1-7] )? )? )*
  )\z/]]

Cron::Weekdayname

Short names for each day of the week.

Alias of Enum['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat']

Changelog

All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.

v5.0.0 (2024-12-10)

Full Changelog

Breaking changes:

• Drop support for EL7 as it is end of life #151 (ghoneycutt)
• Support for sensitive environment variables #111 (teluq-pbrideau)

Implemented enhancements:

• Add EL9 support #141 (bastelfreak)

Fixed bugs:

• remove superfluous empty line from job template #144 (vchepkov)
• cleanup remnants of RHEL5 #143 (vchepkov)

v4.2.0 (2024-07-10)

Full Changelog

Implemented enhancements:

• Add support for FreeBSD 14 #136 (smortex)
• Add parameters for file/directory modes #134 (ludovicus3)

Merged pull requests:

• refactor: define job::multiple template as epp instead of erb #139 (bastelfreak)
• refactor: define job template as epp instead of erb #138 (bastelfreak)
• Remove legacy top-scope syntax #125 (smortex)

v4.1.0 (2023-08-08)

Full Changelog

Implemented enhancements:

• cron::job: make file group configureable #121 (bastelfreak)
• Replace Cron::Mode type with Stdlib::Filemode #120 (bastelfreak)

v4.0.0 (2023-07-31)

Full Changelog

Breaking changes:

• Drop Puppet 6 support #114 (bastelfreak)

Implemented enhancements:

• Add Puppet 8 support #116 (bastelfreak)
• Add more acceptance tests #107 (bastelfreak)
• add basic acceptance tests #106 (bastelfreak)

Merged pull requests:

• Add AlmaLinux/Rocky support #118 (bastelfreak)
• puppetlabs/stdlib: Allow 9.x #117 (bastelfreak)

v3.0.0 (2021-10-20)

Full Changelog

Breaking changes:

• Drop support for RedHat/CentOS/Scientific 6, Debian 8, FreeBSD 11 (EOL) #98 (smortex)
• metadata: update Puppet requirement to >= 6.1.0 \< 8.0.0; drop puppet 5 support #92 (kenyon)

Implemented enhancements:

• Add support for latest RedHat, CentOS, Scientific, Debian, SLES and FreeBSD #99 (smortex)
• fix file group: use 0 instead of 'root' #87 (igalic)
• add merge option #74 (ghost)
• Allow management of /etc/crontab and adding custom run-parts #35 (treydock)

Fixed bugs:

• Adjust cron.allow / cron.deny permissions #80 (noqqe)

Closed issues:

• Test and enable for Puppet 7 #91
• Fails on FreeBSD because gid 0 is wheel, not root #86
• Can't get weekday options to work as an array of days #84
• Implement CIS Benchmark requirements #65
• Special to support @startup #51

Merged pull requests:

• Make the mode a parameter #95 (daisukixci)
• Allow values lower than 3 for skip hours #94 (scorillo)
• Add puppet-strings docs #88 (baurmatt)
• Resolve puppet-lint notices #85 (jcpunk)
• modulesync 3.0.0 & puppet-lint updates #83 (bastelfreak)

v2.0.0 (2020-01-13)

Full Changelog

Breaking changes:

• drop Ubuntu support #76 (bastelfreak)
• modulesync 2.7.0 and drop puppet 4 #70 (bastelfreak)

Implemented enhancements:

• Changes the defaults of the cronjob-files from 644 to 600 #75 (ralfbosz)
• allow dots in cron::user data type #71 (rwaffen)

Fixed bugs:

• If you attempt to use anything below */3 the regex fails #66 (elmobp)
• Fix job::cron special parameter #64 (alexjfisher)

v1.3.1 (2018-10-14)

Full Changelog

Closed issues:

• Special parameter is now set incorrectly with two @ #59

Merged pull requests:

• modulesync 2.1.0 and allow puppet 6.x #62 (bastelfreak)

v1.3.0 (2018-07-16)

Full Changelog

Implemented enhancements:

• Update data types to allow comma-delimited lists #50 (jcbollinger)

Fixed bugs:

• Comma character in hour/minute parameters #49

v1.2.0 (2018-06-25)

Full Changelog

Fixed bugs:

• Code in init.pp doesn't match defined types #31

Closed issues:

• Make first release under voxpupuli's 'puppet' namespace #36
• Add defined types for parameter validation. #30

Merged pull requests:

• Remove docker nodesets #47 (bastelfreak)
• bump puppet version dependency to >= 4.10.0 \< 6.0.0 #46 (bastelfreak)
• Add types for parameter validation. #29 (pillarsdotnet)

v1.1.1 (2018-01-19)

Full Changelog

Merged pull requests:

• Release 1.1.1 #43 (alexjfisher)
• Fix README.md links #42 (alexjfisher)

v1.1.0 (2018-01-19)

Full Changelog

Fixed bugs:

• Fix hiera lookup regression #40 (alexjfisher)

Merged pull requests:

• Voxpupuli migration #37 (alexjfisher)

v1.0.0 (2017-10-14)

• BREAKING: Require Puppet version >=4.9.1
• Added type-hinting to all manifest parameters
• Added management of /etc/cron.allow and /etc/cron.deny
• Replaced hiera_hash() with lookup() calls
• Replaced params.pp with in-module data (Hiera 5)
• Replaced create_resources with iterators
• Replaced anchor pattern with contain
• Made the cron::job command attribute optional

v0.2.1 (2017-07-30)

• Added support for special time options
• Rspec fixes

v0.2.0 (2016-11-22)

• BREAKING: Added cron service managment The cron service is now managed by this module and by default the service will be started
• Rspec fixes

v0.1.8 (2016-06-26)

• Added support for Scientific Linux

v0.1.7 (2016-06-12)

• Properly support Gentoo
• Documentation fixes
• Rspec fixes

v0.1.6 (2016-04-10)

• Added description parameters

v0.1.5 (2016-03-06)

• Fix release on forge

v0.1.4 (2016-03-06)

• Added possibility to add jobs from hiera
• Added Debian as supported operating system
• Allow declaration of cron class without managing the cron package
• Properly detect RHEL 5 based cron packages
• Fix puppet-lint warnings
• Add more tests

v0.1.3 (2015-09-20)

• Support for multiple cron jobs in a single file added (cron::job::multiple)
• Make manifest code more readable
• Change header in template to fit standard 80 char wide terminals
• Extend README.md

v0.1.2 (2015-08-13)

• Update to new style of Puppet modules (metadata.json)

v0.1.1 (2015-07-12)

• Make module Puppet 4 compatible
• Fix Travis CI integration

v0.1.0 (2013-08-27)

• Add support for the ensure parameter

v0.0.3 (2013-07-04)

• Make job files owned by root
• Fix warnings for Puppet 3.2.2

v0.0.2 (2013-05-11)

• Make mode of job file configurable

v0.0.1 (2013-03-02)

• Initial PuppetForge release

* This Changelog was automatically generated by github_changelog_generator