Skip to content

Commit 7fdb1af

Browse files
Merge pull request #290 from microsoft/docs_update_waf
docs: process of choosing between sandbox and production configurations when deploying Azure infrastructure using the `azd up` command
2 parents 2ba411a + cf2349d commit 7fdb1af

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

docs/DeploymentGuide.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,23 +32,29 @@ This will allow the scripts to run for the current session without permanently c
3232

3333
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-
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.
35+
When running `azd up`, you’ll now be prompted to choose between a **WAF-aligned configuration** and a **sandbox configuration** using a simple selection:
3636

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:
37+
- A **sandbox environment** — ideal for development and proof-of-concept scenarios, with minimal security and cost controls for rapid iteration.
3838

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
39+
- A **production deployments environment**, 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:
40+
- Enhanced network security (e.g., Network protection with private endpoints)
41+
- Stricter access controls and managed identities
42+
- Logging, monitoring, and diagnostics enabled by default
43+
- Resource tagging and cost management recommendations
4344

4445
**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`.
46+
47+
When prompted during `azd up`:
48+
49+
![useWAFAlignedArchitecture](images/macae_waf_prompt.png)
50+
51+
- Select **`true`** to deploy a **WAF-aligned, production-ready environment**
52+
- Select **`false`** to deploy a **lightweight sandbox/dev environment**
4753

4854
> [!TIP]
4955
> Always review and adjust parameter values (such as region, capacity, security settings and log analytics workspace configuration) 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.
5056
51-
> To reuse an existing Log Analytics workspace, update the existingWorkspaceResourceId field under the logAnalyticsWorkspaceConfiguration parameter in the bicepparam file with the resource ID of your existing workspace.
57+
> To reuse an existing Log Analytics workspace, update the existingWorkspaceResourceId field under the logAnalyticsWorkspaceConfiguration parameter in the .bicep file with the resource ID of your existing workspace.
5258
For example:
5359
```
5460
param logAnalyticsWorkspaceConfiguration = {

docs/images/macae_waf_prompt.png

5.06 KB
Loading

0 commit comments

Comments
 (0)