You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/DeploymentGuide.md
+39-16Lines changed: 39 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## Overview
4
4
5
-
This guide walks you through deploying the Multi Agent Custom Automation Engine Solution Accelerator to Azure. The deployment process takes approximately 10-15 minutes for the default Development/Testing configuration and includes both infrastructure provisioning and application setup.
5
+
This guide walks you through deploying the Multi Agent Custom Automation Engine Solution Accelerator to Azure. The deployment process takes approximately 9-10 minutes for the default Development/Testing configuration and includes both infrastructure provisioning and application setup.
6
6
7
7
🆘 **Need Help?** If you encounter any issues during deployment, check our [Troubleshooting Guide](./TroubleShootingSteps.md) for solutions to common problems.
8
8
@@ -52,6 +52,7 @@ Ensure you have access to an [Azure subscription](https://azure.microsoft.com/fr
-[GPT Model Capacity](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models)
56
57
57
58
**Recommended Regions:** East US, East US2, Australia East, Japan East, UK South, France Central
@@ -64,9 +65,10 @@ Ensure you have access to an [Azure subscription](https://azure.microsoft.com/fr
64
65
65
66
📖 **Follow:**[Quota Check Instructions](./quota_check.md) to ensure sufficient capacity.
66
67
67
-
<!-- **Recommended Configuration:**
68
-
- **Default:** 200k tokens (minimum)
69
-
- **Optimal:** 500k tokens (recommended for best performance) -->
68
+
**Default Quota Configuration:**
69
+
-**GPT-4.1:** 150k tokens
70
+
-**4o-mini:** 50k tokens
71
+
-**GPT-4.1-mini:** 50k tokens
70
72
71
73
> **Note:** When you run `azd up`, the deployment will automatically show you regions with available quota, so this pre-check is optional but helpful for planning purposes. You can customize these settings later in [Step 3.3: Advanced Configuration](#33-advanced-configuration-optional).
72
74
@@ -130,7 +132,14 @@ Select one of the following options to deploy the Multi Agent Custom Automation
130
132
5. When prompted in the VS Code Web terminal, choose one of the available options shown below:
6. Proceed to [Step 3: Configure Deployment Settings](#step-3-configure-deployment-settings)
135
+
136
+
6.**Authenticate with Azure** (VS Code Web requires device code authentication):
137
+
```shell
138
+
az login --use-device-code
139
+
```
140
+
> **Note:** In VS Code Web environment, the regular `az login` command may fail. Use the `--use-device-code` flag to authenticate via device code flow. Follow the prompts in the terminal to complete authentication.
141
+
142
+
7. Proceed to [Step 3: Configure Deployment Settings](#step-3-configure-deployment-settings)
134
143
135
144
</details>
136
145
@@ -225,7 +234,7 @@ azd env set AZURE_ENV_VM_ADMIN_PASSWORD <your-password>
225
234
226
235
You can customize various deployment settings before running `azd up`, including Azure regions, AI model configurations (deployment type, version, capacity), container registry settings, and resource names.
227
236
228
-
📖 **Complete Guide:** See [Parameter Customization Guide](../docs/CustomizingAzdParameters.md) for the full list of available parameters and their usage.
237
+
📖 **Complete Guide:** See [Parameter Customization Guide](./CustomizingAzdParameters.md) for the full list of available parameters and their usage.
229
238
230
239
</details>
231
240
@@ -268,21 +277,25 @@ To optimize costs and integrate with your existing Azure infrastructure, you can
268
277
269
278
💡 **Before You Start:** If you encounter any issues during deployment, check our [Troubleshooting Guide](./TroubleShootingSteps.md) for common solutions.
270
279
280
+
⚠️ **Critical: Redeployment Warning** - If you have previously run `azd up` in this folder (i.e., a `.azure` folder exists), you must [create a fresh environment](#creating-a-new-environment) to avoid conflicts and deployment failures.
281
+
271
282
### 4.1 Authenticate with Azure
272
283
273
284
```shell
274
285
azd auth login
275
286
```
276
287
288
+
> **Note for VS Code Web Users:** If you're using VS Code Web and have already authenticated using `az login --use-device-code` in Option C, you may skip this step or proceed with `azd auth login` if prompted.
289
+
277
290
**For specific tenants:**
278
291
```shell
279
292
azd auth login --tenant-id <tenant-id>
280
293
```
281
294
282
-
> **Finding Tenant ID:**
283
-
> 1. Open the [Azure Portal](https://portal.azure.com/).
284
-
> 2. Navigate to **Microsoft Entra ID** from the left-hand menu.
285
-
> 3. Under the **Overview** section, locate the **Tenant ID** field. Copy the value displayed.
295
+
**Finding Tenant ID:**
296
+
1. Open the [Azure Portal](https://portal.azure.com/)
297
+
2. Navigate to **Microsoft Entra ID** from the left-hand menu
298
+
3. Under the **Overview** section, locate the **Tenant ID** field. Copy the value displayed
286
299
287
300
### 4.2 Start Deployment
288
301
@@ -291,7 +304,7 @@ azd up
291
304
```
292
305
293
306
**During deployment, you'll be prompted for:**
294
-
1.**Environment name** (e.g., "macae1") - Must be 3-16 characters long, alphanumeric only
307
+
1.**Environment name** (e.g., "macaedev") - Must be 3-16 characters long, alphanumeric only
295
308
2.**Azure subscription** selection
296
309
3.**Azure AI Foundry deployment region** - Select a region with available model quota for AI operations
297
310
4.**Primary location** - Select the region where your infrastructure resources will be deployed
@@ -350,14 +363,24 @@ After successful deployment:
350
363
351
364
### 5.4 Test the Application
352
365
353
-
Follow the detailed workflow to test the Multi Agent functionality:
366
+
**Quick Test Steps:**
367
+
368
+
1. **Access the application** using the URL from Step 4.3
369
+
2. **Sign in** with your authenticated account
370
+
3. **Select a use case** from the available scenarios you uploaded in Step 5.1
371
+
4. **Ask a sample question** relevant to the selected use case
372
+
5. **Verify the response** includes appropriate multi-agent collaboration
373
+
6. **Check the logs** in Azure Portal to confirm backend processing
354
374
355
-
📖 **Detailed Instructions:** See the complete [Sample Workflow](./SampleQuestions.md) guide for step-by-step testing procedures.
375
+
📖 **Detailed Instructions:** See the complete [Sample Workflow](./SampleQuestions.md) guide for step-by-step testing procedures and sample questions for each use case.
356
376
357
377
358
378
## Step 6: Clean Up (Optional)
359
379
360
380
### Remove All Resources
381
+
382
+
To purge resources and clean up after deployment, use the `azd down`command or follow the Delete Resource Group Guide for manual cleanup through Azure Portal.
383
+
361
384
```shell
362
385
azd down
363
386
```
@@ -470,16 +493,16 @@ Now that your deployment is complete and tested, explore these resources to enha
470
493
📚 **Learn More:**
471
494
- [Local Development Setup](./LocalDevelopmentSetup.md) - Set up your local development environment
472
495
- [Sample Questions](./SampleQuestions.md) - Explore sample questions and workflows
496
+
- [MCP Server Documentation](./mcp_server.md) - Learn about Model Context Protocol server integration
0 commit comments