Skip to content

Prerequisites ​

Category: Getting Started

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 ​

RequirementDetails
Azure Local VersionAzure Local 23H2 or later (the docs target 12.2609); Azure Stack HCI 22H2 only with limitations
Cluster NodesMinimum 2 nodes; recommended 4+ for meaningful fleet testing
Storage Spaces Direct (S2D)Enabled and healthy (Get-StorageSubSystem shows HealthStatus: Healthy)
Cluster Shared VolumesAt least one CSV for VM fleet storage; additional CSV for results collection

Network Requirements ​

RequirementDetails
Management NetworkIP connectivity from management station to all cluster nodes
PowerShell RemotingWinRM enabled on all cluster nodes (default for Azure Local)
RDMA (Optional)Required for storage network performance validation with iPerf3
FirewallPorts 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.

RequirementDetails
Operating SystemWindows 10/11 or Windows Server 2019+ (PowerShell 7.2+). Linux tools run on Linux target VMs, not on the management station
PowerShellVersion 7.2 or later (#Requires -Version 7.2; $PSVersionTable.PSVersion). Windows PowerShell 5.1 is not supported
PowerShell ModulesRequired: 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
AsciidoctorOptional. Ruby 3.0+, asciidoctor, asciidoctor-pdf gems (PDF reports)
PandocOptional. Version 3.0+ (DOCX reports)
GitVersion 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.

RequirementDetails
AnsibleVersion 2.14+ (installed via pip install ansible)
Execution EnvironmentWSL2 on Windows, Linux jump box, or CI runner (see installation guide)
SSH AccessKey-based SSH authentication to target Linux VMs
PythonVersion 3.9+ on the Ansible control node

Azure Requirements (Optional) ​

Required only if using Azure Monitor integration or Azure Key Vault for credentials.

RequirementDetails
Azure SubscriptionActive subscription with Contributor access
Azure Key VaultProvisioned Key Vault with secrets for cluster credentials
Log Analytics WorkspaceProvisioned workspace for Azure Monitor metric ingestion
Service Principal or Managed IdentityFor non-interactive Azure authentication in CI/CD
Azure Local custom locationRequired for marketplace image acquisition (azure_local.custom_location_id)
Azure Local storage containerRequired to resolve VHDX path (azure_local.storage_path_id)

Validating Prerequisites ​

Run the pre-check script to validate all common prerequisites:

powershell
# From the repository root
.\common\helpers\Initialize-Environment.ps1 -Solution VMFleet

The 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-yaml module (required)
  • ImportExcel, Az.KeyVault, Az.Monitor, asciidoctor-pdf, pandoc (optional)
  • the VMFleet module (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 Azure Key Vault (Az.KeyVault; role Key Vault Secrets User or an equivalent access policy on the vault) or an interactive prompt. 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:

Next Steps ​

Released under the MIT License.