chore: update README.md

This commit is contained in:
2025-10-16 10:02:43 +10:00
parent 31a11ac255
commit 81698be718

View File

@@ -14,49 +14,19 @@ This repository provisions and manages resources such as the Proxmox VMs and LXC
- Declarative infrastructure management with OpenTofu - Declarative infrastructure management with OpenTofu
- Remote state stored in PostgreSQL backend - Remote state stored in PostgreSQL backend
- Automated formatting, validation, and applies via GitHub Actions
- Secure injection of secrets into `terraform.auto.tfvars` - Secure injection of secrets into `terraform.auto.tfvars`
- Supports Proxmox VM provisioning and Omada configuration - 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 ## 🔄 Workflow
Infrastructure is applied automatically on pushes to the `main` branch.
1. Checkout repo 1. Checkout repo
2. Generate `terraform.auto.tfvars` from GitHub secrets 2. Generate `terraform.auto.tfvars`
3. Run `tofu init`, `tofu fmt`, `tofu validate` 3. Run `tofu init`, `tofu fmt`, `tofu validate`
4. Execute `tofu plan` 4. Execute `tofu plan`
5. If successful, run `tofu apply` 5. If successful, run `tofu apply`
> 🔒 PRs and forks do not run workflows. Only code merged into `main` will trigger an apply.
--- ---
## 📖 Usage ## 📖 Usage