Skip to content

Commit c696de4

Browse files
Merge pull request #552 from microsoft/psl-wafstandard
feat: avm waf standardization
2 parents 49cb1f0 + bea0071 commit c696de4

32 files changed

Lines changed: 47017 additions & 3821 deletions

docs/DeploymentGuide.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,45 @@ Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
2222

2323
This will allow the scripts to run for the current session without permanently changing your system's policy.
2424

25+
## Deployment Options & Steps
26+
27+
### Sandbox or WAF Aligned Deployment Options
28+
29+
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.
30+
31+
By default, the `azd up` command uses the [`main.parameters.json`](../infra/main.parameters.json) 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.
32+
33+
For **production deployments**, the repository also provides [`main.waf.parameters.json`](../infra/main.waf.parameters.json), 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:
34+
35+
- Enhanced network security (e.g., Network protection with private endpoints)
36+
- Stricter access controls and managed identities
37+
- Logging, monitoring, and diagnostics enabled by default
38+
- Resource tagging and cost management recommendations
39+
40+
**How to choose your deployment configuration:**
41+
42+
* Use the default `main.parameters.json` file for a **sandbox/dev environment**
43+
* For a **WAF-aligned, production-ready deployment**, copy the contents of `main.waf.parameters.json` into `main.parameters.json` before running `azd up`
44+
45+
---
46+
47+
### VM Credentials Configuration
48+
49+
By default, the solution sets the VM administrator username and password from environment variables.
50+
51+
To set your own VM credentials before deployment, use:
52+
53+
```sh
54+
azd env set AZURE_ENV_VM_ADMIN_USERNAME <your-username>
55+
azd env set AZURE_ENV_VM_ADMIN_PASSWORD <your-password>
56+
```
57+
58+
> [!TIP]
59+
> 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.
60+
2561

62+
> [!IMPORTANT]
63+
> The WAF-aligned configuration is under active development. More Azure Well-Architected recommendations will be added in future updates.
2664
2765
## Deployment Options & Steps
2866

0 commit comments

Comments
 (0)