Puppet Class: wikistats

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

Overview

SPDX-License-Identifier: Apache-2.0 wikistats - a mediawiki statistics site

wikistats.wmcloud.org

This sets up a site with statistics about as many public MediaWiki installs as possible.

It runs on instance in the 'cloud VPS' project 'wikistats'.

You can control this instance via horizon.wikimedia.org if you are a member or admin of the project.

I will likely stay a labs project forever although results from it are used for some statistic tables inside Wikipedia and other WMF wikis.

If it goes down it would be missed but it will not cause any issues for production wikis. Just some outdated tables.

The matching software is in another repo: operations/debs/wikistats which you can clone from Gerrit.

git clone “gerrit.wikimedia.org/r/operations/debs/wikistats”

Despite the repo name it is not an actual deb package any longer. It gets deployed by simple git clone of PHP files and a local deployment script that is also in the repo itself.

This started out as an external project to create wiki syntax tables for pages like “List of largest wikis” on meta and several similar ones for other projects

Not to be confused with stats.wikimedia.org and wikistats2 run by the WMF Analytics team.

To report bugs use phabricator.wikimedia.org and tag a ticket with 'VPS-project-Wikistats'.

Parameters:

  • jobs_ensure (Wmflib::Ensure) 


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
 
# File 'modules/wikistats/manifests/init.pp', line 41

class wikistats (
    Wmflib::Ensure $jobs_ensure,
){

    $php_version = debian::codename() ? {
        'buster'   => '7.3',
        'bullseye' => '7.4',
        'bookworm' => '8.2',
        default    => fail("unsupported on ${debian::codename()}"),
    }

    group { 'wikistatsuser':
        ensure => present,
        name   => 'wikistatsuser',
        system => true,
    }

    user { 'wikistatsuser':
        home       => '/usr/lib/wikistats',
        groups     => 'wikistatsuser',
        managehome => true,
        system     => true,
    }

    file { '/srv/wikistats':
        ensure => directory,
        owner  => 'wikistatsuser',
        group  => 'wikistatsuser',
    }

    # directory used by deploy-script to store backups
    file { '/usr/lib/wikistats/backup':
        ensure  => directory,
        owner   => 'wikistatsuser',
        group   => 'wikistatsuser',
        require => User['wikistatsuser'],
    }

    file { '/usr/local/bin/wikistats':
        ensure => directory,
    }

    # deployment script that copies files in place after puppet git clones to /srv/
    file { '/usr/local/bin/wikistats/deploy-wikistats':
        ensure => present,
        owner  => 'root',
        group  => 'root',
        mode   => '0544',
        source => 'puppet:///modules/wikistats/deploy-wikistats.sh',
    }

    git::clone { 'repos/cloud/wikistats':
        ensure    => latest,
        directory => '/srv/wikistats',
        branch    => 'master',
        owner     => 'wikistatsuser',
        group     => 'wikistatsuser',
        source    => 'gitlab',
    }

    $db_pass = fqdn_rand_string(23, 'Random9Fn0rd8Seed')

    # install a db on localhost
    class { 'wikistats::db':
        db_pass     => $db_pass,
        php_version => $php_version,
    }

    # location to dump as XML files
    file { '/var/www/wikistats/xml':
        ensure => directory,
        owner  => 'wikistatsuser',
        group  => 'wikistatsuser',
        mode   => '0644',
    }

    # add /usr/local/bin/wikistats/ to PATH for all users
    file { '/etc/profile.d/wikistats_path.sh':
        ensure => present,
        owner  => 'root',
        group  => 'root',
        mode   => '0644',
        source => 'puppet:///modules/wikistats/wikistats_path.sh',
    }

    # symlink into PATH to make it work with sudo without editing secure_path
    file { '/usr/local/bin/deploy-wikistats':
        ensure => 'link',
        target => '/usr/local/bin/wikistats/deploy-wikistats',
    }

    class { 'wikistats::updates':
        db_pass     => $db_pass,
        ensure      => $jobs_ensure,
        php_version => $php_version,
    }
}