Some checks failed
build configuration / push_to_cache (push) Has been skipped
Check meta / check_meta (push) Failing after 27s
Check meta / check_dns (push) Successful in 47s
build configuration / build_storage01 (push) Successful in 1m28s
build configuration / build_vault01 (push) Successful in 1m33s
build configuration / build_compute01 (push) Successful in 1m34s
build configuration / build_web02 (push) Failing after 1m12s
lint / check (push) Successful in 25s
build configuration / build_web01 (push) Successful in 1m40s
build configuration / build_rescue01 (push) Successful in 1m12s
|
||
---|---|---|
.forgejo/workflows | ||
iso | ||
keys | ||
lib | ||
machines | ||
meta | ||
modules | ||
npins | ||
patches | ||
scripts | ||
.envrc | ||
.gitignore | ||
CONTRIBUTE.md | ||
default.nix | ||
hive.nix | ||
LICENSE | ||
README.md | ||
shell.nix |
❄️ infrastructure
The dgnum infrastructure.
Contributing
Some instruction on how to contribute are available (in french) in /CONTRIBUTE.md. You're expected to read this document before commiting to the repo.
Some documentation for the development tools are provided in the aforementioned file.
Adding a new machine
The first step is to create a minimal viable NixOS host, using tha means necessary. The second step is to find a name for this host, it must be unique from the other hosts.
Tip
For the rest of this part, we assume that the host is named
host02
Download the keys
The public SSH keys of host02
have to be saved to keys/machines/host02.keys
, preferably only the ssh-ed25519
one.
It can be retreived with :
ssh-keyscan address.of.host02 2>/dev/null | awk '/ssh-ed25519/ {print $2,$3}'
Initialize the machine folder and configuration
- Create a folder
host02
undermachines/
- Copy the hardware configuration file generated by
nixos-generate-config
tomachines/host02/_hardware-configuration.nix
- Create a
machines/host02/_configuration.nix
file, it will contain the main configuration options, the basic content of this file should be the following
{ lib, ... }:
lib.extra.mkConfig {
enabledModules = [
# List of modules to enable
];
enabledServices = [
# List of services to enable
];
extraConfig = {
services.netbird.enable = true;
};
root = ./.;
}
Fill in the metadata
Network configuration
The network is declared in meta/network.nix
, the necessary hostId
value can be generated with :
head -c4 /dev/urandom | od -A none -t x4 | sed 's/ //'
Other details
The general metadata is declared in meta/nodes.nix
, the main values to declare are :
site
, where the node is physically locatedstateVersion
nixpkgs
, the nixpkgs version to use
Initialize secrets
Create the directory secrets
in the configuration folder, and add a secrets.nix
file containing :
let
lib = import ../../../lib { };
in
lib.setDefault { publicKeys = lib.getNodeKeys "host02"; } [ ]
This will be used for future secret management.
Update encrypted files
Both the Arkheon, Netbox and notification modules have secrets that are deployed on all machines. To make those services work correctly, run in modules/dgn-records
, modules/dgn-netbox-agent
and modules/dgn-notify
:
agenix -r
Commit and create a PR
Once all of this is done, check that the configuration builds correctly :
colmena build --on host02
Apply it, and create a Pull Request.