S2DCartographer
Welcome to S2DCartographer — the Storage Spaces Direct analysis, visualization, and reporting tool for Azure Local and Windows Server clusters.
TIP
Planning a new cluster? Use Azure Local Surveyor to model capacity, compute, and workloads before you deploy. Run S2DCartographer on the running cluster to validate what was actually built. Surveyor plans; Cartographer verifies.
What Is This?
S2DCartographer scans a live cluster and maps your entire S2D storage stack — from raw physical disks through the resiliency layers all the way down to actual usable VM capacity. It renders what you find into publication-quality HTML, Word, PDF, and Excel reports, SVG diagrams for every stage, and a structured JSON snapshot for downstream tooling.
Key Capabilities
| Capability | Description |
|---|---|
| Capacity waterfall | 7 stages from raw physical to final usable capacity |
| TiB/TB dual-display | Every capacity value shows both binary and decimal units |
| Reserve validation | Live comparison of actual vs. recommended reserve space |
| Health assessments | 11 pass/fail checks with remediation guidance, including thin provisioning risk |
| What-if modeling | Model capacity impact of adding nodes, disks, or changing resiliency from a JSON snapshot — no live cluster required |
| Reports | HTML, Word, PDF, Excel — ready for customer deliverables |
| Data export | JSON snapshot + per-collector CSVs for downstream tooling |
| Diagrams | SVG waterfall, disk-node map, pool layout, resiliency views |
Quick Start
powershell
# Install from PSGallery
Install-Module S2DCartographer -Scope CurrentUser
# Connect and run everything in one command
Import-Module S2DCartographer
Invoke-S2DCartographer -ClusterName "my-cluster" -Credential (Get-Credential) -Format Html -OutputDirectory "C:\Reports\"Navigation
- Sample Reports — Browse real HTML, JSON, and what-if output before running the tool
- Getting Started — Prerequisites, installation, first run
- Connecting — Domain-joined, non-domain, local node, and Key Vault connection scenarios
- Collectors — What each collector gathers and from where
- Reports — Report formats, templates, and output options
- Diagrams — Available diagram types and generation options
- Concepts: TiB vs TB — Why the numbers don't match your drive labels
- Concepts: Capacity Math — How the 7-stage waterfall is computed
- Concepts: Architecture — Pipeline design and session cache
- Troubleshooting — Common issues and fixes
- Roadmap — What's coming next