Skip to content

Add azure-reliability — Azure Container Apps reliability reference - #2243

Draft
Madhura Bharadwaj (MadhuraBharadwaj-MSFT) wants to merge 14 commits into
microsoft:mainfrom
MadhuraBharadwaj-MSFT:azure-reliability/container-apps
Draft

Add azure-reliability — Azure Container Apps reliability reference#2243
Madhura Bharadwaj (MadhuraBharadwaj-MSFT) wants to merge 14 commits into
microsoft:mainfrom
MadhuraBharadwaj-MSFT:azure-reliability/container-apps

Conversation

@MadhuraBharadwaj-MSFT

@MadhuraBharadwaj-MSFT Madhura Bharadwaj (MadhuraBharadwaj-MSFT) commented May 12, 2026

Copy link
Copy Markdown
Collaborator

⚠️ DRAFT — depends on #2241 (Functions + skill core). Will be marked ready for review once #2241 merges.

While both PRs are open, this PR's diff includes #2241's files because this branch is stacked on top of it. After #2241 merges into main, this PR's diff will automatically shrink to a single file.

📄 The single new file in this PR (the only thing for review here):
services/container-apps/reliability.md

📁 Browse the full skill folder for context

Overview

Adds the Container Apps-specific reliability reference for the azure-reliability skill introduced in #2241. Single-file change covering environment + app reliability config: zone-redundant environment with VNet, blue/green migration for existing environments, liveness/readiness probes, Bicep + Terraform + AVM patches, and reporting hints for the assessment table.

Companion PRs

Part of a 3-PR set introducing the azure-reliability skill:

What I'd love the Container Apps team to verify

The file includes:

  • A STOP gate before adding a /health route to a container image (consent required)
  • An explicit warning before deleting an old environment (since Container Apps environments are often shared across multiple apps)

Items deferred for the team to verify / expand:

  • KEDA scaler health and behavior during scale-to-zero
  • Dapr cross-region behavior in a multi-region setup
  • Container registry replication for multi-region
  • AVM module parameter mapping in the IaC Patching section

Adds a new azure-reliability skill that assesses Azure PaaS apps (Functions, Container Apps, App Service) for zone redundancy, storage replication, multi-region, and health probes. Reports findings as an enabled/disabled checklist (no numeric scoring) and supports both live (CLI) and IaC (Bicep/Terraform) remediation paths.
…ult SKU, deploy order)

- Note AVM module param naming differs from raw Bicep (skuName vs sku.name); detect with Select-String and patch the actual param in use.
- Annotate FC1/Consumption health probe as 'code-only fix' in the checklist and risk table; do not patch healthCheckPath in IaC for these plans.
- Switch all 'az graph query' examples to '--query data[] -o json' (table output only shows summary cols).
- Handle no-SKU storage case: ARM/AVM defaults to Standard_GRS; add explicit sku/skuName instead of find-and-replace.
- Recommend splitting deploys: safe patches first, then storage migration, then storage SKU patch (a failed redundancy update can fail the whole deploy).
…gger on FC1/Consumption

Adding a /api/health endpoint on Flex Consumption / Consumption Function Apps means modifying app source code (new HTTP trigger), not a Bicep/Terraform patch. Add an explicit STOP gate in configure-health-probes.md, the SKILL.md risk table, and both IaC patching references so the agent must ask the user before touching code, and respects 'no' by leaving everything unchanged.
…and multi-region

Workflow now sequences remediation as: easy ZR + health probes first (CLI or 'Deploy 1' for IaC), then explicitly ASK the user before kicking off the slow storage migration ('to be fully ZR you also need ZRS storage - want to do it?'). After the storage step (or skip), re-assess, then a new Configuration Workflow Step 3 asks about multi-region failover and waits for yes/no/later before generating any Front Door IaC. Phase 3 UX note now defers to Step 3 instead of duplicating the offer.
Replace per-resource checklist (with mostly n/a cells and mixed symbols) with a feature-pivoted table: 4 rows (Zone redundancy compute, Zone-redundant storage, Health probes, Multi-region failover), each with a single status (🟢 ON / 🟡 PARTIAL / 🔴 OFF or storage SKU) and a bullet list of relevant resources with inline reasons. Drops n/a noise; reasons sit on the resource line where users can see them. Re-Assess uses the same format with 'now ON' / 'still off' annotations. Step 3 prompt text aligned to use 🟢 instead of ✅.
…ser to run them

Path B Deploy 1, Storage migration, Deploy 2, and Multi-region all now run the deploy commands (azd up / az deployment / terraform apply) directly after a single yes/no confirmation, then continue to re-assess. Updates Skill Boundaries and Integration tables: 'Deploy IaC for reliability changes: Yes' (was 'No, hand off to azure-deploy'). Bicep and Terraform patching references updated to summarize the deploy plan and ask 'Ready for Deploy 1?' instead of giving the user a list of commands to run.
Removed duplications:
- 'When to Use This Skill' section (duplicate of Skill Activation Triggers)
- 'HARD STOPS' block (each stop already inline at the right step)
- Best Practices items that restated the workflow (kept only the 2 unique tips)
- Path B Step 2 'Deploy-order rule' callout (Steps 3-5 already detail the flow)
- Phase 3 UX note about multi-region (reduced to a one-liner pointing to Step 3)
- Skill Boundaries 'IMPORTANT' header (duplicated description / Quick Reference)

Also:
- Quick Reference now says 'Reliability assessment table' instead of 'Reliability Checklist' for consistency with Phase 3 terminology.
- Storage SKU row in Step 2 risk table now points to the two-deploy flow inline.
- Fixed literal \\u escape sequences in SKILL.md, iac-patching-bicep.md, iac-patching-terraform.md that leaked from a previous edit (\\u2014 -> em-dash, \\u2192 -> arrow, \\u26a0\\ufe0f -> warning, \\u2705 -> checkmark, etc).
…ervice,functions} before team handoff

Container Apps:
- Standardize 'az graph query' to use --query 'data[]' -o json (table mode hides projected fields)
- Fix Configure: Health Probes example (was mixing --set-env-vars + --yaml -<<EOF heredoc, which conflicts and isn't pwsh-portable); use a probes.yaml file instead
- Add AVM modules note pointing to br/public:avm/res/app/managed-environment and avm/res/app/container-app param naming
- Add STOP gate before adding /health route to container code (consent required, mirrors Functions FC1 pattern)
- Add Reporting section showing how each Container Apps resource maps to feature-pivoted assessment rows

App Service:
- Standardize 'az graph query' to use --query 'data[]' -o json
- Add ARR affinity / clientAffinityEnabled query (sticky sessions break ZR + multi-region)
- Add new 'Configure: Disable Client Affinity (ARR Affinity)' section above slots; multi-region note now references it
- Add AVM modules note pointing to br/public:avm/res/web/serverfarm and avm/res/web/site param naming
- Add Reporting section, including PARTIAL state for multi-region with affinity still enabled

Functions:
- Add Reporting section so Functions matches the new convention

Deferred for the App Service / Container Apps teams to verify against current Microsoft docs:
- P1v3 minimum capacity for ZR (table currently says 3; docs may now say 2)
- Standard tier health check support (table claims yes; verify)
- Auto-Heal, backup/restore, VNet integration HA notes (out of scope for this pass)
…c content

Make each services/<svc>/reliability.md the single source of truth for that service's plan/SKU rules, assessment queries, CLI commands, IaC patches (Bicep + Terraform + AVM), and reporting hints. Strip duplicated content from shared references so they only contain platform-level mechanics:

- zone-redundancy-checks.md: keep platform overview + cross-service all-in-one query + AZ regions list. Drop per-service queries and remediation (already in services/).
- configure-zone-redundancy.md: become a thin pointer to per-service refs + storage prerequisite + verification command.
- configure-health-probes.md: become a thin pointer to per-service refs + cross-service consent gate + best practices.
- iac-patching-bicep.md / iac-patching-terraform.md: keep framework (When to Use, Detection, AVM modules note, deploy plan) and the single cross-service Storage patch. Per-service patches now live in services/.
- health-probe-checks.md: keep Front Door / Traffic Manager / App Insights checks + best practices + Multi-region row reporting. Drop per-service queries.
- SKILL.md Phase 2 reworded as 'platform discovery + per-service deep dive'. Path A and Path B Step 3 now point to per-service refs for compute commands/patches.

Net -889 lines (no content lost; the deleted lines were already duplicated in services/).

This sets up a clean 3-PR split: PR #1 = shared platform refs + services/functions/, PR microsoft#2 = services/app-service/, PR microsoft#3 = services/container-apps/.
…ed-env warning (Container Apps)

Two pieces of unique safety content from the deleted shared files were not yet captured in the per-service files. Adding them back:

- Functions: 'Consumption (Y1) - upgrade path required' subsection with Flex vs Premium tradeoffs and cost warning (was in deleted configure-zone-redundancy.md).
- Container Apps: explicit STOP before deleting old environment, with the 'az containerapp list --environment' check command (was in deleted configure-zone-redundancy.md).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant