Validate Deployment #564
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Validate Deployment | |
| on: | |
| workflow_run: | |
| workflows: ["Build Docker and Optional Push"] | |
| types: | |
| - completed | |
| branches: | |
| - main | |
| - hotfix | |
| - dev | |
| schedule: | |
| - cron: "0 11,23 * * *" # Runs at 11:00 AM and 11:00 PM GMT | |
| workflow_dispatch: #Allow manual triggering | |
| env: | |
| GPT_MIN_CAPACITY: 150 | |
| BRANCH_NAME: ${{ github.head_ref || github.ref_name }} | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| RESOURCE_GROUP_NAME: ${{ steps.check_create_rg.outputs.RESOURCE_GROUP_NAME }} | |
| WEBAPP_URL: ${{ steps.get_output.outputs.WEBAPP_URL }} | |
| DEPLOYMENT_SUCCESS: ${{ steps.deployment_status.outputs.SUCCESS }} | |
| MACAE_URL_API: ${{ steps.get_backend_url.outputs.MACAE_URL_API }} | |
| CONTAINER_APP: ${{steps.get_backend_url.outputs.CONTAINER_APP}} | |
| steps: | |
| - name: Checkout Code | |
| uses: actions/checkout@v3 | |
| - name: Run Quota Check | |
| id: quota-check | |
| run: | | |
| export AZURE_CLIENT_ID=${{ secrets.AZURE_CLIENT_ID }} | |
| export AZURE_TENANT_ID=${{ secrets.AZURE_TENANT_ID }} | |
| export AZURE_CLIENT_SECRET=${{ secrets.AZURE_CLIENT_SECRET }} | |
| export AZURE_SUBSCRIPTION_ID="${{ secrets.AZURE_SUBSCRIPTION_ID }}" | |
| export GPT_MIN_CAPACITY="150" | |
| export AZURE_REGIONS="${{ vars.AZURE_REGIONS }}" | |
| chmod +x infra/scripts/checkquota.sh | |
| if ! infra/scripts/checkquota.sh; then | |
| # If quota check fails due to insufficient quota, set the flag | |
| if grep -q "No region with sufficient quota found" infra/scripts/checkquota.sh; then | |
| echo "QUOTA_FAILED=true" >> $GITHUB_ENV | |
| fi | |
| exit 1 # Fail the pipeline if any other failure occurs | |
| fi | |
| - name: Send Notification on Quota Failure | |
| if: env.QUOTA_FAILED == 'true' | |
| run: | | |
| RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" | |
| EMAIL_BODY=$(cat <<EOF | |
| { | |
| "body": "<p>Dear Team,</p><p>The quota check has failed, and the pipeline cannot proceed.</p><p><strong>Build URL:</strong> ${RUN_URL}</p><p>Please take necessary action.</p><p>Best regards,<br>Your Automation Team</p>" | |
| } | |
| EOF | |
| ) | |
| curl -X POST "${{ secrets.AUTO_LOGIC_APP_URL }}" \ | |
| -H "Content-Type: application/json" \ | |
| -d "$EMAIL_BODY" || echo "Failed to send notification" | |
| - name: Fail Pipeline if Quota Check Fails | |
| if: env.QUOTA_FAILED == 'true' | |
| run: exit 1 | |
| - name: Set Deployment Region | |
| run: | | |
| echo "Selected Region: $VALID_REGION" | |
| echo "AZURE_LOCATION=$VALID_REGION" >> $GITHUB_ENV | |
| - name: Setup Azure CLI | |
| run: | | |
| curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash | |
| az --version # Verify installation | |
| - name: Login to Azure | |
| run: | | |
| az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }} | |
| - name: Install Bicep CLI | |
| run: az bicep install | |
| - name: Generate Resource Group Name | |
| id: generate_rg_name | |
| run: | | |
| ACCL_NAME="macae" | |
| SHORT_UUID=$(uuidgen | cut -d'-' -f1) | |
| UNIQUE_RG_NAME="arg-${ACCL_NAME}-${SHORT_UUID}" | |
| echo "RESOURCE_GROUP_NAME=${UNIQUE_RG_NAME}" >> $GITHUB_ENV | |
| echo "Generated Resource_GROUP_PREFIX: ${UNIQUE_RG_NAME}" | |
| - name: Check and Create Resource Group | |
| id: check_create_rg | |
| run: | | |
| set -e | |
| rg_exists=$(az group exists --name ${{ env.RESOURCE_GROUP_NAME }}) | |
| if [ "$rg_exists" = "false" ]; then | |
| az group create --name ${{ env.RESOURCE_GROUP_NAME }} --location ${{ env.AZURE_LOCATION }} | |
| fi | |
| echo "RESOURCE_GROUP_NAME=${{ env.RESOURCE_GROUP_NAME }}" >> $GITHUB_OUTPUT | |
| - name: Generate Unique Solution Prefix | |
| id: generate_solution_prefix | |
| run: | | |
| COMMON_PART="macae" | |
| TIMESTAMP=$(date +%s) | |
| UPDATED_TIMESTAMP=$(echo $TIMESTAMP | tail -c 6) | |
| UNIQUE_SOLUTION_PREFIX="${COMMON_PART}${UPDATED_TIMESTAMP}" | |
| echo "SOLUTION_PREFIX=${UNIQUE_SOLUTION_PREFIX}" >> $GITHUB_ENV | |
| - name: Deploy Bicep Template | |
| id: deploy | |
| run: | | |
| if [[ "${{ env.BRANCH_NAME }}" == "main" ]]; then | |
| IMAGE_TAG="latest" | |
| elif [[ "${{ env.BRANCH_NAME }}" == "dev" ]]; then | |
| IMAGE_TAG="dev" | |
| elif [[ "${{ env.BRANCH_NAME }}" == "hotfix" ]]; then | |
| IMAGE_TAG="hotfix" | |
| else | |
| IMAGE_TAG="latest" | |
| fi | |
| az deployment group create \ | |
| --resource-group ${{ env.RESOURCE_GROUP_NAME }} \ | |
| --template-file infra/main.bicep \ | |
| --parameters \ | |
| environmentName=${{ env.SOLUTION_PREFIX }} \ | |
| solutionLocation="${{ env.AZURE_LOCATION }}" \ | |
| modelDeploymentType="GlobalStandard" \ | |
| gptModelName="gpt-4o" \ | |
| gptModelVersion="2024-08-06" \ | |
| imageTag="${IMAGE_TAG}" \ | |
| useWafAlignedArchitecture=false \ | |
| aiDeploymentsLocation='${{ env.AZURE_LOCATION }}' \ | |
| gptModelCapacity=150 \ | |
| logAnalyticsWorkspaceConfiguration='{"dataRetentionInDays": 30, "existingWorkspaceResourceId": ""}' \ | |
| applicationInsightsConfiguration='{"retentionInDays": 30}' \ | |
| virtualNetworkConfiguration='{"enabled": false}' \ | |
| webServerFarmConfiguration='{"skuCapacity": 1, "skuName": "B2"}' \ | |
| --output json | |
| - name: Extract Web App and API App URLs | |
| id: get_output | |
| run: | | |
| WEBAPP_NAMES=$(az webapp list --resource-group ${{ env.RESOURCE_GROUP_NAME }} --query "[].name" -o tsv) | |
| for NAME in $WEBAPP_NAMES; do | |
| if [[ $NAME == app-* ]]; then | |
| WEBAPP_URL="https://${NAME}.azurewebsites.net" | |
| echo "WEBAPP_URL=$WEBAPP_URL" >> $GITHUB_OUTPUT | |
| fi | |
| done | |
| - name: Get Container App Backend URL | |
| id: get_backend_url | |
| run: | | |
| CONTAINER_APP_NAME=$(az containerapp list \ | |
| --resource-group ${{ env.RESOURCE_GROUP_NAME }} \ | |
| --query "[0].name" -o tsv) | |
| MACAE_URL_API=$(az containerapp show \ | |
| --name "$CONTAINER_APP_NAME" \ | |
| --resource-group ${{ env.RESOURCE_GROUP_NAME }} \ | |
| --query "properties.configuration.ingress.fqdn" -o tsv) | |
| echo "MACAE_URL_API=https://${MACAE_URL_API}" >> $GITHUB_OUTPUT | |
| echo "CONTAINER_APP=${CONTAINER_APP_NAME}" >> $GITHUB_OUTPUT | |
| - name: Set Deployment Status | |
| id: deployment_status | |
| if: always() | |
| run: | | |
| if [ "${{ job.status }}" == "success" ]; then | |
| echo "SUCCESS=true" >> $GITHUB_OUTPUT | |
| else | |
| echo "SUCCESS=false" >> $GITHUB_OUTPUT | |
| fi | |
| e2e-test: | |
| needs: deploy | |
| if: needs.deploy.outputs.DEPLOYMENT_SUCCESS == 'true' | |
| uses: ./.github/workflows/test-automation.yml | |
| with: | |
| MACAE_WEB_URL: ${{ needs.deploy.outputs.WEBAPP_URL }} | |
| MACAE_URL_API: ${{ needs.deploy.outputs.MACAE_URL_API }} | |
| MACAE_RG: ${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }} | |
| MACAE_CONTAINER_APP: ${{ needs.deploy.outputs.CONTAINER_APP }} | |
| secrets: inherit | |
| cleanup-deployment: | |
| if: always() && needs.deploy.outputs.RESOURCE_GROUP_NAME != '' | |
| needs: [deploy, e2e-test] | |
| runs-on: ubuntu-latest | |
| env: | |
| RESOURCE_GROUP_NAME: ${{ needs.deploy.outputs.RESOURCE_GROUP_NAME }} | |
| steps: | |
| - name: Setup Azure CLI | |
| run: | | |
| curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash | |
| az --version | |
| - name: Login to Azure | |
| run: | | |
| az login --service-principal -u ${{ secrets.AZURE_CLIENT_ID }} -p ${{ secrets.AZURE_CLIENT_SECRET }} --tenant ${{ secrets.AZURE_TENANT_ID }} | |
| az account set --subscription "${{ secrets.AZURE_SUBSCRIPTION_ID }}" | |
| - name: Extract AI Services and Key Vault Names | |
| if: always() | |
| run: | | |
| echo "Fetching AI Services and Key Vault names before deletion..." | |
| # Get Key Vault name | |
| KEYVAULT_NAME=$(az resource list --resource-group "${{ env.RESOURCE_GROUP_NAME }}" --resource-type "Microsoft.KeyVault/vaults" --query "[].name" -o tsv) | |
| echo "Detected Key Vault: $KEYVAULT_NAME" | |
| echo "KEYVAULT_NAME=$KEYVAULT_NAME" >> $GITHUB_ENV | |
| # Extract AI Services names | |
| echo "Fetching AI Services..." | |
| AI_SERVICES=$(az resource list --resource-group '${{ env.RESOURCE_GROUP_NAME }}' --resource-type "Microsoft.CognitiveServices/accounts" --query "[].name" -o tsv) | |
| # Flatten newline-separated values to space-separated | |
| AI_SERVICES=$(echo "$AI_SERVICES" | paste -sd ' ' -) | |
| echo "Detected AI Services: $AI_SERVICES" | |
| echo "AI_SERVICES=$AI_SERVICES" >> $GITHUB_ENV | |
| - name: Get OpenAI Resource from Resource Group | |
| id: get_openai_resource | |
| run: | | |
| set -e | |
| echo "Fetching OpenAI resource from resource group ${{ env.RESOURCE_GROUP_NAME }}..." | |
| # Run the az resource list command to get the OpenAI resource name | |
| openai_resource_name=$(az resource list --resource-group ${{ env.RESOURCE_GROUP_NAME }} --resource-type "Microsoft.CognitiveServices/accounts" --query "[0].name" -o tsv) | |
| if [ -z "$openai_resource_name" ]; then | |
| echo "No OpenAI resource found in resource group ${{ env.RESOURCE_GROUP_NAME }}." | |
| exit 0 | |
| else | |
| echo "OPENAI_RESOURCE_NAME=${openai_resource_name}" >> $GITHUB_ENV | |
| echo "OpenAI resource name: ${openai_resource_name}" | |
| fi | |
| - name: Delete Bicep Deployment | |
| if: always() | |
| run: | | |
| set -e | |
| echo "Checking if resource group exists..." | |
| rg_exists=$(az group exists --name ${{ env.RESOURCE_GROUP_NAME }}) | |
| if [ "$rg_exists" = "true" ]; then | |
| echo "Resource group exist. Cleaning..." | |
| az group delete \ | |
| --name ${{ env.RESOURCE_GROUP_NAME }} \ | |
| --yes \ | |
| --no-wait | |
| echo "Resource group deleted... ${{ env.RESOURCE_GROUP_NAME }}" | |
| else | |
| echo "Resource group does not exists." | |
| fi | |
| - name: Wait for resource deletion to complete | |
| run: | | |
| # Add resources to the array | |
| resources_to_check=("${{ env.OPENAI_RESOURCE_NAME }}") | |
| echo "List of resources to check: ${resources_to_check[@]}" | |
| # Maximum number of retries | |
| max_retries=3 | |
| # Retry intervals in seconds (30, 60, 120) | |
| retry_intervals=(30 60 120) | |
| # Retry mechanism to check resources | |
| retries=0 | |
| while true; do | |
| resource_found=false | |
| # Get the list of resources in YAML format again on each retry | |
| resource_list=$(az resource list --resource-group ${{ env.RESOURCE_GROUP_NAME }} --output yaml) | |
| # Iterate through the resources to check | |
| for resource in "${resources_to_check[@]}"; do | |
| echo "Checking resource: $resource" | |
| if echo "$resource_list" | grep -q "name: $resource"; then | |
| echo "Resource '$resource' exists in the resource group." | |
| resource_found=true | |
| else | |
| echo "Resource '$resource' does not exist in the resource group." | |
| fi | |
| done | |
| # If any resource exists, retry | |
| if [ "$resource_found" = true ]; then | |
| retries=$((retries + 1)) | |
| if [ "$retries" -gt "$max_retries" ]; then | |
| echo "Maximum retry attempts reached. Exiting." | |
| break | |
| else | |
| # Wait for the appropriate interval for the current retry | |
| echo "Waiting for ${retry_intervals[$retries-1]} seconds before retrying..." | |
| sleep ${retry_intervals[$retries-1]} | |
| fi | |
| else | |
| echo "No resources found. Exiting." | |
| break | |
| fi | |
| done | |
| - name: Purging the Resources | |
| if: always() | |
| run: | | |
| set -e | |
| echo "Azure OpenAI: ${{ env.OPENAI_RESOURCE_NAME }}" | |
| # Purge OpenAI Resource | |
| echo "Purging the OpenAI Resource..." | |
| if ! az resource delete --ids /subscriptions/${{ secrets.AZURE_SUBSCRIPTION_ID }}/providers/Microsoft.CognitiveServices/locations/eastus/resourceGroups/${{ env.RESOURCE_GROUP_NAME }}/deletedAccounts/${{ env.OPENAI_RESOURCE_NAME }} --verbose; then | |
| echo "Failed to purge openai resource: ${{ env.OPENAI_RESOURCE_NAME }}" | |
| else | |
| echo "Purged the openai resource: ${{ env.OPENAI_RESOURCE_NAME }}" | |
| fi | |
| echo "Resource purging completed successfully" | |
| - name: Send Notification on Failure | |
| if: failure() | |
| run: | | |
| RUN_URL="https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" | |
| # Construct the email body | |
| EMAIL_BODY=$(cat <<EOF | |
| { | |
| "body": "<p>Dear Team,</p><p>We would like to inform you that the Multi-Agent-Custom-Automation-Engine-Solution-Accelerator Automation process has encountered an issue and has failed to complete successfully.</p><p><strong>Build URL:</strong> ${RUN_URL}<br> ${OUTPUT}</p><p>Please investigate the matter at your earliest convenience.</p><p>Best regards,<br>Your Automation Team</p>" | |
| } | |
| EOF | |
| ) | |
| # Send the notification | |
| curl -X POST "${{ secrets.LOGIC_APP_URL }}" \ | |
| -H "Content-Type: application/json" \ | |
| -d "$EMAIL_BODY" || echo "Failed to send notification" | |
| - name: Logout from Azure | |
| if: always() | |
| run: | | |
| az logout | |
| echo "Logged out from Azure." |