Puppet Class: profile::lists::automation

Defined in:
modules/profile/manifests/lists/automation.pp

Overview

SPDX-License-Identifier: Apache-2.0 automate subscribing users to certain lists introduced for steward-related lists (T351202, T388354)

This class be used to automate syncing the members of a mailman list.

It looks in the data_dir for plain text files with email addresses and then runs a mailman command to sync the members of a mailing list with that file.

It can run in dry-run mode where a timer/service is created except the command executed does not actually make the changes. This is for testing and verifying what would happen with a given input file.

Lists in the “wet-run” (yea, it's actually called that, comes from fire fighting per Wikipedia) lists actually have their members synced.

The other parameters are for automating a sync of the data dirs from another host. Because in this first use case the source is the steward onboarding system on steward* VMs.

Parameters:

  • data_dir (Stdlib::Unixpath) (defaults to: lookup('profile::lists::automation::data_dir', {default_value => '/srv/exports'}))
  • lists_host (Stdlib::Host) (defaults to: lookup('lists_primary_host'))
  • stewards_host (Stdlib::Host) (defaults to: lookup('stewards_primary_host'))
  • ensure (Wmflib::Ensure) (defaults to: lookup('profile::lists::automation::ensure', { default_value => 'absent' }))
  • lists_to_sync_dry (Array[String]) (defaults to: lookup('profile::lists::automation::lists_to_sync_dry_run'))
  • lists_to_sync_wet (Array[String]) (defaults to: lookup('profile::lists::automation::lists_to_sync_wet_run')) 


20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'modules/profile/manifests/lists/automation.pp', line 20

class profile::lists::automation (
    Stdlib::Unixpath $data_dir = lookup('profile::lists::automation::data_dir', {default_value => '/srv/exports'}),
    Stdlib::Host $lists_host = lookup('lists_primary_host'),
    Stdlib::Host $stewards_host = lookup('stewards_primary_host'),
    Wmflib::Ensure $ensure = lookup('profile::lists::automation::ensure', { default_value => 'absent' }),
    Array[String] $lists_to_sync_dry = lookup('profile::lists::automation::lists_to_sync_dry_run'),
    Array[String] $lists_to_sync_wet = lookup('profile::lists::automation::lists_to_sync_wet_run'),
){

    wmflib::dir::mkdir_p($data_dir, {
        mode  => '0775',
    })

    systemd::timer::job { 'stewards_subscriber_data_sync':
        ensure      => $ensure,
        user        => 'root',
        description => 'copy exported stewards subscriber data from primary steward machine',
        command     => "/usr/bin/rsync --address ${lists_host} -ap rsync://${stewards_host}/steward-data-export-dir ${data_dir}",
        interval    => {'start' => 'OnCalendar', 'interval' => 'hourly'},
    }

    $list_sync_ensure = $lists_host ? {
        $facts['networking']['fqdn'] => 'present',
        default => 'absent',
    }

    each($lists_to_sync_dry) |$list_name| {
        mailman3::sync_list_members { "sync-members-${list_name}":
            ensure    => $list_sync_ensure,
            list_name => $list_name,
            dry_run   => 'y',
        }
    }

    each($lists_to_sync_wet) |$list_name| {
        mailman3::sync_list_members { "sync-members-${list_name}":
            ensure    => $list_sync_ensure,
            list_name => $list_name,
            dry_run   => 'n',
        }
    }
}