Puppet Class: profile::doc

Defined in:
modules/profile/manifests/doc.pp

Overview

web server hosting doc.wikimedia.org

Parameters:

  • active_host (Stdlib::Fqdn) (defaults to: lookup('profile::doc::active_host'))
  • all_hosts (Array[Stdlib::Fqdn]) (defaults to: lookup('profile::doc::all_hosts'))
  • wmf_doc_path (Stdlib::Unixpath) (defaults to: lookup('profile::doc::wmf_doc_path', {'default_value' => '/srv/doc'}))
  • gitlab_runner_hosts (Array[Stdlib::Host]) (defaults to: lookup('profile::doc::gitlab_runner_hosts'))
  • contint_hosts (Array[Stdlib::Host]) (defaults to: lookup('profile::doc::contint_hosts')) 


2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'modules/profile/manifests/doc.pp', line 2

class profile::doc (
    Stdlib::Fqdn        $active_host  = lookup('profile::doc::active_host'),
    Array[Stdlib::Fqdn] $all_hosts    = lookup('profile::doc::all_hosts'),
    Stdlib::Unixpath    $wmf_doc_path = lookup('profile::doc::wmf_doc_path', {'default_value' => '/srv/doc'}),
    Array[Stdlib::Host] $gitlab_runner_hosts = lookup('profile::doc::gitlab_runner_hosts'),
    Array[Stdlib::Host] $contint_hosts = lookup('profile::doc::contint_hosts'),
) {

    $deploy_user = 'deploy-ci-docroot'

    scap::target { 'integration/docroot':
        deploy_user => $deploy_user,
    }

    $php = debian::codename() ? {
        'buster'   => 'php7.3',
        'bullseye' => 'php7.4',
        default    => fail("${module_name} not supported by ${debian::codename()}")
    }

    ensure_packages(["${php}-fpm", "${php}-xml"])

    $restart_cmd = "/bin/systemctl restart ${php}-fpm"

    # scap deployment swap symlink which confuses PHP opcache. On promote
    # stage, scap invoke this script to clear the opcache.
    file { '/usr/local/sbin/restart-php-fpm-unsafe':
        ensure  => present,
        owner   => 'root',
        group   => 'root',
        mode    => '0555',
        content => "#!/bin/bash\nexec sudo -u root -- ${restart_cmd}\n"
    }

    sudo::user { 'deploy_restart_fpm':
        user       => $deploy_user,
        privileges => ["ALL = NOPASSWD: ${restart_cmd}"],
    }

    class { '::httpd':
        modules => ['setenvif',
                    'headers',
                    'rewrite',
                    'proxy',
                    'proxy_fcgi'],
    }

    class { '::httpd::mpm':
        mpm    => 'worker',
        source => 'puppet:///modules/profile/doc/httpd_worker.conf'
    }

    httpd::conf { 'wmf_doc_path':
        priority => 40,
        content  => "Define WMF_DOC_PATH ${wmf_doc_path}\nDefine WMF_DOC_PHP_VERSION ${php}",
    }

    # Apache configuration for doc.wikimedia.org
    httpd::site { 'doc.wikimedia.org':
        source => 'puppet:///modules/profile/doc/httpd-doc.wikimedia.org.conf'
    }

    profile::auto_restarts::service { "${php}-fpm": }

    ferm::service { 'doc-http':
        proto  => 'tcp',
        port   => '80',
        srange => '($CACHES $DEPLOYMENT_HOSTS)',
    }

    profile::auto_restarts::service { 'apache2': }

    user { 'doc-uploader':
        ensure => present,
        shell  => '/bin/false',
        system => true,
    }

    file { '/srv/doc':
        ensure => 'directory',
        owner  => 'doc-uploader',
        group  => 'doc-uploader',
        mode   => '0755',
    }

    # This is to prevent monitoring from alerting. The directory is empty until
    # we have completed the migration of generated documentations. Once done,
    # we should remove the file.
    file { '/srv/doc/BACKMEUP':
        ensure  => 'file',
        owner   => 'root',
        group   => 'root',
        mode    => '0444',
        content => 'Placeholder for Bacula',
    }

    backup::set { 'srv-doc': }

    class { '::rsync::server': }

    $is_active = $::fqdn == $active_host
    $ensure_on_active = $is_active.bool2str('present', 'absent')

    rsync::server::module { 'doc':
        ensure         => $ensure_on_active,
        comment        => 'Docroot of https://doc.wikimedia.org/',
        read_only      => 'no',
        path           => '/srv/doc',
        uid            => 'doc-uploader',
        gid            => 'doc-uploader',
        incoming_chmod => 'D775,F664',
        hosts_allow    => $gitlab_runner_hosts + $contint_hosts,
        auto_ferm      => true,
        auto_ferm_ipv6 => true,
        require        => [
            User['doc-uploader'],
            File['/srv/doc'],
        ],
    }

    rsync::server::module { 'doc-between-nodes':
        ensure         => $is_active.bool2str('absent', 'present'),
        path           => '/srv/doc',
        read_only      => 'no',
        hosts_allow    => [$active_host],
        auto_ferm      => true,
        auto_ferm_ipv6 => true,
    }

    $all_hosts.each |Stdlib::Fqdn $other_host| {
        if $::fqdn != $other_host {
            systemd::timer::job { "rsync-doc-${other_host}":
                ensure      => $ensure_on_active,
                user        => 'root',
                description => 'rsync documentation to a non-active server',
                command     => "/usr/bin/rsync -avp --delete /srv/doc/ rsync://${other_host}/doc-between-nodes",
                interval    => {'start' => 'OnUnitInactiveSec', 'interval' => '1h'},
            }
        }
    }

    profile::auto_restarts::service { 'rsync': }
}