Skip to main content

Phase 05: Cluster Deployment

Runbook Azure

DOCUMENT CATEGORY: Runbook
SCOPE: Azure Local cluster deployment
PURPOSE: Deploy the cluster through Azure Portal or ARM templates
MASTER REFERENCE: Microsoft Learn - Deploy Azure Local

Status: Active Estimated Time: 1.5-3 hours (Learn gives 2.5-3 hours for the ARM deployment itself) Last Updated: 2026-11-08 (verified against Microsoft Learn view=azloc-2610)


Overview​

This stage deploys the Azure Local cluster using the configured infrastructure. Deployment can be performed through the Azure Portal (GUI-based) or ARM templates (infrastructure-as-code). Azure Local Cloud supports both Active Directory and Local Identity authentication methods.

Before Validate

Every machine needs its OS steps done first: OEM drivers and SBE, one static management address with one default gateway, DNS and time. Which ones you run yourself depends on your route; see the decision matrix. Check Microsoft Learn and your OEM's deployment guide for your build.

Simplified provisioning: pass each machine's arcMachineResourceId from Azure (named <device-id>-1), and read the known issue with Arc machine names at Deploy before you deploy.

Automated route. The toolkit's ARM run (Invoke-AzureLocalArmDeployment.ps1) refuses to Validate or Deploy without a passing, current result of the pre-cluster verification gate (Invoke-AzureLocalPreClusterVerification.ps1) for the same infrastructure file. Run the gate after the OS configuration, by hand or with its pipeline (pipelines/github-actions/pre-cluster-verification.yml, pipelines/gitlab/stages/pre-cluster-verification.yml, pipelines/azure-devops/pre-cluster-verification.yml). The pipeline fails when the verdict is not Pass.


Deployment Methods​

Storage Spaces Direct (S2D) — Hyperconverged​

MethodAuthenticationUse Case
Portal - Active DirectoryDomain-joinedStandard enterprise deployment
ARM Template - Active DirectoryDomain-joinedAutomated/repeatable deployment
Portal - Local IdentityLocal accountsEdge/disconnected scenarios
ARM Template - Local IdentityLocal accountsAutomated edge deployment

Storage Area Network (SAN) — Disaggregated​

MethodAuthenticationUse Case
Portal - Active Directory (SAN)Domain-joinedSAN with enterprise AD
ARM Template - Active Directory (SAN)Domain-joinedSAN with automated deployment
Portal - Local Identity (SAN)Local accountsSAN at edge without AD
ARM Template - Local Identity (SAN)Local accountsSAN with automated edge
Choosing Your Storage Type
  • S2D (Hyperconverged): Local NVMe/SSD/HDD in each node, up to 16 nodes. Compute and storage scale together.
  • SAN (Disaggregated): External SAN via Fibre Channel or iSCSI, up to 64 nodes. Compute and storage scale independently. See SAN Deployment for prerequisites and network patterns.
  • Hybrid (S2D + SAN): a SAN attached to a hyperconverged cluster after initial deployment (version 2604 or later). It is a day-2 operation, see Connect an external storage array to Azure Local.
Azure Local Cloud Standard

For Azure Local Cloud Azure Local deployments, Active Directory with ARM Template is the recommended approach for consistency and repeatability.


Prerequisites​

All Deployment Methods​

RequirementValidation
Arc registration complete (Phase 04)All nodes show "Connected" in Azure Portal
Network infrastructure configuredManagement, storage, and compute networks ready
Required Azure permissionsSubscription: user access administrator and contributor. Resource group used for the Arc machines: Azure Stack HCI Administrator, Reader, Key Vault Data Access Administrator, Key Vault Secrets Officer, Key Vault Contributor, Storage Account Contributor, plus Azure Connected Machine Onboarding and Azure Connected Machine Resource Administrator
Storage infrastructure readyS2D: physical disks clean and enclosures configured. SAN: infrastructure LUN (250 GB or more) and performance history LUN (20 GB or more) visible and RAW

Active Directory Deployments Only​

RequirementValidation
AD pre-created with New-HciAdObjectsPreCreationOU exists, LCM user created in OU, GPO inheritance blocked at OU level
Nodes in workgroup (default) or domain-joined before deployment (optional, 2604 and later)(Get-WmiObject Win32_ComputerSystem).Domain returns WORKGROUP, or the domain name if you joined first. If domain-joined, the deployment user is in the local Administrators group. If not joined, the wizard joins the machines to the domain during deployment
DNS resolves the AD domain FQDN from all nodesResolve-DnsName <domain.fqdn> succeeds on each node

Local Identity Deployments Only​

RequirementValidation
Non-built-in local admin account with identical credentials on ALL nodesAccount is NOT the built-in Administrator; login succeeds on each node
Nodes remain in workgroup(Get-WmiObject Win32_ComputerSystem).Domain returns WORKGROUP
Azure Key Vault availableExisting KV accessible (an existing Key Vault with Private Endpoints is not supported), or will be created during portal deployment
DNS server with zone configured for cluster nodesResolve-DnsName <node-fqdn> succeeds for each node

Deployment Workflow​

graph TD
A[Start Deployment] --> B{Authentication Type?}
B -->|Active Directory| C[AD Pre-checks]
B -->|Local Identity| D[Local Admin Setup]
C --> E{Deployment Method?}
D --> E
E -->|Portal| F[Portal Wizard]
E -->|ARM Template| G[ARM Deployment]
F --> H[Validation]
G --> H
H --> I{Deployment Successful?}
I -->|Yes| J[Phase 16: Post-Deployment]
I -->|No| K[Troubleshooting]
K --> E

Azure Portal Deployment Overview​

The Azure Portal deployment wizard guides you through:

  1. Basics - Subscription, resource group, cluster name, region
  2. Configuration - Node configuration, witness, and storage settings
  3. Networking - Management, compute, and storage network settings
  4. Management - Update settings, key vault integration
  5. Tags - Resource tagging for governance
  6. Validation - Pre-deployment checks
  7. Review + Create - Final review and deployment

ARM Template Deployment Overview​

ARM template deployments provide:

  • Repeatability - Consistent deployments across environments
  • Version Control - Track infrastructure changes in Git
  • Automation - Integrate with CI/CD pipelines
  • Compliance - Audit trail of infrastructure changes
Azure Local Cloud ARM Templates

The Azure Local Toolkit keeps no parameter file to fill in by hand. The parameters of a deployment are built from infrastructure.yml: New-AzureLocalArmParameters.ps1 writes the full parameter file for the design of the file (Active Directory or local identity, Storage Spaces Direct or a SAN, rack aware), and Invoke-AzureLocalArmDeployment.ps1 builds the same parameters and runs the deployment. parameter-sources.md in the report directory shows which key fed each parameter.

Toolkit location: config/azure/arm-templates/

  • template-parameters.json — the parameters of each Microsoft quickstart template the toolkit can select
  • parameter-sources.json — which infrastructure.yml keys feed which ARM parameter
  • examples/*.parameters.json — example parameter files generated from the toolkit's example infrastructure files by config/variables/scripts/New-ArmParameterExample.ps1 (do not edit them)

The earlier hand-filled parameter files are gone. Microsoft's copy of the create-cluster template is now a test fixture (tests/fixtures/arm/microsoft-create-cluster/), read only by the tests.

Microsoft official templates: Pull at deploy time from the Azure Quickstart Templates repository. Do not modify the main template — customize only via the parameters file. Template per scenario (Learn 2610):

ScenarioQuickstart template
S2D, Active Directoryazurestackhci/create-cluster
Local identity (hyperconverged)azurestackhci/create-adless-cluster-external-dns-public-preview
Disaggregated, Fibre Channelazurestackhci/create-cluster-san
Disaggregated, iSCSIazurestackhci/create-cluster-san-iscsi

Learn documents no ARM template for SAN plus local identity.

Deployment authentication

Starting with software version 12.2512, new deployments no longer create a Microsoft Entra ID application (service principal). The cluster authenticates to Azure with a system-assigned managed identity.


Estimated Deployment Time​

PhaseDuration
Pre-deployment validation15-30 minutes
Cluster deployment45-90 minutes
Extension installation15-30 minutes
Post-deployment validation15-30 minutes
Total1.5-3 hours

Next Steps​

Select your deployment method:

S2D (Hyperconverged)​

AuthenticationMethodLink
Active DirectoryPortalPortal Instructions
Active DirectoryARM TemplateARM Template Instructions
Local IdentityPortalPortal Instructions
Local IdentityARM TemplateARM Template Instructions

SAN (Disaggregated)​

AuthenticationMethodLink
Active DirectoryPortalPortal Instructions (SAN)
Active DirectoryARM TemplateARM Template Instructions (SAN)
Local IdentityPortalPortal Instructions (SAN)
Local IdentityARM TemplateARM Template Instructions (SAN)

After completing cluster deployment, proceed to Phase 16: Post Deployment.


PreviousUpNext
Phase 14: Arc RegistrationCluster Deployment IndexPhase 16: Post-Deployment

References: