Merge pull request #331 from microsoft/psl-quota-script-update

Roopan-Microsoft · web-flow · commit 1b8775a9d1c1 · 2025-03-31T22:13:19.000+05:30
fix: Psl quota script update
diff --git a/docs/images/quota-check-output.png b/docs/images/quota-check-output.png
diff --git a/docs/quota_check.md b/docs/quota_check.md
@@ -1,57 +1,84 @@
 ## Check Quota Availability Before Deployment
 
-Before deploying the accelerator, **ensure sufficient quota availability** for the required model.  
-Use one of the following scripts based on your needs:  
+Before deploying the accelerator, **ensure sufficient quota availability** for the required model.  \
 
-- **`quota_check_params.sh`** → If you **know the model and capacity** required.  
-- **`quota_check_all_regions.sh`** → If you **want to check available capacity across all regions** for supported models.  
+### 📌 Default Models & Capacities:
+```
+gpt-4o:30, text-embedding-ada-002:80, gpt-4:30
+```
+### 📌 Default Regions:
+```
+eastus, uksouth, eastus2, northcentralus, swedencentral, westus, westus2, southcentralus, canadacentral
+```
+### Usage Scenarios:
+- No parameters passed → Default models and capacities will be checked in default regions.
+- Only model(s) provided → The script will check for those models in the default regions.
+- Only region(s) provided → The script will check default models in the specified regions.
+- Both models and regions provided → The script will check those models in the specified regions.
+  
+### **Input Formats**
+✔️ Run without parameters to check default models & regions:
+   ```
+  ./quota_check_params.sh
+   ```
+✔️ Model name and required capacity in the format:
+  ```
+  ./quota_check_params.sh gpt-4o:30
+  ```
+✔️ Multiple models can be passed, separated by commas:
+  ```
+  ./quota_check_params.sh gpt-4o:30,text-embedding-ada-002:80
+  ```
+✔️ Passing Both models and regions:  
+  ```
+  ./quota_check_params.sh gpt-4o:30 eastus,westus2
+  ```
+✔️ Check default models in specific regions:
+  ```
+  ./quota_check_params.sh "" eastus,westus2
+  ```
+
+### **Sample Output**
+The final table lists regions with available quota. You can select any of these regions for deployment.
+
+![quota-check-ouput](images/quota-check-output.png)
 
 ---
-## **If using Azure Portal and Cloud Shell**
+### **If using Azure Portal and Cloud Shell**
 
 1. Navigate to the [Azure Portal](https://portal.azure.com).
 2. Click on **Azure Cloud Shell** in the top right navigation menu.
 3. Run the appropriate command based on your requirement:  
 
-   **To check quota for a specific model and capacity:**  
+   **To check quota for the deployment**  
 
     ```sh
     curl -L -o quota_check_params.sh "https://raw.githubusercontent.com/microsoft/document-generation-solution-accelerator/main/scripts/quota_check_params.sh"
     chmod +x quota_check_params.sh
-    ./quota_check_params.sh <model_name:capacity> [<model_region>] (e.g., gpt-4o-mini:30,text-embedding-ada-002:20 eastus)
+    ./quota_check_params.sh
     ```
-
-   **To check available quota across all regions for supported models:**  
-
-    ```sh
-    curl -L -o quota_check_all_regions.sh "https://raw.githubusercontent.com/microsoft/document-generation-solution-accelerator/main/scripts/quota_check_all_regions.sh"
-    chmod +x quota_check_all_regions.sh
-    ./quota_check_all_regions.sh
+    - Refer to [Input Formats](#input-formats) for detailed commands.
+      
+### **If using VS Code or Codespaces**
+1. Open the terminal in VS Code or Codespaces.  
+2. Navigate to the `scripts` folder where the script files are located and make the script as executable:
+   ```sh
+    cd scripts
+    chmod +x quota_check_params.sh
     ```
-    
-## **If using VS Code or Codespaces**
-
-1. Run the appropriate script based on your requirement:  
+3. Run the appropriate script based on your requirement:  
 
-   **To check quota for a specific model and capacity:**  
+   **To check quota for the deployment**  
 
     ```sh
-    ./quota_check_params.sh <model_name:capacity> [<model_region>] (e.g., gpt-4o-mini:30,text-embedding-ada-002:20 eastus)
+    ./quota_check_params.sh
     ```
+   - Refer to [Input Formats](#input-formats) for detailed commands.
 
-   **To check available quota across all regions for supported models:**  
-
-    ```sh
-    ./quota_check_all_regions.sh
-    ```
-2. If you see the error `_bash: az: command not found_`, install Azure CLI:  
+4. If you see the error `_bash: az: command not found_`, install Azure CLI:  
 
     ```sh
     curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
     az login
     ```
-3. Rerun the script after installing Azure CLI.
-   
-    **Parameters**
-    - `<model_name:capacity>`: The name and required capacity for each model, in the format model_name:capacity (**e.g., gpt-4o-mini:30,text-embedding-ada-002:20**).
-    - `[<model_region>] (optional)`: The Azure region to check first. If not provided, all supported regions will be checked (**e.g., eastus**).
+5. Rerun the script after installing Azure CLI.
diff --git a/scripts/quota_check_params.sh b/scripts/quota_check_params.sh
@@ -1,159 +1,163 @@
 #!/bin/bash
 
-# Parameters
-IFS=',' read -r -a MODEL_CAPACITY_PAIRS <<< "$1"  # Split the comma-separated model and capacity pairs into an array
+# Default Models and Capacities (Comma-separated in "model:capacity" format)
+DEFAULT_MODEL_CAPACITY="gpt-4o:30,text-embedding-ada-002:80,gpt-4:30"
+
+# Convert the comma-separated string into an array
+IFS=',' read -r -a MODEL_CAPACITY_PAIRS <<< "$DEFAULT_MODEL_CAPACITY"
+
+# Default Regions to check (Comma-separated, now configurable)
+DEFAULT_REGIONS="eastus,uksouth,eastus2,northcentralus,swedencentral,westus,westus2,southcentralus,canadacentral"
+IFS=',' read -r -a DEFAULT_REGION_ARRAY <<< "$DEFAULT_REGIONS"
+
+# Read parameters (if any)
+IFS=',' read -r -a USER_PROVIDED_PAIRS <<< "$1"
 USER_REGION="$2"
 
-if [ ${#MODEL_CAPACITY_PAIRS[@]} -lt 1 ]; then
-    echo "❌ ERROR: At least one model and capacity pairs must be provided as arguments."
-    exit 1
+IS_USER_PROVIDED_PAIRS=false
+
+if [ ${#USER_PROVIDED_PAIRS[@]} -lt 1 ]; then
+    echo "No parameters provided, using default model-capacity pairs: ${MODEL_CAPACITY_PAIRS[*]}"
+else
+    echo "Using provided model and capacity pairs: ${USER_PROVIDED_PAIRS[*]}"
+    IS_USER_PROVIDED_PAIRS=true
+    MODEL_CAPACITY_PAIRS=("${USER_PROVIDED_PAIRS[@]}")
 fi
 
-# Extract model names and required capacities into arrays
-declare -a MODEL_NAMES
-declare -a CAPACITIES
+declare -a FINAL_MODEL_NAMES
+declare -a FINAL_CAPACITIES
+declare -a TABLE_ROWS
 
 for PAIR in "${MODEL_CAPACITY_PAIRS[@]}"; do
-    MODEL_NAME=$(echo "$PAIR" | cut -d':' -f1)
+    MODEL_NAME=$(echo "$PAIR" | cut -d':' -f1 | tr '[:upper:]' '[:lower:]')
     CAPACITY=$(echo "$PAIR" | cut -d':' -f2)
 
     if [ -z "$MODEL_NAME" ] || [ -z "$CAPACITY" ]; then
         echo "❌ ERROR: Invalid model and capacity pair '$PAIR'. Both model and capacity must be specified."
         exit 1
     fi
 
-    MODEL_NAMES+=("$MODEL_NAME")
-    CAPACITIES+=("$CAPACITY")
-done
-
-echo "🔄 Using Models: ${MODEL_NAMES[*]} with respective Capacities: ${CAPACITIES[*]}"
+    FINAL_MODEL_NAMES+=("$MODEL_NAME")
+    FINAL_CAPACITIES+=("$CAPACITY")
 
-echo "🔄 Fetching available Azure subscriptions..."
-SUBSCRIPTIONS=$(az account list --query "[?state=='Enabled'].{Name:name, ID:id}" --output tsv)
-SUB_COUNT=$(echo "$SUBSCRIPTIONS" | wc -l)
-
-if [ "$SUB_COUNT" -eq 1 ]; then
-    # If only one subscription, automatically select it
-    AZURE_SUBSCRIPTION_ID=$(echo "$SUBSCRIPTIONS" | awk '{print $2}')
-    echo "✅ Using the only available subscription: $AZURE_SUBSCRIPTION_ID"
-else
-    # If multiple subscriptions exist, prompt the user to choose one
-    echo "Multiple subscriptions found:"
-    echo "$SUBSCRIPTIONS" | awk '{print NR")", $1, "-", $2}'
-
-    while true; do
-        echo "Enter the number of the subscription to use:"
-        read SUB_INDEX
-
-        # Validate user input
-        if [[ "$SUB_INDEX" =~ ^[0-9]+$ ]] && [ "$SUB_INDEX" -ge 1 ] && [ "$SUB_INDEX" -le "$SUB_COUNT" ]; then
-            AZURE_SUBSCRIPTION_ID=$(echo "$SUBSCRIPTIONS" | awk -v idx="$SUB_INDEX" 'NR==idx {print $2}')
-            echo "✅ Selected Subscription: $AZURE_SUBSCRIPTION_ID"
-            break
-        else
-            echo "❌ Invalid selection. Please enter a valid number from the list."
-        fi
-    done
-fi
-
-# Set the selected subscription
-az account set --subscription "$AZURE_SUBSCRIPTION_ID"
-echo "🎯 Active Subscription: $(az account show --query '[name, id]' --output table)"
+done
 
-# List of regions to check
-DEFAULT_REGIONS=("eastus" "uksouth" "eastus2" "northcentralus" "swedencentral" "westus" "westus2" "southcentralus" "canadacentral")
+echo "🔄 Using Models: ${FINAL_MODEL_NAMES[*]} with respective Capacities: ${FINAL_CAPACITIES[*]}"
+echo "----------------------------------------"
 
-# Prioritize user-provided region if given
+# Check if the user provided a region, if not, use the default regions
 if [ -n "$USER_REGION" ]; then
-    # Ensure the user-provided region is checked first
-    REGIONS=("$USER_REGION" "${DEFAULT_REGIONS[@]}")
+    echo "🔍 User provided region: $USER_REGION"
+    IFS=',' read -r -a REGIONS <<< "$USER_REGION"
 else
-    REGIONS=("${DEFAULT_REGIONS[@]}")
+    echo "No region specified, using default regions: ${DEFAULT_REGION_ARRAY[*]}"
+    REGIONS=("${DEFAULT_REGION_ARRAY[@]}")
+    APPLY_OR_CONDITION=true
 fi
 
 echo "✅ Retrieved Azure regions. Checking availability..."
+INDEX=1
 
 VALID_REGIONS=()
 for REGION in "${REGIONS[@]}"; do
     echo "----------------------------------------"
     echo "🔍 Checking region: $REGION"
 
-    # Fetch quota information for the region
-    QUOTA_INFO=$(az cognitiveservices usage list --location "$REGION" --output json)
+    QUOTA_INFO=$(az cognitiveservices usage list --location "$REGION" --output json | tr '[:upper:]' '[:lower:]')
     if [ -z "$QUOTA_INFO" ]; then
         echo "⚠️ WARNING: Failed to retrieve quota for region $REGION. Skipping."
         continue
     fi
 
-    # Initialize a flag to track if both models have sufficient quota in the region
-    BOTH_MODELS_AVAILABLE=true
-
-    for index in "${!MODEL_NAMES[@]}"; do
-        MODEL_NAME="${MODEL_NAMES[$index]}"
-        REQUIRED_CAPACITY="${CAPACITIES[$index]}"
-        
-        echo "🔍 Checking model: $MODEL_NAME with required capacity: $REQUIRED_CAPACITY"
-
-        # Extract model quota information
-        MODEL_INFO=$(echo "$QUOTA_INFO" | awk -v model="\"value\": \"OpenAI.Standard.$MODEL_NAME\"" '
-            BEGIN { RS="},"; FS="," }
-            $0 ~ model { print $0 }
-        ')
-
-        if [ -z "$MODEL_INFO" ]; then
-            echo "⚠️ WARNING: No quota information found for model: OpenAI.Standard.$MODEL_NAME in $REGION. Skipping."
-            BOTH_MODELS_AVAILABLE=false
-            break  # If any model is not available, no need to check further for this region
-        fi
-
-        CURRENT_VALUE=$(echo "$MODEL_INFO" | awk -F': ' '/"currentValue"/ {print $2}' | tr -d ',' | tr -d ' ')
-        LIMIT=$(echo "$MODEL_INFO" | awk -F': ' '/"limit"/ {print $2}' | tr -d ',' | tr -d ' ')
+    TEXT_EMBEDDING_AVAILABLE=false
+    AT_LEAST_ONE_MODEL_AVAILABLE=false
+    TEMP_TABLE_ROWS=()
 
-        CURRENT_VALUE=${CURRENT_VALUE:-0}
-        LIMIT=${LIMIT:-0}
+    for index in "${!FINAL_MODEL_NAMES[@]}"; do
+        MODEL_NAME="${FINAL_MODEL_NAMES[$index]}"
+        REQUIRED_CAPACITY="${FINAL_CAPACITIES[$index]}"
+        FOUND=false
+        INSUFFICIENT_QUOTA=false
 
-        CURRENT_VALUE=$(echo "$CURRENT_VALUE" | cut -d'.' -f1)
-        LIMIT=$(echo "$LIMIT" | cut -d'.' -f1)
-
-        AVAILABLE=$((LIMIT - CURRENT_VALUE))
-
-        echo "✅ Model: OpenAI.Standard.$MODEL_NAME | Used: $CURRENT_VALUE | Limit: $LIMIT | Available: $AVAILABLE"
-
-        # Check if quota is sufficient
-        if [ "$AVAILABLE" -lt "$REQUIRED_CAPACITY" ]; then
-            echo "❌ ERROR: 'OpenAI.Standard.$MODEL_NAME' in $REGION has insufficient quota. Required: $REQUIRED_CAPACITY, Available: $AVAILABLE"
-            echo "➡️  To request a quota increase, visit: https://aka.ms/oai/stuquotarequest"
-            BOTH_MODELS_AVAILABLE=false
-            break
+        if [ "$MODEL_NAME" = "text-embedding-ada-002" ]; then
+            MODEL_TYPES=("openai.standard.$MODEL_NAME")
+        else
+            MODEL_TYPES=("openai.standard.$MODEL_NAME" "openai.globalstandard.$MODEL_NAME")
         fi
+
+        for MODEL_TYPE in "${MODEL_TYPES[@]}"; do
+            FOUND=false
+            INSUFFICIENT_QUOTA=false
+            echo "🔍 Checking model: $MODEL_NAME with required capacity: $REQUIRED_CAPACITY ($MODEL_TYPE)"
+
+            MODEL_INFO=$(echo "$QUOTA_INFO" | awk -v model="\"value\": \"$MODEL_TYPE\"" '
+                BEGIN { RS="},"; FS="," }
+                $0 ~ model { print $0 }
+            ')
+
+            if [ -z "$MODEL_INFO" ]; then
+                FOUND=false
+                echo "⚠️ WARNING: No quota information found for model: $MODEL_NAME in region: $REGION for model type: $MODEL_TYPE."
+                continue
+            fi
+
+            if [ -n "$MODEL_INFO" ]; then
+                FOUND=true
+                CURRENT_VALUE=$(echo "$MODEL_INFO" | awk -F': ' '/"currentvalue"/ {print $2}' | tr -d ',' | tr -d ' ')
+                LIMIT=$(echo "$MODEL_INFO" | awk -F': ' '/"limit"/ {print $2}' | tr -d ',' | tr -d ' ')
+
+                CURRENT_VALUE=${CURRENT_VALUE:-0}
+                LIMIT=${LIMIT:-0}
+
+                CURRENT_VALUE=$(echo "$CURRENT_VALUE" | cut -d'.' -f1)
+                LIMIT=$(echo "$LIMIT" | cut -d'.' -f1)
+
+                AVAILABLE=$((LIMIT - CURRENT_VALUE))
+                echo "✅ Model: $MODEL_TYPE | Used: $CURRENT_VALUE | Limit: $LIMIT | Available: $AVAILABLE"
+
+                if [ "$AVAILABLE" -ge "$REQUIRED_CAPACITY" ]; then
+                    FOUND=true
+                    if [ "$MODEL_NAME" = "text-embedding-ada-002" ]; then
+                        TEXT_EMBEDDING_AVAILABLE=true
+                    fi
+                    AT_LEAST_ONE_MODEL_AVAILABLE=true
+                    TEMP_TABLE_ROWS+=("$(printf "| %-4s | %-20s | %-60s | %-10s | %-10s | %-10s |" "$INDEX" "$REGION" "$MODEL_TYPE" "$LIMIT" "$CURRENT_VALUE" "$AVAILABLE")")
+                else
+                    INSUFFICIENT_QUOTA=true
+                fi
+            fi
+            
+            if [ "$FOUND" = false ]; then
+                echo "❌ No models found for model: $MODEL_NAME in region: $REGION (${MODEL_TYPES[*]})"
+            elif [ "$INSUFFICIENT_QUOTA" = true ]; then
+                echo "⚠️ Model $MODEL_NAME in region: $REGION has insufficient quota (${MODEL_TYPES[*]})."
+            fi
+        done
     done
 
-    # If both models have sufficient quota, add region to valid regions
-    if [ "$BOTH_MODELS_AVAILABLE" = true ]; then
-        echo "✅ All models have sufficient quota in $REGION."
+if { [ "$IS_USER_PROVIDED_PAIRS" = true ] && [ "$INSUFFICIENT_QUOTA" = false ] && [ "$FOUND" = true ]; } || { [ "$TEXT_EMBEDDING_AVAILABLE" = true ] && { [ "$APPLY_OR_CONDITION" != true ] || [ "$AT_LEAST_ONE_MODEL_AVAILABLE" = true ]; }; }; then
         VALID_REGIONS+=("$REGION")
+        TABLE_ROWS+=("${TEMP_TABLE_ROWS[@]}")
+        INDEX=$((INDEX + 1))
+    elif [ ${#USER_PROVIDED_PAIRS[@]} -eq 0 ]; then
+        echo "🚫 Skipping $REGION as it does not meet quota requirements."
     fi
+
 done
 
-# Determine final result and display in table format
-if [ ${#VALID_REGIONS[@]} -eq 0 ]; then
-    echo "----------------------------------------"
-    echo "❌ No region with sufficient quota found for all models. Blocking deployment."
-    echo "----------------------------------------"
-    exit 0
+if [ ${#TABLE_ROWS[@]} -eq 0 ]; then
+    echo "----------------------------------------------------------------------------------------------------------"
+
+    echo "❌ No regions have sufficient quota for all required models. Please request a quota increase: https://aka.ms/oai/stuquotarequest"
 else
-    echo "----------------------------------------"
-    echo "✅ Suggested Regions with Sufficient Quota"
-    echo "----------------------------------------"
-    printf "| %-5s | %-20s |\n" "No." "Region"
-    echo "----------------------------------------"
-    
-    INDEX=1
-    for REGION in "${VALID_REGIONS[@]}"; do
-        printf "| %-5s | %-20s |\n" "$INDEX" "$REGION"
-        INDEX=$((INDEX + 1))
+    echo "----------------------------------------------------------------------------------------------------------"
+    printf "| %-4s | %-20s | %-60s | %-10s | %-10s | %-10s |\n" "No." "Region" "Model Name" "Limit" "Used" "Available"
+    echo "----------------------------------------------------------------------------------------------------------"
+    for ROW in "${TABLE_ROWS[@]}"; do
+        echo "$ROW"
     done
-    
-    echo "----------------------------------------"
-    exit 0
+    echo "----------------------------------------------------------------------------------------------------------"
+    echo "➡️  To request a quota increase, visit: https://aka.ms/oai/stuquotarequest"
 fi
+
+echo "✅ Script completed."
