From 81698be7181172e424016a7b66cd32909ce15409 Mon Sep 17 00:00:00 2001 From: Matthew McKinnon Date: Thu, 16 Oct 2025 10:02:43 +1000 Subject: [PATCH] chore: update README.md --- README.md | 32 +------------------------------- 1 file changed, 1 insertion(+), 31 deletions(-) diff --git a/README.md b/README.md index fdfb43d..c5d6bb1 100644 --- a/README.md +++ b/README.md @@ -14,49 +14,19 @@ This repository provisions and manages resources such as the Proxmox VMs and LXC - Declarative infrastructure management with OpenTofu - Remote state stored in PostgreSQL backend -- Automated formatting, validation, and applies via GitHub Actions - Secure injection of secrets into `terraform.auto.tfvars` - Supports Proxmox VM provisioning and Omada configuration --- -## 📂 Repository Layout - -``` -├── dev-docker.tf # Docker VM definitions -├── github.tf # GitHub repo/org configuration -├── omada.tf # Omada network definitions -├── provider.tf # Provider setup and backend configuration -``` - ---- - -## ⚙️ Requirements - -- **OpenTofu** (installed automatically in GitHub Actions via [`opentofu/setup-opentofu`](https://github.com/opentofu/setup-opentofu)) -- **PostgreSQL** database for remote state - Connection string provided via secret: `PG_CONN_STR` -- **GitHub Actions self-hosted runner** with access to Proxmox and Omada APIs -- Configured repository secrets: - - `PG_CONN_STR` - - `CI_USER`, `CI_PASSWORD` - - `PVE_API_URL`, `PVE_API_TOKEN_ID`, `PVE_API_TOKEN_SECRET` - - `SSH_PRIVATE_KEY`, `SSH_PASSPHRASE` - ---- - ## 🔄 Workflow -Infrastructure is applied automatically on pushes to the `main` branch. - 1. Checkout repo -2. Generate `terraform.auto.tfvars` from GitHub secrets +2. Generate `terraform.auto.tfvars` 3. Run `tofu init`, `tofu fmt`, `tofu validate` 4. Execute `tofu plan` 5. If successful, run `tofu apply` -> 🔒 PRs and forks do not run workflows. Only code merged into `main` will trigger an apply. - --- ## 📖 Usage