summaryrefslogtreecommitdiff
path: root/docs/critical/template.rst
blob: 89319c89a94bbe38fb5f0a8bedd449f443716295 (plain)
1
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
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
.. index::
   single: Systems; <host>

==================
Systems - TEMPLATE
==================

Purpose
=======

.. <SHORT DESCRIPTION>

Application Links
-----------------

.. link1
     https://<hostname>/<path>

   link2
     https://<hostname>/<path2>


Administration
==============

System Administration
---------------------

.. people_<name> are defined in people.rst

* Primary: :ref:`people_primary`
* Secondary: :ref:`people_secondary`

Application Administration
--------------------------

+---------------+---------------------+
| Application   | Administrator(s)    |
+===============+=====================+
| <application> | :ref:`people_admin` |
+---------------+---------------------+

Contact
-------

* <system>-admin@cacert.org

Additional People
-----------------

:ref:`people_a` and :ref:`people_b` have :program:`sudo` access on that machine too.

Basics
======

Physical Location
-----------------

.. <PHYSICAL HOST, VM GUEST, APACHE VIRTUAL HOST, etc.>

.. ## Use the following for containers on Infra02:

This system is located in an :term:`LXC` container on physical machine
:doc:`infra02`.

Physical Configuration
----------------------

.. seealso::

   See :wiki:`SystemAdministration/EquipmentList`

Logical Location
----------------

:IP Internet: :ip:v4:`<IP>`
:IP Intranet: :ip:v4:`<IP>`
:IP Internal: :ip:v4:`<IP>`
:MAC address: :mac:`<MAC>` (interfacename)

.. seealso::

   See :doc:`../network`

DNS
---

.. index::
   single: DNS records; <machine>

========================== ======== ==========================================
Name                       Type     Content
========================== ======== ==========================================
<HOST>.cacert.org.         IN A     <IP>
<HOST>.intra.cacert.org.   IN A     <IP>
========================== ======== ==========================================

.. seealso::

   See :wiki:`SystemAdministration/Procedures/DNSChanges`

Operating System
----------------

.. index::
   single: Debian GNU/Linux; Codename
   single: Debian GNU/Linux; x.y

* Debian GNU/Linux x.y

Applicable Documentation
------------------------

This is it :-)

Services
========

Listening services
------------------

.. use the values from this table or add new lines if applicable

+----------+-----------+-----------+-----------------------------------------+
| Port     | Service   | Origin    | Purpose                                 |
+==========+===========+===========+=========================================+
| 22/tcp   | ssh       | ANY       | admin console access                    |
+----------+-----------+-----------+-----------------------------------------+
| 25/tcp   | smtp      | local     | mail delivery to local MTA              |
+----------+-----------+-----------+-----------------------------------------+
| 80/tcp   | http      | ANY       | application                             |
+----------+-----------+-----------+-----------------------------------------+
| 443/tcp  | https     | ANY       | application                             |
+----------+-----------+-----------+-----------------------------------------+
| 5666/tcp | nrpe      | monitor   | remote monitoring service               |
+----------+-----------+-----------+-----------------------------------------+
| 3306/tcp | mysql     | local     | MySQL database for ...                  |
+----------+-----------+-----------+-----------------------------------------+
| 5432/tcp | pgsql     | local     | PostgreSQL database for ...             |
+----------+-----------+-----------+-----------------------------------------+
| 465/udp  | syslog    | local     | syslog port                             |
+----------+-----------+-----------+-----------------------------------------+

Running services
----------------

.. index::
   single: Apache
   single: Icinga2
   single: MySQL
   single: OpenERP
   single: Postfix
   single: PostgreSQL
   single: cron
   single: nginx
   single: nrpe
   single: openssh

+--------------------+--------------------+----------------------------------------+
| Service            | Usage              | Start mechanism                        |
+====================+====================+========================================+
| openssh server     | ssh daemon for     | init script :file:`/etc/init.d/ssh`    |
|                    | remote             |                                        |
|                    | administration     |                                        |
+--------------------+--------------------+----------------------------------------+
| Apache httpd       | Webserver for ...  | init script                            |
|                    |                    | :file:`/etc/init.d/apache2`            |
+--------------------+--------------------+----------------------------------------+
| cron               | job scheduler      | init script :file:`/etc/init.d/cron`   |
+--------------------+--------------------+----------------------------------------+
| rsyslog            | syslog daemon      | init script                            |
|                    |                    | :file:`/etc/init.d/syslog`             |
+--------------------+--------------------+----------------------------------------+
| PostgreSQL         | PostgreSQL         | init script                            |
|                    | database server    | :file:`/etc/init.d/postgresql`         |
|                    | for ...            |                                        |
+--------------------+--------------------+----------------------------------------+
| MySQL              | MySQL database     | init script                            |
|                    | server for ...     | :file:`/etc/init.d/mysql`              |
+--------------------+--------------------+----------------------------------------+
| Postfix            | SMTP server for    | init script                            |
|                    | local mail         | :file:`/etc/init.d/postfix`            |
|                    | submission, ...    |                                        |
+--------------------+--------------------+----------------------------------------+
| Exim               | SMTP server for    | init script                            |
|                    | local mail         | :file:`/etc/init.d/exim4`              |
|                    | submission, ...    |                                        |
+--------------------+--------------------+----------------------------------------+
| Nagios NRPE server | remote monitoring  | init script                            |
|                    | service queried by | :file:`/etc/init.d/nagios-nrpe-server` |
|                    | :doc:`monitor`     |                                        |
+--------------------+--------------------+----------------------------------------+

Databases
---------

+-------------+--------------+---------------------------+
| RDBMS       | Name         | Used for                  |
+=============+==============+===========================+
| MySQL       | application1 | fictional application one |
+-------------+--------------+---------------------------+
| PostgreSQL  | application2 | fictional application two |
+-------------+--------------+---------------------------+

Running Guests
--------------

+----------------+-------------+---------------+---------+---------------+
| Machine        | IP Intranet | IP Internet   | Ports   | Purpose       |
+================+=============+===============+=========+===============+
| :doc:`machine` | <LOCAL IP>  | <INTERNET IP> | <PORTS> | <DESCRIPTION> |
+----------------+-------------+---------------+---------+---------------+

Connected Systems
-----------------

* :doc:`monitor`

Outbound network connections
----------------------------

* DNS (53) resolving nameservers 172.16.2.2 and 172.16.2.3
* :doc:`emailout` as SMTP relay
* ftp.nl.debian.org as Debian mirror
* security.debian.org for Debian security updates
* crl.cacert.org (rsync) for getting CRLs

Security
========

.. add the MD5 fingerprints of the SSH host keys

.. sshkeys::
   :RSA:
   :DSA:
   :ECDSA:
   :ED25519:

Dedicated user roles
--------------------

.. If the system has some dedicated user groups besides the sudo group used for
   administration it should be documented here Regular operating system groups
   should not be documented

+-------------+-----------------------------+
| Group       | Purpose                     |
+=============+=============================+
| <groupname> | <short purpose description> |
+-------------+-----------------------------+

Non-distribution packages and modifications
-------------------------------------------

.. * None
   or
   * List of non-distribution packages and modifications (with some
     explaination why no distribution package could be used)

Risk assessments on critical packages
-------------------------------------

.. add a paragraph for each known risk. The risk has to be described.
   Mitigation or risk acceptance has to be documented.

Critical Configuration items
============================

Keys and X.509 certificates
---------------------------

.. use the sslcert directive to have certificates added to the certificate list
   automatically

.. sslcert:: template.cacert.org
   :altnames:
   :certfile:
   :keyfile:
   :serial:
   :expiration:
   :sha1fp:
   :issuer:

.. for certificates that are orginally created on another host use

.. sslcert:: other.cacert.org
   :certfile:
   :keyfile:
   :serial:
   :secondary:

.. * `/etc/apache2/ssl/cacert-certs.pem` CAcert.org Class 1 and Class 3 CA certificates (allowed CA certificates for client certificates)
   * `/etc/apache2/ssl/cacert-chain.pem` CAcert.org Class 1 certificate (certificate chain for server certificate)

.. seealso::

   * :wiki:`SystemAdministration/CertificateList`

<service_x> configuration
-------------------------

.. add a section for the configuration of each service where configuration
   deviates from OS package defaults

Tasks
=====

Planned
-------

.. add a paragraph or todo directive for each larger planned task. You may want
   to link to specific issues if you use some issue tracker.

Changes
=======

System Future
-------------

.. use this section to describe any plans for the system future. These are
   larger plans like moving to another host, abandoning the system or replacing
   its functionality with something else.

.. * No plans

Additional documentation
========================

.. add inline documentation

.. remove unneeded links from the list below, add other links that apply

.. seealso::

   * :wiki:`Exim4Configuration`
   * :wiki:`PostfixConfiguration`
   * :wiki:`QmailConfiguration`
   * :wiki:`SendmailConfiguration`
   * :wiki:`StunnelConfiguration`

References
----------

.. can be used to provide links to reference documentation
   * http://product.site.com/docs/
   * [[http://product.site.com/whitepaper/document.pdf|Paper on how to setup...]]