Skip to content

Conversation

@Abdul-Microsoft
Copy link
Contributor

Purpose

  • This pull request introduces significant enhancements to the infrastructure-as-code setup for the solution accelerator, focusing on parameterization, environment alignment, and modularization for improved security, scalability, and maintainability. The changes include a major refactor of deployment parameters to support both sandbox and Well-Architected Framework (WAF) production deployments, the addition of new Bicep modules for key infrastructure components, and updated documentation to guide users in selecting the appropriate deployment configuration.

Key changes:

Deployment Parameter Refactor and Environment Alignment

  • Refactored infra/main.parameters.json to use more descriptive and standardized parameter names (e.g., solutionName, location, azureAiServiceLocation, gptModelDeploymentType, gptModelCapacity, backendContainerImageTag, frontendContainerImageTag), and to align environment variable usage for improved clarity and maintainability. Obsolete or ambiguous parameters were replaced or renamed. [1] [2]
  • Added a new infra/main.waf.parameters.json file for WAF-aligned (production-ready) deployments, introducing parameters for enhanced security, monitoring, scalability, private networking, and VM credentials.
  • Updated the deployment workflow (.github/workflows/deploy-KMGeneric.yml) to use the new azureAiServiceLocation parameter, reflecting the parameterization changes.

Infrastructure Modularization

  • Introduced a new network.bicep module to define virtual network, subnets, network security groups, Bastion host, and Jumpbox VM with best-practice configurations and output references for downstream use.
  • Added a keyVaultExport.bicep module to streamline exporting secrets to Azure Key Vault, supporting secure and reusable secret management.
  • Added a deploy_aifp_aisearch_connection.bicep module to automate the creation of AI Search connections within an existing AI Project, supporting Cognitive Search integration.

Documentation and Usability Improvements

  • Updated DeploymentGuide.md with clear guidance on choosing between sandbox and WAF-aligned deployments, including instructions for configuring VM credentials and best-practice recommendations for parameter review and security.

These changes collectively make the deployment process more robust, secure, and flexible, supporting both rapid prototyping and production-grade environments with clear separation and documentation.

Does this introduce a breaking change?

  • Yes
  • No

Golden Path Validation

  • I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation

  • I have validated the deployment process successfully and all services are running as expected with this change.

What to Check

Verify that the following are valid

  • ...

Other Information

@Prajwal-Microsoft Prajwal-Microsoft merged commit b6463fa into dev Sep 16, 2025
6 checks passed
@github-actions
Copy link
Contributor

🎉 This PR is included in version 3.14.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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.

5 participants