Merge branch 'macae-v3-dev-v2-vip' of https://github.com/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator into macae-v3-dev-marktayl

Author: marktayl1

.github/workflows/deploy-waf.yml

@@ -109,13 +109,15 @@ jobs:
             --resource-group ${{ env.RESOURCE_GROUP_NAME }} \
             --template-file infra/main.bicep \
             --parameters \
-              environmentName=${{ env.SOLUTION_PREFIX }} \
-              useWafAlignedArchitecture=true \
-              aiDeploymentsLocation='${{ env.AZURE_LOCATION }}' \
+              solutionName=${{ env.SOLUTION_PREFIX }} \
+              location="${{ env.AZURE_LOCATION }}" \
+              azureAiServiceLocation='${{ env.AZURE_LOCATION }}' \
               gptModelCapacity=5 \
-              virtualMachineConfiguration='{"adminUsername": "adminuser", "adminPassword": "P@ssw0rd1234"}' \
-              logAnalyticsWorkspaceConfiguration='{"existingWorkspaceResourceId": ""}'
-
+              enableTelemetry=true \
+              enableMonitoring=true \
+              enablePrivateNetworking=true \
+              enableScalability=true \
+              
 
       - name: Send Notification on Failure
         if: failure()

.github/workflows/deploy.yml

@@ -129,19 +129,16 @@ jobs:
             --resource-group ${{ env.RESOURCE_GROUP_NAME }} \
             --template-file infra/main.bicep \
             --parameters \
-              environmentName=${{ env.SOLUTION_PREFIX }} \
-              solutionLocation="${{ env.AZURE_LOCATION }}" \
-              modelDeploymentType="GlobalStandard" \
+              solutionName=${{ env.SOLUTION_PREFIX }} \
+              location="${{ env.AZURE_LOCATION }}" \
+              gptModelDeploymentType="GlobalStandard" \
               gptModelName="gpt-4o" \
               gptModelVersion="2024-08-06" \
-              imageTag="${IMAGE_TAG}" \
-              useWafAlignedArchitecture=false \
-              aiDeploymentsLocation='${{ env.AZURE_LOCATION }}' \
+              backendContainerImageTag="${IMAGE_TAG}" \
+              frontendContainerImageTag="${IMAGE_TAG}" \
+              azureAiServiceLocation='${{ env.AZURE_LOCATION }}' \
               gptModelCapacity=150 \
-              logAnalyticsWorkspaceConfiguration='{"dataRetentionInDays": 30, "existingWorkspaceResourceId": ""}' \
-              applicationInsightsConfiguration='{"retentionInDays": 30}' \
-              virtualNetworkConfiguration='{"enabled": false}' \
-              webServerFarmConfiguration='{"skuCapacity": 1, "skuName": "B2"}' \
+              createdBy="Pipeline" \
             --output json
 
       - name: Extract Web App and API App URLs

.github/workflows/test.yml

@@ -51,7 +51,7 @@ jobs:
       - name: Run tests with coverage
         if: env.skip_tests == 'false'
         run: |
-          pytest --cov=. --cov-report=term-missing --cov-report=xml
+          pytest --cov=. --cov-report=term-missing --cov-report=xml --ignore=tests/e2e-test/tests
           
       - name: Skip coverage report if no tests
         if: env.skip_tests == 'true'

.gitignore

@@ -460,4 +460,7 @@ __pycache__/
 .azure
 .github/copilot-instructions.md
 # Ignore sample code folder
-data/sample_code/
+data/sample_code/
+# Bicep local files
+*.local*.bicepparam
+*.local*.parameters.json

azure.yaml

@@ -3,4 +3,38 @@ name: multi-agent-custom-automation-engine-solution-accelerator
 metadata:
   template: [email protected]
 requiredVersions:
-  azd: ">=1.15.0 !=1.17.1"
+  azd: ">=1.15.0 !=1.17.1"
+hooks:
+  postdeploy:
+    windows:
+      run: |
+        Write-Host "To upload Team Configurations to Cosmos. Run the following command in PowerShell:"
+        Write-Host "infra\scripts\Upload-Team-Config.ps1" -ForegroundColor Cyan
+        Write-Host ""
+        Write-Host "To index Sample Data into Azure Search. Run the following command in PowerShell:"
+        Write-Host "infra\scripts\Process-Sample-Data.ps1" -ForegroundColor Cyan
+        Write-Host ""
+        Write-Host "To upload team configurations and index sample data both in one command, you can use the following command in PowerShell:"
+        Write-Host "infra\scripts\Team-Config-And-Data.ps1" -ForegroundColor Cyan
+        Write-Host ""
+        Write-Host "You can access the deployed Frontend application at the following URL:"
+        Write-Host "https://$env:webSiteDefaultHostname" -ForegroundColor Cyan
+      shell: pwsh
+      interactive: true
+    posix:
+      run: |
+        Blue='\033[0;34m'
+        NC='\033[0m'
+        echo "To upload Team Configurations to Cosmos. Run the following command in Bash:"
+        echo "${Blue}bash infra/scripts/upload_team_config.sh"
+        echo ""
+        echo "${NC}To index Sample Data into Azure Search. Run the following command in Bash:"
+        echo "${Blue}bash infra/scripts/process_sample_data.sh"
+        echo ""
+        echo "${NC}To upload team configurations and index sample data both in one command, you can use the following command in Bash:"
+        echo "${Blue}bash infra/scripts/team_config_and_data.sh"
+        echo ""
+        echo "${NC}You can access the deployed Frontend application at the following URL:"
+        echo "${Blue}https://$webSiteDefaultHostname"
+      shell: sh
+      interactive: true

azure_custom.yaml

@@ -38,4 +38,39 @@ services:
           shell: sh
           run: bash ../../infra/scripts/package_frontend.sh
           interactive: true
-          continueOnError: false
+          continueOnError: false
+
+hooks:
+  postdeploy:
+    windows:
+      run: |
+        Write-Host "To upload Team Configurations to Cosmos. Run the following command in PowerShell:"
+        Write-Host "infra\scripts\Upload-Team-Config.ps1" -ForegroundColor Cyan
+        Write-Host ""
+        Write-Host "To index Sample Data into Azure Search. Run the following command in PowerShell:"
+        Write-Host "infra\scripts\Process-Sample-Data.ps1" -ForegroundColor Cyan
+        Write-Host ""
+        Write-Host "If you want to run both scripts as single command, you can use the following command in PowerShell:"
+        Write-Host "infra\scripts\Team-Config-And-Data.ps1" -ForegroundColor Cyan
+        Write-Host ""
+        Write-Host "You can access the deployed Frontend application at the following URL:"
+        Write-Host "https://$env:webSiteDefaultHostname" -ForegroundColor Cyan
+      shell: pwsh
+      interactive: true
+    posix:
+      run: |
+        Blue='\033[0;34m'
+        NC='\033[0m'
+        echo "To upload Team Configurations to Cosmos. Run the following command in Bash:"
+        echo "${Blue}bash infra/scripts/upload_team_config.sh"
+        echo ""
+        echo "${NC}To index Sample Data into Azure Search. Run the following command in Bash:"
+        echo "${Blue}bash infra/scripts/process_sample_data.sh"
+        echo ""
+        echo "${NC}If you want to run both scripts as single command, you can use the following command in Bash:"
+        echo "${Blue}bash infra/scripts/team_config_and_data.sh"
+        echo ""
+        echo "${NC}You can access the deployed Frontend application at the following URL:"
+        echo "${Blue}https://$webSiteDefaultHostname"
+      shell: sh
+      interactive: true

docs/CustomizingAzdParameters.md

@@ -19,6 +19,8 @@ By default this template will use the environment name as the prefix to prevent
 | `AZURE_ENV_IMAGETAG`            | string | `latest`          | Docker image tag used for container deployments.                                                   |
 | `AZURE_ENV_ENABLE_TELEMETRY`    | bool   | `true`            | Enables telemetry for monitoring and diagnostics.                                                  |
 | `AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID` | string  | Guide to get your [Existing Workspace ID](/docs/re-use-log-analytics.md) | Set this if you want to reuse an existing Log Analytics Workspace instead of creating a new one.     |
+| `AZURE_ENV_VM_ADMIN_USERNAME`  | string | `take(newGuid(), 20)`               | The administrator username for the virtual machine.         |
+| `AZURE_ENV_VM_ADMIN_PASSWORD`  | string | `newGuid()`               | The administrator password for the virtual machine.         |
 ---
 
 ## How to Set a Parameter

docs/DeploymentGuide.md

@@ -26,42 +26,68 @@ Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
 
 This will allow the scripts to run for the current session without permanently changing your system's policy.
 
+### **Azure Developer CLI (azd) Requirement**
+
+Ensure that you are using the latest version of the [Azure Developer CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/overview).
+The `azd` version must be **1.18.0 or higher**.
+
+Upgrade commands by OS:
+
+* **Windows (using winget):**
+
+  ```bash
+  winget install microsoft.azd
+  ```
+
+* **Linux (using apt):**
+
+  ```bash
+  curl -fsSL https://aka.ms/install-azd.sh | bash
+  ```
+
+* **macOS (using Homebrew):**
+
+  ```bash
+  brew update && brew tap azure/azd && brew install azd
+  ```
+
 ## Deployment Options & Steps
 
 ### Sandbox or WAF Aligned Deployment Options
 
 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.
 
-When running `azd up`, you’ll now be prompted to choose between a **WAF-aligned configuration** and a **sandbox configuration** using a simple selection:
+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.
 
-- A **sandbox environment** — ideal for development and proof-of-concept scenarios, with minimal security and cost controls for rapid iteration.
+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:
 
-- A **production deployments environment**, 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:
   - Enhanced network security (e.g., Network protection with private endpoints)
   - Stricter access controls and managed identities
   - Logging, monitoring, and diagnostics enabled by default
   - Resource tagging and cost management recommendations
 
 **How to choose your deployment configuration:**
 
-When prompted during `azd up`:
+* Use the default `main.parameters.json` file for a **sandbox/dev environment**
+* For a **WAF-aligned, production-ready deployment**, copy the contents of `main.waf.parameters.json` into `main.parameters.json` before running `azd up`
 
-![useWAFAlignedArchitecture](images/macae_waf_prompt.png)
+---
 
-- Select **`true`** to deploy a **WAF-aligned, production-ready environment**  
-- Select **`false`** to deploy a **lightweight sandbox/dev environment**
+### VM Credentials Configuration
+
+By default, the solution sets the VM administrator username and password from environment variables.
+If you do not configure these values, a randomly generated GUID will be used for both the username and password.
+
+To set your own VM credentials before deployment, use:
+
+```sh
+azd env set AZURE_ENV_VM_ADMIN_USERNAME <your-username>
+azd env set AZURE_ENV_VM_ADMIN_PASSWORD <your-password>
+```
 
 > [!TIP]
 > 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.
 
-> To reuse an existing Log Analytics workspace, update the existingWorkspaceResourceId field under the logAnalyticsWorkspaceConfiguration parameter in the .bicep file with the resource ID of your existing workspace.
-For example: 
-```
-param logAnalyticsWorkspaceConfiguration = {
-  dataRetentionInDays: 30
-  existingWorkspaceResourceId: '/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.OperationalInsights/workspaces/<workspace-name>'
-}
-```
 
 > [!IMPORTANT]
 > The WAF-aligned configuration is under active development. More Azure Well-Architected recommendations will be added in future updates.
@@ -213,11 +239,51 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
    - This deployment will take _4-6 minutes_ to provision the resources in your account and set up the solution with sample data.
    - If you encounter an error or timeout during deployment, changing the location may help, as there could be availability constraints for the resources.
 
-5. Once the deployment has completed successfully, open the [Azure Portal](https://portal.azure.com/), go to the deployed resource group, find the App Service, and get the app URL from `Default domain`.
+5. After deployment completes, you can upload Team Configurations using command printed in the terminal. The command will look like one of the following. Run the appropriate command for your shell from the project root:
+
+  - **For Bash (Linux/macOS/WSL):**
+    ```bash
+    bash infra/scripts/upload_team_config.sh
+    ```
+
+  - **For PowerShell (Windows):**
+    ```powershell
+    infra\scripts\Upload-Team-Config.ps1
+    ```
+
+6. After deployment completes, you can index Sample Data into Search Service using command printed in the terminal. The command will look like one of the following. Run the appropriate command for your shell from the project root:
 
-6. When Deployment is complete, follow steps in [Set Up Authentication in Azure App Service](../docs/azure_app_service_auth_setup.md) to add app authentication to your web app running on Azure App Service
+  - **For Bash (Linux/macOS/WSL):**
+    ```bash
+    bash infra/scripts/process_sample_data.sh
+    ```
 
-7. If you are done trying out the application, you can delete the resources by running `azd down`.
+  - **For PowerShell (Windows):**
+    ```powershell
+    infra\scripts\Process-Sample-Data.ps1
+    ```
+
+7. To upload team configurations and index sample data in one step. Run the appropriate command for your shell from the project root:
+
+  - **For Bash (Linux/macOS/WSL):**
+    ```bash
+    bash infra/scripts/team_config_and_data.sh
+    ```
+
+  - **For PowerShell (Windows):**
+    ```powershell
+    infra\scripts\Team-Config-And-Data.ps1
+    ```
+
+8. Once the deployment has completed successfully, open the [Azure Portal](https://portal.azure.com/), go to the deployed resource group, find the App Service, and get the app URL from `Default domain`.
+
+9. When Deployment is complete, follow steps in [Set Up Authentication in Azure App Service](../docs/azure_app_service_auth_setup.md) to add app authentication to your web app running on Azure App Service
+
+10. If you are done trying out the application, you can delete the resources by running `azd down`.
+
+
+### 🛠️ Troubleshooting
+ If you encounter any issues during the deployment process, please refer [troubleshooting](../docs/TroubleShootingSteps.md) document for detailed steps and solutions.
 
 # Local setup
 
@@ -324,27 +390,39 @@ The files for the dev container are located in `/.devcontainer/` folder.
    - Update the `.env` file with the required values from your Azure resource group in Azure Portal App Service environment variables.
    - Alternatively, if resources were
    provisioned using `azd provision` or `azd up`, a `.env` file is automatically generated in the `.azure/<env-name>/.env`
-   file. To get your `<env-name>` run `azd env list` to see which env is default.
+   file. You can copy the contents of this file into your backend `.env` file.
+
+    _**Note**: To get your `<env-name>` run `azd env list` to see which env is default._
 
 6. **Fill in the `.env` file:**
 
    - Use the output from the deployment or check the Azure Portal under "Deployments" in the resource group.
    - Make sure to set APP_ENV to "**dev**" in `.env` file.
+   - For local development, make sure to include below env variables in the `.env`
+     - `BACKEND_API_URL=http://localhost:8000`
+     - `FRONTEND_SITE_NAME=http://127.0.0.1:3000` .
 
 7. **(Optional) Set up a virtual environment:**
 
    - If you are using `venv`, create and activate your virtual environment for both the frontend and backend folders.
 
-8. **Install requirements - frontend:**
+8. **Install requirements - Backend:**
 
-   - In each of the frontend and backend folders -
-     Open a terminal in the `src` folder and run:
+   - To install the requirement for backend -
+     Open a terminal in the `src/backend` folder and run:
      ```bash
-     pip install -r requirements.txt
+     pip install uv
+     uv sync
      ```
      
 9. **Build the frontend (important):**
 
+    - To install the requirement for frontend -
+     Open a terminal in the `src/frontend` folder and run:
+     ```bash
+     pip install -r requirements.txt
+     ```
+
     - Before running the frontend server, you must build the frontend to generate the necessary `build/assets` directory.
 
       From the `src/frontend` directory, run:
@@ -356,7 +434,7 @@ The files for the dev container are located in `/.devcontainer/` folder.
 
 10. **Run the application:**
 
-- From the src/backend directory:
+- From the `src/backend` directory activate the virtual environment created through step 8 and Run:
 
 ```bash
 python app_kernel.py
@@ -368,8 +446,22 @@ python app_kernel.py
  python frontend_server.py
 ```
 
-10. Open a browser and navigate to `http://localhost:3000`
-11. To see swagger API documentation, you can navigate to `http://localhost:8000/docs`
+or Run 
+
+  ```bash
+  npm run dev
+  ```
+
+11. Open a browser and navigate to `http://localhost:3000`
+12. To see swagger API documentation, you can navigate to `http://localhost:8000/docs`
+
+## Deploy Your local changes
+To Deploy your local changes rename the below files.
+   1. Rename `azure.yaml` to `azure_custom2.yaml` and `azure_custom.yaml` to `azure.yaml`.
+   2. Go to `infra` directory
+        - Remove `main.bicep` to `main_custom2.bicep` and `main_custom.bicep` to `main.bicep`.
+Continue with the [deploying steps](#deploying-with-azd).
+
 
 ## Debugging the solution locally