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
+49-7Lines changed: 49 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,8 +59,9 @@ Ensure you have access to an [Azure subscription](https://azure.microsoft.com/fr
59
59
📖 **Follow:**[Quota Check Instructions](./QuotaCheck.md) to ensure sufficient capacity.
60
60
61
61
**Recommended Configuration:**
62
-
-**Default:** 150k tokens (minimum)
63
-
-**Optimal:** More than 150k tokens (for best performance)
62
+
63
+
-**Minimum:** 150k tokens for Global Standard GPT-4.1
64
+
-**Optimal:** More 150k tokens (for best performance)
64
65
65
66
> **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).
66
67
@@ -115,7 +116,7 @@ Select one of the following options to deploy the Document Generation Solution A
115
116
<details>
116
117
<summary><b>Option C: Visual Studio Code Web</b></summary>
117
118
118
-
[&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9taWNyb3NvZnQvQ29udGFpbmVyLU1pZ3JhdGlvbi1Tb2x1dGlvbi1BY2NlbGVyYXRvci9yZWZzL2hlYWRzL21haW4vaW5mcmEvdnNjb2RlX3dlYiIsICJpbmRleFVybCI6ICIvaW5kZXguanNvbiIsICJ2YXJpYWJsZXMiOiB7ImFnZW50SWQiOiAiIiwgImNvbm5lY3Rpb25TdHJpbmciOiAiIiwgInRocmVhZElkIjogIiIsICJ1c2VyTWVzc2FnZSI6ICIiLCAicGxheWdyb3VuZE5hbWUiOiAiIiwgImxvY2F0aW9uIjogIiIsICJzdWJzY3JpcHRpb25JZCI6ICIiLCAicmVzb3VyY2VJZCI6ICIiLCAicHJvamVjdFJlc291cmNlSWQiOiAiIiwgImVuZHBvaW50IjogIiJ9LCAiY29kZVJvdXRlIjogWyJhaS1wcm9qZWN0cy1zZGsiLCAicHl0aG9uIiwgImRlZmF1bHQtYXp1cmUtYXV0aCIsICJlbmRwb2ludCJdfQ==)
119
+
[&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9taWNyb3NvZnQvZG9jdW1lbnQtZ2VuZXJhdGlvbi1zb2x1dGlvbi1hY2NlbGVyYXRvci9yZWZzL2hlYWRzL21haW4vaW5mcmEvdnNjb2RlX3dlYiIsICJpbmRleFVybCI6ICIvaW5kZXguanNvbiIsICJ2YXJpYWJsZXMiOiB7ImFnZW50SWQiOiAiIiwgImNvbm5lY3Rpb25TdHJpbmciOiAiIiwgInRocmVhZElkIjogIiIsICJ1c2VyTWVzc2FnZSI6ICIiLCAicGxheWdyb3VuZE5hbWUiOiAiIiwgImxvY2F0aW9uIjogIiIsICJzdWJzY3JpcHRpb25JZCI6ICIiLCAicmVzb3VyY2VJZCI6ICIiLCAicHJvamVjdFJlc291cmNlSWQiOiAiIiwgImVuZHBvaW50IjogIiJ9LCAiY29kZVJvdXRlIjogWyJhaS1wcm9qZWN0cy1zZGsiLCAicHl0aG9uIiwgImRlZmF1bHQtYXp1cmUtYXV0aCIsICJlbmRwb2ludCJdfQ==)
119
120
120
121
1. Click the badge above (may take a few minutes to load)
121
122
2. Sign in with your Azure account when prompted
@@ -207,7 +208,7 @@ azd env set AZURE_ENV_VM_ADMIN_PASSWORD <your-password>
207
208
208
209
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.
209
210
210
-
📖 **Complete Guide:** See [Parameter Customization Guide](../docs/CustomizingAzdParameters.md) for the full list of available parameters and their usage.
211
+
📖 **Complete Guide:** See [Parameter Customization Guide](./CustomizingAzdParameters.md) for the full list of available parameters and their usage.
211
212
212
213
</details>
213
214
@@ -275,6 +276,7 @@ azd up
275
276
### 4.3 Get Application URL
276
277
277
278
After successful deployment:
279
+
278
280
1. Open [Azure Portal](https://portal.azure.com/)
279
281
2. Navigate to your resource group
280
282
3. Find the App Service with "app"in the name
@@ -309,14 +311,23 @@ After successful deployment:
309
311
## Step 6: Clean Up (Optional)
310
312
311
313
### Remove All Resources
314
+
312
315
```shell
313
316
azd down
314
317
```
315
-
> **Note:** If you deployed with `enableRedundancy=true` and Log Analytics workspace replication is enabled, you must first disable replication before running `azd down` else resource group delete will fail. Follow the steps in [Handling Log Analytics Workspace Deletion with Replication Enabled](./LogAnalyticsReplicationDisable.md), wait until replication returns `false`, then run `azd down`.
318
+
319
+
> **Note:** To purge resources and clean up after deployment, use the `azd down` command or follow the [Delete Resource Group Guide](./DeleteResourceGroup.md) for manual cleanup through Azure Portal. If you deployed with `enableRedundancy=true` and Log Analytics workspace replication is enabled, you must first disable replication before running `azd down` else resource group delete will fail. Follow the steps in [Handling Log Analytics Workspace Deletion with Replication Enabled](./LogAnalyticsReplicationDisable.md), wait until replication returns `false`, then run `azd down`.
316
320
317
321
### Manual Cleanup (if needed)
322
+
318
323
If deployment fails or you need to clean up manually:
324
+
319
325
- Follow [Delete Resource Group Guide](./DeleteResourceGroup.md)
326
+
- See section below for "Deleting Resources After a Failed Deployment"
327
+
328
+
## 🛠️ Troubleshooting
329
+
330
+
If you encounter issues during deployment, see our comprehensive [Troubleshooting Guide](./TroubleShootingSteps.md) for solutions to common problems.
- **Different regions:** Deploy to multiple regions for testing quota availability
414
425
- **Separate configurations:** Each environment can have different parameter settings
415
426
- **Clean up unused environments:** Use `azd down` to remove environments you no longer need
@@ -418,8 +429,19 @@ azd env get-values
418
429
419
430
Now that your deployment is complete and tested, explore these resources to enhance your experience:
420
431
421
-
📚 **Learn More:**
432
+
� **Get Started:**
433
+
434
+
- [Sample Questions](./SampleQuestions.md) - Try these sample questions to explore the solution's capabilities
435
+
436
+
🔧 **Development & Customization:**
437
+
422
438
- [Local Development Setup](./LocalDevelopmentSetup.md) - Set up your local development environment
439
+
- Review [Test Case Flows](../src/TEST_CASE_FLOWS.md) for detailed testing scenarios
440
+
441
+
📚 **Learn More:**
442
+
443
+
- Explore the architecture and design principles
444
+
- Understand the solution's components and workflows
423
445
424
446
## Need Help?
425
447
@@ -429,6 +451,26 @@ Now that your deployment is complete and tested, explore these resources to enha
429
451
430
452
---
431
453
454
+
## Environment configuration for local development & debugging
455
+
456
+
To run and debug the application locally, you need to configure environment variables in a `.env` file:
457
+
458
+
1. Create a `.env` file in the `src` directory of your project
459
+
2. Set the `APP_ENV` variable to match your deployed environment name:
460
+
```
461
+
APP_ENV=<your-environment-name>
462
+
```
463
+
3. Authenticate with Azure CLI to access deployed resources:
464
+
```shell
465
+
az login
466
+
```
467
+
468
+
The application will use the Azure CLI credentials to connect to the deployed Azure resources (Azure AI Search, Cosmos DB, etc.) using the environment name specified in `APP_ENV`.
469
+
470
+
For complete local development setup instructions, see the [Local Development Setup Guide](./LocalDevelopmentSetup.md).
471
+
472
+
---
473
+
432
474
## Advanced: Deploy Local Changes
433
475
434
476
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