Update readme with deployment and update instructions

main
kalle 2025-02-04 06:31:29 +01:00
parent 44ece1a06c
commit ae04786633
2 changed files with 24 additions and 1 deletions

View File

@ -1,6 +1,25 @@
# Home lab configuration # Home lab configuration
The nix based configuration for my home lab. The nix based configuration for my home lab.
## Deploying a new VM
1. Create a clone of the template VM in proxmox.
2. Change cloud-init config of the clone to contain the new IP address.
3. Create the configuration file in the `hosts/` folder.
4. Make sure the IPs match between the configuration file and the cloud-init config.
5. Create a secrets file with `sops edit secrets/HOSTNAME.yml` and put all required secrets in there.
6. Commit changes to git.
7. Start the VM.
8. Deploy the configuration with `colmena apply HOSTNAME`.
9. (Optional) If the VM requires an update to traefik run `colmena apply` to update all hosts.
## Updating packages
1. Run `nix flake update`.
2. Commit the changes to git.
3. Run `colmena apply`.
## File Organization ## File Organization
``` ```
- hosts/ # Host definitions files - hosts/ # Host definitions files
@ -16,6 +35,7 @@ The nix based configuration for my home lab.
### Traefik ### Traefik
HTTP reverse proxy. HTTP reverse proxy.
## TODO: ## TODO:
### Services ### Services
**For sure**: **For sure**:

View File

@ -26,7 +26,10 @@
in in
{ {
devShells.x86_64-linux.default = pkgs.mkShell { devShells.x86_64-linux.default = pkgs.mkShell {
buildInputs = [ pkgs.colmena ]; buildInputs = with pkgs; [
colmena
sops
];
}; };
colmena = colmena =
{ {