Documentation Restructure
This commit is contained in:
65
index.md
65
index.md
@@ -1,55 +1,36 @@
|
||||
# Home
|
||||
## 🏡 Homelab Documentation Structure
|
||||
|
||||
This documentation details the design, setup, and day-to-day management of my personal homelab environment. The content is shared to benefit others exploring similar projects, from newcomers to advanced users. Topics range from initial hardware choices to complex network and automation workflows.
|
||||
|
||||
!!! info "General Purpose"
|
||||
- Provides a transparent look into my homelab architecture.
|
||||
- Share practical guides, workflows, and lessons learned.
|
||||
- Help others adapt and improve their own setups.
|
||||
## Homelab Documentation Structure
|
||||
This documentation details the design, setup, and day-to-day management of my homelab environment. The goal is to keep it deterministic, CLI-first, and easy to audit or reproduce.
|
||||
|
||||
---
|
||||
|
||||
## 📂 What You’ll Find Here
|
||||
This site is organized into several main areas:
|
||||
## Top-Level Sections
|
||||
**Foundations**
|
||||
- Conventions, templates, glossary, and shared standards
|
||||
|
||||
**Hardware**
|
||||
|
||||
- Rack and device inventory
|
||||
- Storage solutions (disk arrays, NAS, SSD/HDD, etc.)
|
||||
- UPS and power management
|
||||
- Node build sheets, storage layouts, and physical inventory
|
||||
|
||||
**Networking**
|
||||
- Addressing plans, firewall rules, VPNs, and network services
|
||||
|
||||
- Physical and virtual network topology
|
||||
- VLAN, subnets, and IP management
|
||||
- Firewall and security rules
|
||||
- Docker and container network configurations
|
||||
**Platforms**
|
||||
- Virtualization and containerization stacks (hypervisors, Kubernetes, Docker)
|
||||
|
||||
**Servers & Virtualization**
|
||||
**Services**
|
||||
- Deployable apps and services (auth, docs, email, monitoring, etc.)
|
||||
|
||||
- Host OS installation and hardening
|
||||
- Proxmox, Docker, Kubernetes deployment notes
|
||||
- VM/container orchestration
|
||||
- Infrastructure-as-Code
|
||||
**Automation**
|
||||
- Ansible, Puppet, and workflow automation notes
|
||||
|
||||
**Automation & Monitoring**
|
||||
**Operations**
|
||||
- Runbooks for maintenance, backups, and troubleshooting
|
||||
|
||||
- Ansible playbooks and workflows
|
||||
- Monitoring stacks (Prometheus, Grafana, etc.)
|
||||
- Alerting and log management
|
||||
**Reference**
|
||||
- Quick scripts and snippets for day-to-day tasks
|
||||
|
||||
**Application Services**
|
||||
|
||||
- Self-hosted applications and deployment strategies
|
||||
- Reverse proxies, SSL, and SSO integration
|
||||
- Routine maintenance and update automation
|
||||
|
||||
**General Tips & Reference**
|
||||
|
||||
- Command-line snippets and troubleshooting
|
||||
- Backups, recovery, and disaster planning
|
||||
- Migration notes and lessons learned
|
||||
**Blog**
|
||||
- Narrative posts and lessons learned
|
||||
|
||||
---
|
||||
|
||||
@@ -59,17 +40,15 @@ This site is organized into several main areas:
|
||||
- **Personal Environment:** These docs reflect my own environment, goals, and risk tolerance.
|
||||
- **Security & Scale:** Approaches described here are suited to homelab or SMB use, and may need adjustments for enterprise-scale, regulatory compliance, or higher security standards.
|
||||
- **No Credentials:** All sensitive info is redacted or generalized.
|
||||
- **Assumptions:** Some guides assume the use of specific tools, e.g. [Portainer](https://docs.bunny-lab.io/Docker%20%26%20Kubernetes/Servers/Docker/Portainer/), [AWX](https://docs.bunny-lab.io/Docker%20%26%20Kubernetes/Servers/AWX/AWX%20Operator/Ansible%20AWX%20Operator/), etc. Substitute with your preferred tools as needed.
|
||||
- **Assumptions:** Some guides assume specific tools, e.g. [Portainer](./platforms/containerization/docker/deploy-portainer.md), [AWX](./automation/ansible/awx/deployment/awx-operator.md), etc. Substitute with your preferred tools as needed.
|
||||
|
||||
---
|
||||
|
||||
## ✨ Quick Start
|
||||
|
||||
- Use the navigation panel to explore categories or search for keywords.
|
||||
- Each section is designed to be as modular and self-contained as possible.
|
||||
- Feedback and suggestions are always welcome!
|
||||
- Each section is designed to be modular and self-contained.
|
||||
- Feedback and suggestions are always welcome.
|
||||
|
||||
---
|
||||
|
||||
> _“Homelabs are for learning, breaking things, and sharing the journey. Hope you find something helpful here!”_
|
||||
|
||||
|
||||
Reference in New Issue
Block a user