auto docs
This commit is contained in:
parent
a955528e44
commit
ce8c543e84
18 changed files with 3129 additions and 55 deletions
65
docs/README.md
Normal file
65
docs/README.md
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
# Homelab Documentation
|
||||
|
||||
> Auto-generated documentation for the homelab deployment
|
||||
>
|
||||
> Generated on: tir 29 jul 16:25:52 CEST 2025
|
||||
> 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**: tir 29 jul 16:25:55 CEST 2025
|
||||
|
||||
## 🛠️ 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
|
||||
|
||||
---
|
||||
|
||||
*This documentation reflects the live state of your homelab deployment as evaluated by colmena.*
|
||||
Loading…
Add table
Add a link
Reference in a new issue