Skip to content

Commit bd3f322

Browse files
kristopherjturnerkristopherjturner
authored
fix: merge intro.md into index.mdx and remove stale versioned docs (#23)
- Merge intro.md content into docs/index.mdx as single clean landing page - Delete docs/intro.md (duplicate that was showing in sidebar) - Remove stale versioned docs (v1.0.0, v2.0.0 were just 'coming soon' placeholders) - Remove versions.json and versioned_sidebars/ - Update navbar: replace version dropdown + docsVersion with direct doc link - Update footer and homepage links from /docs/intro to /docs/ - Site builds successfully, /docs/ now lands on Azure Local Documentation Closes #19
1 parent 25423bc commit bd3f322

43 files changed

Lines changed: 46 additions & 425 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/index.mdx‎

Lines changed: 42 additions & 201 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,41 @@
11
---
22
title: Azure Local Documentation
3-
description: Comprehensive documentation for the Azure Local automation toolkit and deployment standard.
4-
owners:
5-
- team@azurelocal.cloud
6-
- automation-team@azurelocal.cloud
7-
status: active
3+
description: Comprehensive documentation for deploying and operating Azure Local infrastructure at scale.
84
---
95

106
# Azure Local Documentation
117

12-
[![Status](https://img.shields.io/badge/Status-Active-green?style=flat-square&logo=git)](./)
13-
[![Category](https://img.shields.io/badge/Category-Product-blue?style=flat-square&logo=microsoftazure)](./)
14-
15-
> **DOCUMENT CATEGORY**: Product Documentation
16-
> **SCOPE**: Complete Azure Local solution documentation
17-
> **PURPOSE**: Standardized deployment of Azure Local infrastructure
18-
> **MASTER REFERENCE**: [Microsoft Learn - Azure Local](https://learn.microsoft.com/en-us/azure/azure-local/)
19-
20-
**Status**: Active
21-
**Last Updated**: 2025-01-30
22-
23-
---
8+
Welcome to the **Azure Local Cloud** documentation site — your comprehensive guide to planning, deploying, and operating Azure Local (formerly Azure Stack HCI) infrastructure.
249

2510
## Quick Start
2611

27-
New to Azure Local? Follow this path:
28-
29-
| Step | Action | Link |
30-
|:----:|--------|------|
12+
| Step | Action | Section |
13+
|:----:|--------|---------|
3114
| 1 | Review planning requirements | [Planning & Discovery](./planning/) |
32-
| 2 | Set up CI/CD infrastructure | [CI/CD Infrastructure](./implementation/01-cicd-infra/) |
33-
| 3 | Deploy Azure foundation | [Azure Foundation](./implementation/02-azure-foundation/) |
34-
| 4 | Prepare on-premises environment | [On-Prem Readiness](./implementation/03-onprem-readiness/) |
35-
| 5 | Deploy the cluster | [Cluster Deployment](./implementation/04-cluster-deployment/) |
36-
| 6 | Complete handover | [Validation & Handover](./implementation/07-go-live/) |
37-
38-
---
39-
40-
## Overview
41-
42-
**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.
43-
44-
This documentation serves as the "Master Reference" for the solution, while the accompanying **Toolkit Repository** (`azurelocal-toolkit`) contains the actual scripts, templates, and configuration files used during deployment.
45-
46-
---
47-
48-
## Prerequisites Checklist
49-
50-
Before starting an Azure Local deployment, ensure you have:
15+
| 2 | Review solution design | [Design](./design/) |
16+
| 3 | Set up CI/CD infrastructure | [CI/CD Infrastructure](./implementation/01-cicd-infra/) |
17+
| 4 | Deploy Azure foundation | [Azure Foundation](./implementation/02-azure-foundation/) |
18+
| 5 | Prepare on-premises environment | [On-Prem Readiness](./implementation/03-onprem-readiness/) |
19+
| 6 | Deploy the cluster | [Cluster Deployment](./implementation/04-cluster-deployment/) |
20+
| 7 | Configure operational foundations | [Operational Foundations](./implementation/05-operational-foundations/) |
21+
| 8 | Test and validate | [Testing & Validation](./implementation/06-testing-validation/) |
22+
| 9 | Complete handover | [Go Live](./implementation/07-go-live/) |
23+
24+
## Documentation Structure
25+
26+
- **[Planning](./planning/)** — Naming standards, discovery checklists, site assessments, and hardware requirements
27+
- **[Design](./design/)** — High-Level Design (HLD) and Low-Level Design (LLD) documentation
28+
- **[Implementation](./implementation/)** — Step-by-step deployment runbook across 8 stages
29+
- **[Automation](./automation/)** — Terraform, Bicep, Ansible, and CI/CD pipeline references
30+
- **[Operations](./operations/)** — As-built documentation, monitoring, and support procedures
31+
- **[Azure Services](./azure-services/)** — Running Azure services on Azure Local (AKS, AVD, SQL MI, IoT, etc.)
32+
- **[Lab Environment](./lab-environment/)** — Lab setup and access information
33+
- **[Assets](./assets/)** — Architecture diagrams and images
34+
- **[Reference](./reference.mdx)** — External links and resources
35+
36+
## Prerequisites
37+
38+
Before starting a deployment, ensure you have:
5139

5240
| Requirement | Description |
5341
|-------------|-------------|
@@ -60,176 +48,29 @@ Before starting an Azure Local deployment, ensure you have:
6048

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

63-
---
51+
## Architecture
6452

65-
## System Architecture
53+
This solution uses a **Two-Repo Architecture** that separates automation logic from documentation:
6654

6755
```
6856
┌─────────────────────────────────────────────────────────────────────┐
69-
│ TWO-REPO ARCHITECTURE │
57+
│ TWO-REPO ARCHITECTURE │
7058
├─────────────────────────────┬───────────────────────────────────────┤
71-
│ DOCUMENTATION REPO │ TOOLKIT REPO │
72-
│ (This Site) │ (azurelocal-toolkit) │
59+
│ DOCUMENTATION REPO │ TOOLKIT REPO │
60+
│ (This Site) │ (azurelocal-toolkit) │
7361
├─────────────────────────────┼───────────────────────────────────────┤
74-
│ • High-Level Design (HLD) │ • PowerShell Scripts │
75-
│ • Low-Level Design (LLD) │ • Ansible Playbooks │
76-
│ • Standard Operating Procs │ • Bicep/Terraform Templates │
77-
│ • Runbooks & Procedures │ • CI/CD Pipeline Definitions │
78-
│ • Reference Documentation │ • Customer Configuration Files │
62+
│ • High-Level Design (HLD) │ • PowerShell Scripts │
63+
│ • Low-Level Design (LLD) │ • Ansible Playbooks │
64+
│ • Standard Operating Procs │ • Bicep/Terraform Templates │
65+
│ • Runbooks & Procedures │ • CI/CD Pipeline Definitions │
66+
│ • Reference Documentation │ • Customer Configuration Files │
7967
└─────────────────────────────┴───────────────────────────────────────┘
8068
```
8169

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

84-
---
85-
86-
## Documentation Sections
87-
88-
| Section | Description | Status | Files |
89-
|---------|-------------|:------:|:-----:|
90-
| [Design](./design/) | High-level and low-level design documents | Draft | 3 |
91-
| [Planning & Discovery](./planning/) | Site assessment, requirements, discovery sessions | Active | 8 |
92-
| [Implementation](./implementation/) | Complete deployment runbook (Parts 1-8) | Active | 149 |
93-
| [Automation](./automation/) | IaC templates, CI/CD pipelines | Draft | 7 |
94-
| [Operations](./operations/) | Day-2 operations, monitoring, support | Draft | 8 |
95-
| [Lab Environment](./lab-environment/) | Lab access and configuration | Draft | 3 |
96-
| [Assets](./assets/) | Diagrams, scripts, configurations | Active | 6 |
97-
| [Reference](./reference.mdx) | External links and resources | Draft | 1 |
98-
99-
---
100-
101-
## Deployment Stages at a Glance
102-
103-
The implementation is divided into 8 parts with phased tasks:
104-
105-
### Part 1: CI/CD Infrastructure
106-
107-
| Phase | Name | Est. Time | Link |
108-
|:-----:|------|:---------:|------|
109-
| 1 | B2B Cross-Tenant Configuration | 30 min | [Phase 1](./implementation/01-cicd-infra/phase-01-cicd-setup/) |
110-
| 2 | CI/CD Setup | 45 min | [Phase 2](./implementation/01-cicd-infra/phase-01-cicd-setup/) |
111-
| 3 | Infrastructure Deployment | 30 min | Phase 3 |
112-
113-
### Part 2: Azure Foundation
114-
115-
| Phase | Name | Est. Time | Link |
116-
|:-----:|------|:---------:|------|
117-
| 1 | Landing Zones | 1 hour | [Phase 1](./implementation/02-azure-foundation/phase-01-landing-zones/) |
118-
| 2 | Resource Providers | 15 min | [Phase 2](./implementation/02-azure-foundation/phase-02-resource-providers/) |
119-
| 3 | RBAC Permissions | 30 min | [Phase 3](./implementation/02-azure-foundation/phase-03-rbac-permissions/) |
120-
| 4 | Azure Management Infrastructure | 2 hours | [Phase 4](./implementation/02-azure-foundation/phase-04-azure-management-infrastructure/) |
121-
| 5 | Identity & Security | 1 hour | [Phase 5](./implementation/02-azure-foundation/phase-05-identity-security/) |
122-
123-
### Part 3: On-Premises Readiness
124-
125-
| Phase | Name | Est. Time | Link |
126-
|:-----:|------|:---------:|------|
127-
| 1 | Active Directory | 1 hour | [Phase 1](./implementation/03-onprem-readiness/phase-01-active-directory/) |
128-
| 2 | Enterprise Network Validation | 2 hours | [Phase 2](./implementation/03-onprem-readiness/phase-02-enterprise-readiness/) |
129-
| 3 | Network Infrastructure | 2 hours | [Phase 3](./implementation/03-onprem-readiness/phase-03-network-infrastructure/) |
130-
131-
### Part 4: Cluster Deployment
132-
133-
| Phase | Name | Est. Time | Link |
134-
|:-----:|------|:---------:|------|
135-
| 1 | Hardware Provisioning | 1 hour | [Phase 1](./implementation/04-cluster-deployment/phase-01-hardware-provisioning/) |
136-
| 2 | OS Installation | 2 hours | [Phase 2](./implementation/04-cluster-deployment/phase-02-os-installation/) |
137-
| 3 | OS Configuration | 1 hour | [Phase 3](./implementation/04-cluster-deployment/phase-03-os-configuration/) |
138-
| 4 | Arc Registration | 30 min | [Phase 4](./implementation/04-cluster-deployment/phase-04-arc-registration/) |
139-
| 5 | Cluster Deployment | 2 hours | [Phase 5](./implementation/04-cluster-deployment/phase-05-cluster-deployment/) |
140-
| 6 | Post-Deployment | 1 hour | [Phase 6](./implementation/04-cluster-deployment/phase-06-post-deployment/) |
141-
142-
### Part 5: Operational Foundations
143-
144-
| Phase | Name | Est. Time | Link |
145-
|:-----:|------|:---------:|------|
146-
| 1 | SDN Deployment | 2 hours | [Phase 1](./implementation/05-operational-foundations/phase-01-sdn-deployment/) |
147-
| 2 | Monitoring & Observability | 1 hour | [Phase 2](./implementation/05-operational-foundations/phase-02-monitoring-observability/) |
148-
| 3 | Backup & DR | 1 hour | [Phase 3](./implementation/05-operational-foundations/phase-03-backup-dr/) |
149-
| 4 | Security & Governance | 1 hour | [Phase 4](./implementation/05-operational-foundations/phase-04-security-governance/) |
150-
| 5 | Licensing & Telemetry | 30 min | [Phase 5](./implementation/05-operational-foundations/phase-05-licensing-telemetry/) |
151-
152-
### Part 6: Cluster Testing & Validation
153-
154-
| Activity | Est. Time | Link |
155-
|----------|:---------:|------|
156-
| Infrastructure Validation | 2 hours | [Testing](./implementation/06-testing-validation/) |
157-
158-
### Part 7: Validation & Handover
159-
160-
| Activity | Est. Time | Link |
161-
|----------|:---------:|------|
162-
| Cluster Validation | 1 hour | [Validation](./implementation/07-go-live/01-cluster-validation/) |
163-
| Client Handover | 2 hours | [Handover](./implementation/07-go-live/02-cluster-handover/) |
164-
165-
### Part 8: Lifecycle Operations
166-
167-
| Activity | Est. Time | Link |
168-
|----------|:---------:|------|
169-
| Ongoing Operations | Continuous | [Lifecycle](./implementation/08-lifecycle-operations/) |
170-
171-
**Total Estimated Time**: 20-24 hours (spread across multiple days)
172-
173-
---
174-
175-
## Key Capabilities
176-
177-
| Capability | Description |
178-
|------------|-------------|
179-
| **Part-Based Deployment** | Infrastructure delivery broken into 8 parts with phased tasks |
180-
| **Validation First** | Pre-flight checks and post-deployment validation scripts |
181-
| **Infrastructure as Code** | Bicep and Terraform for Azure resource management |
182-
| **Vendor Integration** | Standardized workflows for Dell, OpenGear, and Fortinet hardware |
183-
| **CI/CD Automation** | CI/CD pipelines for automated deployments |
184-
| **Drift Detection** | Continuous monitoring for configuration drift |
185-
186-
---
187-
188-
## Version History
189-
190-
| Version | Date | Changes |
191-
|:-------:|------|---------|
192-
| 1.0.0 | 2025-01-30 | Rebrand to Azure Local, remove legacy content |
193-
| 0.2.0 | 2025-01-30 | Standards compliance update, documentation restructure |
194-
| 0.1.0 | 2025-01-01 | Initial documentation structure |
195-
196-
---
197-
198-
## Support & Resources
199-
200-
### Repositories
201-
202-
| Repository | Description | Link |
203-
|------------|-------------|------|
204-
| Documentation | This site | [GitHub](https://github.com/AzureLocal/azurelocal.github.io) |
205-
| Toolkit | Scripts, templates, pipelines | [GitHub](https://github.com/AzureLocal/azurelocal-toolkit) |
206-
| Terraform Modules | Azure Local module | [GitHub](https://github.com/AzureLocal/tf-module-azr-local) |
207-
208-
### Team Contacts
209-
210-
| Contact | Purpose |
211-
|---------|---------|
212-
| [Teams Channel](https://teams.microsoft.com/l/team/19%3Akn8v-WNxeOktyON9w2gv4sXD_qMQn2CXHAQurGMO1bc1%40thread.tacv2/conversations?groupId=d05d37a2-0ae0-4f3f-9e11-756788d45a40&tenantId=fdfe8868-8df3-4832-87bc-7a57c45d4c1f) | General questions, support |
213-
| team@azurelocal.cloud | Documentation issues |
214-
| automation-team@azurelocal.cloud | Automation & scripting |
215-
216-
### External Resources
217-
218-
| Resource | Link |
219-
|----------|------|
220-
| Microsoft Learn - Azure Local | [Documentation](https://learn.microsoft.com/en-us/azure/azure-local/) |
221-
| Dell AX Nodes | [Support](https://www.dell.com/en-us/lp/dt/open-manage-systems-management) |
222-
| Azure Arc | [Documentation](https://learn.microsoft.com/en-us/azure/azure-arc/) |
223-
224-
---
225-
226-
## Browse Documentation
72+
## Related Resources
22773

228-
- [Planning & Discovery](./planning/)
229-
- [Design](./design/)
230-
- [Implementation Guide](./implementation/)
231-
- [Operations](./operations/)
232-
- [Azure Services](./azure-services/)
233-
- [Automation](./automation/)
234-
- [Assets](./assets/)
235-
- [Lab Environment](./lab-environment/)
74+
- **[Azure Local Toolkit](https://azurelocal.cloud/azurelocal-toolkit/)** — Deployment scripts, validation suites, and configuration management
75+
- **[Microsoft Learn - Azure Local](https://learn.microsoft.com/en-us/azure/azure-local/)** — Official Microsoft documentation
76+
- **[Azure Arc](https://learn.microsoft.com/en-us/azure/azure-arc/)** — Hybrid cloud management

‎docs/intro.md‎

Lines changed: 0 additions & 39 deletions
This file was deleted.

‎docusaurus.config.js‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,9 @@ const config = {
8383
},
8484
items: [
8585
{
86-
type: 'docsVersionDropdown',
86+
type: 'doc',
87+
docId: 'index',
8788
position: 'left',
88-
//dropdownItemsAfter: [{to: '/versions', label: 'All versions'}],
89-
dropdownActiveClassDisabled: true,
90-
},
91-
{
92-
type: 'docsVersion',
93-
position: 'left',
94-
to: '/docs/intro',
9589
label: 'Docs',
9690
},
9791
{ to: '/working', label: 'Blog', position: 'left' },
@@ -178,7 +172,7 @@ const config = {
178172
items: [
179173
{
180174
label: 'Azure Local Docs',
181-
to: '/docs/intro',
175+
to: '/docs/',
182176
},
183177
],
184178
},

‎src/pages/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ function HomepageHeader() {
1919
<div className={styles.buttons}>
2020
<Link
2121
className="button button--secondary button--lg"
22-
to="/docs/intro"
22+
to="/docs/"
2323
>
2424
Learn More About Azure Local
2525
</Link>

‎versioned_docs/version-1.0.0/docs-lab-env/_category_.json‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎versioned_docs/version-1.0.0/docs-lab-env/about-the-lab.md‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎versioned_docs/version-1.0.0/docs-lab-env/access-the-lab.md‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎versioned_docs/version-1.0.0/docs-lab-env/img/docsVersionDropdown.png‎

-24.8 KB
Binary file not shown.

‎versioned_docs/version-1.0.0/docs-lab-env/img/localeDropdown.png‎

-27.2 KB
Binary file not shown.

‎versioned_docs/version-1.0.0/docs-planning-for-azure-local/_category_.json‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)