loc_az_hci/docs/INDEX.md

Documentation Index

This is the master index for all project documentation. Documentation is organized by purpose to make it easy to find what you need.

Getting Started

• Quick Start Guide - Get up and running quickly
• Prerequisites - System requirements and prerequisites
• Installation Guide - Step-by-step installation instructions

Architecture

• Architecture Overview - High-level system architecture
• Complete Architecture - Detailed architecture documentation
• Network Topology - Network design and VLAN configuration
• Hardware BOM - Bill of materials and hardware specifications
• PCIe Allocation - PCIe slot allocation map
• Driver Matrix - Driver compatibility matrix

Deployment

• Deployment Guide - Complete deployment instructions
• Bring-Up Checklist - Day-one installation checklist
• Azure Arc Onboarding - Azure Arc integration guide
• Cloudflare Integration - Cloudflare Tunnel and Zero Trust setup

Operations

• Runbooks - Operational procedures
  • Proxmox Operations
  • Azure Arc Troubleshooting
  • GitOps Workflow
• Proxmox Ubuntu Images - Ubuntu image management
• Guest Agent Setup - QEMU guest agent configuration

Troubleshooting

• Common Issues - Frequently encountered problems and solutions
• VM Troubleshooting - VM-specific troubleshooting guide

Security

• Security Guide - Security best practices and configuration
• Proxmox RBAC - Role-based access control for Proxmox

Reference

• API Reference - API documentation
• Command Reference - Command-line reference

Archived Documentation

• Temporary Files - Archived temporary files and status reports

Documentation by Topic

For New Users

1. Start with Quick Start Guide
2. Review Prerequisites
3. Follow Installation Guide

For Deployment

1. Review Architecture Overview
2. Follow Deployment Guide
3. Use Bring-Up Checklist

For Operations

1. Review Runbooks
2. Check Common Issues for problems
3. Refer to Command Reference for commands

For Troubleshooting

1. Check Common Issues
2. Review relevant Runbooks
3. Consult VM Troubleshooting

Contributing to Documentation

When adding or updating documentation:

1. Place files in the appropriate directory
2. Update this index
3. Ensure cross-references are correct
4. Follow the documentation style guide (to be created)

Documentation Maintenance

• Documentation index is auto-generated by scripts/docs/generate-docs-index.sh
• Broken links are validated by scripts/docs/validate-docs.sh
• Diagrams are updated by scripts/docs/update-diagrams.sh