Skip to content

Conversation

Roopan-Microsoft
Copy link
Collaborator

@Roopan-Microsoft Roopan-Microsoft commented Sep 22, 2025

Purpose

  • This pull request introduces several documentation improvements, parameter updates, and workflow enhancements to support Azure deployments and troubleshooting. The most significant changes include the addition of comprehensive guides for Azure Container Registry (ACR) usage, expanded troubleshooting steps for common Azure deployment errors, updates to environment variable naming for Foundry Project resource IDs, and important prerequisite instructions for WAF-aligned deployments. There are also minor workflow and infrastructure updates.

Documentation Improvements:

  • Added a new docs/ACRBuildAndPushGuide.md file with step-by-step instructions for building and pushing Docker images for Backend and WebApp services to Azure Container Registry, including verification and manual update steps.
  • Expanded docs/TroubleShootingSteps.md with detailed troubleshooting for a wide range of Azure deployment errors, including quota issues, resource provider registration, diagnostic log support, principal and resource errors, and links to relevant Microsoft documentation.

Parameter and Naming Updates:

  • Updated environment variable naming for Foundry Project resource ID from AZURE_ENV_FOUNDRY_PROJECT_ID to AZURE_EXISTING_AI_PROJECT_RESOURCE_ID in both deployment parameter documentation and the Foundry Project reuse guide, ensuring consistency across docs and scripts. [1] [2]

Deployment Prerequisites and Guides:

  • Added prerequisite instructions to docs/DeploymentGuide.md for enabling the Microsoft.Compute/EncryptionAtHost feature for WAF-aligned (production) deployments, including step-by-step registration commands and reference links.

Infrastructure and Workflow Updates:

  • Increased the default daily quota for Log Analytics Workspace in WAF-aligned deployments from 10 GB to 150 GB in infra/main.bicep, reflecting updated recommendations for production workloads.
  • Added a createdBy="Pipeline" tag to the deployment workflow in .github/workflows/deploy-waf.yml for improved traceability.

Minor Documentation Fixes:

  • Corrected a navigation step in the quota check guide to include cd infra before entering the scripts folder.
  • Expanded error descriptions and solutions in troubleshooting documentation for deployment model errors and resource ID formatting issues. [1] [2]

Does this introduce a breaking change?

  • Yes
  • No

How to Test

  • Get the code
git clone [repo-address]
cd [repo-name]
git checkout [branch-name]
npm install
  • Test the code

What to Check

Verify that the following are valid

  • ...

Other Information

Harmanpreet-Microsoft and others added 30 commits September 2, 2025 11:55
Added a step to navigate to the 'infra' directory before accessing the 'scripts' folder.
Removed duplicate lines explaining the DeploymentNotFound issue and its avoidance.
fix: Restrict Supported Azure Regions and Add Configurable Zone Redundancy for Cosmos DB
fix: merge Cosmos DB issue fixes from dev into main
Added guidance for resolving BadRequest errors related to failed provisioning of Azure Cosmos DB accounts.
Updated the summary of troubleshooting steps to include 'SpecialFeatureOrQuotaIdRequired'.
@Roopan-Microsoft Roopan-Microsoft merged commit dd8f394 into macae-v3-dev-v2-vip Sep 22, 2025
4 of 5 checks passed
Copy link

🎉 This PR is included in version 2.2.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@Roopan-Microsoft Roopan-Microsoft deleted the psldownmerge branch September 24, 2025 05:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants