README.md

Azure Mission-Critical - Full List of Documentation

Azure Mission-Critical Landing Page

• Landing Page

Introduction to Azure Mission-Critical

• Introduction (➡️ Azure/Mission-Critical)

Azure Mission-Critical Reference Implementation Guide

• Overview
• Getting Started
  • Getting Started using CLI
  • Set up private build agents
• Frequently Asked Questions (FAQs)
• Critical Design Areas
  • Application Design
    • Application Design
    • Business Continuity / Disaster Recovery
    • SLO and Availability
  • Data Platform
    • Data Platform Design Decisions
  • Health Modelling
    • Monitoring
    • Alerting
    • Failure Analysis
  • Deployment and Testing
    • Deployment - DevOps Design Decisions
    • Deployment - Zero Downtime Update Strategy
    • Testing - Failure Injection
  • Networking and Connectivity
    • Networking Design Decisions
    • Custom Domains
  • Operational Procedures
    • Operational Procedures
    • Key and Secret Rotation
• ESLZ Alignment
• Troubleshooting

Source Code README Files

• Infrastructure
  • Terraform-based IaC
  • Grafana
• Application
  • Catalog Service
  • Health Service
  • Background Processor
  • Unit Tests
  • UI Application
• Deployment Pipelines
• Configuration
• Testing

---

Documentation Conventions

• Overarching topics concerning the Azure Mission-Critical architecture, design principles, design decisions, and cross-component integration are documented as separate markdown documents within the /docs/ folder.

• Each source code component for the reference implementation has it's own README.md file which explains how that particular component works, how it is supposed to be used, and how it may interact with other aspects of the Azure Mission-Critical solution.

  • Within the main branch, each README.md file must accurately represent the state of the associated component which will serve as a core aspect of PR reviews. Any modifications to source components must therefore be reflected in the documentation as well.