nixos-servers/README.md

48 lines
2.1 KiB
Markdown
Raw Normal View History

2023-11-05 17:43:32 +00:00
# nixos-servers
2024-02-10 22:14:10 +00:00
Nix definitions to configure our server.
Currently, our three main machines and all virtual machines run NixOS!
2023-11-05 17:43:32 +00:00
2024-02-10 22:14:10 +00:00
## Acknowledgements
- [deploy-rs](https://github.com/serokell/deploy-rs): NixOS deploy tool with rollback functionality
- [disko](https://github.com/nix-community/disko): declarative disk partitioning
- [agenix](https://github.com/ryantm/agenix): deployment of encrypted secrets to NixOS machines
- [dns.nix](https://github.com/kirelagin/dns.nix): A Nix DSL for defining DNS zones
- [microvm.nix](https://github.com/astro/microvm.nix): Declarative virtual machine management in NixOS
2023-12-29 11:51:42 +00:00
2024-02-10 22:14:10 +00:00
## Installation
2023-12-29 11:51:42 +00:00
2024-02-10 22:14:10 +00:00
### Prerequisites
2023-11-05 18:03:44 +00:00
2023-11-15 12:24:06 +00:00
1. Install the Nix package manager or NixOS ([link](https://nixos.org/download))
2. Enable flake and nix commands ([link](https://nixos.wiki/wiki/Flakes#Enable_flakes_permanently_in_NixOS))
3. Install Direnv ([link](https://direnv.net/))
4. Allow direnv for this repository: `direnv allow`
2023-11-13 21:44:43 +00:00
2024-02-10 22:14:10 +00:00
### Bootstrapping
2023-11-13 21:44:43 +00:00
2023-11-15 12:24:06 +00:00
We bootstrap our physical server using [nixos-anywhere](https://github.com/nix-community/nixos-anywhere).
This reformats the hard disk of the server and installs a fresh NixOS.
Additionally, it deploys an age identity, which is later used for decrypting secrets.
2023-11-05 18:03:44 +00:00
2023-11-15 12:24:06 +00:00
⚠️ This will wipe your server completely ⚠️
2023-11-05 18:03:44 +00:00
2023-11-15 12:24:06 +00:00
1. Make sure your have a [Secret service](https://www.gnu.org/software/emacs/manual/html_node/auth/Secret-Service-API.html) running (such as Keepassxc) that provides the age identity.
2. Ensure you have root SSH access to the server.
3. Run nixos-anywhere: `./bootstrap.sh <servername> <hostname>`
2023-11-05 18:07:32 +00:00
2024-02-10 22:14:10 +00:00
### Deployment
2023-11-05 18:07:32 +00:00
2024-02-28 21:02:16 +00:00
To deploy all servers at once: `deploy -k`
To deploy only one server: `deploy -k --targets .#<host>`
2024-02-05 21:50:57 +00:00
## Known bugs
When deploying a new virtiofs share, the error `Failed to connect to '<name>.sock': No such file or directory` can occur.
This seems to be a bug in `microvm.nix` and I opened a bug report [here](https://github.com/astro/microvm.nix/issues/200).
A workaround is to deploy the share without `deploy-rs`'s rollback feature enabled:
```
2024-02-28 21:02:16 +00:00
deploy -k --targets .#lewis --auto-rollback false --magic-rollback false
2024-02-05 21:50:57 +00:00
```