diff --git a/docs/DeploymentGuide.md b/docs/DeploymentGuide.md index 5fc6337d0..e955f1ea1 100644 --- a/docs/DeploymentGuide.md +++ b/docs/DeploymentGuide.md @@ -32,23 +32,29 @@ This will allow the scripts to run for the current session without permanently c 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. -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. +When running `azd up`, you’ll now be prompted to choose between a **WAF-aligned configuration** and a **sandbox configuration** using a simple selection: -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: +- A **sandbox environment** — ideal for development and proof-of-concept scenarios, with minimal security and cost controls for rapid iteration. -- Enhanced network security (e.g., Network protection with private endpoints) -- Stricter access controls and managed identities -- Logging, monitoring, and diagnostics enabled by default -- Resource tagging and cost management recommendations +- 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: + - Enhanced network security (e.g., Network protection with private endpoints) + - Stricter access controls and managed identities + - Logging, monitoring, and diagnostics enabled by default + - Resource tagging and cost management recommendations **How to choose your deployment configuration:** -- Use the default [`main.bicepparam`](../infra/main.bicepparam) for a sandbox/dev environment. -- 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`. + +When prompted during `azd up`: + +![useWAFAlignedArchitecture](images/macae_waf_prompt.png) + +- Select **`true`** to deploy a **WAF-aligned, production-ready environment** +- Select **`false`** to deploy a **lightweight sandbox/dev environment** > [!TIP] > 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. -> 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. +> 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. For example: ``` param logAnalyticsWorkspaceConfiguration = { diff --git a/docs/images/macae_waf_prompt.png b/docs/images/macae_waf_prompt.png new file mode 100644 index 000000000..b3f8f6cac Binary files /dev/null and b/docs/images/macae_waf_prompt.png differ