diff --git a/docs/implementation/02-azure-foundation/phase-04-azure-management-infrastructure/02-manual-deployment/task-08-arc-gateway.mdx b/docs/implementation/02-azure-foundation/phase-04-azure-management-infrastructure/02-manual-deployment/task-08-arc-gateway.mdx index 56b868c13..3953695d9 100644 --- a/docs/implementation/02-azure-foundation/phase-04-azure-management-infrastructure/02-manual-deployment/task-08-arc-gateway.mdx +++ b/docs/implementation/02-azure-foundation/phase-04-azure-management-infrastructure/02-manual-deployment/task-08-arc-gateway.mdx @@ -1,4 +1,4 @@ ---- +--- title: "Task 08: Arc Gateway" sidebar_label: "Task 08: Arc Gateway" sidebar_position: 8 @@ -48,6 +48,14 @@ This task deploys an Azure Arc Gateway resource. The Arc Gateway provides a cent **Tab Profile**: 3 tabs — Azure Portal · Azure CLI / PowerShell · Standalone Script ::: +:::danger Decide before you deploy the cluster +The Arc gateway can only be enabled during deployment of a new Azure Local instance (software version 2506 or later). It cannot be enabled after deployment. Decide whether to use it, and create the gateway resource in the subscription that will host the instance, before you register the machines. + +If your environment inspects or terminates TLS, Arc gateway is not recommended and does not support TLS-terminating proxies. Skip TLS inspection for the gateway endpoint (`.gw.arc.azure.com`). + +Source: [Overview of Azure Arc gateway for Azure Local](https://learn.microsoft.com/en-us/azure/azure-local/deploy/deployment-azure-arc-gateway-overview?view=azloc-2609#supported-and-unsupported-scenarios) and [Azure Arc gateway limitations](https://learn.microsoft.com/en-us/azure/azure-arc/servers/arc-gateway#current-limitations). +::: + :::warning Azure API Resource The Arc Gateway uses the `Microsoft.HybridCompute/gateways` resource type. As of this writing, it requires the AzAPI provider in Terraform (not yet in azurerm). ::: diff --git a/docs/planning/08-planning-tools.mdx b/docs/planning/08-planning-tools.mdx new file mode 100644 index 000000000..cb555dcee --- /dev/null +++ b/docs/planning/08-planning-tools.mdx @@ -0,0 +1,70 @@ +--- +title: "Planning Tools" +sidebar_label: "Planning Tools" +sidebar_position: 9 +description: "Assess and size workloads with Azure Local Surveyor, then record the deployment design with Azure Local Trailwright" +--- + +# Planning Tools + +[![Runbook](https://img.shields.io/badge/Type-Runbook-blue?style=flat-square)](./index.mdx) +[![Azure](https://img.shields.io/badge/Platform-Azure_Local-0078D4?style=flat-square&logo=microsoftazure)](https://learn.microsoft.com/en-us/azure/azure-local/) + +> **DOCUMENT CATEGORY**: Runbook +> **SCOPE**: Planning tools for Azure Local +> **PURPOSE**: Choose and use the assessment and design tools before deployment +> **MASTER REFERENCE**: [Microsoft Learn - Azure Local system requirements](https://learn.microsoft.com/en-us/azure/azure-local/concepts/system-requirements) + +**Status**: Active + +--- + +## Overview + +Use [Azure Local Surveyor](https://azurelocal.cloud/azurelocal-surveyor/) to assess workload fit, sizing, and storage design. Then use [Azure Local Trailwright](https://labs.hybridsolutions.cloud/azurelocal-trailwright/) to record the deployment design and review its findings. + +Surveyor accepts RVTools exports or Azure Migrate inventory. Its plan can be exported as JSON using schema 2.8.0. Trailwright can import that plan, with a conflict preview before anything is applied. + +## The two tools + +| Tool | Question it answers | Input | Output | +| --- | --- | --- | --- | +| [Azure Local Surveyor](https://azurelocal.cloud/azurelocal-surveyor/) | Does it fit? | RVTools exports or Azure Migrate inventory | Workload assessment, sizing, and storage design. A plan can be exported as JSON using schema 2.8.0. See the [Surveyor documentation](https://azurelocal.cloud/azurelocal-surveyor/docs/). | +| [Azure Local Trailwright](https://labs.hybridsolutions.cloud/azurelocal-trailwright/) | How is it built? | A Surveyor plan or a saved Trailwright project | A recorded design, release-aware validation findings, and data-only handoffs. | + +Trailwright records nodes and topology; identity route using Active Directory or Local Identity with Key Vault; networking including VLANs, Network ATC intents, switched or switchless storage, and an IP plan; connectivity using a direct, proxy, Arc gateway, or private path; Azure landing zone resources; storage volumes and resiliency; and operations. + +Trailwright validation is release-aware, with each finding linked to its Microsoft Learn source. Release 2609 is the baseline. + +Trailwright exports include: + +- Design handoff in Markdown and PDF +- `infrastructure.yml` in the Toolkit registry shape +- ARM parameter files for the Active Directory and Local Identity templates +- A Bicep parameter file +- Schedules in CSV and Excel +- A draw.io topology +- The project as JSON + +Secrets appear only as references. + +## Workflow + +1. Collect the workload inventory in RVTools or Azure Migrate. +2. Assess and size the workloads in Surveyor, including storage design. +3. Export the Surveyor plan as JSON. +4. Import the plan into Trailwright. Review the conflict preview before applying anything. +5. Record the deployment design in Trailwright. You can also start from a saved Trailwright project. +6. Review the release-aware findings and their linked Microsoft Learn sources. +7. Export the design handoff and other data-only outputs as needed. +8. Follow the Implementation section of this site. + +## What the tools do not do + +Neither tool deploys anything. Trailwright exports are handoffs and starting points, not a complete or executable deployment. + +## Related pages + +- [Site assessment](./03-site-assessment.mdx) +- [Hardware requirements](./05-hardware-requirements.mdx) +- [Storage planning](./07-storage-planning.mdx) \ No newline at end of file diff --git a/docs/planning/index.mdx b/docs/planning/index.mdx index 746621cf7..18e428f1f 100644 --- a/docs/planning/index.mdx +++ b/docs/planning/index.mdx @@ -31,6 +31,7 @@ Before beginning an Azure Local deployment, thorough planning and discovery ensu - **[Hardware Requirements](./05-hardware-requirements.mdx)** - Hardware and connectivity prerequisites - **[Landing Zone Strategy](./06-landing-zone-strategy.mdx)** - Azure landing zone configuration decisions - **[Storage Architecture](./07-storage-planning.mdx)** - S2D vs SAN storage topology decision guide +- **[Planning Tools](./08-planning-tools.mdx)** - Assess and size with Surveyor, record the design with Trailwright :::info Naming Convention Planning documents use numbered prefixes (01-06) rather than the `step-NN-` prefix used in deployment stages. This reflects their nature as reference materials and decision frameworks rather than sequential procedural steps.