README.md 10.5 KB
Newer Older
Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
1
2
3
4
# Arch Infrastructure

This repository contains the complete collection of ansible playbooks and roles for the Arch Linux infrastructure.

5
6
7
It also contains git submodules so you have to run `git submodule update --init
--recursive` after cloning or some tasks will fail to run.

8
9
## Requirements

10
Install these packages:
11
  - terraform
12
  - terraform-provider-keycloak
13

14
15
### Instructions

Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
16
All systems are set up the same way. For the first time setup in the Hetzner rescue system,
17
run the provisioning script: `ansible-playbook playbooks/tasks/install-arch.yml -l $host`.
Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
18
19
20
The provisioning script configures a sane basic systemd with sshd. By design, it is NOT idempotent.
After the provisioning script has run, it is safe to reboot.

21
Once in the new system, run the regular playbook: `HCLOUD_TOKEN=$(misc/get_key.py misc/vault_hetzner.yml hetzner_cloud_api_key) ansible-playbook playbooks/$hostname.yml`.
22
This playbook is the one regularity used for administrating the server and is entirely idempotent.
Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
23

24
25
26
27
When adding a new machine you should also deploy our SSH known_hosts file and update the SSH hostkeys file in this git repo.
For this you can simply run the `playbooks/tasks/sync-ssh-hostkeys.yml` playbook and commit the changes it makes to this git repository.
It will also deploy any new SSH host keys to all our machines.

28
29
30
#### Note about GPG keys

The root_access.yml file contains the root_gpgkeys variable that determine the users that have access to the vault, as well as the borg backup keys.
31
All the keys should be on the local user gpg keyring and at **minimum** be locally signed with --lsign-key. This is necessary for running either the reencrypt-vault-key
Jelle van der Waa's avatar
Jelle van der Waa committed
32
or the fetch-borg-keys tasks.
33

34
35
36
37
38
39
40
41
#### Note about Ansible dynamic inventories

We use a dynamic inventory script in order to automatically get information for
all servers directly from hcloud. You don't really have to do anything to make
this work but you should keep in mind to NOT add hcloud servers to `hosts`!
They'll be available automatically.

#### Note about first time certificates
42
43
44
45
46

The first time a certificate is issued, you'll have to do this manually by yourself. First, configure the DNS to
point to the new server and then run a playbook onto the server which includes the nginx role. Then on the server,
it is necessary to run the following once:

Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
47
    certbot certonly --email webmaster@archlinux.org --agree-tos --rsa-key-size 4096 --renew-by-default --webroot -w /var/lib/letsencrypt/ -d <domain-name>
48

49
50
Note that some roles already run this automatically.

51
#### Note about packer
Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
52
53
54
55

We use packer to build snapshots on hcloud to use as server base images.
In order to use this, you need to install packer and then run

56
    packer build -var $(misc/get_key.py misc/vault_hetzner.yml hetzner_cloud_api_key env) packer/archlinux.json
Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
57
58
59

This will take some time after which a new snapshot will have been created on the primary hcloud archlinux project.

60
#### Note about terraform
61

62
63
64
65
66
67
68
69
70
71
72
We use terraform in two ways:

    1) To provision a part of the infrastructure on hcloud (and possibly other service providers in the future)
    2) To declaratively configure applications

For both of these, we have set up a separate terraform script. The reason for that is that sadly terraform can't have
providers depend on other providers so we can't declaratively state that we want to configure software on a server which
itself needs to be provisioned first. Therefore, we use a two-stage process. Generally speaking, scenario 1) is configured in
`tf-stage1` and 2) is in `tf-stage2`. Maybe in the future, we can just have a single terraform script for everything
but for the time being, this is what we're stuck with.

73
74
The very first time you run terraform on your system, you'll have to init it:

75
    cd tf-stage1  # and also tf-stage2
76
    terraform init -backend-config="conn_str=postgres://terraform:$(../misc/get_key.py group_vars/all/vault_terraform.yml vault_terraform_db_password)@state.archlinux.org"
77

78
After making changes to the infrastructure in `tf-stage1/archlinux.fg`, run
79
80

    terraform plan
81
82
83
84

This will show you planned changes between the current infrastructure and the desired infrastructure.
You can then run

85
    terraform apply
86
87
88

to actually apply your changes.

89
90
91
The same applies to changed application configuration in which case you'd run
it inside of `tf-stage2` instead of `tf-stage1`.

92
93
94
95
96
97
We store terraform state on a special server that is the only hcloud server NOT
managed by terraform so that we do not run into a chicken-egg problem. The
state server is assumed to just exist so in an unlikely case where we have to
entirely redo this infrastructure, the state server would have to be manually
set up.

98
99
100
101
#### SMTP Configuration

All hosts should be relaying email through our primary mx host (currently 'orion'). See docs/email.txt for full details.

102
#### Note about opendkim
103
104
105
106
107

The opendkim DNS data has to be added to DNS manually. The roles verifies that the DNS is correct before starting opendkim.

The file that has to be added to the zone is `/etc/opendkim/private/$selector.txt`.

108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
### Putting a service in maintenance mode

Most web services with a nginx configuration, can be put into a maintenance mode, by running the playbook with a maintenance variable:

    ansible-playbook -e maintenance=true playbooks/<playbook.yml>

This also works with a tag:

    ansible-playbook -t <tag> -e maintenance=true playbooks/<playbook.yml>

As long as you pass the maintenance variable to the playbook run, the web service will stay in maintenance mode. As soon as you stop
passing it on the command line and run the playbook again, the regular nginx configuration should resume and the service should accept
requests by the end of the run.

Passing maintenance=false, will also prevent the regular nginx configuration from resuming, but will not put the service into maintence
mode.

Keep in mind that passing the maintenance variable to the whole playbook, without any tag, will make all the web services that have the
maintenance mode in them, to be put in maintenance mode. Use tags to affect only the services you want.

Documentation on how to add the maintenance mode to a web service is inside docs/maintenance.txt
129
130
131
132
133
134
135

### Finding servers requiring security updates

Arch-audit can be used to find servers in need of updates for security issues.

    ansible all -a "arch-audit -u"

136
137
138
139
#### Updating servers

The following steps should be used to update our managed servers:

140
141
142
143
144
  * pacman -Syu
  * manually update the kernel, since it is in IgnorePkg by default
  * sync
  * checkservices
  * reboot
145

Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
146
147
148
149
150
## Servers

### vostok

#### Services
151
  - backups
Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
152
153
154
155

### orion

#### Services
156
157
158
159
  - repos/sync (repos.archlinux.org)
  - sources (sources.archlinux.org)
  - archive (archive.archlinux.org)
  - torrent tracker hefurd (tracker.archlinux.org)
Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
160

161
### luna
Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
162
163

#### Services
164

165
166
  - aur (aur.archlinux.org)
  - mailman
167
168
169
170
171
172
  - projects (projects.archlinux.org)

### apollo

#### Services
  - wiki (wiki.archlinux.org)
173
174
175
  - bugs (bugs.archlinux.org)
  - archweb
  - patchwork
176
177
178
179
180
181
182
183
184
185

## bugs.archlinux.org

#### Services
  - flyspray

## bbs.archlinux.org

#### Services
  - bbs
Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
186

187
### phrik.archlinux.org
188
189

#### Services
190
191
192
193
   - phrik (irc bot) users in the phrik group defined in
     the hosts vars and re-used the archusers role. Users
     in the phrik group are allowed to restar the irc bot.

194
195
196
### dragon

#### Services
Jelle van der Waa's avatar
Jelle van der Waa committed
197
  - build server
198
  - sogrep
Jelle van der Waa's avatar
Jelle van der Waa committed
199
  - arch-boxes (packer)
200

201
### state.archlinux.org
202

203
#### Services
204
  - postgres server for terraform state
205

206
207
### quassel.archlinux.org

208
#### Services
209
  - quassel core
210

211
### homedir.archlinux.org
Jelle van der Waa's avatar
Jelle van der Waa committed
212

213
#### Services
Jelle van der Waa's avatar
Jelle van der Waa committed
214
  - ~/user/ webhost
215

216
217
218
219
220
221
222
223
### accounts.archlinux.org

This server is /special/. It runs keycloak and is central to our unified Arch Linux account management world.
It has an Ansible playbook for the keycloak service but that only installs the package and starts it but it's configured via a secondary Terraform file only for keycloak `keycloak.tf`.
The reason for doing it this way is that Terraform support for Keycloak is much superior and it's declarative too which is great for making sure that no old config remains in the case of config changes.

So to set up this server from scratch, run:

224
225
226
227
228
  - `cd tf-stage1`
  - `terraform apply`
  - `cd ../tf-stage2`
  - `terraform import keycloak_realm.master master`
  - `terraform apply`
229

230
#### Services
231
  - keycloak
Jelle van der Waa's avatar
Jelle van der Waa committed
232

233
### mirror.pkgbuild.com
234

235
#### Services
236
237
238
239
  - Load balancer for PIA mirrors across the world. Uses Maxmind's GeoIP City
    database for routing users to their nearest mirror. Account information is
    stored in the ansible vault.

240
### reproducible.archlinux.org
Jelle van der Waa's avatar
Jelle van der Waa committed
241

242
#### Services
243
244
245
  - Runs a master rebuilderd instance with two PIA workers (repro1.pkgbuild.com,
    repro2.pkgbuild.com and repro3.pkgbuild.com).
    repro3.pkgbuild.com is packet.net machine which runs Ubuntu.
Jelle van der Waa's avatar
Jelle van der Waa committed
246

247
248
249
250
251
252
253
254
255
256
257
258
259
260
### runner1.archlinux.org

Slow-ish PIA box with spinning disks.

#### Services
  - GitLab runner

### runner2.archlinux.org

Medium-fast-ish packet.net box with Debian on it. Is currently maintained manually.

#### Services
  - GitLab runner

261
262
263
264
## Ansible repo workflows

### Replace vault password and change vaulted passwords

265
266
267
268
  - Generate a new key and save it as ./new-vault-pw: `pwgen -s 64 1 > new-vault-pw`
  - `for i in $(ag ANSIBLE_VAULT -l); do ansible-vault rekey --new-vault-password-file new-vault-pw $i; done`
  - Change the key in misc/vault-password.gpg
  - `rm new-vault-pw`
269

270
271
### Re-encrypting the vault after adding or removing a new GPG key

272
273
  - Make sure you have all the GPG keys **at least** locally signed
  - Run the playbooks/tasks/reencrypt-vault-key.yml playbook and make sure it does not have **any** failed task
274
275
276
277
278
  - Test that the vault is working by running ansible-vault view on any encrypted vault file
  - Commit and push your changes

### Fetching the borg keys for local storage

279
  - Make sure you have all the GPG keys **at least** locally signed
280
281
  - Run the playbooks/tasks/fetch-borg-keys.yml playbook
  - Make sure the playbook runs successfully and check the keys under the borg-keys directory
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301

## Backup documentation

Backups should be checked now and then. Some common tasks:

### Listing current backups per server

    borg list borg@vostok.archlinux.org:/backup/<hostname>

Example

    borg list borg@vostok.archlinux.org:/backup/homedir.archlinux.org

### Listing files in a backup

    borg list borg@vostok.archlinux.org:/backup/<hostname>::<archive name>

Example

    borg list borg@vostok.archlinux.org:/backup/homedir.archlinux.org::20191127-084357
302
303
304
305
306

## One-shots

A bunch of once-only admin task scripts can be found in `one-shots/`.
We try to minimize the amount of manual one-shot admin work we have to do but sometimes for some migrations it might be necessary to have such scripts.