Skip to content

Commit 7db7672

Browse files
Update deployment guide to avoid inconsistency.
1 parent bc3f20e commit 7db7672

1 file changed

Lines changed: 32 additions & 19 deletions

File tree

docs/DeploymentGuide.md

Lines changed: 32 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Overview
44

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 4-6 minutes for the default Development/Testing configuration and includes both infrastructure provisioning and application setup.
66

77
🆘 **Need Help?** If you encounter any issues during deployment, check our [Troubleshooting Guide](./TroubleShootingSteps.md) for solutions to common problems.
88

@@ -52,6 +52,7 @@ Ensure you have access to an [Azure subscription](https://azure.microsoft.com/fr
5252
- [Azure Cosmos DB](https://learn.microsoft.com/en-us/azure/cosmos-db/)
5353
- [Azure Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/)
5454
- [Azure Blob Storage](https://learn.microsoft.com/en-us/azure/storage/blobs/)
55+
- [Azure Queue Storage](https://learn.microsoft.com/en-us/azure/storage/queues/)
5556
- [GPT Model Capacity](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models)
5657

5758
**Recommended Regions:** East US, East US2, Australia East, Japan East, UK South, France Central
@@ -64,9 +65,9 @@ Ensure you have access to an [Azure subscription](https://azure.microsoft.com/fr
6465

6566
📖 **Follow:** [Quota Check Instructions](./quota_check.md) to ensure sufficient capacity.
6667

67-
<!-- **Recommended Configuration:**
68+
**Recommended Configuration:**
6869
- **Default:** 200k tokens (minimum)
69-
- **Optimal:** 500k tokens (recommended for best performance) -->
70+
- **Optimal:** 500k tokens (recommended for best performance)
7071

7172
> **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).
7273
@@ -225,14 +226,14 @@ azd env set AZURE_ENV_VM_ADMIN_PASSWORD <your-password>
225226

226227
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.
227228

228-
📖 **Complete Guide:** See [Parameter Customization Guide](../docs/CustomizingAzdParameters.md) for the full list of available parameters and their usage.
229+
📖 **Complete Guide:** See [Parameter Customization Guide](./CustomizingAzdParameters.md) for the full list of available parameters and their usage.
229230

230231
</details>
231232

232233
<details>
233234
<summary><b>[Optional] Quota Recommendations</b></summary>
234235

235-
By default, the **GPT model capacity** in deployment is set to **150k tokens**.
236+
By default, the **GPT model capacity** in deployment is set to **140k tokens**.
236237

237238
To adjust quota settings, follow these [steps](./AzureGPTQuotaSettings.md).
238239

@@ -268,6 +269,8 @@ To optimize costs and integrate with your existing Azure infrastructure, you can
268269

269270
💡 **Before You Start:** If you encounter any issues during deployment, check our [Troubleshooting Guide](./TroubleShootingSteps.md) for common solutions.
270271

272+
⚠️ **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.
273+
271274
### 4.1 Authenticate with Azure
272275

273276
```shell
@@ -279,10 +282,10 @@ azd auth login
279282
azd auth login --tenant-id <tenant-id>
280283
```
281284

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.
285+
**Finding Tenant ID:**
286+
1. Open the [Azure Portal](https://portal.azure.com/)
287+
2. Navigate to **Microsoft Entra ID** from the left-hand menu
288+
3. Under the **Overview** section, locate the **Tenant ID** field. Copy the value displayed
286289

287290
### 4.2 Start Deployment
288291

@@ -291,13 +294,13 @@ azd up
291294
```
292295

293296
**During deployment, you'll be prompted for:**
294-
1. **Environment name** (e.g., "macae1") - Must be 3-16 characters long, alphanumeric only
297+
1. **Environment name** (e.g., "macaedev") - Must be 3-16 characters long, alphanumeric only
295298
2. **Azure subscription** selection
296299
3. **Azure AI Foundry deployment region** - Select a region with available model quota for AI operations
297300
4. **Primary location** - Select the region where your infrastructure resources will be deployed
298301
5. **Resource group** selection (create new or use existing)
299302

300-
**Expected Duration:** 9-10 minutes for default configuration
303+
**Expected Duration:** 4-6 minutes for default configuration
301304

302305
- **Upon successful completion**, you will see a success message indicating that all resources have been deployed, along with the application URL and next steps for uploading team configurations and sample data.
303306

@@ -310,8 +313,8 @@ azd up
310313
After successful deployment:
311314
1. Open [Azure Portal](https://portal.azure.com/)
312315
2. Navigate to your resource group
313-
3. Find the Frontend App Service
314-
4. Copy the **Default domain**
316+
3. Find the Container App
317+
4. Copy the **Application URI**
315318

316319
⚠️ **Important:** Complete [Post-Deployment Steps](#step-5-post-deployment-configuration) before accessing the application.
317320

@@ -346,18 +349,28 @@ After successful deployment:
346349

347350
1. Access your application using the URL from Step 4.3
348351
2. Confirm the application loads successfully
349-
<!-- 3. Verify you can sign in with your authenticated account -->
352+
3. Verify you can sign in with your authenticated account
350353

351354
### 5.4 Test the Application
352355

353-
Follow the detailed workflow to test the Multi Agent functionality:
356+
**Quick Test Steps:**
357+
358+
1. **Access the application** using the URL from Step 4.3
359+
2. **Sign in** with your authenticated account
360+
3. **Select a use case** from the available scenarios you uploaded in Step 5.1
361+
4. **Ask a sample question** relevant to the selected use case
362+
5. **Verify the response** includes appropriate multi-agent collaboration
363+
6. **Check the logs** in Azure Portal to confirm backend processing
354364

355-
📖 **Detailed Instructions:** See the complete [Sample Workflow](./SampleQuestions.md) guide for step-by-step testing procedures.
365+
📖 **Detailed Instructions:** See the complete [Sample Workflow](./SampleQuestions.md) guide for step-by-step testing procedures and sample questions for each use case.
356366

357367

358368
## Step 6: Clean Up (Optional)
359369

360370
### Remove All Resources
371+
372+
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.
373+
361374
```shell
362375
azd down
363376
```
@@ -470,16 +483,16 @@ Now that your deployment is complete and tested, explore these resources to enha
470483
📚 **Learn More:**
471484
- [Local Development Setup](./LocalDevelopmentSetup.md) - Set up your local development environment
472485
- [Sample Questions](./SampleQuestions.md) - Explore sample questions and workflows
486+
- [MCP Server Documentation](./mcp_server.md) - Learn about Model Context Protocol server integration
487+
- [Customizing Parameters](./CustomizingAzdParameters.md) - Advanced configuration options
488+
- [Azure Account Setup](./AzureAccountSetUp.md) - Detailed Azure subscription configuration
473489
474490
## Need Help?
475491
476492
- 🐛 **Issues:** Check [Troubleshooting Guide](./TroubleShootingSteps.md)
477493
- 💬 **Support:** Review [Support Guidelines](../SUPPORT.md)
478494
- 🔧 **Development:** See [Contributing Guide](../CONTRIBUTING.md)
479495
480-
---
481-
482-
483496
## Advanced: Deploy Local Changes
484497
485498
If you've made local modifications to the code and want to deploy them to Azure, follow these steps to swap the configuration files:

0 commit comments

Comments
 (0)