Azure · darshan-patnekar · Nov 10, 2023 · Nov 11, 2023 · Nov 11, 2023 · Nov 11, 2023
diff --git a/cosmos/infra/azuredeploy.json b/cosmos/infra/azuredeploy.json
@@ -4,9 +4,9 @@
     "parameters": {
         "projectName": {
             "type": "string",
-            "defaultValue": "Benchmarking",
+            "defaultValue": "benchmarking",
             "metadata": {
-                "description": "Specifies a name for generating resource names."
+                "description": "Specifies a name for generating resource names. Should be one word, lowercase letters and numbers only."
             }
         },
         "location": {
@@ -68,7 +68,7 @@
         "resultsStorageConnectionString": {
             "type": "string",
             "metadata": {
-                "description": "Specifies a connection string of the storage account where results will be avaialble"
+                "description": "Specifies a connection string of the storage account where results will be available."
             }
         },
         "cosmosURI": {
@@ -155,7 +155,7 @@
             "type": "bool",
             "defaultValue": false,
             "metadata": {
-                "description": "Specifies if the gateway connectivity mode should be used. The default value 'flase' indicates direct connectivity mode"
+                "description": "Specifies if the gateway connectivity mode should be used. The default value 'false' indicates direct connectivity mode"
             }
         },
         "diagnosticsLatencyThresholdInMS": {
@@ -543,7 +543,7 @@
                 "settings": {
                 },
                 "protectedSettings": {
-                    "commandToExecute": "[concat('DB_BINDING_NAME=',parameters('ycsbDatabaseBindingName'),' ','ADMIN_USER_NAME=',parameters('adminUsername'),' ','BENCHMARKING_TOOLS_URL=',variables('benchmarkingToolsURL'),' ','BENCHMARKING_TOOLS_BRANCH_NAME=',parameters('benchmarkingToolsBranchName'),' ','YCSB_GIT_REPO_URL=',variables('ycsbGitHubRepoUrl'),' ','GUID=',parameters('guidValue'),' ','YCSB_GIT_BRANCH_NAME=',parameters('ycsbGitHubBranchName'),' ','TARGET_OPERATIONS_PER_SECOND=',parameters('targetOperationsPerSecond'),' ','THREAD_COUNT=',parameters('threads'),' ','YCSB_OPERATION_COUNT=',parameters('ycsbOperationCount'), ' ','WORKLOAD_TYPE=',parameters('workloadType'),' ','VM_NAME=',variables('vmName'),copyIndex(1), ' ','RESULT_STORAGE_CONNECTION_STRING=','\"',parameters('resultsStorageConnectionString'),'\"',' ','COSMOS_URI=','\"',parameters('cosmosURI'),'\"', ' ','COSMOS_KEY=',parameters('cosmosKey'), ' ','VM_COUNT=',parameters('vmCount'), ' ','USE_GATEWAY=',parameters('useGateway'), ' ','DIAGNOSTICS_LATENCY_THRESHOLD_IN_MS=',parameters('diagnosticsLatencyThresholdInMS'), ' ','YCSB_RECORD_COUNT=',parameters('ycsbRecordCount'), ' ','WRITE_ONLY_OPERATION=',parameters('writeOnlyOperation'), ' ','READ_PROPORTION=',parameters('readproportion'), ' ','SCAN_PROPORTION=',parameters('scanproportion'), ' ','UPDATE_PROPORTION=',parameters('updateproportion'), ' ','INSERT_PROPORTION=',parameters('insertproportion'), ' ','REQUEST_DISTRIBUTION=',parameters('requestdistribution'), ' ','INSERT_ORDER=',parameters('insertorder'), ' ','CUSTOM_SCRIPT_URL=',variables('customScriptUrl'), ' ','MACHINE_INDEX=',copyIndex(1), ' ','INCLUDE_EXCEPTION_STACK=',parameters('includeExceptionStackInLog'), ' ','FIELD_COUNT=',parameters('fieldcount'), ' ','SKIP_LOAD_PHASE=',parameters('skipLoadPhase'), ' ','WAIT_FOR_FAULT_TO_START_IN_SEC=',parameters('waitForFaultToStartInSec'), ' ','DURATION_OF_FAULT_IN_SEC=',parameters('durationOfFaultInSec'), ' ','DROP_PROBABILITY=',parameters('dropProbability'), ' ','FAULT_REGION=','\"',parameters('faultRegion'),'\"',' ','DELAY_IN_MS=',parameters('delayInMs'),' ','USER_AGENT=',parameters('userAgent'),' ','CONSISTENCY_LEVEL=',parameters('consistencyLevel'),' ','PREFERRED_REGION_LIST=','\"',parameters('preferredRegionList'),'\"',' ','APP_INSIGHT_CONN_STR=','\"',parameters('appInsightConnectionString'),'\"',' ','POINT_OPERATION_THRESHOLD_IN_MS=',parameters('pointOperationLatencyThresholdInMS'),' ','NON_POINT_OPERATION_THRESHOLD_IN_MS=',parameters('nonPointOperationLatencyThresholdInMS'),' ','REQUEST_CHARGE_THRESHOLD=',parameters('requestChargeThreshold'),' ','APP_INSIGHT_METRIC_INTERVAL_IN_SECONDS=',parameters('appInsightsMetricIntervalInSeconds'),' ', 'bash ',variables('vmScriptExtensionScriptName'))]",
+                    "commandToExecute": "[concat('DB_BINDING_NAME=',parameters('ycsbDatabaseBindingName'),' ','ADMIN_USER_NAME=',parameters('adminUsername'),' ','PROJECT_NAME=',parameters('projectName'),' ','BENCHMARKING_TOOLS_URL=',variables('benchmarkingToolsURL'),' ','BENCHMARKING_TOOLS_BRANCH_NAME=',parameters('benchmarkingToolsBranchName'),' ','YCSB_GIT_REPO_URL=',variables('ycsbGitHubRepoUrl'),' ','GUID=',parameters('guidValue'),' ','YCSB_GIT_BRANCH_NAME=',parameters('ycsbGitHubBranchName'),' ','TARGET_OPERATIONS_PER_SECOND=',parameters('targetOperationsPerSecond'),' ','THREAD_COUNT=',parameters('threads'),' ','YCSB_OPERATION_COUNT=',parameters('ycsbOperationCount'), ' ','WORKLOAD_TYPE=',parameters('workloadType'),' ','VM_NAME=',variables('vmName'),copyIndex(1), ' ','RESULT_STORAGE_CONNECTION_STRING=','\"',parameters('resultsStorageConnectionString'),'\"',' ','COSMOS_URI=','\"',parameters('cosmosURI'),'\"', ' ','COSMOS_KEY=',parameters('cosmosKey'), ' ','VM_COUNT=',parameters('vmCount'), ' ','USE_GATEWAY=',parameters('useGateway'), ' ','DIAGNOSTICS_LATENCY_THRESHOLD_IN_MS=',parameters('diagnosticsLatencyThresholdInMS'), ' ','YCSB_RECORD_COUNT=',parameters('ycsbRecordCount'), ' ','WRITE_ONLY_OPERATION=',parameters('writeOnlyOperation'), ' ','READ_PROPORTION=',parameters('readproportion'), ' ','SCAN_PROPORTION=',parameters('scanproportion'), ' ','UPDATE_PROPORTION=',parameters('updateproportion'), ' ','INSERT_PROPORTION=',parameters('insertproportion'), ' ','REQUEST_DISTRIBUTION=',parameters('requestdistribution'), ' ','INSERT_ORDER=',parameters('insertorder'), ' ','CUSTOM_SCRIPT_URL=',variables('customScriptUrl'), ' ','MACHINE_INDEX=',copyIndex(1), ' ','INCLUDE_EXCEPTION_STACK=',parameters('includeExceptionStackInLog'), ' ','FIELD_COUNT=',parameters('fieldcount'), ' ','SKIP_LOAD_PHASE=',parameters('skipLoadPhase'), ' ','WAIT_FOR_FAULT_TO_START_IN_SEC=',parameters('waitForFaultToStartInSec'), ' ','DURATION_OF_FAULT_IN_SEC=',parameters('durationOfFaultInSec'), ' ','DROP_PROBABILITY=',parameters('dropProbability'), ' ','FAULT_REGION=','\"',parameters('faultRegion'),'\"',' ','DELAY_IN_MS=',parameters('delayInMs'),' ','USER_AGENT=',parameters('userAgent'),' ','CONSISTENCY_LEVEL=',parameters('consistencyLevel'),' ','PREFERRED_REGION_LIST=','\"',parameters('preferredRegionList'),'\"',' ','APP_INSIGHT_CONN_STR=','\"',parameters('appInsightConnectionString'),'\"',' ','POINT_OPERATION_THRESHOLD_IN_MS=',parameters('pointOperationLatencyThresholdInMS'),' ','NON_POINT_OPERATION_THRESHOLD_IN_MS=',parameters('nonPointOperationLatencyThresholdInMS'),' ','REQUEST_CHARGE_THRESHOLD=',parameters('requestChargeThreshold'),' ','APP_INSIGHT_METRIC_INTERVAL_IN_SECONDS=',parameters('appInsightsMetricIntervalInSeconds'),' ', 'bash ',variables('vmScriptExtensionScriptName'))]",
                     "fileUris": [ "[concat(variables('vmScriptExtensionScriptURL'))]" ]
                 }
             },
@@ -559,4 +559,4 @@
             "value": "The Benchmarking job has been triggered successfully. Please check the storage account you provided for Job Status and Results. The jobs status will be available in a storage table within a few minutes and results will be available once the job finishes."
         }
     }
-}
+}
diff --git a/cosmos/infra/azuredeploy_mongo.json b/cosmos/infra/azuredeploy_mongo.json
@@ -4,9 +4,9 @@
     "parameters": {
         "projectName": {
             "type": "string",
-            "defaultValue": "Benchmarking",
+            "defaultValue": "benchmarking",
             "metadata": {
-                "description": "Specifies a name for generating resource names."
+                "description": "Specifies a name for generating resource names. Should be one word, lowercase letters and numbers only."
             }
         },
         "location": {

diff --git a/cosmos/mongoapi/tools/java/ycsb/recipes/read/10-thousand-rps-read/azuredeploy.json b/cosmos/mongoapi/tools/java/ycsb/recipes/read/10-thousand-rps-read/azuredeploy.json
@@ -4,9 +4,9 @@
     "parameters": {
         "projectName": {
             "type": "string",
-            "defaultValue": "Benchmarking",
+            "defaultValue": "benchmarking",
             "metadata": {
-                "description": "Specifies a name for generating resource names."
+                "description": "Specifies a name for generating resource names. Should be one word, lowercase letters and numbers only."
             }
         },
         "location": {

diff --git a/cosmos/mongoapi/tools/java/ycsb/recipes/read/20-thousand-rps-read/azuredeploy.json b/cosmos/mongoapi/tools/java/ycsb/recipes/read/20-thousand-rps-read/azuredeploy.json
@@ -4,9 +4,9 @@
     "parameters": {
         "projectName": {
             "type": "string",
-            "defaultValue": "Benchmarking",
+            "defaultValue": "benchmarking",
             "metadata": {
-                "description": "Specifies a name for generating resource names."
+                "description": "Specifies a name for generating resource names. Should be one word, lowercase letters and numbers only."
             }
         },
         "location": {

diff --git a/cosmos/mongoapi/tools/java/ycsb/recipes/read/30-thousand-rps-read/azuredeploy.json b/cosmos/mongoapi/tools/java/ycsb/recipes/read/30-thousand-rps-read/azuredeploy.json
@@ -4,9 +4,9 @@
     "parameters": {
         "projectName": {
             "type": "string",
-            "defaultValue": "Benchmarking",
+            "defaultValue": "benchmarking",
             "metadata": {
-                "description": "Specifies a name for generating resource names."
+                "description": "Specifies a name for generating resource names. Should be one word, lowercase letters and numbers only."
             }
         },
         "location": {

diff --git a/cosmos/mongoapi/tools/java/ycsb/recipes/read/5-thousand-rps-read/azuredeploy.json b/cosmos/mongoapi/tools/java/ycsb/recipes/read/5-thousand-rps-read/azuredeploy.json
@@ -4,9 +4,9 @@
     "parameters": {
         "projectName": {
             "type": "string",
-            "defaultValue": "Benchmarking",
+            "defaultValue": "benchmarking",
             "metadata": {
-                "description": "Specifies a name for generating resource names."
+                "description": "Specifies a name for generating resource names. Should be one word, lowercase letters and numbers only."
             }
         },
         "location": {

diff --git a/cosmos/mongoapi/tools/java/ycsb/recipes/read/try-it-read/azuredeploy.json b/cosmos/mongoapi/tools/java/ycsb/recipes/read/try-it-read/azuredeploy.json
@@ -4,9 +4,9 @@
     "parameters": {
         "projectName": {
             "type": "string",
-            "defaultValue": "Benchmarking",
+            "defaultValue": "benchmarking",
             "metadata": {
-                "description": "Specifies a name for generating resource names."
+                "description": "Specifies a name for generating resource names. Should be one word, lowercase letters and numbers only."
             }
         },
         "location": {

diff --git a/cosmos/mongoapi/tools/java/ycsb/recipes/update/10-thousand-rps-update/azuredeploy.json b/cosmos/mongoapi/tools/java/ycsb/recipes/update/10-thousand-rps-update/azuredeploy.json
@@ -4,9 +4,9 @@
     "parameters": {
         "projectName": {
             "type": "string",
-            "defaultValue": "Benchmarking",
+            "defaultValue": "benchmarking",
             "metadata": {
-                "description": "Specifies a name for generating resource names."
+                "description": "Specifies a name for generating resource names. Should be one word, lowercase letters and numbers only."
             }
         },
         "location": {

diff --git a/cosmos/mongoapi/tools/java/ycsb/recipes/update/20-thousand-rps-update/azuredeploy.json b/cosmos/mongoapi/tools/java/ycsb/recipes/update/20-thousand-rps-update/azuredeploy.json
@@ -4,9 +4,9 @@
     "parameters": {
         "projectName": {
             "type": "string",
-            "defaultValue": "Benchmarking",
+            "defaultValue": "benchmarking",
             "metadata": {
-                "description": "Specifies a name for generating resource names."
+                "description": "Specifies a name for generating resource names. Should be one word, lowercase letters and numbers only."
             }
         },
         "location": {

diff --git a/cosmos/mongoapi/tools/java/ycsb/recipes/update/30-thousand-rps-update/azuredeploy.json b/cosmos/mongoapi/tools/java/ycsb/recipes/update/30-thousand-rps-update/azuredeploy.json
@@ -4,9 +4,9 @@
     "parameters": {
         "projectName": {
             "type": "string",
-            "defaultValue": "Benchmarking",
+            "defaultValue": "benchmarking",
             "metadata": {
-                "description": "Specifies a name for generating resource names."
+                "description": "Specifies a name for generating resource names. Should be one word, lowercase letters and numbers only."
             }
         },
         "location": {

diff --git a/cosmos/mongoapi/tools/java/ycsb/recipes/update/5-thousand-rps-update/azuredeploy.json b/cosmos/mongoapi/tools/java/ycsb/recipes/update/5-thousand-rps-update/azuredeploy.json
@@ -4,9 +4,9 @@
     "parameters": {
         "projectName": {
             "type": "string",
-            "defaultValue": "Benchmarking",
+            "defaultValue": "benchmarking",
             "metadata": {
-                "description": "Specifies a name for generating resource names."
+                "description": "Specifies a name for generating resource names. Should be one word, lowercase letters and numbers only."
             }
         },
         "location": {

diff --git a/cosmos/mongoapi/tools/java/ycsb/recipes/write/10-thousand-rps-write/azuredeploy.json b/cosmos/mongoapi/tools/java/ycsb/recipes/write/10-thousand-rps-write/azuredeploy.json
@@ -4,9 +4,9 @@
     "parameters": {
         "projectName": {
             "type": "string",
-            "defaultValue": "Benchmarking",
+            "defaultValue": "benchmarking",
             "metadata": {
-                "description": "Specifies a name for generating resource names."
+                "description": "Specifies a name for generating resource names. Should be one word, lowercase letters and numbers only."
             }
         },
         "location": {

diff --git a/cosmos/mongoapi/tools/java/ycsb/recipes/write/20-thousand-rps-write/azuredeploy.json b/cosmos/mongoapi/tools/java/ycsb/recipes/write/20-thousand-rps-write/azuredeploy.json
@@ -4,9 +4,9 @@
     "parameters": {
         "projectName": {
             "type": "string",
-            "defaultValue": "Benchmarking",
+            "defaultValue": "benchmarking",
             "metadata": {
-                "description": "Specifies a name for generating resource names."
+                "description": "Specifies a name for generating resource names. Should be one word, lowercase letters and numbers only."
             }
         },
         "location": {

diff --git a/cosmos/mongoapi/tools/java/ycsb/recipes/write/30-thousand-rps-write/azuredeploy.json b/cosmos/mongoapi/tools/java/ycsb/recipes/write/30-thousand-rps-write/azuredeploy.json
@@ -4,9 +4,9 @@
     "parameters": {
         "projectName": {
             "type": "string",
-            "defaultValue": "Benchmarking",
+            "defaultValue": "benchmarking",
             "metadata": {
-                "description": "Specifies a name for generating resource names."
+                "description": "Specifies a name for generating resource names. Should be one word, lowercase letters and numbers only."
             }
         },
         "location": {

diff --git a/cosmos/mongoapi/tools/java/ycsb/recipes/write/5-thousand-rps-write/azuredeploy.json b/cosmos/mongoapi/tools/java/ycsb/recipes/write/5-thousand-rps-write/azuredeploy.json
@@ -4,9 +4,9 @@
     "parameters": {
         "projectName": {
             "type": "string",
-            "defaultValue": "Benchmarking",
+            "defaultValue": "benchmarking",
             "metadata": {
-                "description": "Specifies a name for generating resource names."
+                "description": "Specifies a name for generating resource names. Should be one word, lowercase letters and numbers only."
             }
         },
         "location": {

diff --git a/cosmos/scripts/chaos/chaos_script.ps1 b/cosmos/scripts/chaos/chaos_script.ps1
@@ -1,3 +1,31 @@
+<#
+.SYNOPSIS
+This script introduces network faults into a Cosmos DB environment for testing purposes.
+.DESCRIPTION
+The script takes several parameters to configure the fault injection, including the endpoint, master key, database ID, container ID, duration of fault, drop percentage, delay in milliseconds, fault region, and wait time for fault to start. It then uses these parameters to introduce network faults using the Clumsy utility.
+.PARAMETER endpoint
+The endpoint for the Cosmos DB instance.
+.PARAMETER masterKey
+The master key for the Cosmos DB instance.
+.PARAMETER databaseId
+The ID of the database in the Cosmos DB instance.
+.PARAMETER containerId
+The ID of the container in the database.
+.PARAMETER durationOfFaultInSec
+The duration of the network fault in seconds.
+.PARAMETER dropPercentage
+The percentage of packets to drop (optional).
+.PARAMETER delayInMs
+The delay to introduce in milliseconds (optional).
+.PARAMETER faultRegion
+The region where the fault should be introduced.
+.PARAMETER waitForFaultToStartInSec
+The time to wait before starting the fault in seconds (optional).
+.EXAMPLE
+.\chaos_script.ps1 -endpoint "https://my-cosmos-db.documents.azure.com:443/" -masterKey "my-master-key" -databaseId "my-database" -containerId "my-container" -durationOfFaultInSec 60 -dropPercentage 50 -delayInMs 200 -faultRegion "West US" -waitForFaultToStartInSec 10
+This example introduces a network fault that drops 50% of packets and introduces a 200ms delay for 60 seconds in the "West US" region of the specified Cosmos DB instance. It waits 10 seconds before starting the fault.
+#>
+
 param (
     [parameter(Mandatory = $true)]
     [ValidateNotNull()]
@@ -40,9 +68,9 @@ if ($waitForFaultToStartInSec)
 }
 
 Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
-choco install chocolatey-compatibility.extension
-choco install clumsy  -y
-#choco uninstall clumsy
+choco install chocolatey-compatibility.extension -y --force
+choco install clumsy -y --force
+Write-Host "To remove WinDivertXX.sys, please remove/uninstall all WinDivert client application(s) and reboot." -ForegroundColor Cyan
 
 $databaseAccountResponseJson = & .\GetDatabaseAccount.ps1 -Endpoint $endpoint -MasterKey $masterKey
 $databaseAccountResponseObject = $databaseAccountResponseJson | ConvertFrom-Json
@@ -141,4 +169,8 @@ if ($durationOfFaultInSec)
 }
 
 # Clearing the fault
-Stop-Process -Name clumsy
+Stop-Process -Name clumsy
+
+# Uninstall Clumsy
+choco uninstall clumsy -y
+Write-Host "To remove WinDivertXX.sys, please remove/uninstall all WinDivert client application(s) and reboot." -ForegroundColor Cyan
diff --git a/cosmos/scripts/chaos/chaos_script.sh b/cosmos/scripts/chaos/chaos_script.sh
@@ -31,6 +31,61 @@ install_powershell() {
   pwsh
 }
 
+while getopts "e:m:d:c:w:t:r:p:l:" opt;
+do
+    case "$opt" in
+    e)  endpoint=$OPTARG;;
+    m)  masterkey=$OPTARG;;
+    d)  databaseid=$OPTARG;;
+    c)  containerid=$OPTARG;;
+    w)  wait_for_fault_to_start_in_sec=$OPTARG;;
+    t)  duration_of_fault_in_sec=$OPTARG;;
+    r)  fault_region=$OPTARG;;
+    p)  drop_probability=$OPTARG;;
+    l)  delay_in_ms=$OPTARG;;
+    esac
+done
+
+usage(){
+  echo "Usage: ./chaos_script.sh -e <endpoint> -d <databaseid> -c <containerid> -w <wait_for_fault_to_start_in_sec> -t <duration_of_fault_in_sec> -r <fault_region> -p <drop_probability> -l <delay_in_ms>"
+}
+
+if [ -z "$endpoint" ]; then
+  echo "The endpoint for the Cosmos DB instance is not set. Please pass it with -e option."
+  usage
+  exit 1
+fi
+
+if [ -z "$masterkey" ]; then
+  echo "The masterkey for the Cosmos DB instance is not set. Please pass it with -m option."
+  usage
+  exit 1
+fi
+
+if [ -z "$databaseid" ]; then
+  echo "The databaseid for the Cosmos DB instance is not set. Please pass it with -d option."
+  usage
+  exit 1
+fi
+
+if [ -z "$containerid" ]; then
+  echo "The containerid for the Cosmos DB instance is not set. Please pass it with -c option."
+  usage
+  exit 1
+fi
+
+if [ -z "$duration_of_fault_in_sec" ]; then
+  echo "The duration_of_fault_in_sec is not set. Please pass it with -t option."
+  usage
+  exit 1
+fi
+
+if [ -z "$fault_region" ]; then
+  echo "The fault_region is not set. Please pass it with -r option."
+  usage
+  exit 1
+fi
+
 if ! command -v pwsh &>/dev/null; then
   install_powershell
 fi