Skip to content

Azure Local Ranger

Azure Local Ranger — Know your ground truth.

Know your ground truth.

Azure Local Ranger is a discovery, documentation, audit, and reporting solution for Azure Local.

Its purpose is to document an Azure Local deployment as a complete system — the on-prem platform, the workloads running on it, and the Azure resources that represent, manage, monitor, or extend that deployment.

Ranger supports two primary modes of use:

  • Current-state documentation — run at any time to document what exists, how something is configured, and what its current health and risk posture looks like.
  • As-built handoff documentation — run after a deployment to produce a structured documentation package suitable for customer handoff, operations onboarding, or managed-service transition.

Both modes use the same discovery engine. The difference is a parameter, not a different product.

Ranger is designed with explicit support for the range of Azure Local operating models — hyperconverged, switchless, rack-aware, local identity with Azure Key Vault, disconnected operations, and future multi-rack scenarios. It does not silently assume one cluster shape.

If you are new to Ranger, the cleanest path through the docs is:

  1. product definition
  2. architecture and operator model
  3. discovery domains and outputs
  4. roadmap and repository structure
  5. contributor guidance

Current Project Phase

AzureLocalRanger is in the v1.0.0 release-candidate phase. The collectors, manifest pipeline, report renderers, and docs set are implemented in this repository; PSGallery publication is tracked separately from the feature work.

Import-Module .\AzureLocalRanger.psd1 -Force
Invoke-AzureLocalRanger -ConfigPath .\ranger.yml

See the Prerequisites, Quickstart, and Command Reference pages for installation and first-run instructions.

Where To Start

Audience Start Here
Everyone What Ranger Is
Everyone Ranger vs Scout
Everyone Scope Boundary
Everyone Deployment Variants
Architects and operators Architecture Overview
Architects and operators Discovery Domain Pages
Project and repo readers Roadmap
Project and repo readers Documentation Roadmap
Project and repo readers Repository Structure
Contributors Getting Started
Contributors Contributing