HomeNet Docker Swarm Infrastructure - Obsidian Vault¶
Documentation Version: 1.0 Created: 2026-01-11 Last Updated: 2026-01-11
Welcome¶
This Obsidian vault contains comprehensive documentation for a production-grade, multi-node Docker Swarm infrastructure managing 73+ services across 5 nodes. The documentation is organized for easy navigation, cross-referenced with wiki-links, and includes troubleshooting runbooks, operational procedures, and architectural diagrams.
Quick Start¶
- Open in Obsidian:
- Install Obsidian from https://obsidian.md
- Open this folder as a vault (File → Open vault → Open folder as vault)
-
Select:
/home/cjustin/homenet-docker-services/obsidian-vault/ -
Start Here:
- Open
00-Index.md(should open automatically) -
This is your main navigation hub
-
Install Recommended Plugins (Optional):
- Core plugins: Graph view, Outline, File explorer, Tags pane
- Community plugins: Dataview (for dynamic queries), Excalidraw (for diagrams)
Vault Structure¶
obsidian-vault/
├── 00-Index.md # Main navigation hub (start here!)
│
├── 01-Infrastructure/ # Node topology & architecture
│ ├── Cluster-Overview.md
│ ├── Node-201-Manager.md
│ ├── Node-202-Worker.md
│ ├── Node-203-Worker.md
│ ├── Node-204-Worker.md
│ ├── Node-205-Worker.md
│ └── Network-Architecture.md
│
├── 02-Services/ # Service catalog & stack details
│ ├── Service-Catalog.md # Complete service inventory
│ ├── Stack-Homenet1.md
│ ├── Stack-Homenet2.md
│ ├── Stack-Homenet3.md
│ ├── Stack-Homenet4.md
│ ├── Stack-Traefik.md
│ ├── Monitoring-Stack.md
│ ├── ARR-Stack.md
│ └── Critical-Services-Offline.md
│
├── 03-Operations/ # Daily operations & procedures
│ ├── Daily-Operations.md
│ ├── Stack-Deployment.md
│ ├── Script-Reference.md
│ ├── Cron-Jobs.md
│ └── Backup-Procedures.md
│
├── 04-Monitoring/ # Prometheus, Grafana, health checks
│ ├── Prometheus-Setup.md
│ ├── Grafana-Dashboards.md
│ ├── Service-Health.md
│ └── Metrics-Exporters.md
│
├── 05-Storage/ # NFS, volumes, capacity planning
│ ├── NFS-Architecture.md
│ ├── Storage-Critical-Warning.md
│ └── Volume-Management.md
│
├── 06-Troubleshooting/ # Known issues & runbooks
│ ├── Known-Issues.md # Current problems & gaps
│ ├── ELK-Stack-Offline.md
│ ├── Service-Restart-Runbook.md
│ ├── Database-Recovery.md
│ └── NFS-Mount-Issues.md
│
├── 07-Documentation/ # Existing docs index
│ └── Existing-Docs-Index.md
│
├── 08-Templates/ # Reusable templates
│ ├── Service-Addition-Template.md
│ ├── Troubleshooting-Template.md
│ └── Quick-Reference-Cards.md # Cheat sheet!
│
└── _assets/ # Images, diagrams, attachments
Organization Philosophy¶
1. Wiki-Style Linking¶
- Documents use
[[Wiki Links]]for internal references - Click any link to navigate to related documentation
- Use Graph View (Ctrl/Cmd + G) to visualize connections
2. Tags for Discovery¶
#infrastructure- Node and cluster architecture#services- Service definitions and stacks#operations- Procedures and workflows#troubleshooting- Issues and runbooks#critical- Important/urgent items#monitoring- Observability and metrics
3. Callouts for Important Info¶
> [!danger]- Critical warnings> [!warning]- Important cautions> [!info]- General information> [!tip]- Helpful hints> [!success]- Completed items
4. Mermaid Diagrams¶
- Architecture diagrams embedded in markdown
- Automatically rendered in Obsidian
- Editable text-based format
Navigation Tips¶
Use the Index¶
00-Index.mdis your main hub- Contains links to all major sections
- Shows critical alerts and recent updates
Search Everything¶
Ctrl/Cmd + O- Quick switcher (find files)Ctrl/Cmd + Shift + F- Search in all files- Use tags to filter:
tag:#infrastructure
Graph View¶
Ctrl/Cmd + G- Open graph view- Visualize relationships between notes
- Filter by tags or file names
Backlinks¶
- See "Backlinks" pane for pages linking to current page
- Helps discover related documentation
Critical Information¶
Active Alerts¶
🔴 ELK Stack Offline
- No centralized logging (Elasticsearch, Logstash, Kibana offline)
- See: 06-Troubleshooting/ELK-Stack-Offline.md
🔴 Storage Near Capacity
- Multiple NFS mounts at 92% (254GB remaining)
- See: 05-Storage/Storage-Critical-Warning.md
🟡 Swarmpit Agent Missing
- 4/5 global instances (one node not reporting)
- See: 06-Troubleshooting/Known-Issues.md
Quick Access URLs¶
Monitoring: - Grafana: http://100.1.100.201:3010 - Prometheus: http://100.1.100.201:9090 - Uptime Kuma: http://100.1.100.201:3001
Dashboards: - Homer: http://100.1.100.201:8080 - Homepage: http://100.1.100.201:3000 - Swarmpit: (cluster management)
Infrastructure: - Proxmox-1: https://100.1.100.10:8006 - Proxmox-2: https://100.1.100.15:8006 - OMV NFS Server: 100.1.100.199 - Pi DNS: 100.1.100.11
Documentation Standards¶
Frontmatter¶
All documents include YAML frontmatter:
---
title: Document Title
tags:
- category
- subcategory
created: YYYY-MM-DD
updated: YYYY-MM-DD
aliases:
- Alternative Name
---
Linking Conventions¶
- Use
[[Page Name]]for internal links - Use
[[Page Name|Display Text]]for custom text - Use
[[Folder/Page Name]]for pages in subfolders - Use
[[Page Name#Section]]to link to specific section
Code Blocks¶
- Always specify language:
```bash,```yaml, etc. - Include comments for complex commands
- Use
#for inline comments
Tables¶
- Use markdown tables for structured data
- Include headers for clarity
- Align columns for readability
Maintenance¶
Updating Documentation¶
- Edit existing pages:
- Update
updated:field in frontmatter - Add changes to relevant sections
-
Update
00-Index.mdif major changes -
Add new pages:
- Create file in appropriate folder
- Add frontmatter with tags
- Link from
00-Index.mdor parent pages -
Add backlinks from related pages
-
Archive old information:
- Move outdated docs to
archive/folder - Update links to point to new docs
- Add redirect notes if needed
Regular Reviews¶
- Daily: Check
06-Troubleshooting/Known-Issues.mdfor updates - Weekly: Update service status in
02-Services/Service-Catalog.md - Monthly: Review and update monitoring documentation
- Quarterly: Audit entire vault for accuracy
External Documentation¶
This vault complements the main repository documentation:
Primary Repository: /home/cjustin/homenet-docker-services/
Key Files:
- CLAUDE.md - AI assistant instructions and architecture
- README.md - High-level overview
- MONITORING.md - Monitoring setup guide
- DEPLOYMENT-SUMMARY.md - Deployment notes
- 50+ other markdown files in repository root
Integration: - This vault organizes existing information - Links to repository files where appropriate - Adds runbooks and troubleshooting guides - Provides navigation structure
Contributing¶
Adding New Documentation¶
- Identify the appropriate folder
- Create markdown file with descriptive name
- Add frontmatter (title, tags, dates)
- Write content using wiki-links and callouts
- Link from parent pages
- Update
00-Index.mdif major addition
Reporting Issues¶
Document problems in 06-Troubleshooting/Known-Issues.md:
- Include severity (Critical, Warning, Info)
- Document symptoms and impact
- Add troubleshooting steps
- Link to relevant runbooks
Useful Obsidian Features¶
Embedded Notes¶
Dataview Queries (if plugin installed)¶
Templates¶
- Store templates in
08-Templates/ - Use Templates core plugin
- Consistent structure for similar docs
Excalidraw Diagrams (if plugin installed)¶
- Create visual diagrams
- Embedded in markdown files
- Stored in
_assets/
Getting Help¶
Within Vault¶
- Check
00-Index.mdfor navigation - Search for topic:
Ctrl/Cmd + Shift + F - Review
08-Templates/Quick-Reference-Cards.md - Check
06-Troubleshooting/Known-Issues.md
External Resources¶
- Obsidian Documentation: https://help.obsidian.md
- Docker Swarm Docs: https://docs.docker.com/engine/swarm/
- Repository:
/home/cjustin/homenet-docker-services/
Version History¶
v1.0 - 2026-01-11: - Initial vault creation - Complete infrastructure documentation - Service catalog and node details - Troubleshooting runbooks - Quick reference cards - Templates for common tasks
License & Attribution¶
Created: 2026-01-11 For: HomeNet Docker Swarm Infrastructure Research Date: 2026-01-11 Documentation System: Obsidian.md
Questions? Check 00-Index.md or search the vault for your topic.