75 lines
1.9 KiB
Markdown
75 lines
1.9 KiB
Markdown
# Homelab Documentation
|
|
|
|
> Auto-generated documentation for the homelab deployment
|
|
>
|
|
> Generated on: $(date -R)
|
|
> Source: $(pwd)
|
|
|
|
## 📚 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**: ons 30 jul 01:56:04 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
|
|
|
|
## 🎯 Integration with CI/CD
|
|
|
|
### GitHub Actions Example
|
|
|
|
|
|
|
|
### Manual Generation
|
|
|
|
|
|
|
|
---
|
|
|
|
*This documentation reflects the live state of your homelab deployment as evaluated by colmena.*
|