Skip to content

Commit c436d8d

Browse files
committed
Update Deployment Guide to clarify WAF and sandbox deployment options
1 parent 93eafb1 commit c436d8d

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

documentation/DeploymentGuide.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ To deploy this solution accelerator, ensure you have access to an [Azure subscri
66

77
Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=all&regions=all) page and select a **region** where the following services are available:
88

9-
- [Azure OpenAI Service](https://learn.microsoft.com/en-us/azure/ai-services/openai/)
9+
- [Azure AI Foundry](https://learn.microsoft.com/en-us/azure/ai-foundry/)
1010
- [Azure Container Apps](https://learn.microsoft.com/en-us/azure/container-apps/)
1111
- [Azure Container Registry](https://learn.microsoft.com/en-us/azure/container-registry/)
1212
- [Azure Cosmos DB](https://learn.microsoft.com/en-us/azure/cosmos-db/)
@@ -28,21 +28,31 @@ This will allow the scripts to run for the current session without permanently c
2828

2929
## Deployment Options & Steps
3030

31-
### WAF Deployment Option ###
31+
### Sandbox or WAF Aligned Deployment Options
3232

33-
The Multi Agent Solution Accelerator has an option for a [WAF aligned](https://learn.microsoft.com/en-us/azure/well-architected/) deployment. In order to enable a WAF aligned deployment, go to the main.bicepparam file and change the virtualNetworkConfiguration param to 'true'.
33+
The [`infra`](../infra) folder of the Multi Agent Solution Accelerator contains the [`main.bicep`](../infra/main.bicep) Bicep script, which defines all Azure infrastructure components for this solution.
3434

35-
```bicep
36-
param virtualNetworkConfiguration = {
37-
enabled: true
38-
}
39-
```
35+
By default, the `azd up` command uses the [`main.bicepparam`](../infra/main.bicepparam) file to deploy the solution. This file is pre-configured for a **sandbox environment** — ideal for development and proof-of-concept scenarios, with minimal security and cost controls for rapid iteration.
36+
37+
For **production deployments**, the repository also provides [`main.waf-aligned.bicepparam`](../infra/main.waf-aligned.bicepparam), which applies a [Well-Architected Framework (WAF) aligned](https://learn.microsoft.com/en-us/azure/well-architected/) configuration. This option enables additional Azure best practices for reliability, security, cost optimization, operational excellence, and performance efficiency, such as:
38+
39+
- Enhanced network security (e.g., Network protection with private endpoints)
40+
- Stricter access controls and managed identities
41+
- Logging, monitoring, and diagnostics enabled by default
42+
- Resource tagging and cost management recommendations
4043

44+
**How to choose your deployment configuration:**
45+
- Use the default [`main.bicepparam`](../infra/main.bicepparam) for a sandbox/dev environment.
46+
- For a WAF-aligned, production-ready deployment, copy the contents of [`main.waf-aligned.bicepparam`](../infra/main.waf-aligned.bicepparam) into `main.bicepparam` before running `azd up`.
4147

42-
This will enable the use of the main.waf-aligned.bicepparam file during deployment. This param file is where all the WAF settings for a production type of deployment will be set.
43-
>**Note**: WAF deployment is still in active development and all params needed for a complete WAF aligned deployment are still being added. Changing the virtualNetworkConfiguration value will still deploy a demo enviroment for devlopment work with virtual Machines, Private Dns Zones, and Private Endpoints.
48+
> [!TIP]
49+
> Always review and adjust parameter values (such as region, capacity, and security settings) to match your organization’s requirements before deploying. For production, ensure you have sufficient quota and follow the principle of least privilege for all identities and role assignments.
50+
51+
> [!IMPORTANT]
52+
> The WAF-aligned configuration is under active development. More Azure Well-Architected recommendations will be added in future updates.
4453
4554
### Deployment Steps
55+
4656
Pick from the options below to see step-by-step instructions for GitHub Codespaces, VS Code Dev Containers, Local Environments, and Bicep deployments.
4757

4858
| [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator) | [![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator) |

0 commit comments

Comments
 (0)