README.md 6.3 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

13
14
### Instructions

Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
15
All systems are set up the same way. For the first time setup in the Hetzner rescue system,
16
run the provisioning script: `ansible-playbook playbooks/tasks/install-arch.yml -l $host`.
Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
17
18
19
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.

20
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`.
21
This playbook is the one regularity used for administrating the server and is entirely idempotent.
Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
22

23
24
25
26
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.

27
28
29
30
31
32
33
34
#### 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
35
36
37
38
39

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
40
    certbot certonly --email webmaster@archlinux.org --agree-tos --rsa-key-size 4096 --renew-by-default --webroot -w /var/lib/letsencrypt/ -d <domain-name>
41

42
43
Note that some roles already run this automatically.

44
#### Note about packer
Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
45
46
47
48

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

49
    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
50
51
52

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

53
#### Note about terraform
54
55

We use terraform to provision a part of the infrastructure on hcloud.
56
57
The very first time you run terraform on your system, you'll have to init it:

58
    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"
59

60
61
62
After making changes to the infrastructure in `archlinux.fg`, run

    terraform plan
63
64
65
66

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

67
    terraform apply
68
69
70

to actually apply your changes.

71
72
73
74
75
76
77
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.

#### Note about opendkim
78
79
80
81
82

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`.

83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
### 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
104
105
106
107
108
109
110

### 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"

111
112
113
114
#### Updating servers

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

115
116
117
118
119
  * pacman -Syu
  * manually update the kernel, since it is in IgnorePkg by default
  * sync
  * checkservices
  * reboot
120

Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
121
122
123
124
125
## Servers

### vostok

#### Services
126
  - backups
Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
127
128
129
130

### orion

#### Services
131
132
133
134
  - 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
135
136
137
138

### apollo

#### Services
139
140
141
142
143
144
145
146
147
148
  - bbs (bbs.archlinux.org)
  - wiki (wiki.archlinux.org)
  - aur (aur.archlinux.org)
  - flyspray (bugs.archlinux.org)
  - mailman
  - planet (planet.archlinux.org)
  - bugs (bugs.archlinux.org)
  - archweb
  - patchwork
  - projects (projects.archlinux.org)
Sven-Hendrik Haase's avatar
Sven-Hendrik Haase committed
149
150
151
152

### soyuz

#### Services
153
154
155
156
157
158
159
160
  - build server (pkgbuild.com)
  - releng
  - sogrep
  - /~user/ webhost
  - irc bot (phrik)
  - matrix
  - docker images
  - arch boxes (packer)
161

162
163
164
### dragon

#### Services
165
166
  - build server (pkgbuild.com)
  - sogrep
167

168
### state.archlinux.org
169
170

#### Services:
171
  - postgres server for terraform state
172

173
174
175
### quassel.archlinux.org

#### Services:
176
  - quassel core
177
178
179
180
181

## Ansible repo workflows

### Replace vault password and change vaulted passwords

182
183
184
185
  - 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`
186