Skip to content

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

  1. Open in Obsidian:
  2. Install Obsidian from https://obsidian.md
  3. Open this folder as a vault (File → Open vault → Open folder as vault)
  4. Select: /home/cjustin/homenet-docker-services/obsidian-vault/

  5. Start Here:

  6. Open 00-Index.md (should open automatically)
  7. This is your main navigation hub

  8. Install Recommended Plugins (Optional):

  9. Core plugins: Graph view, Outline, File explorer, Tags pane
  10. 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

Use the Index

  • 00-Index.md is 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
  • 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

  1. Edit existing pages:
  2. Update updated: field in frontmatter
  3. Add changes to relevant sections
  4. Update 00-Index.md if major changes

  5. Add new pages:

  6. Create file in appropriate folder
  7. Add frontmatter with tags
  8. Link from 00-Index.md or parent pages
  9. Add backlinks from related pages

  10. Archive old information:

  11. Move outdated docs to archive/ folder
  12. Update links to point to new docs
  13. Add redirect notes if needed

Regular Reviews

  • Daily: Check 06-Troubleshooting/Known-Issues.md for 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

  1. Identify the appropriate folder
  2. Create markdown file with descriptive name
  3. Add frontmatter (title, tags, dates)
  4. Write content using wiki-links and callouts
  5. Link from parent pages
  6. Update 00-Index.md if 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

![[Other Note]]  # Embeds entire note
![[Other Note#Section]]  # Embeds specific section

Dataview Queries (if plugin installed)

TABLE status, updated
FROM #infrastructure
SORT updated DESC

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

  1. Check 00-Index.md for navigation
  2. Search for topic: Ctrl/Cmd + Shift + F
  3. Review 08-Templates/Quick-Reference-Cards.md
  4. 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.