Prerequisites
Before deploying the Azure Local Load Testing Framework, ensure the following common prerequisites are met. Individual tools may have additional requirements — see each tool's prerequisites page.
Azure Local Cluster Requirements
| Requirement | Details |
|---|---|
| Azure Local Version | Azure Local 23H2 or later (the docs target 12.2609); Azure Stack HCI 22H2 only with limitations |
| Cluster Nodes | Minimum 2 nodes; recommended 4+ for meaningful fleet testing |
| Storage Spaces Direct (S2D) | Enabled and healthy (Get-StorageSubSystem shows HealthStatus: Healthy) |
| Cluster Shared Volumes | At least one CSV for VM fleet storage; additional CSV for results collection |
Network Requirements
| Requirement | Details |
|---|---|
| Management Network | IP connectivity from management station to all cluster nodes |
| PowerShell Remoting | WinRM enabled on all cluster nodes (default for Azure Local) |
| RDMA (Optional) | Required for storage network performance validation with iPerf3 |
| Firewall | Ports 5985 (WinRM HTTP), 5986 (WinRM HTTPS) open from management station |
Management Station Requirements
The management station is where automation scripts execute. This can be a physical workstation, jump box, or CI/CD runner.
| Requirement | Details |
|---|---|
| Operating System | Windows 10/11 or Windows Server 2019+ (PowerShell 7.2+). Linux tools run on Linux target VMs, not on the management station |
| PowerShell | Version 7.2 or later (#Requires -Version 7.2; $PSVersionTable.PSVersion). Windows PowerShell 5.1 is not supported |
| PowerShell Modules | Required: powershell-yaml (CI pins 0.4.12) and, for VMFleet, the VMFleet module. Optional: Az.KeyVault (Key Vault credentials), Az.Monitor (Azure Monitor push), ImportExcel (XLSX reports). Install with Install-Module <name> -Scope CurrentUser |
| Asciidoctor | Optional. Ruby 3.0+, asciidoctor, asciidoctor-pdf gems (PDF reports) |
| Pandoc | Optional. Version 3.0+ (DOCX reports) |
| Git | Version 2.30+ (for repository management) |
Ansible Requirements (for Linux-Based Tools)
Ansible is required only if using fio, iPerf3, HammerDB, or stress-ng on Linux VMs.
| Requirement | Details |
|---|---|
| Ansible | Version 2.14+ (installed via pip install ansible) |
| Execution Environment | WSL2 on Windows, Linux jump box, or CI runner (see installation guide) |
| SSH Access | Key-based SSH authentication to target Linux VMs |
| Python | Version 3.9+ on the Ansible control node |
Azure Requirements (Optional)
Required only if using Azure Monitor integration or Azure Key Vault for credentials.
| Requirement | Details |
|---|---|
| Azure Subscription | Active subscription with Contributor access |
| Azure Key Vault | Provisioned Key Vault with secrets for cluster credentials |
| Log Analytics Workspace | Provisioned workspace for Azure Monitor metric ingestion |
| Service Principal or Managed Identity | For non-interactive Azure authentication in CI/CD |
| Azure Local custom location | Required for marketplace image acquisition (azure_local.custom_location_id) |
| Azure Local storage container | Required to resolve VHDX path (azure_local.storage_path_id) |
Validating Prerequisites
Run the pre-check script to validate all common prerequisites:
# From the repository root
.\common\helpers\Initialize-Environment.ps1 -Solution VMFleetThe script prints an [OK] / [FAIL] / [SKIP] report and stops on a missing required item. It checks the local machine only:
- PowerShell 7.2+ and the
powershell-yamlmodule (required) ImportExcel,Az.KeyVault,Az.Monitor,asciidoctor-pdf,pandoc(optional)- the
VMFleetmodule (required when-Solution VMFleet)
It does not test cluster connectivity, S2D health, volumes, Azure or Ansible. Check those with the tool pages below.
Azure Roles and Credentials
Credentials are never stored in the repository. Cluster and VM credentials come from a parameter, an environment variable or Azure Key Vault (Az.KeyVault; role Key Vault Secrets User or an equivalent access policy on the vault); no script prompts. Azure Monitor push needs a role that can publish metrics to the workspace (for example Monitoring Metrics Publisher). Network: HTTPS 443 to Azure Resource Manager, Key Vault and Azure Monitor endpoints; WinRM 5985/5986 to the cluster nodes; SSH 22 to Linux target VMs when Ansible is used.
Tool-Specific Prerequisites
Each tool may have additional requirements beyond the common set above:
- VMFleet Prerequisites — Base VHD, Collect volume, VMFleet module
- fio Prerequisites — Linux VMs, fio package
- iPerf3 Prerequisites — iPerf3 binaries, RDMA configuration
- HammerDB Prerequisites — SQL Server, HammerDB installation
- stress-ng Prerequisites — Linux VMs, stress-ng package
Next Steps
- Installation — Install the framework and dependencies