Skip to content

Variable Reference ​

All load testing tools read from a single central configuration file: config/variables.yml. This file is the single source of truth — cluster details, credentials, testing defaults, and monitoring settings are all declared here and consumed by every automation tool.

TIP

Getting started Copy the example and fill in your values:

powershell
cp config/variables.example.yml config/variables.yml

Never commit variables.yml — it is excluded by .gitignore because it contains environment-specific values and Key Vault references.

!!! info "Additional configs" Detailed configs live in subdirectories under config/:

- `config/clusters/` — Per-cluster connection details
- `config/credentials/` — Key Vault credential mappings
- `config/profiles/` — Workload profiles (vmfleet, fio, iperf, etc.)
- `config/variables/` — Master variable registry and solution schemas

Naming Rules ​

ScopeConventionExample
Top-level sectionssnake_caseazure_local, credentials
Keys within sectionssnake_casesubscription_id, default_tool
BooleansDescriptive nameenable_real_time: true
Secretskeyvault:// URIkeyvault://kv-name/secret-name

Azure ​

yaml
azure:
  subscription_id: "00000000-0000-0000-0000-000000000000"
  tenant_id: "00000000-0000-0000-0000-000000000000"
  resource_group: "rg-loadtools-eus-01"
  location: "eastus"
VariableTypeRequiredDescriptionDefault
azure.subscription_idstringYesAzure subscription ID—
azure.tenant_idstringYesAzure AD tenant ID—
azure.resource_groupstringYesResource group for load testing resources—
azure.locationstringYesAzure regioneastus

Key Vault ​

yaml
keyvault:
  name: "kv-iic-loadtools"
  auth_method: "az_cli"
VariableTypeRequiredDescriptionDefault
keyvault.namestringYesKey Vault name for all keyvault:// URI resolution—
keyvault.auth_methodstringNoAuth method: managed_identity, service_principal, or az_cliaz_cli

Azure Local Cluster ​

yaml
azure_local:
  cluster_name: "azl-cluster-01"
  cluster_domain: "contoso.local"
  nodes:
    - name: "azl-node-01"
      management_ip: "10.0.0.1"
      storage_ip: "10.0.1.1"
VariableTypeRequiredDescriptionDefault
azure_local.cluster_namestringYesAzure Local cluster name—
azure_local.cluster_domainstringYesActive Directory domain for the cluster—
azure_local.nodeslistYesCluster nodes with name, management_ip, and storage_ip—

Storage ​

yaml
storage:
  csv_path: "C:\\ClusterStorage\\Volume1"
  collect_volume_path: "C:\\ClusterStorage\\Collect"
  base_vhd_path: "C:\\ClusterStorage\\Collect\\BaseImage.vhdx"
VariableTypeRequiredDescriptionDefault
storage.csv_pathstringYesCluster Shared Volume path for VM storage—
storage.collect_volume_pathstringNoVMFleet Collect volume path (ReFS, 200 GB+)—
storage.base_vhd_pathstringNoWindows Server Core base VHDX path—

Networking ​

yaml
networking:
  management:
    subnet: "10.0.0.0/24"
    vlan_id: 0
  storage:
    subnet: "10.0.1.0/24"
    vlan_id: 100
    rdma_enabled: true
  compute:
    subnet: "10.0.2.0/24"
    vlan_id: 200
VariableTypeRequiredDescriptionDefault
networking.management.subnetstringNoManagement network CIDR—
networking.management.vlan_idintegerNoManagement VLAN ID0
networking.storage.subnetstringNoStorage network CIDR—
networking.storage.vlan_idintegerNoStorage VLAN ID—
networking.storage.rdma_enabledbooleanNoWhether RDMA is enabled on storage NICstrue
networking.compute.subnetstringNoCompute network CIDR—
networking.compute.vlan_idintegerNoCompute VLAN ID—

Credentials ​

yaml
credentials:
  cluster_admin_username: "keyvault://kv-iic-loadtools/hci-cluster-admin-user"
  cluster_admin_password: "keyvault://kv-iic-loadtools/hci-cluster-admin-pwd"
  vmfleet_admin_username: "keyvault://kv-iic-loadtools/vmfleet-admin-user"
  vmfleet_admin_password: "keyvault://kv-iic-loadtools/vmfleet-admin-pwd"
VariableTypeRequiredDescriptionDefault
credentials.cluster_admin_usernamestringYesKey Vault URI — cluster admin username—
credentials.cluster_admin_passwordstringYesKey Vault URI — cluster admin password—
credentials.vmfleet_admin_usernamestringNoKey Vault URI — VMFleet VM admin username—
credentials.vmfleet_admin_passwordstringNoKey Vault URI — VMFleet VM admin password—

Testing Defaults ​

yaml
testing:
  default_tool: "vmfleet"
  default_profile: "general"
  duration_seconds: 300
  warmup_seconds: 60
VariableTypeRequiredDescriptionDefault
testing.default_toolstringYesDefault tool: vmfleet, fio, iperf, hammerdb, stress-ngvmfleet
testing.default_profilestringNoProfile name from config/profiles/<tool>/general
testing.duration_secondsintegerNoDuration of each test pass in seconds300
testing.warmup_secondsintegerNoWarmup period before measurement60

Monitoring & Reporting ​

yaml
monitoring:
  log_analytics_workspace_id: "00000000-0000-0000-0000-000000000000"
  log_analytics_shared_key: "keyvault://kv-iic-loadtools/log-analytics-key"
  enable_real_time: true
  collection_interval_seconds: 10

reporting:
  output_dir: "reports"
  format: "html"
  include_charts: true
VariableTypeRequiredDescriptionDefault
monitoring.log_analytics_workspace_idstringNoLog Analytics workspace ID—
monitoring.log_analytics_shared_keystringNoKey Vault URI — Log Analytics shared key—
monitoring.enable_real_timebooleanNoEnable real-time metric collectiontrue
monitoring.collection_interval_secondsintegerNoMetric sampling interval10
reporting.output_dirstringNoReport output directoryreports
reporting.formatstringNoOutput format: html, json, csvhtml
reporting.include_chartsbooleanNoInclude charts in reportstrue

WinRM ​

yaml
winrm:
  port: 5985
  use_ssl: false
  authentication: "Kerberos"
  operation_timeout_seconds: 300
VariableTypeRequiredDescriptionDefault
winrm.portintegerNoWinRM port5985
winrm.use_sslbooleanNoEnable HTTPS for WinRMfalse
winrm.authenticationstringNoAuth method: Kerberos, Negotiate, BasicKerberos
winrm.operation_timeout_secondsintegerNoCommand timeout in seconds300

Tags ​

yaml
tags:
  project: "LoadTools"
  environment: "production"
  workload: "performance-testing"
  solution: "loadtools-azure-local"
VariableTypeRequiredDescriptionDefault
tags.projectstringNoProject tagLoadTools
tags.environmentstringNoEnvironment tagproduction
tags.workloadstringNoWorkload tagperformance-testing
tags.solutionstringNoSolution tagloadtools-azure-local

Key Vault Secret Resolution ​

Secrets are never stored in plaintext. The keyvault:// URI format tells deployment tools to resolve the value at runtime:

yaml
cluster_admin_password: "keyvault://kv-iic-loadtools/hci-cluster-admin-pwd"

Resolution flow:

  1. Tool parses the URI → vault name: kv-iic-loadtools, secret name: hci-cluster-admin-pwd
  2. Tool calls az keyvault secret show --vault-name kv-iic-loadtools --name hci-cluster-admin-pwd
  3. Secret value is passed directly to the script — never written to disk

Released under the MIT License.