homelab/README.md

NixOS x Proxmox infra configuration with Terranix

This repository allows to manage LXC containers on Proxmox.

It's supposed to be used from an host where nixos-rebuild is available.

• Uses nix-community/generators to build a LXC template with a base NixOS container
• Uses terranix to build the infra definition and opentofu to deploy it on Proxmox
• Uses nixos-rebuild to deploy the configuration on the container

My main objective was to have a "light" definition for the containers and to be able to use Nix to factorize configuration.

Usage

Prepare the infra constants

• cp lib/constants.nix.template lib/constants.nix
• adapt lib/constants.nix to match your needs
• touch lib/ips.nix
• remove both these files from .gitignore and git add them.

Build NixOS template

• modify lib/lxc-template.nix as needed
• run build-template
• template available in nixos-template/tarball/ (.tar.xz to be uploaded to Proxmox)

TODO Script the Proxmox Template upload if possible.

Prepare Terraform

• create a user/role etc on Proxmox (see the provider documentation)
• cp terraform.tfvars.example terraform.tfvars
• edit terraform.tfvars to fill in values
• adapt the terraform base config as needed in infra/main.nix
• run tofu init

Adapt NixOS / Terraform modules building

• edit lib/container_build.nix to change how a container definition is translated to TF / NixOS config (in particular check the template name)

Create containers definitions

• run add-lxc [name] [id]
• edit lxc/#NAME#.nix as needed
• run build-terraform-json
• run tofu plan and review the plan
• run tofu apply, hopefully without errors
• run deploy-lxc #NAME#

Update container

• edit lxc/#NAME#.nix as needed
• if the container specs have changed, do all as above
• otherwise you can just run deploy-lxc #NAME#