feat: WAF Implementation for Client Advisor #665

Prekshith-Microsoft · 2025-09-10T14:48:50Z

Purpose

This pull request introduces several important updates to improve deployment consistency, documentation clarity, and infrastructure management for the solution. The main changes include standardizing the Docker image tag naming convention for WAF-aligned deployments, updating documentation to reflect these changes and provide clearer deployment guidance, and removing several obsolete Bicep infrastructure modules.

Key changes:

Deployment Tag Standardization

Changed the default Docker image tag from latest to latest_waf for main branch deployments in both .github/workflows/CAdeploy.yml and .github/workflows/build-docker.yml, ensuring consistency for WAF-aligned (Well-Architected Framework) production deployments. [1] [2]
Updated parameter names in the deployment workflow to use more descriptive and accurate names (e.g., containerImageTag, gptModelCapacity, azureAiServiceLocation) to match current infrastructure and improve clarity.

Documentation Updates

Updated documentation to reflect the new default image tag (latest_waf) and its allowed values in both the parameters reference and deployment guides. [1] [2]
Expanded the deployment guide to include detailed instructions on choosing between sandbox and WAF-aligned deployments, as well as guidance on configuring VM credentials and emphasizing the evolving nature of the WAF configuration.

Infrastructure Cleanup

Removed obsolete Bicep modules: infra/deploy_cosmos_db.bicep, infra/deploy_foundry_model_role_assignment.bicep, infra/deploy_keyvault.bicep, and infra/deploy_managed_identity.bicep, likely because their functionality has been consolidated or replaced elsewhere in the infrastructure codebase. [1] [2] [3] [4]

Minor Fixes

Fixed a typo in the troubleshooting documentation section for "ParentResourceNotFound".

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

…tingpr fix: model deployment when reusing existing foundry

* fixed opent telemetry issue CustomDomainInUse, FlagMustBeSetForRestore (#618) (#619) Co-authored-by: VishalS-Microsoft <[email protected]> * directory update in dependabot template (#634) --------- Co-authored-by: NirajC-Microsoft <[email protected]> Co-authored-by: VishalS-Microsoft <[email protected]> Co-authored-by: Prajwal-Microsoft <[email protected]>

* Agent deletion handled successfully * use get azure credentials * remove unused import --------- Co-authored-by: Shreyas-Microsoft <[email protected]>

…ilot-Solution-Accelerator into PSLRJ-TS-21657

… azd up

feat: Add required environment variables for local debugging in .env generated by azd up

…ur-own-copilot-Solution-Accelerator into psl-bug-21342

…ilot-Solution-Accelerator into PSLRJ-TS-21657

fix: Sample data processing script fails when using cross-subscription existing AI project resource ID

chore: Down merge from main to dev

…ilot-Solution-Accelerator into PSLRJ-TS-21657

…ation

* chore: Dev to Main changes merge (#657) * model deployment when reusing existing foundry * change model deployment name * removed system managed identity code * seggregated the files * fix: Updated file names * chore: down merging main into dev (#638) * fixed opent telemetry issue CustomDomainInUse, FlagMustBeSetForRestore (#618) (#619) Co-authored-by: VishalS-Microsoft <[email protected]> * directory update in dependabot template (#634) --------- Co-authored-by: NirajC-Microsoft <[email protected]> Co-authored-by: VishalS-Microsoft <[email protected]> Co-authored-by: Prajwal-Microsoft <[email protected]> * added for cross-subscription existing AI project resource ID * update * fix: agent cleanup (#639) * Agent deletion handled successfully * use get azure credentials * remove unused import --------- Co-authored-by: Shreyas-Microsoft <[email protected]> * TS( 21657) Bicep Standard code changes * Added required env variables for local debugging in .env generated by azd up * Added "Required/Optional" and changed aiProjectName suffix. * removed location tag * foundry project documentation * corrected name * updated CAdeploy.yml * update CAdeploy.yml * changed pipeline variable * updated main.json file * updated yml file * test * test * update * update * test * update CAdeploy.yml * CustomizingAzdparamMd * deploymentMdUpdate * Updated * Update infra/main.bicep Fixed typo error. Co-authored-by: Copilot <[email protected]> * Update src/App/backend/plugins/chat_with_data_plugin.py Updated the finally block for function "get_SQL_Response" Co-authored-by: Copilot <[email protected]> * Update infra/main.bicep Removed Commented-out code Co-authored-by: Copilot <[email protected]> * Revert Copilot suggestion: `and project_client` is unnecessary. `project_client` is always initialized before thread creation, so `if thread:` is sufficient. * docs: Added Troubleshoot.md files for BYOC-Client Advisor (#650) * Added Troubleshoot.md files for BYOC-Client Advisor * fixed Check Markdown Broken Links * updated troubleshotingsteps file * Changed MACAE Github issues link with BYOC issue link --------- Co-authored-by: NirajC-Microsoft <[email protected]> * added colon Co-authored-by: Copilot <[email protected]> * Replace 'u' with 'you' for proper grammarUpdate docs/TroubleShootingSteps.md Co-authored-by: Copilot <[email protected]> * extra space removed Co-authored-by: Copilot <[email protected]> * The command block is not properly closed Co-authored-by: Copilot <[email protected]> * The command should be wrapped in a proper code block with language identifier for better formatting and readability. Co-authored-by: Copilot <[email protected]> * The total asset value and current asset value are responding correctly, and the total value matches the asset value displayed in the left panel. (#651) * Bicep file changes to add CreatedBy tag (#655) * Update docs/TroubleShootingSteps.md Co-authored-by: Copilot <[email protected]> * fix: Adding a hardcoded createdBy parameter to the CAdeploy.yml file to prevent validation pipeline failures caused by the deployer function in the Bicep file. (#659) * Adding a hardcoded createdBy parameter to the CAdeploy.yml file to prevent validation pipeline failures caused by the deployer function in the Bicep file. * Consolidate parameters in CAdeploy.yml --------- Co-authored-by: Priyanka-Microsoft <[email protected]> Co-authored-by: Prajwal D C <[email protected]> Co-authored-by: Rafi-Microsoft <[email protected]> Co-authored-by: VishalS-Microsoft <[email protected]> Co-authored-by: Kanchan Nagshetti (Persistent Systems Inc) <[email protected]> Co-authored-by: Shreyas-Microsoft <[email protected]> Co-authored-by: Shreyas-Microsoft <[email protected]> Co-authored-by: Bangarraju-Microsoft <[email protected]> Co-authored-by: Prasanjeet-Microsoft <[email protected]> Co-authored-by: UtkarshMishra-Microsoft <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: Roopan P M <[email protected]> Co-authored-by: Prekshith-Microsoft <[email protected]> Co-authored-by: Roopan-Microsoft <[email protected]> * fix: merging dev to main changes (#661) * model deployment when reusing existing foundry * change model deployment name * removed system managed identity code * seggregated the files * fix: Updated file names * chore: down merging main into dev (#638) * fixed opent telemetry issue CustomDomainInUse, FlagMustBeSetForRestore (#618) (#619) Co-authored-by: VishalS-Microsoft <[email protected]> * directory update in dependabot template (#634) --------- Co-authored-by: NirajC-Microsoft <[email protected]> Co-authored-by: VishalS-Microsoft <[email protected]> Co-authored-by: Prajwal-Microsoft <[email protected]> * added for cross-subscription existing AI project resource ID * update * fix: agent cleanup (#639) * Agent deletion handled successfully * use get azure credentials * remove unused import --------- Co-authored-by: Shreyas-Microsoft <[email protected]> * TS( 21657) Bicep Standard code changes * Added required env variables for local debugging in .env generated by azd up * Added "Required/Optional" and changed aiProjectName suffix. * removed location tag * foundry project documentation * corrected name * updated CAdeploy.yml * update CAdeploy.yml * changed pipeline variable * updated main.json file * updated yml file * test * test * update * update * test * update CAdeploy.yml * CustomizingAzdparamMd * deploymentMdUpdate * Updated * Update infra/main.bicep Fixed typo error. Co-authored-by: Copilot <[email protected]> * Update src/App/backend/plugins/chat_with_data_plugin.py Updated the finally block for function "get_SQL_Response" Co-authored-by: Copilot <[email protected]> * Update infra/main.bicep Removed Commented-out code Co-authored-by: Copilot <[email protected]> * Revert Copilot suggestion: `and project_client` is unnecessary. `project_client` is always initialized before thread creation, so `if thread:` is sufficient. * docs: Added Troubleshoot.md files for BYOC-Client Advisor (#650) * Added Troubleshoot.md files for BYOC-Client Advisor * fixed Check Markdown Broken Links * updated troubleshotingsteps file * Changed MACAE Github issues link with BYOC issue link --------- Co-authored-by: NirajC-Microsoft <[email protected]> * added colon Co-authored-by: Copilot <[email protected]> * Replace 'u' with 'you' for proper grammarUpdate docs/TroubleShootingSteps.md Co-authored-by: Copilot <[email protected]> * extra space removed Co-authored-by: Copilot <[email protected]> * The command block is not properly closed Co-authored-by: Copilot <[email protected]> * The command should be wrapped in a proper code block with language identifier for better formatting and readability. Co-authored-by: Copilot <[email protected]> * The total asset value and current asset value are responding correctly, and the total value matches the asset value displayed in the left panel. (#651) * Bicep file changes to add CreatedBy tag (#655) * Update docs/TroubleShootingSteps.md Co-authored-by: Copilot <[email protected]> * fix: Adding a hardcoded createdBy parameter to the CAdeploy.yml file to prevent validation pipeline failures caused by the deployer function in the Bicep file. (#659) * Adding a hardcoded createdBy parameter to the CAdeploy.yml file to prevent validation pipeline failures caused by the deployer function in the Bicep file. * Consolidate parameters in CAdeploy.yml --------- Co-authored-by: Priyanka-Microsoft <[email protected]> Co-authored-by: Prajwal D C <[email protected]> Co-authored-by: Rafi-Microsoft <[email protected]> Co-authored-by: NirajC-Microsoft <[email protected]> Co-authored-by: VishalS-Microsoft <[email protected]> Co-authored-by: Kanchan Nagshetti (Persistent Systems Inc) <[email protected]> Co-authored-by: Shreyas-Microsoft <[email protected]> Co-authored-by: Shreyas-Microsoft <[email protected]> Co-authored-by: Bangarraju-Microsoft <[email protected]> Co-authored-by: Prasanjeet-Microsoft <[email protected]> Co-authored-by: UtkarshMishra-Microsoft <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: Prekshith-Microsoft <[email protected]> * fixed vulnerabilities * removed duplicate variable --------- Co-authored-by: NirajC-Microsoft <[email protected]> Co-authored-by: Priyanka-Microsoft <[email protected]> Co-authored-by: Prajwal D C <[email protected]> Co-authored-by: Rafi-Microsoft <[email protected]> Co-authored-by: VishalS-Microsoft <[email protected]> Co-authored-by: Shreyas-Microsoft <[email protected]> Co-authored-by: Shreyas-Microsoft <[email protected]> Co-authored-by: Bangarraju-Microsoft <[email protected]> Co-authored-by: Prasanjeet-Microsoft <[email protected]> Co-authored-by: UtkarshMishra-Microsoft <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: Roopan P M <[email protected]> Co-authored-by: Prekshith-Microsoft <[email protected]> Co-authored-by: Roopan-Microsoft <[email protected]>

ci: update image tag to latest_waf

…lutionName

fix: update aiSearchName variable to use solutionSuffix instead of solutionName

…yment (#674)

github-actions · 2025-09-18T08:59:18Z

🎉 This PR is included in version 1.9.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Priyanka-Microsoft and others added 30 commits July 25, 2025 13:41

model deployment when reusing existing foundry

1a8347f

change model deployment name

383706b

removed system managed identity code

5ccc7c1

seggregated the files

99ad169

fix: Updated file names

e0747b2

Resolved main json commit

d604cea

Merge pull request #621 from microsoft/model-deployment-resusing-exis…

d4065d5

…tingpr fix: model deployment when reusing existing foundry

added for cross-subscription existing AI project resource ID

c509549

update

ad9ba63

fix: agent cleanup (#639)

18f3e78

* Agent deletion handled successfully * use get azure credentials * remove unused import --------- Co-authored-by: Shreyas-Microsoft <[email protected]>

TS( 21657) Bicep Standard code changes

0f8ccc5

Merge branch 'dev' of https://github.com/microsoft/Build-your-own-cop…

d499936

…ilot-Solution-Accelerator into PSLRJ-TS-21657

Added required env variables for local debugging in .env generated by…

e8a113f

… azd up

Merge pull request #642 from microsoft/PSL-US-21463

12b99bb

feat: Add required environment variables for local debugging in .env generated by azd up

Added "Required/Optional" and changed aiProjectName suffix.

2c17025

removed location tag

51df269

Merge branch 'dev' into psl-bug-21342

f9dbf41

foundry project documentation

f202b60

Merge branch 'psl-bug-21342' of https://github.com/microsoft/Build-yo…

313f6e3

…ur-own-copilot-Solution-Accelerator into psl-bug-21342

corrected name

8b24bca

Merge branch 'dev' of https://github.com/microsoft/Build-your-own-cop…

b0e5161

…ilot-Solution-Accelerator into PSLRJ-TS-21657

updated CAdeploy.yml

d455118

update CAdeploy.yml

a8e25dd

Merge pull request #640 from microsoft/psl-bug-21342

2f89864

fix: Sample data processing script fails when using cross-subscription existing AI project resource ID

changed pipeline variable

1df9fc6

Merge pull request #644 from microsoft/main

1166aa8

chore: Down merge from main to dev

Merge branch 'dev' of https://github.com/microsoft/Build-your-own-cop…

d9c999d

…ilot-Solution-Accelerator into PSLRJ-TS-21657

updated main.json file

a911f20

updated yml file

d3ed0ee

Prajwal-Microsoft temporarily deployed to production September 12, 2025 12:12 — with GitHub Actions Inactive

Harsh-Microsoft and others added 5 commits September 17, 2025 18:46

update image tag to 'latest_waf' in deployment workflows and document…

f0bfe3b

…ation

rebuild main.json

44a7e57

Update main.parameters.json

ff922b0

Update main.waf.parameters.json

25067ef

Roopan-Microsoft temporarily deployed to production September 17, 2025 14:36 — with GitHub Actions Inactive

Merge pull request #672 from microsoft/hb-waf-tag-update

cc73024

ci: update image tag to latest_waf

Prajwal-Microsoft temporarily deployed to production September 17, 2025 16:03 — with GitHub Actions Inactive

Vamshi-Microsoft and others added 2 commits September 18, 2025 10:30

fix: update aiSearchName variable to use solutionSuffix instead of so…

6eefc04

…lutionName

Merge pull request #673 from microsoft/psl-searchservice

ea82b45

fix: update aiSearchName variable to use solutionSuffix instead of solutionName

Prajwal-Microsoft temporarily deployed to production September 18, 2025 05:10 — with GitHub Actions Inactive

Harsh-Microsoft changed the title ~~chore: Merge all changes from dev to main~~ feat: WAF Implementation for Client Advisor Sep 18, 2025

update location parameter to enforce allowed Azure regions for deplo…

00b50e3

…yment (#674)

Roopan-Microsoft temporarily deployed to production September 18, 2025 06:39 — with GitHub Actions Inactive

Prajwal-Microsoft approved these changes Sep 18, 2025

View reviewed changes

Roopan-Microsoft approved these changes Sep 18, 2025

View reviewed changes

Merge branch 'main' into dev

b5f688a

Roopan-Microsoft had a problem deploying to production September 18, 2025 07:01 — with GitHub Actions Failure

Prajwal-Microsoft approved these changes Sep 18, 2025

View reviewed changes

fix: Resolved cnflict issue

9599829

Prajwal-Microsoft temporarily deployed to production September 18, 2025 07:13 — with GitHub Actions Inactive

Prajwal-Microsoft self-requested a review September 18, 2025 07:14

Prajwal-Microsoft approved these changes Sep 18, 2025

View reviewed changes

fix: Added location param for deployment

185a83a

Prajwal-Microsoft temporarily deployed to production September 18, 2025 07:25 — with GitHub Actions Inactive

Roopan-Microsoft approved these changes Sep 18, 2025

View reviewed changes

Prajwal-Microsoft merged commit ff681af into main Sep 18, 2025
15 checks passed

github-actions bot added the released label Sep 18, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: WAF Implementation for Client Advisor #665

feat: WAF Implementation for Client Advisor #665

Prekshith-Microsoft commented Sep 10, 2025 •

edited by Harsh-Microsoft

Loading

Uh oh!

Uh oh!

github-actions bot commented Sep 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

16 participants

feat: WAF Implementation for Client Advisor #665

feat: WAF Implementation for Client Advisor #665

Conversation

Prekshith-Microsoft commented Sep 10, 2025 • edited by Harsh-Microsoft Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Does this introduce a breaking change?

Golden Path Validation

Deployment Validation

What to Check

Other Information

Uh oh!

Uh oh!

github-actions bot commented Sep 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

16 participants

Prekshith-Microsoft commented Sep 10, 2025 •

edited by Harsh-Microsoft

Loading