Skip to content

Day-2 Smoke (readiness gate step) ​

Category: ReferenceStatus: Not proven on hardware

An optional, roughly 15-minute VMFleet run for a Day-2 readiness gate. It uses the Day2Smoke profile (the General workload: 8k blocks, 30% writes, 70% random, 2 minutes of warm-up and 10 minutes measured, plus about 3 minutes to start, collect and stop). It answers "does the storage path still perform in the range we expect", not "what is the maximum". It is a smoke test, not a benchmark.

WARNING

Running it deploys a fleet of VMs on the cluster. It has not been run on a live cluster. See status.

Run it ​

powershell
# Run the pipeline, then evaluate (asks for confirmation; -WhatIf prints the plan and exits 3)
.\tools\vmfleet\scripts\Invoke-Day2Smoke.ps1 -OutputPath out\smoke -NodeCount 4 -FleetAdminCredential $fleetCred

# Evaluate a run that already exists (no cluster access)
.\tools\vmfleet\scripts\Invoke-Day2Smoke.ps1 -ResultPath reports\<run-id>\<run-id>-aggregate.json -OutputPath out\smoke -NodeCount 4

# Add the regression check against an approved baseline
.\tools\vmfleet\scripts\Invoke-Day2Smoke.ps1 -ResultPath candidate.json -BaselinePath baseline.json -OutputPath out\smoke -NodeCount 4

Thresholds come from tools/vmfleet/config/profiles/day2-smoke.yml (min_iops_per_node, max_latency_ms, min_throughput_mbps); the values shipped are examples, set your own.

Exit codes ​

CodestatusMeaning
0PassEvery threshold holds (and no regression, when a baseline was given)
1FailA threshold or the regression check failed
2ErrorInvalid or incomparable input, unknown node count, run failed. Not a pass.
3SkippedNothing was run (plan only). Not a pass.

A gate script must treat every non-zero code as "not passed". The script also writes day2-smoke-result.json to the output folder, whatever the outcome.

JSON result ​

Schema: day2-smoke-result.schema.json (JSON Schema 2020-12). Validate with Test-Json -Json (Get-Content day2-smoke-result.json -Raw) -SchemaFile docs/reference/day2-smoke-result.schema.json. The tests validate the fixtures in tests/fixtures/day2-smoke (four valid, three invalid) and what the code emits for every status.

FieldTypeNotes
schema_version"1.0"
tool, profilestringvmfleet, Day2Smoke
statusPass / Fail / Error / SkippedThe schema ties each status to its exit code
exit_code0 / 1 / 2 / 3Same as the process exit code
proven_on_hardwarebooleanAlways false until the owner proves the run path
started_at, finished_atdate-timeUTC
duration_secondsinteger
run_id, cluster_namestringEmpty when no result was read
node_countintegerNeeded for the per-node IOPS check; 0 means unknown, which is an Error
baseline_run_idstring or null
metricsobject or nulltotal_iops, total_throughput_mbps, avg_latency_ms, and the read/write and percentile values the result carries
checks[]arraymetric, kind (min, max, regression), limit, actual, status (Pass, Fail, Error)
notes[]array of stringReasons, including why a comparison was refused

Example (abridged):

json
{
  "schema_version": "1.0",
  "tool": "vmfleet",
  "profile": "Day2Smoke",
  "status": "Pass",
  "exit_code": 0,
  "proven_on_hardware": false,
  "run_id": "fixture-candidate-ok-002",
  "node_count": 4,
  "baseline_run_id": "fixture-baseline-001",
  "checks": [
    { "metric": "iops_per_node", "kind": "min", "limit": 5000, "actual": 28875, "status": "Pass" }
  ],
  "notes": []
}

Using it from a gate script ​

powershell
& .\tools\vmfleet\scripts\Invoke-Day2Smoke.ps1 -ResultPath $aggregate -OutputPath $out -NodeCount 4
$r = Get-Content (Join-Path $out 'day2-smoke-result.json') -Raw | ConvertFrom-Json
if ($LASTEXITCODE -ne 0 -or $r.status -ne 'Pass') { throw "Day-2 smoke did not pass: $($r.status)" }

Released under the MIT License.