99 lines
2.4 KiB
Markdown
99 lines
2.4 KiB
Markdown
# Homelab Documentation
|
|
|
|
> Auto-generated documentation for the homelab deployment
|
|
>
|
|
> Generated on: Wed, 30 Jul 2025 02:30:55 +0200
|
|
> Source: /home/plasmagoat/homelab
|
|
|
|
## 📚 Documentation Files
|
|
|
|
This documentation is automatically generated from your colmena flake configuration.
|
|
|
|
### 📊 Overview Documents
|
|
- **[Fleet Overview](fleet-overview.md)** - High-level fleet statistics and service distribution
|
|
- **[Current Deployment](current-deployment.md)** - Current deployment state and node status
|
|
|
|
### 📖 Detailed Configuration
|
|
- **[Node Configurations](nodes.md)** - Per-node detailed configuration and services
|
|
- **[Service Configurations](services.md)** - Service configurations across the fleet
|
|
|
|
## 🚀 Quick Actions
|
|
|
|
### View Current Status
|
|
```bash
|
|
# Service status across fleet (if homelab CLI is available)
|
|
homelab services --global
|
|
|
|
# Backup status
|
|
homelab backups --global
|
|
|
|
# Overall status
|
|
homelab status
|
|
```
|
|
|
|
### Update Documentation
|
|
```bash
|
|
# Regenerate all documentation
|
|
homelab-generate-docs ./docs
|
|
|
|
# Generate in different directory
|
|
homelab-generate-docs /path/to/output
|
|
```
|
|
|
|
## 📋 Quick Stats
|
|
|
|
- **Total Nodes**: 2
|
|
- **Homelab-Enabled Nodes**: 2
|
|
- **Generated**: Wed, 30 Jul 2025 02:30:59 +0200
|
|
|
|
## 🛠️ Management Tools
|
|
|
|
### Documentation Commands
|
|
- `homelab-generate-docs` - Regenerate this documentation
|
|
- `homelab-docs-fleet` - Generate fleet overview only
|
|
- `homelab-docs-nodes` - Generate node configurations only
|
|
- `homelab-docs-services` - Generate service configurations only
|
|
- `homelab-docs-deployment` - Generate deployment state only
|
|
|
|
### Colmena Commands
|
|
- `colmena eval` - Evaluate flake expressions
|
|
- `colmena apply` - Deploy configuration changes
|
|
- `colmena build` - Build configurations without deploying
|
|
|
|
## 🎯 Integration with CI/CD
|
|
|
|
### GitHub Actions Example
|
|
|
|
```yaml
|
|
name: Generate Documentation
|
|
on:
|
|
push:
|
|
branches: [ main ]
|
|
|
|
jobs:
|
|
docs:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: cachix/install-nix-action@v24
|
|
- name: Generate docs
|
|
run: nix develop --command homelab-generate-docs ./docs
|
|
- name: Commit docs
|
|
run: |
|
|
git add docs/
|
|
git commit -m "docs: update homelab documentation" || exit 0
|
|
git push
|
|
```
|
|
|
|
### Manual Generation
|
|
|
|
```bash
|
|
# From your homelab directory
|
|
nix develop
|
|
homelab-generate-docs ./docs
|
|
git add docs/ && git commit -m "Update docs"
|
|
```
|
|
|
|
---
|
|
|
|
*This documentation reflects the live state of your homelab deployment as evaluated by colmena.*
|