Skip to content

Implementation Status ​

Category: Reference

This page is the single source of truth for what is built, what is unit-tested, and what has been proven on real hardware. The README, the roadmap, the tool overview and every tool page point here. If another page disagrees with this one, this page wins and the other page is a bug.

IMPORTANT

Nothing in this repository has been proven on a live Azure Local cluster yet. "Implemented" means the scripts exist and the command-construction, parsing and refusal logic pass Pester tests with mocks and fixtures. It does not mean the end-to-end run has been executed on a cluster. Treat every tool as a pre-release until the hardware column says otherwise.

Definitions ​

ColumnMeaning
ImplementedThe scripts for install, run and collect exist and are wired together.
Unit-testedPester tests cover the script structure, parameter handling, command construction and result parsing. No cluster, no network, no Azure calls.
Proven on hardwareSomeone ran it end to end on a real Azure Local cluster and kept the evidence. No for every tool today.

Tools ​

ToolImplementedUnit-testedProven on hardwareNotes
VMFleet (DiskSpd)Yes: pipeline (pre-check, install, deploy, test, monitor, collect, report, cleanup), monitoring collectors, base-image preparationYes: 143 tests (scripts, profiles, base image, failure-injection opt-in guard)NoThe deploy phase passes VM count, base VHD and CSV to the fleet cmdlet; the per-VM memory, vCPU and data-disk values are resolved and logged only. Verify the sizing options of your VMFleet version on the cluster.
fioYes: install, start, collect, Ansible role and playbookYes: 62 testsNoLinux VMs only.
iPerf3Yes: start, collect, Ansible role and playbook (no install script: the Ansible role installs it)Yes: 39 testsNoPlain TCP/UDP only. It does not exercise RDMA; see Azure Local network guidance.
HammerDBYes: install, start, collectYes: 43 tests (1 skipped)No
stress-ngYes: start, collect, Ansible role and playbook (no install script: the Ansible role installs it)Yes: 36 testsNoLinux VMs only.

Framework ​

ComponentImplementedUnit-testedProven on hardware
ConfigManager, Logger, StateManager, CredentialManager, MonitoringManagerYesYes (Config, Logger, State; Credential and Monitoring are not covered yet)No
ReportGenerator (PDF via asciidoctor-pdf, DOCX via pandoc, XLSX via ImportExcel)YesPartly: 3 tests, the external tools are not exercisedNo
ResultAnalysis: offline HTML + CSV report, baseline comparison, regression exit code, trendYesYes: 27 tests on fixturesNot applicable (offline), but the inputs come from runs that are unproven
Day-2 smoke gate (Invoke-Day2Smoke.ps1, JSON schema)YesYes: 25 tests (schema, exit codes, fixtures)No
FaultInjection (node pause, drive fault, guarded, opt-in)YesYes: 43 mocked testsNo (see failure injection)
CI (GitHub Actions and Azure DevOps): analyzer, Pester per suite, link checkYesNot applicableNot applicable

Known documentation gaps ​

  • No script has a -CredentialSource parameter, and the tool pages no longer show one. The scripts take a -Credential (PSCredential) or a secret parameter such as -WorkspaceKey, then fall back to the environment variables and the Key Vault mapping (see Credential Management). For any other command example, the script param blocks are the reference.
  • The monitoring/ and reports/ folders are per tool (tools/<tool>/monitoring, tools/<tool>/reports/templates), not at the repository root.

What would change a "No" to a "Yes" ​

An owner runs the tool on a non-production cluster, keeps the output, and records the date, Azure Local release and result here. The suggested order is in the roadmap.

Released under the MIT License.