8000 Rewrite the Architecture section of the README for v0.4.0 · Issue #25 · dominikzorgnotti/esx-hcl-check · GitHub
[go: up one dir, main page]

Skip to content

Rewrite the Architecture section of the README for v0.4.0 #25

Closed

Description

@dominikzorgnotti

Summary

The "Architecture: vSAN Offline DB & Firmware Limitations" section is stale after the v0.4.0 work. It notably claims NIC firmware needs esxcli (the tool now reads it via govmomi pNIC properties) and omits: the vSphere 9.1 SOAP path for HBA firmware/driver, cross-host query de-duplication, timeouts/retry, atomic cache writes with integrity check, the typed TRUE/FALSE/N/A/ERROR/SKIPPED verdicts, and offline mode.

Change

Rewrite the section from scratch as "Architecture: How Verification Works":

  • The no-esxcli design constraint stated up front.
  • Phase 1 (inventory collection) with the real firmware/driver sources: pNIC props, NVMe topology + PCIe HBA + 9.1 SOAP, FC/RAID via 9.1 SOAP (older -> Issues), NVMe vendor tokenization, CPUID decode.
  • Phase 2 (two-source verification): local vSAN DB (matrices -> driver/firmware verdicts, supported_* lists, -mismatch, prefix matching) then live API fallback (baseline only, timeouts + retry + cross-host dedup).
  • vSAN DB caching (auto-download, 24h refresh, atomic + integrity check, -vsanhcl, -offline).
  • A certification-status vocabulary table.

Docs only; no code change.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      0