2021-12-30 20:23:24 +00:00
|
|
|
# Deuxfleurs on NixOS!
|
|
|
|
|
|
|
|
This repository contains code to run Deuxfleur's infrastructure on NixOS.
|
|
|
|
|
|
|
|
It sets up the following:
|
|
|
|
|
|
|
|
- A Wireguard mesh between all nodes
|
|
|
|
- Consul, with TLS
|
|
|
|
- Nomad, with TLS
|
|
|
|
|
2022-04-20 14:13:14 +00:00
|
|
|
|
2022-10-16 09:14:50 +00:00
|
|
|
## How to welcome a new administrator
|
2022-04-20 14:13:14 +00:00
|
|
|
|
2022-10-16 09:14:50 +00:00
|
|
|
See: https://guide.deuxfleurs.fr/operations/acces/pass/
|
2022-04-20 14:13:14 +00:00
|
|
|
|
2022-10-16 09:14:50 +00:00
|
|
|
Basically:
|
|
|
|
- The new administrator generates a GPG key and publishes it on Gitea
|
|
|
|
- All existing administrators pull their key and sign it
|
|
|
|
- An existing administrator reencrypt the keystore with this new key and push it
|
|
|
|
- The new administrator clone the repo and check that they can decrypt the secrets
|
2022-10-16 09:58:11 +00:00
|
|
|
- Finally, the new administrator must choose a password to operate over SSH with `./passwd prod rick` where `rick` is the target username
|
2022-04-20 16:14:56 +00:00
|
|
|
|
2022-10-16 10:02:55 +00:00
|
|
|
|
2022-10-16 09:14:50 +00:00
|
|
|
## How to create files for a new zone
|
2022-04-20 14:13:14 +00:00
|
|
|
|
2022-10-16 09:14:50 +00:00
|
|
|
*The documentation is written for the production cluster, the same apply for other clusters.*
|
2022-04-20 14:13:14 +00:00
|
|
|
|
2022-10-16 09:14:50 +00:00
|
|
|
Basically:
|
|
|
|
- Create your `site` file in `cluster/prod/site/` folder
|
|
|
|
- Create your `node` files in `cluster/prod/node/` folder
|
2022-10-16 10:02:55 +00:00
|
|
|
- Add your wireguard configuration to `cluster/prod/cluster.nix`
|
|
|
|
- You will have to edit your NAT config manually
|
|
|
|
- To get your node's wg public key, you must run `./deploy_prod prod <node>`, see the next section for more information
|
2022-10-16 12:13:55 +00:00
|
|
|
- Add your nodes to `cluster/prod/ssh_config`, it will be used by the various SSH scripts.
|
|
|
|
- If you use `ssh` directly, use `ssh -F ./cluster/prod/ssh_config`
|
2022-10-16 12:45:57 +00:00
|
|
|
- Add `User root` for the first time as your user will not be declared yet on the system
|
2022-04-20 14:13:14 +00:00
|
|
|
|
2022-10-16 09:14:50 +00:00
|
|
|
## How to deploy a Nix configuration on a fresh node
|
2022-04-20 14:13:14 +00:00
|
|
|
|
2022-10-16 09:58:11 +00:00
|
|
|
We suppose that the node name is `datura`.
|
|
|
|
Start by doing the deployment one node at a time, you will have plenty of time
|
|
|
|
in your operator's life to break everything through automation.
|
|
|
|
|
|
|
|
Run:
|
|
|
|
- `./deploy_wg prod datura` - to generate wireguard's keys
|
2022-10-16 10:11:02 +00:00
|
|
|
- `./deploy_nixos prod datura` - to deploy the nix configuration files
|
|
|
|
- need to be redeployed on all nodes as the new wireguard conf is needed everywhere
|
2022-10-16 09:58:11 +00:00
|
|
|
- `./deploy_password prod datura` - to deploy user's passwords
|
2022-10-16 10:11:02 +00:00
|
|
|
- need to be redeployed on all nodes to setup the password on all nodes
|
2022-10-16 09:58:11 +00:00
|
|
|
- `./deploy_pki prod datura` - to deploy Nomad's and Consul's PKI
|
2022-04-20 14:13:14 +00:00
|
|
|
|
2022-10-16 09:14:50 +00:00
|
|
|
## How to operate a node
|
2022-04-20 14:13:14 +00:00
|
|
|
|
2022-10-16 13:20:16 +00:00
|
|
|
Edit your `~/.ssh/config` file:
|
|
|
|
|
|
|
|
```
|
|
|
|
Host dahlia
|
|
|
|
HostName dahlia.machine.deuxfleurs.fr
|
|
|
|
LocalForward 14646 127.0.0.1:4646
|
|
|
|
LocalForward 8501 127.0.0.1:8501
|
|
|
|
LocalForward 1389 bottin.service.prod.consul:389
|
|
|
|
LocalForward 5432 psql-proxy.service.prod.consul:5432
|
|
|
|
```
|
|
|
|
|
|
|
|
And then run the TLS proxy:
|
|
|
|
|
|
|
|
```
|
|
|
|
./tlsproxy prod
|
|
|
|
```
|
|
|
|
|
|
|
|
And then open in your browser:
|
|
|
|
|
|
|
|
- http://localhost:8500
|
|
|
|
- http://localhost:4646
|
|
|
|
|
2022-04-20 14:13:14 +00:00
|
|
|
|
2022-10-16 09:14:50 +00:00
|
|
|
## More
|
2021-12-30 20:23:24 +00:00
|
|
|
|
2022-10-16 09:14:50 +00:00
|
|
|
Please read README.more.md for more detailed information
|