homelab/documentation
Nathan ac6e68e301 docs(ansible): add comprehensive documentation for openapply_app role
Complete role documentation suite per Ansible Galaxy and homelab standards:
- Add role README.md with variable tables, usage examples, and deployment notes
- Add meta/main.yml for Galaxy metadata and collection dependencies
- Add OPENAPPLY-VAULT-REFERENCE.md with vault setup and Proxmox token guide
- Add OPENAPPLY-IMPLEMENTATION-REPORT.md with architecture, validation, and handoff details

Context: Completes the OpenApply LXC deployment implementation from session plan.
This documentation enables users to configure vault secrets, understand role variables,
and execute the two-tier Proxmox provisioning workflow.

Ref: Session plan at /memories/session/plan.md (Phases 1-6 complete)
2026-04-17 19:29:13 -04:00
..

Documentation

Overview

This directory contains all technical documentation for the Castaldi Family Homelab infrastructure.


Quick Reference

📘 Runbooks & Guides


Knowledge Base Articles (KBAs/)

Structured troubleshooting articles following the incident → resolution format.

GitOps & Deployment


Standard Operating Procedures (SOPs/)

Step-by-step guides for operational tasks and migrations.

Infrastructure Deployment

  • SOP-002: Initial Infrastructure Deployment
    Complete guide for deploying the homelab from scratch, including secure repository setup, Ansible control node configuration, core service deployment, and GitOps integration.

Stack Management


Document Conventions

  • KBA-XXX: Troubleshooting articles with clear problem/solution format (stored in KBAs/)
  • SOP-XXX: Procedural guides for operational tasks (stored in SOPs/)
  • Runbooks: Infrastructure reference and emergency procedures (root level)

Contributing

When documenting new issues or procedures:

  1. KBAs: Create in KBAs/ folder for troubleshooting scenarios with clear diagnosis → resolution
  2. SOPs: Create in SOPs/ folder for repeatable operational procedures and migrations
  3. Update Runbook: Add new emergency procedures to TECHNICAL_RUNBOOK.md
  4. Update Repository Memory: Store critical lessons in /memories/repo/
  5. Commit Messages: Use conventional commits (e.g., docs(kba): add KBA-002 for...)

Last Updated: April 12, 2026