Defined Type: profile::mediawiki::periodic_job

Defined in:
modules/profile/manifests/mediawiki/periodic_job.pp

Overview

define profile::mediawiki::periodic_job

Helper for defining multi-dc-safe MediaWiki jobs as systemd timers.

This allows to run the timers in both dcs, but only execute the commands in the active dc. (per conftool)

Parameters

command

The command to execute

interval

The frequency with which the job must be executed, expressed as one of the Calendar expressions accepted by systemd. See systemd.time(7)

splay

Sets a maximum delay to wait before starting the timer

ensure

Either 'present' or 'absent'. Default: present

Parameters:

  • command (String)
  • interval (Variant[ Systemd::Timer::Interval, Systemd::Timer::Datetime ])
  • ensure (Wmflib::Ensure) (defaults to: present)
  • splay (Optional[Integer]) (defaults to: undef) 


19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'modules/profile/manifests/mediawiki/periodic_job.pp', line 19

define profile::mediawiki::periodic_job(
    String $command,
    Variant[
        Systemd::Timer::Interval,
        Systemd::Timer::Datetime
    ] $interval,
    Wmflib::Ensure $ensure = present,
    Optional[Integer] $splay = undef,
) {
    require ::profile::mediawiki::common
    require ::profile::conftool::state

    systemd::timer::job { "mediawiki_job_${title}":
        ensure            => $ensure,
        description       => "MediaWiki periodic job ${title}",
        command           => "/usr/local/bin/mw-cli-wrapper ${command}",
        interval          => {'start' => 'OnCalendar', 'interval' => $interval},
        user              => $::mediawiki::users::web,
        logfile_basedir   => '/var/log/mediawiki',
        logfile_group     => $::mediawiki::users::web,
        syslog_identifier => "mediawiki_job_${title}",
        splay             => $splay,
        require           => File['/usr/local/bin/mw-cli-wrapper']
    }
}