Document the CATS system
[cacert-infradocs.git] / docs / systems.rst
1 ====================
2 Non-Critical Systems
3 ====================
4
5 Non-critical systems are those that are managed by the infrastructure
6 administrator team.
7
8 .. toctree::
9 :maxdepth: 1
10
11 systems/infra02
12 systems/arbitration
13 systems/blog
14 systems/board
15 systems/bugs
16 systems/cats
17 systems/email
18 systems/emailout
19 systems/monitor
20 systems/webmail
21
22
23 General
24 =======
25
26 .. todo:: consider whether a central MySQL service should be setup
27
28 Many containers contain their own instance of MySQL. It might be a better
29 idea to centralize the MySQL setups in a single container.
30
31 .. todo:: consider whether a central PostgreSQL service should be setup
32
33 .. todo::
34
35 setup a central syslog service and install syslog clients in each container
36
37 .. _setup_apt_checking:
38
39 .. topic:: Setup package update monitoring for a new container
40
41 For Icinga to be able to check the update status of packages on you server
42 you need to install NRPE, a helper service. Install the necessary packages::
43
44 sudo aptitude install nagios-plugins-basic nagios-nrpe-server
45
46 Put :doc:`systems/monitor` on the list of allowed hosts to access the NRPE
47 service by adding the following line to :file:`/etc/nagios/nrpe_local.cfg`::
48
49 allowed_hosts=172.16.2.18
50
51 Tell the NRPE service that there is such a thing as the check_apt command by
52 creating the file :file:`/etc/nagios/nrpe.d/apt.cfg` with the following
53 contents::
54
55 # 'check_apt' command definition
56 command[check_apt]=/usr/lib/nagios/plugins/check_apt
57
58 # 'check_apt_distupgrade' command definition
59 command[check_apt_distupgrade]=/usr/lib/nagios/plugins/check_apt -d
60
61 Restart the NRPE service::
62
63 sudo service nagios-nrpe-server restart
64
65 Check that everything went well by going to https://monitor.cacert.org/,
66 going to the APT service on the host and clicking :guilabel:`"Re-schedule
67 the next check of this service"`. Make sure that :guilabel:`"Force Check"`
68 is checked and click :guilabel:`"Commit"`. Now you should see a page with a
69 green background. If not something went wrong, please contact the
70 :doc:`systems/monitor` administrators with the details.
71
72 That's it, now the package update status should be properly displayed in
73 Icinga.
74
75 .. todo:: think about replacing nrpe with Icinga2 satellites
76
77 Checklist
78 =========
79
80 .. index::
81 single: etckeeper
82 single: nrpe
83
84 * All containers should be monitored by :doc:`systems/monitor` and should
85 therefore have :program:`nagios-nrpe-server` installed
86 * All containers should use :program:`etckeeper` to put their local setup into
87 version control. All local setup should use :file:`/etc` to make sure it is
88 handled by :program:`etckeeper`
89 * All infrastructure systems must send their mail via :doc:`systems/emailout`
90 * All infrastructure systems should have an system-admin@cacert.org alias to
91 reach their admins
92 * The installation of :index:`systemd-sysv` in containers can be blocked by
93 putting the following lines in :file:`/etc/apt/preferences.d/systemd-sysv`::
94
95 Package: systemd-sysv
96 Pin: release a=stable
97 Pin-Priority: -1
98
99 .. todo:: document how to setup the system-admin alias on the email system