Skip to content

Commit baa66d4

Browse files
kristopherjturnerkristopherjturner
committed
fix: merge landing page content, fix broken anchors, remove vendor-specific refs
- Merged all detailed content into docs/index.mdx (single landing page) - Added badges (Reference, Azure Local, Active status) - Updated deployment stages to match actual implementation docs - Removed B2B cross-tenant references - Made hardware references vendor-agnostic - Fixed broken anchor #appendix-alternative-script-options in arm-template-instructions - Fixed broken anchor #3-software-requirements -> #3-software-prerequisites - Removed fake team contacts section Closes #19
1 parent 0c8a052 commit baa66d4

3 files changed

Lines changed: 155 additions & 24 deletions

File tree

‎docs/implementation/04-cluster-deployment/phase-05-cluster-deployment/deployment-methods/local-identity/arm-template-instructions.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import TabItem from '@theme/TabItem';
2121
:::info Script Options in This Document
2222
This runbook uses **Option 2 — Azure PowerShell** (config-driven, reads `infrastructure.yml`) as the primary automated path alongside **Option 1 — Manual** steps.
2323

24-
Alternative script options (Option 3: Azure CLI PowerShell, Option 4: Azure CLI Bash, Option 5: Standalone) are available in the [Appendix](#appendix-alternative-script-options) at the bottom of this document.
24+
Alternative script options (Option 3: Azure CLI PowerShell, Option 4: Azure CLI Bash, Option 5: Standalone) are available in the Reference section below.
2525
:::
2626

2727
**Status**: Active

‎docs/implementation/04-prerequisites-and-assumptions.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ If `Microsoft.Insights` is not registered, the diagnostic account and Key Vault
202202

203203
### Azure Arc Prerequisites
204204

205-
- **Azure Stack HCI OS** installed on all cluster nodes (see [Section 3: Software Requirements](#3-software-requirements))
205+
- **Azure Stack HCI OS** installed on all cluster nodes (see [Section 3: Software Prerequisites](#3-software-prerequisites))
206206
- **Outbound internet connectivity** to required Azure Arc endpoints (see [Section 5: Network Prerequisites](#5-network-prerequisites))
207207
- **Arc Gateway** configured if deploying through a proxy environment (optional)
208208
- RBAC roles for Arc registration (`Azure Connected Machine Onboarding` + `Azure Connected Machine Resource Administrator`) assigned per the permissions table above

‎docs/index.mdx‎

Lines changed: 153 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
11
---
22
title: Azure Local Documentation
33
description: Comprehensive documentation for deploying and operating Azure Local infrastructure at scale.
4-
sidebar_class_name: hidden-sidebar-item
4+
---
5+
6+
[![Reference](https://img.shields.io/badge/Type-Reference-purple?style=flat-square)](./index.mdx)
7+
[![Azure](https://img.shields.io/badge/Platform-Azure_Local-0078D4?style=flat-square&logo=microsoftazure)](https://learn.microsoft.com/en-us/azure/azure-local/)
8+
[![Active](https://img.shields.io/badge/Status-Active-brightgreen?style=flat-square)](./index.mdx)
9+
10+
> **DOCUMENT CATEGORY**: Reference
11+
> **SCOPE**: Complete Azure Local solution documentation
12+
> **PURPOSE**: Standardized deployment of Azure Local infrastructure
13+
> **MASTER REFERENCE**: [Microsoft Learn - Azure Local](https://learn.microsoft.com/en-us/azure/azure-local/)
14+
15+
**Status**: Active | **Last Updated**: 2025-01-30
16+
517
---
618

719
Welcome to the **Azure Local Cloud** documentation site — your comprehensive guide to planning, deploying, and operating Azure Local (formerly Azure Stack HCI) infrastructure.
@@ -20,36 +32,28 @@ Welcome to the **Azure Local Cloud** documentation site — your comprehensive g
2032
| 8 | Test and validate | [Testing & Validation](./implementation/06-testing-validation/) |
2133
| 9 | Complete handover | [Go Live](./implementation/07-go-live/) |
2234

23-
## Documentation Structure
35+
## Overview
2436

25-
- **[Planning](./planning/)** — Naming standards, discovery checklists, site assessments, and hardware requirements
26-
- **[Design](./design/)** — High-Level Design (HLD) and Low-Level Design (LLD) documentation
27-
- **[Implementation](./implementation/)** — Step-by-step deployment runbook across 8 stages
28-
- **[Automation](./automation/)** — Terraform, Bicep, Ansible, and CI/CD pipeline references
29-
- **[Operations](./operations/)** — As-built documentation, monitoring, and support procedures
30-
- **[Azure Services](./azure-services/)** — Running Azure services on Azure Local (AKS, AVD, SQL MI, IoT, etc.)
31-
- **[Lab Environment](./lab-environment/)** — Lab setup and access information
32-
- **[Assets](./assets/)** — Architecture diagrams and images
33-
- **[Reference](./reference.mdx)** — External links and resources
37+
Azure Local is a standardized, automation-first solution for deploying Azure Local (formerly Azure Stack HCI) infrastructure. It is designed around a **Two-Repo Architecture** that separates the automation logic from the documentation, ensuring portable and repeatable deployments across different customer environments.
3438

35-
## Prerequisites
39+
This documentation serves as the "Master Reference" for the solution, while the accompanying **Toolkit Repository** ([azurelocal-toolkit](https://github.com/AzureLocal/azurelocal-toolkit)) contains the actual scripts, templates, and configuration files used during deployment.
3640

37-
Before starting a deployment, ensure you have:
41+
## Prerequisites Checklist
42+
43+
Before starting an Azure Local deployment, ensure you have:
3844

3945
| Requirement | Description |
4046
|-------------|-------------|
4147
| Azure Subscription | Active Azure subscription with Owner or Contributor rights |
4248
| Entra ID Access | Global Administrator or Privileged Role Administrator |
4349
| Network Connectivity | VPN or ExpressRoute to on-premises environment |
44-
| Hardware | Dell AX-series nodes (or compatible) racked and powered |
45-
| Credentials | Access to Dell iDRAC, network switches, and firewalls |
50+
| Hardware | Azure Local validated nodes racked and powered |
51+
| Credentials | Access to BMC/iDRAC, network switches, and firewalls |
4652
| GitHub Access | Source control account with repository access |
4753

4854
See [Prerequisites & Assumptions](./implementation/04-prerequisites-and-assumptions.mdx) for complete details.
4955

50-
## Architecture
51-
52-
This solution uses a **Two-Repo Architecture** that separates automation logic from documentation:
56+
## System Architecture
5357

5458
```
5559
┌─────────────────────────────────────────────────────────────────────┐
@@ -68,8 +72,135 @@ This solution uses a **Two-Repo Architecture** that separates automation logic f
6872

6973
The **Toolkit Repo** is cloned and instanced for each customer deployment, while this documentation remains the single source of truth for procedures.
7074

71-
## Related Resources
75+
## Documentation Sections
76+
77+
| Section | Description | Status | Files |
78+
|---------|-------------|--------|-------|
79+
| [Design](./design/) | High-level and low-level design documents | Draft | 3 |
80+
| [Planning & Discovery](./planning/) | Site assessment, requirements, discovery sessions | Active | 8 |
81+
| [Implementation](./implementation/) | Complete deployment runbook (Parts 1-8) | Active | 149 |
82+
| [Automation](./automation/) | IaC templates, CI/CD pipelines | Draft | 7 |
83+
| [Operations](./operations/) | Day-2 operations, monitoring, support | Draft | 8 |
84+
| [Azure Services](./azure-services/) | Running Azure services on Azure Local | Active | — |
85+
| [Lab Environment](./lab-environment/) | Lab access and configuration | Draft | 3 |
86+
| [Assets](./assets/) | Diagrams, scripts, configurations | Active | 6 |
87+
| [Reference](./reference.mdx) | External links and resources | Draft | 1 |
88+
89+
## Deployment Stages at a Glance
90+
91+
The implementation is divided into 8 parts with phased tasks:
92+
93+
### Part 1: CI/CD Infrastructure
94+
95+
| Phase | Name | Est. Time | Link |
96+
|:-----:|------|:---------:|------|
97+
| 1 | CI/CD Setup | 45 min | [Phase 1](./implementation/01-cicd-infra/phase-01-cicd-setup/) |
98+
99+
### Part 2: Azure Cloud Foundation
100+
101+
| Phase | Name | Est. Time | Link |
102+
|:-----:|------|:---------:|------|
103+
| 1 | Landing Zones | 1 hour | [Phase 1](./implementation/02-azure-foundation/phase-01-landing-zones/) |
104+
| 2 | Resource Providers | 15 min | [Phase 2](./implementation/02-azure-foundation/phase-02-resource-providers/) |
105+
| 3 | RBAC Permissions | 30 min | [Phase 3](./implementation/02-azure-foundation/phase-03-rbac-permissions/) |
106+
| 4 | Azure Management Infrastructure | 2 hours | [Phase 4](./implementation/02-azure-foundation/phase-04-azure-management-infrastructure/) |
107+
| 5 | Identity & Access Management | 1 hour | [Phase 5](./implementation/02-azure-foundation/phase-05-identity-security/) |
108+
109+
### Part 3: On-Premises Readiness
110+
111+
| Phase | Name | Est. Time | Link |
112+
|:-----:|------|:---------:|------|
113+
| 1 | Active Directory Preparation | 1 hour | [Phase 1](./implementation/03-onprem-readiness/phase-01-active-directory/) |
114+
| 2 | Enterprise Network Readiness Validation | 2 hours | [Phase 2](./implementation/03-onprem-readiness/phase-02-enterprise-readiness/) |
115+
| 3 | Network Infrastructure Configuration | 2 hours | [Phase 3](./implementation/03-onprem-readiness/phase-03-network-infrastructure/) |
116+
117+
### Part 4: Cluster Deployment
118+
119+
| Phase | Name | Est. Time | Link |
120+
|:-----:|------|:---------:|------|
121+
| 1 | Hardware Provisioning & BIOS/iDRAC | 1 hour | [Phase 1](./implementation/04-cluster-deployment/phase-01-hardware-provisioning/) |
122+
| 2 | OS Installation | 2 hours | [Phase 2](./implementation/04-cluster-deployment/phase-02-os-installation/) |
123+
| 3 | OS Configuration | 1 hour | [Phase 3](./implementation/04-cluster-deployment/phase-03-os-configuration/) |
124+
| 4 | Arc Registration | 30 min | [Phase 4](./implementation/04-cluster-deployment/phase-04-arc-registration/) |
125+
| 5 | Cluster Deployment | 2 hours | [Phase 5](./implementation/04-cluster-deployment/phase-05-cluster-deployment/) |
126+
| 6 | Post-Deployment Configuration | 1 hour | [Phase 6](./implementation/04-cluster-deployment/phase-06-post-deployment/) |
127+
128+
### Part 5: Operational Foundations
129+
130+
| Phase | Name | Est. Time | Link |
131+
|:-----:|------|:---------:|------|
132+
| 1 | SDN Integration (Optional) | 2 hours | [Phase 1](./implementation/05-operational-foundations/phase-01-sdn-deployment/) |
133+
| 2 | Monitoring & Observability | 1 hour | [Phase 2](./implementation/05-operational-foundations/phase-02-monitoring-observability/) |
134+
| 3 | Backup & DR | 1 hour | [Phase 3](./implementation/05-operational-foundations/phase-03-backup-dr/) |
135+
| 4 | Security & Governance | 1 hour | [Phase 4](./implementation/05-operational-foundations/phase-04-security-governance/) |
136+
| 5 | Licensing & Telemetry | 30 min | [Phase 5](./implementation/05-operational-foundations/phase-05-licensing-telemetry/) |
137+
138+
### Part 6: Cluster Testing & Validation
139+
140+
| Activity | Est. Time | Link |
141+
|----------|:---------:|------|
142+
| Infrastructure Health Validation | 2 hours | [Testing](./implementation/06-testing-validation/) |
143+
144+
### Part 7: Validation & Handover
145+
146+
| Activity | Est. Time | Link |
147+
|----------|:---------:|------|
148+
| Delivery Confirmation | 1 hour | [Validation](./implementation/07-go-live/01-cluster-validation/) |
149+
| Cluster Handover | 2 hours | [Handover](./implementation/07-go-live/02-cluster-handover/) |
150+
151+
### Part 8: Lifecycle Operations
152+
153+
| Activity | Est. Time | Link |
154+
|----------|:---------:|------|
155+
| Client Training & Handover | — | [Training](./implementation/08-lifecycle-operations/client-training-handover) |
156+
| CMDB Creation | — | [CMDB](./implementation/08-lifecycle-operations/cmdb-creation) |
157+
| Deprovision Steps | — | [Deprovision](./implementation/08-lifecycle-operations/deprovision-steps) |
158+
159+
**Total Estimated Time**: 20-24 hours (spread across multiple days)
160+
161+
## Key Capabilities
162+
163+
| Capability | Description |
164+
|------------|-------------|
165+
| Part-Based Deployment | Infrastructure delivery broken into 8 parts with phased tasks |
166+
| Validation First | Pre-flight checks and post-deployment validation scripts |
167+
| Infrastructure as Code | Bicep and Terraform for Azure resource management |
168+
| Vendor Integration | Standardized workflows for supported hardware vendors |
169+
| CI/CD Automation | CI/CD pipelines for automated deployments |
170+
| Drift Detection | Continuous monitoring for configuration drift |
171+
172+
## Version History
173+
174+
| Version | Date | Changes |
175+
|---------|------|---------|
176+
| 1.0.0 | 2025-01-30 | Rebrand to Azure Local, remove legacy content |
177+
| 0.2.0 | 2025-01-30 | Standards compliance update, documentation restructure |
178+
| 0.1.0 | 2025-01-01 | Initial documentation structure |
179+
180+
## Support & Resources
181+
182+
### Repositories
183+
184+
| Repository | Description | Link |
185+
|------------|-------------|------|
186+
| Documentation | This site | [GitHub](https://github.com/AzureLocal/azurelocal.github.io) |
187+
| Toolkit | Scripts, templates, pipelines | [GitHub](https://github.com/AzureLocal/azurelocal-toolkit) |
188+
189+
### External Resources
190+
191+
| Resource | Link |
192+
|----------|------|
193+
| Microsoft Learn - Azure Local | [Documentation](https://learn.microsoft.com/en-us/azure/azure-local/) |
194+
| Azure Local Catalog | [Validated Hardware](https://azurestackhcisolutions.azure.microsoft.com/) |
195+
| Azure Arc | [Documentation](https://learn.microsoft.com/en-us/azure/azure-arc/) |
196+
197+
## Browse Documentation
72198

73-
- **[Azure Local Toolkit](https://azurelocal.cloud/azurelocal-toolkit/)** — Deployment scripts, validation suites, and configuration management
74-
- **[Microsoft Learn - Azure Local](https://learn.microsoft.com/en-us/azure/azure-local/)** — Official Microsoft documentation
75-
- **[Azure Arc](https://learn.microsoft.com/en-us/azure/azure-arc/)** — Hybrid cloud management
199+
- [Planning & Discovery](./planning/)
200+
- [Design](./design/)
201+
- [Implementation Guide](./implementation/)
202+
- [Operations](./operations/)
203+
- [Azure Services](./azure-services/)
204+
- [Automation](./automation/)
205+
- [Assets](./assets/)
206+
- [Lab Environment](./lab-environment/)

0 commit comments

Comments
 (0)