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