Skip to content

Repository Map

The Azure Kubernetes Service Practical Guide is organized to mirror the workflow of deploying, operating, and troubleshooting AKS — from cluster architecture to production diagnosis. This page explains the structure and purpose of each section so you can jump directly to what you need.

graph TD
    Root[docs/] --> Start[start-here/]
    Root --> Platform[platform/]
    Root --> BP[best-practices/]
    Root --> Ops[operations/]
    Root --> Tut[tutorials/]
    Root --> Trouble[troubleshooting/]
    Root --> Ref[reference/]

Directory Structure

  • docs/start-here/
    • overview.md: Introduction to Azure Kubernetes Service and this guide.
    • learning-paths.md: Role-based reading paths for architects, operators, and troubleshooters.
    • repository-map.md: This file — a map of major sections and when to use them.
    • prerequisites.md: Required Azure, Kubernetes, networking, and tooling readiness.
    • aks-vs-other-compute.md: Positioning AKS against App Service and Azure Container Apps.
  • docs/platform/
    • Core concepts: cluster architecture, node pools, networking models, ingress and load balancing, identity and secrets, storage options, and scaling.
  • docs/best-practices/
    • Production patterns: production baseline, security, networking, resource governance, reliability, cost optimization, and common anti-patterns.
  • docs/operations/
    • Day-2 execution: cluster creation, node pool operations, upgrades, scaling operations, monitoring and logging, maintenance windows, and credential rotation.
  • docs/tutorials/
    • Hands-on lab guides: AKS cluster deployment, Application Gateway ingress, Azure Key Vault CSI driver, Azure Policy for AKS, and disaster recovery.
  • docs/troubleshooting/
    • Diagnosis-first content: architecture overview, decision tree, evidence map, mental model, quick diagnosis cards, first-10-minutes runbooks, and playbooks for pod, node, connectivity, and operations scenarios.
  • docs/reference/
    • Quick-lookup material: CLI cheatsheet, diagnostic commands, limits and quotas, version support, and glossary.

When to Use Each Section

If you want to... Go to
Understand AKS concepts Platform
Design a production cluster architecture Best Practices
Operate a cluster in production Operations
Practice with a hands-on lab Tutorials
Diagnose a live incident Troubleshooting
Look up a command or limit Reference

See Also

Sources