|
| 1 | +# AVM Post Deployment Guide |
| 2 | + |
| 3 | +This document provides guidance on post-deployment steps after deploying the Multi-Agent Custom Automation Engine Solution Accelerator from the [AVM (Azure Verified Modules) repository](https://github.com/Azure/bicep-registry-modules/tree/main/avm/ptn/sa/multi-agent-custom-automation-engine). |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +After deploying the infrastructure using AVM, you'll need to complete the application layer setup, which includes: |
| 8 | +- Configuring team agent configurations |
| 9 | +- Processing and uploading sample datasets |
| 10 | +- Setting up Azure AI Search indexes |
| 11 | +- Configuring blob storage containers |
| 12 | +- Setting up application authentication |
| 13 | + |
| 14 | +## Prerequisites |
| 15 | + |
| 16 | +Before starting the post-deployment process, ensure you have the following: |
| 17 | + |
| 18 | +### Required Software |
| 19 | + |
| 20 | +1. **[PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.4)** <small>(v7.0+ recommended)</small> - Available for Windows, macOS, and Linux |
| 21 | + |
| 22 | +2. **[Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)** <small>(v2.50+)</small> - Command-line tool for managing Azure resources |
| 23 | + |
| 24 | +3. **[Python](https://www.python.org/downloads/)** <small>(v3.9+ recommended)</small> - Required for data processing scripts |
| 25 | + |
| 26 | +4. **[Git](https://git-scm.com/downloads/)** - Version control system for cloning the repository |
| 27 | + |
| 28 | +### Azure Requirements |
| 29 | + |
| 30 | +5. **Azure Access** - One of the following roles on the subscription or resource group: |
| 31 | + - `Contributor` |
| 32 | + - `Owner` |
| 33 | + |
| 34 | +6. **Deployed Infrastructure** - A successful Multi-Agent Custom Automation Engine deployment from the [AVM repository](https://github.com/Azure/bicep-registry-modules/tree/main/avm/ptn/sa/multi-agent-custom-automation-engine) |
| 35 | + |
| 36 | +#### **Important Note for PowerShell Users** |
| 37 | + |
| 38 | +If you encounter issues running PowerShell scripts due to execution policy restrictions, you can temporarily adjust the `ExecutionPolicy` by running the following command in an elevated PowerShell session: |
| 39 | + |
| 40 | +```powershell |
| 41 | +Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass |
| 42 | +``` |
| 43 | + |
| 44 | +This will allow the scripts to run for the current session without permanently changing your system's policy. |
| 45 | + |
| 46 | +## Post-Deployment Steps |
| 47 | + |
| 48 | +### Step 1: Clone the Repository |
| 49 | + |
| 50 | +First, clone this repository to access the post-deployment scripts: |
| 51 | + |
| 52 | +```powershell |
| 53 | +git clone https://github.com/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator.git |
| 54 | +``` |
| 55 | +```powershell |
| 56 | +cd Multi-Agent-Custom-Automation-Engine-Solution-Accelerator |
| 57 | +``` |
| 58 | + |
| 59 | +### Step 2: Run the Post-Deployment Script |
| 60 | + |
| 61 | +The post-deployment process is automated through a single PowerShell or Bash script that completes the following tasks in approximately 5-10 minutes: |
| 62 | + |
| 63 | +#### What the Script Does: |
| 64 | +1. **Configure Team Agent Settings** - Upload HR, Marketing, and Retail team configurations |
| 65 | +2. **Process Sample Datasets** - Upload and index sample customer data, analytics, and business metrics |
| 66 | +3. **Set Up Azure AI Search** - Create and configure search indexes for agent data retrieval |
| 67 | +4. **Configure Blob Storage** - Set up containers for document and data storage |
| 68 | + |
| 69 | +#### Execute the Script: |
| 70 | + |
| 71 | +1. **Choose the appropriate command based on your deployment method and OS:** |
| 72 | + |
| 73 | + **If you deployed using custom templates, ARM/Bicep deployments, or `az deployment group` commands:** |
| 74 | + |
| 75 | + - **For PowerShell (Windows/Linux/macOS):** |
| 76 | + ```powershell |
| 77 | + .\infra\scripts\Team-Config-And-Data.ps1 -ResourceGroup "<your-resource-group-name>" |
| 78 | + ``` |
| 79 | +
|
| 80 | + - **For Bash (Linux/macOS/WSL):** |
| 81 | + ```bash |
| 82 | + bash infra/scripts/team_config_and_data.sh "<your-resource-group-name>" |
| 83 | + ``` |
| 84 | + |
| 85 | + **If you deployed using `azd up` command:** |
| 86 | +
|
| 87 | + - **For PowerShell (Windows/Linux/macOS):** |
| 88 | + ```powershell |
| 89 | + .\infra\scripts\Team-Config-And-Data.ps1 |
| 90 | + ``` |
| 91 | +
|
| 92 | + - **For Bash (Linux/macOS/WSL):** |
| 93 | + ```bash |
| 94 | + bash infra/scripts/team_config_and_data.sh |
| 95 | + ``` |
| 96 | + |
| 97 | + > **Note**: Replace `<your-resource-group-name>` with the actual name of the resource group containing your deployed Azure resources. |
| 98 | +
|
| 99 | + > **💡 Tip**: Since this guide is for AVM deployments, you'll most likely use the first command with the `-ResourceGroup` parameter. |
| 100 | +
|
| 101 | +### Step 3: Provide Required Information |
| 102 | +
|
| 103 | +During script execution, you'll be prompted for: |
| 104 | +
|
| 105 | +- You'll be prompted to authenticate with Azure if not already logged in |
| 106 | +- Select the appropriate Azure subscription |
| 107 | +
|
| 108 | +#### Resource Validation |
| 109 | +- The script will automatically detect and validate your deployed Azure resources |
| 110 | +- Confirmation prompts will appear before making configuration changes |
| 111 | +
|
| 112 | +### Step 4: Post Deployment Script Completion |
| 113 | +
|
| 114 | +Upon successful completion, you'll see a success message. |
| 115 | +
|
| 116 | +**🎉 Congratulations!** Your post-deployment configuration is complete. |
| 117 | +
|
| 118 | +### Step 5: Set Up App Authentication (Optional) |
| 119 | +
|
| 120 | +Follow the steps in [Set Up Authentication in Azure App Service](azure_app_service_auth_setup.md) to add app authentication to your web app running on Azure App Service. |
| 121 | +
|
| 122 | +--- |
| 123 | +
|
| 124 | +> **📋 Note**: This guide is specifically for post-deployment steps after using the AVM template. For complete deployment from scratch, see the main [Deployment Guide](./DeploymentGuide.md). |
0 commit comments