Puppet Class: scap

Defined in:
modules/scap/manifests/init.pp

Summary

Common role for scap masters and targets

Overview

SPDX-License-Identifier: Apache-2.0

Parameters:

  • deployment_server (Variant[Stdlib::Host,String]) (defaults to: 'deployment') —

    Server that provides git repositories for scap3. Default 'deployment'.

  • wmflabs_master (Stdlib::Fqdn) (defaults to: 'deployment-deploy04.deployment-prep.eqiad1.wikimedia.cloud') —

    Master scap rsync host in the wmflabs domain. Default 'deployment-deploy04.deployment-prep.eqiad1.wikimedia.cloud'.

  • is_master (Boolean) (defaults to: false) —

    indicates if the server is a scap::master

  • manage_logstash_credentials (Boolean) (defaults to: false) —

    If true, install /etc/scap/logstash_credentials from the private repo and tell scap to use it. Scap then authenticates its logstash queries. Only scap masters query logstash, so the file is installed on masters only.

  • logstash_credentials_group (String[1]) (defaults to: 'wikidev') —

    Group that can read the logstash credentials file. Keep this the same as the 'deployment_group' hiera key, since scap runs both as the deployer and as the spiderpig user.

  • betacluster_udplog_host (Stdlib::Fqdn) (defaults to: 'deployment-mwlog02.deployment-prep.eqiad1.wikimedia.cloud')
  • k8s_deployments (Optional[Hash]) (defaults to: {})
  • enable_bootstrapping (Boolean) (defaults to: true)


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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'modules/scap/manifests/init.pp', line 20

class scap (
    Variant[Stdlib::Host,String] $deployment_server = 'deployment',
    Stdlib::Fqdn $wmflabs_master                    = 'deployment-deploy04.deployment-prep.eqiad1.wikimedia.cloud',
    Stdlib::Fqdn $betacluster_udplog_host           = 'deployment-mwlog02.deployment-prep.eqiad1.wikimedia.cloud',
    Boolean      $is_master                         = false,
    Optional[Hash] $k8s_deployments                 = {},
    Boolean $enable_bootstrapping                   = true,
    Boolean $manage_logstash_credentials            = false,
    String[1] $logstash_credentials_group           = 'wikidev',
) {
    require git::lfs
    include scap::user

    # Required python3 package is provided by base::standard_packages class
    stdlib::ensure_packages(['rsync', 'python3-venv'])

    # Deployment servers/masters are bootstrapped in profile::mediawiki::deployment::server
    if $enable_bootstrapping and !$is_master {
        $scap_home = $scap::user::home_dir

        file { '/usr/local/bin/bootstrap-scap-target.sh':
          mode   => '0755',
          owner  => 'root',
          group  => 'root',
          source => 'puppet:///modules/scap/bootstrap-scap-target.sh',
        }

        exec { 'bootstrap-scap-target':
          command => "/usr/local/bin/bootstrap-scap-target.sh ${deployment_server} ${scap_home}",
          user    => 'scap',
          creates => "${scap_home}/scap/bin/scap",
          require => File['/usr/local/bin/bootstrap-scap-target.sh']
        }

        file { '/usr/bin/scap':
          ensure  => 'link',
          target  => "${scap_home}/scap/bin/scap",
          owner   => 'root',
          group   => 'root',
          mode    => '0755',
          require => Exec['bootstrap-scap-target']
        }
    }

    $deploy_k8s = !$k8s_deployments.empty
    $k8s_releases_dir = pick($k8s_deployments['releases_dir'], '/etc/mediawiki/releases')
    $k8s_clusters = $k8s_deployments['clusters']
    $k8s_deployments_file = $k8s_deployments['file']

    # T434114: Credentials for authenticated logstash queries. Only scap
    # masters query logstash.
    $logstash_credentials_file = '/etc/scap/logstash_credentials'
    $use_logstash_credentials = $is_master and $manage_logstash_credentials
    if $use_logstash_credentials {
        wmflib::dir::mkdir_p('/etc/scap')

        file { $logstash_credentials_file:
            ensure    => present,
            owner     => 'root',
            group     => $logstash_credentials_group,
            mode      => '0440',
            content   => secret('scap/logstash_credentials'),
            show_diff => false,
        }
    } else {
        file { $logstash_credentials_file:
            ensure => absent,
        }
    }

    # Disable Scap deployments on the inactive deployment server
    $block_scap_deployments = $is_master and $facts['networking']['fqdn'] != $deployment_server
    file { '/etc/scap.cfg':
        content => template('scap/scap.cfg.erb'),
        owner   => 'root',
        group   => 'root',
        mode    => '0444',
    }
}