Skip to content

Restructure repo to docs-first Proxmox homelab platform and archive legacy Talos/PXE#9

Closed
azunaVT wants to merge 5 commits intomainfrom
codex/restructure-repository-for-documentation-first-direction-7ck07p
Closed

Restructure repo to docs-first Proxmox homelab platform and archive legacy Talos/PXE#9
azunaVT wants to merge 5 commits intomainfrom
codex/restructure-repository-for-documentation-first-direction-7ck07p

Conversation

@azunaVT
Copy link
Collaborator

@azunaVT azunaVT commented Mar 10, 2026

Motivation

  • Pivot the repository from an infrastructure-code-first Talos/PXE focus to a documentation-first homelab platform centered on Proxmox virtualization and staged modernization.
  • Preserve prior bare-metal Talos/PXE and Flux/Terraform artifacts as a clearly labeled archive for historical reference rather than deleting them.
  • Avoid inventing missing technical details and surface unknowns as explicit TODOs so reviewers can supply facts rather than assumptions.

Description

  • Introduced a docs-first top-level layout and supporting areas including docs/{vision,inventory,architecture,decisions,runbooks,roadmap,archive}, proxmox/, kubernetes/, argocd/, automation/, ai/, and scripts/, and added concise starter READMEs.
  • Moved existing legacy infra into docs/archive/legacy-baremetal-talos-pxe/infra-legacy/ and replaced the environment tfvars with a redacted structural example to avoid exposing private values.
  • Added a set of ADRs (ADR-001..ADR-005) in docs/decisions/ using the requested ADR format, plus foundational docs for vision, inventory, architecture, runbooks, and a phased roadmap/backlog.
  • Added GitHub-native templates in .github/ISSUE_TEMPLATE/ (task.yml, epic.yml, decision.yml) and a .github/pull_request_template.md to support project tracking and reviews.

Testing

  • Verified presence and layout of created directories and files using filesystem inspection commands such as find and confirmed file contents with lightweight readers (nl/sed).
  • Scanned archived Terraform files for environment-specific values and confirmed sensitive values were redacted with rg to avoid leaking operational details.
  • Confirmed all new documentation and template files exist and contain the requested TODO markers where facts are intentionally missing.
  • No CI pipeline was run in this environment; remote repository operations were not performed from this session due to the environment configuration.

Codex Task

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Restructures the repository into a documentation-first homelab platform centered on a Proxmox-first direction, while archiving the prior Talos/PXE + Flux/Terraform/OpenTofu implementation as legacy reference material.

Changes:

  • Adds foundational docs (vision, inventories, architecture, runbooks, roadmap) plus ADRs capturing baseline decisions.
  • Introduces new top-level “areas” (proxmox/, kubernetes/, argocd/, automation/, ai/, scripts/) with starter READMEs.
  • Archives the legacy Talos/PXE infrastructure under docs/archive/legacy-baremetal-talos-pxe/ and replaces env tfvars with a redacted structural example.

Reviewed changes

Copilot reviewed 34 out of 66 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
scripts/README.md Adds scripts area README for operational helpers.
proxmox/README.md Adds Proxmox area README with TODOs.
kubernetes/README.md Adds Kubernetes area README with TODOs.
infra/live/prod/terraform.auto.tfvars Removes legacy prod tfvars from the active path.
docs/vision/homelab-vision.md Defines purpose/principles/non-goals/constraints for the homelab direction.
docs/runbooks/bootstrap-sequence.md Adds high-level bootstrap sequence runbook.
docs/roadmap/milestones.md Defines milestone plan M0–M9.
docs/roadmap/media-migration.md Adds phased media migration planning track.
docs/roadmap/current-phase.md Documents current phase focus and DoD.
docs/roadmap/backlog.md Seeds an initial backlog checklist.
docs/inventory/service-inventory.md Adds starter service inventory with TODOs.
docs/inventory/network-inventory.md Adds starter network inventory with TODOs.
docs/inventory/hardware-inventory.md Adds starter hardware inventory with TODOs.
docs/inventory/current-media-stack.md Captures current media stack components and constraints at a non-sensitive level.
docs/decisions/ADR-001-proxmox-first.md Records Proxmox-first decision.
docs/decisions/ADR-002-k8s-inside-proxmox.md Records decision to run Kubernetes inside Proxmox VMs.
docs/decisions/ADR-003-argocd-over-flux.md Records preference for Argo CD over Flux.
docs/decisions/ADR-004-truenas-separate.md Records decision to keep TrueNAS as separate storage anchor.
docs/decisions/ADR-005-media-platform-stays-separate-from-core-lab.md Records media platform as parallel track decision.
docs/archive/legacy-baremetal-talos-pxe/README.md Documents archive intent/status for legacy direction.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/README.md Preserves legacy infra README and prerequisites.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/live/dev/.gitkeep Keeps legacy dev env directory present.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/live/prod/.terraform.lock.hcl Preserves legacy OpenTofu/Terraform dependency lockfile.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/live/prod/main.tf Preserves legacy root module wiring for baremetal/Talos/Flux.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/live/prod/providers.tf Preserves legacy provider configuration (k8s/helm/github).
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/live/prod/terraform.auto.tfvars Adds redacted legacy tfvars example.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/live/prod/variables.tf Preserves legacy root input variable definitions.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/baremetal/main.tf Preserves legacy baremetal PXE bootstrap module.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/baremetal/outputs.tf Preserves baremetal module outputs.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/baremetal/providers.tf Preserves baremetal module provider constraints.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/baremetal/variables.tf Preserves baremetal module inputs/validation.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/cluster/main.tf Preserves legacy Talos cluster bootstrap + kubeconfig output module.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/cluster/outputs.tf Preserves cluster module outputs for kube provider wiring.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/cluster/providers.tf Preserves cluster module provider constraints.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/cluster/variables.tf Preserves cluster module inputs.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/config/main.tf Preserves legacy config/secrets + helm templating module.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/config/outputs.tf Preserves config module sensitive outputs.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/config/providers.tf Preserves config module provider constraints.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/config/variables.tf Preserves config module inputs.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/flux/main.tf Preserves legacy Flux operator/instance install module.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/flux/providers.tf Preserves flux module provider constraints.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/flux/values/components.yaml Preserves Flux components configuration/patches.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/flux/variables.tf Preserves flux module inputs.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/github_deploy_key/main.tf Preserves legacy GitHub deploy key module.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/github_deploy_key/outputs.tf Preserves deploy key module outputs.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/github_deploy_key/providers.tf Preserves deploy key module provider constraints.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/github_deploy_key/variables.tf Preserves deploy key module inputs.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/node/main.tf Preserves legacy Talos node apply module.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/node/providers.tf Preserves node module provider constraints.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/node/templates/cilium-install.yaml.tftpl Preserves inline-manifest Cilium installer job template.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/node/templates/controlplane.yaml.tftpl Preserves Talos controlplane config patch template.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/node/templates/worker.yaml.tftpl Preserves legacy worker template placeholder.
docs/archive/legacy-baremetal-talos-pxe/infra-legacy/modules/node/variables.tf Preserves node module inputs.
docs/architecture/target-architecture.md Defines planned target architecture layers and TODOs.
docs/architecture/security-model.md Adds initial security model principles and TODOs.
docs/architecture/proxmox-k8s-strategy.md Documents Proxmox+Kubernetes strategy and sequencing.
docs/architecture/network-topology.md Adds initial network topology intent and TODOs.
docs/architecture/media-platform.md Documents current/future media platform architecture considerations.
automation/README.md Adds automation area README.
argocd/README.md Adds Argo CD area README with TODOs.
ai/README.md Adds AI area README.
README.md Adds top-level docs-first navigation and “start here” pointers.
.github/pull_request_template.md Adds PR template aligned to restructure/archive/docs review flow.
.github/ISSUE_TEMPLATE/task.yml Adds GitHub issue form for tasks.
.github/ISSUE_TEMPLATE/epic.yml Adds GitHub issue form for epics.
.github/ISSUE_TEMPLATE/decision.yml Adds GitHub issue form for decision proposals.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

azunaVT and others added 4 commits March 11, 2026 17:22
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…/terraform.auto.tfvars

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 34 out of 66 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

@azunaVT azunaVT closed this Mar 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants