Update README with documentation overview
This commit is contained in:
@@ -1,3 +1,40 @@
|
|||||||
# infrastructure-docs
|
# Infrastructure Documentation
|
||||||
|
|
||||||
Infrastructure documentation and standards for hobbs.farm
|
Central repository for hobbs.farm infrastructure standards and documentation.
|
||||||
|
|
||||||
|
## Contents
|
||||||
|
|
||||||
|
### Naming Conventions
|
||||||
|
- **[naming-convention.md](naming-convention.md)** - Enterprise naming standard (full specification)
|
||||||
|
- **[naming-convention-simple.md](naming-convention-simple.md)** - Quick reference guide
|
||||||
|
|
||||||
|
### Host Documentation
|
||||||
|
- **[hosts/README.md](hosts/README.md)** - Infrastructure hosts overview
|
||||||
|
- **[hosts/hobbs.md](hosts/hobbs.md)** - Hobbs (primary Docker host) documentation
|
||||||
|
|
||||||
|
## Related Repositories
|
||||||
|
|
||||||
|
| Repository | Description |
|
||||||
|
|------------|-------------|
|
||||||
|
| [ansible-homelab](https://git.hobbs.farm/jeremy/ansible-homelab) | Ansible roles and playbooks for infrastructure automation |
|
||||||
|
| [hobbs-iac](https://git.hobbs.farm/jeremy/hobbs-iac) | Infrastructure as Code configurations |
|
||||||
|
|
||||||
|
## Quick Reference
|
||||||
|
|
||||||
|
### Enterprise Naming Format
|
||||||
|
```
|
||||||
|
<location>-<type><function>-<sequence>
|
||||||
|
```
|
||||||
|
Example: `hf-pdocker-01` = Hobbs.farm Physical Docker host #01
|
||||||
|
|
||||||
|
### Key Hosts
|
||||||
|
| Friendly Name | Formal Name | IP | Role |
|
||||||
|
|---------------|-------------|-----|------|
|
||||||
|
| hobbs | hf-pdocker-01 | 192.168.86.192 | Primary Docker host |
|
||||||
|
| peggy | hf-pdocker-02 | 192.168.86.45 | Secondary Docker (legacy) |
|
||||||
|
| bart | hf-pnvr-01 | 192.168.86.181 | Frigate NVR |
|
||||||
|
| yoda | hf-pnvr-02 | 192.168.86.31 | Blue Iris NVR |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Maintained by Pluto 🪐*
|
||||||
|
|||||||
Reference in New Issue
Block a user