Repository Map¶

The Azure Container Apps Guide is a comprehensive hub for all things Container Apps and Jobs. This page describes the structure and how to find what you need.

Hub Sections¶

The hub is divided into 5 main categories to help you navigate based on your current task:

1. Start Here: The entry point for everyone. Includes a platform overview, learning paths for different skill levels, and this repository map.
2. Platform: Architectural and conceptual guides. This is where you go to design your application, covering scaling, networking, identity, and jobs.
3. Language Guides: Practical, language-specific implementation. Includes step-by-step tutorials, runtime guides, and integration recipes.
4. Operations: Focuses on running in production. Covers deployment patterns, monitoring, alerts, and operational tasks like secret rotation.
5. Troubleshooting: A systematic guide to fixing issues. Includes quick triage steps, detailed playbooks, and Lab Guides for practice.

Directory Structure¶

In addition to the documentation, this repository contains practical code samples:

• app/python/: A reference Flask application that follows production-ready patterns for Container Apps (health checks, structured logging, graceful shutdown).
• jobs/python/: A reference job implementation showing how to run event-driven or scheduled tasks.
• labs/: Practical troubleshooting labs designed to help you practice diagnosing common Container Apps issues.
• infra/: Bicep infrastructure templates for deploying the reference apps and environments.

How to Navigate¶

Use this simple logic to find your way:

• "I'm new": Start with Start Here and follow the Learning Paths.
• "I'm designing": Head to the Platform section to understand your architectural options.
• "I'm coding": Go to Language Guides for tutorials and recipes.
• "I'm deploying/running": See the Operations hub for production practices.
• "Something is broken": Check the Troubleshooting hub immediately.

Navigation Flow¶

graph TD
    Start[Start Here] --> Learn[Learning Paths]
    Learn --> Design[Platform Section]
    Design --> Implement[Language Guides]
    Implement --> Ops[Operations Guide]
    Ops --> Problem{Issue?}
    Problem -- Yes --> Fix[Troubleshooting Hub]
    Problem -- No --> Running[Production Stable]

Navigation by Goal¶

Use this table when you need a direct path from a practical goal to the right part of the repository.

Visual Repository Topology¶

graph TD
    R[Repository Root] --> D[docs]
    R --> A[apps]
    R --> J[jobs]
    R --> L[labs]
    R --> I[infra]
    D --> SH[start-here]
    D --> P[platform]
    D --> BP[best-practices]
    D --> LG[language-guides]
    D --> O[operations]
    D --> T[troubleshooting]
    D --> REF[reference]

What Lives Where¶

Quick Entry Paths by Persona¶

Suggested Onboarding Sequence¶

1. Read overview.md to align on scope.
2. Read when-to-use-container-apps.md to validate service choice.
3. Follow learning-paths.md by role.
4. Complete at least one tutorial track in docs/language-guides/python/.
5. Set up monitoring and alerts from docs/operations/ before production traffic.

See Also¶

• Platform Overview
• Learning Paths
• Language Guides
• When to Use Container Apps
• Best Practices Hub
• Operations Hub
• Troubleshooting Hub
• Reference Hub

Sources¶

• Azure Container Apps documentation (Microsoft Learn)
• Well-Architected Framework for Azure Container Apps (Microsoft Learn)
• Deploy to Azure Container Apps (Microsoft Learn)