Puppet Class: profile::puppetserver::git

Defined in:
modules/profile/manifests/puppetserver/git.pp

Summary

configuyre git repos

Overview

SPDX-License-Identifier: Apache-2.0

Parameters:

  • ensure (Wmflib::Ensure) (defaults to: lookup('profile::puppetserver::git::ensure')) —

    ensurable parameter

  • basedir (Stdlib::Unixpath) (defaults to: lookup('profile::puppetserver::git::basedir')) —

    the git repo base dir

  • user (String[1]) (defaults to: lookup('profile::puppetserver::git::user')) —

    the owner of the git repo

  • group (String[1]) (defaults to: lookup('profile::puppetserver::git::group')) —

    the group owner of the git repo

  • control_repo (String[1]) (defaults to: lookup('profile::puppetserver::git::control_repo')) —

    the name of the main puppet control repo

  • repos (Hash[String, Hash]) (defaults to: lookup('profile::puppetserver::git::repos')) —

    additional repos to configure

  • exclude_servers (Array[Stdlib::Host]) (defaults to: lookup('profile::puppetserver::git::exclude_servers')) —

    exclude servers under maintenance from various configs

  • code_dir (Stdlib::Unixpath) (defaults to: lookup('profile::puppetserver::code_dir')) 


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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'modules/profile/manifests/puppetserver/git.pp', line 10

class profile::puppetserver::git (
    Wmflib::Ensure      $ensure             = lookup('profile::puppetserver::git::ensure'),
    Stdlib::Unixpath    $basedir            = lookup('profile::puppetserver::git::basedir'),
    String[1]           $user               = lookup('profile::puppetserver::git::user'),
    String[1]           $group              = lookup('profile::puppetserver::git::group'),
    String[1]           $control_repo       = lookup('profile::puppetserver::git::control_repo'),
    Hash[String, Hash]  $repos              = lookup('profile::puppetserver::git::repos'),
    Stdlib::Unixpath    $code_dir           = lookup('profile::puppetserver::code_dir'),
    Array[Stdlib::Host] $exclude_servers    = lookup('profile::puppetserver::git::exclude_servers')
) {
    $servers = (wmflib::role::hosts('puppetmaster::frontend') +
                wmflib::role::hosts('puppetserver') -
                $exclude_servers).sort.unique

    # FIXME: the name "masters" is tightly coupled with the MASTERS
    # bash env variable in puppet-merge.sh, that at the time of its
    # creation was meant to target only puppetmaster frontend nodes.
    # Once puppetmasters are gone from our infra, we can remove
    # the MASTERS config and the following one as well.
    $masters = (wmflib::role::hosts('puppetmaster::frontend') +
                wmflib::role::hosts('puppetserver') -
                $exclude_servers).sort.unique

    unless $repos.has_key($control_repo) {
        fail("\$control_repo (${control_repo}) must be defined in \$repos")
    }

    $control_repo_dir = "${basedir}/${control_repo}"
    $home_dir = "/home/${user}"

    systemd::sysuser { $user:
        home_dir          => $home_dir,
        shell             => '/bin/sh',
        additional_groups => [ 'prometheus-node-exporter' ],
    }
    file { $home_dir:
        ensure  => directory,
        owner   => $user,
        group   => $user,
        mode    => '0755',
        require => Systemd::Sysuser[$user],
    }
    # TODO: refactor this so its closer to the g10k code
    # This is required to run g10k as root
    sudo::user { "${user}-puppetserver-deploy-code":
        user       => $user,
        privileges => [
            'ALL = NOPASSWD: /usr/local/bin/puppetserver-deploy-code',
        ],
    }

    file {"${home_dir}/.ssh":
        ensure => directory,
        owner  => $user,
        group  => $group,
        mode   => '0700',
    }
    file {
        default:
            ensure    => file,
            owner     => $user,
            group     => $group,
            mode      => '0400',
            show_diff => false,
        ;
        "${home_dir}/.ssh/id_rsa":
            content => secret('ssh/gitpuppet/gitpuppet.key'),
        ;
        "${home_dir}/.ssh/gitpuppet-private-repo":
            content => secret('ssh/gitpuppet/gitpuppet-private.key'),
        ;
    }
    ssh::userkey { $user:
        content => template('profile/puppetserver/git/gitpuppet_authorized_keys.erb'),
    }

    unless $servers.empty() {
        ferm::service { 'open access for puppetservers':
            proto  => 'tcp',
            port   => 22,
            srange => $servers,
        }
    }

    wmflib::dir::mkdir_p([$basedir.dirname, $basedir], {
        owner  => $user,
        group  => $group
    })

    $repos.each |$repo, $config| {
        $dir = "${basedir}/${repo}"
        if $config.has_key('safedir') and $config['safedir'] {
            git::systemconfig { "mark puppet repo ${dir} as safe":
                settings => {
                    'safe' => {
                        'directory' => $dir,
                    },
                },
            }
        } else {
            # By default in environments like Cloud we want to leverage the git's
            # safe directory checks to avoid users messing up with repos that should
            # be managed only by system users (like gitpuppet).
            git::systemconfig { "mark puppet repo ${dir} as safe":
                ensure   => absent,
                settings => {},
            }
        }
        $origin = $config['origin'].lest || { "https://gerrit.wikimedia.org/r/${repo}" }
        ensure_resource('file', $dir.dirname, {
            ensure => stdlib::ensure($ensure, 'directory'),
            owner  => $user,
            group  => $group,
        })
        if $config.has_key('private') and $config['private'] {
            $git_dir_mode = '0750'
        } else {
            $git_dir_mode = '0755'
        }
        if $config.has_key('private_group') {
            $git_dir_group = $config['private_group']
        } else {
            $git_dir_group = $group
        }
        if $config['init'] {
            file { $dir:
                ensure => directory,
                owner  => $user,
                group  => $git_dir_group,
                mode   => $git_dir_mode,
            }
            exec { "git init ${dir}":
                command => '/usr/bin/git init',
                user    => $user,
                group   => $group,
                cwd     => $dir,
                creates => "${dir}/.git",
                require => File[$dir],
            }
            $git_require = Exec["git init ${dir}"]
        } else {
            git::clone { $repo:
                ensure    => $ensure,
                directory => $dir,
                branch    => $config['branch'],
                origin    => $origin,
                owner     => $user,
                group     => $git_dir_group,
                mode      => $git_dir_mode,
                require   => File[$dir.dirname],
                before    => Service['puppetserver'],
            }
            $git_require = Git::Clone[$repo]
        }
        if $config.has_key('hooks') {
            $hooks_dir = "${dir}/.git/hooks"
            $config['hooks'].each |$hook, $source| {
                $content = $source.stdlib::start_with('puppet:///modules/') ? {
                    true    => {'source' => $source},
                    default => {'content' => template($source)},
                }
                file { "${hooks_dir}/${hook}":
                    ensure  => stdlib::ensure($ensure, 'file'),
                    owner   => $user,
                    group   => $group,
                    mode    => '0550',
                    require => $git_require,
                    *       => $content,
                }
            }
        }
        if $config.has_key('link') {
            file { $config['link']:
                ensure  => stdlib::ensure($ensure, 'link'),
                target  => $dir,
                force   => true,
                before  => Service['puppetserver'],
                require => $git_require,
            }
        }
        if $config.has_key('config') {
            $content = $config['config'].stdlib::start_with('puppet:///modules/') ? {
                true    => {'source' => $config['config']},
                default => {'content' => template($config['config'])},
            }
            file { "${dir}/.git/config":
                ensure  => stdlib::ensure($ensure, 'file'),
                owner   => $user,
                group   => $group,
                require => $git_require,
                *       => $content,
            }
        }
    }

    exec { 'puppetserver-deploy-code':
        command   => '/usr/local/bin/puppetserver-deploy-code',
        creates   => "${code_dir}/environments/production",
        notify    => Service['puppetserver'],
        require   => [Package['g10k'], File['/usr/local/bin/puppetserver-deploy-code']],
        subscribe => [Git::Clone[$control_repo], Class['puppetserver::g10k']],
    }

    file { '/usr/local/bin/pgit':
        ensure  => file,
        content => "#!/bin/sh\nexec sudo -u ${user} git \"$@\"\n",
        mode    => '0555',
    }

    git::config { "${home_dir}/.gitconfig":
        settings => {
            'user' => {
                'name'  => $user,
                'email' => "${user}@${facts['networking']['fqdn']}",
            },
        },
    }
}