Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
61acc67
Add comprehensive DevOps documentation for CI/CD workflows
Evilazaro Jan 23, 2026
babd75d
Add setup script for Azure Dev Box environment with GitHub/Azure DevO…
Evilazaro Jan 23, 2026
80bc5d0
Add scripts for managing Azure DevCenter roles and GitHub secrets
Evilazaro Jan 23, 2026
a364aff
Add comprehensive documentation for PowerShell scripts in DevExp-DevBox
Evilazaro Jan 23, 2026
b0479ab
Add initial documentation for Business Architecture of DevExp-DevBox
Evilazaro Jan 23, 2026
cff91d8
Add comprehensive documentation for Data Architecture in DevExp-DevBox
Evilazaro Jan 23, 2026
c4ad472
Add missing line breaks in Application Architecture documentation for…
Evilazaro Jan 23, 2026
3d99786
Add comprehensive Technology Architecture documentation for DevExp-De…
Evilazaro Jan 23, 2026
f2f1678
Add comprehensive Security Architecture documentation for DevExp-DevBox
Evilazaro Jan 23, 2026
23f773e
Enhance documentation consistency and readability across architecture…
Evilazaro Jan 23, 2026
a993d66
Enhance documentation for release, setup, and cleanup scripts by addi…
Evilazaro Jan 23, 2026
bb800f9
Enhance documentation for createUsersAndAssignRole.ps1 and deleteDepl…
Evilazaro Jan 23, 2026
c09ec62
Enhance documentation for generateDeploymentCredentials.ps1 by adding…
Evilazaro Jan 23, 2026
68d5911
Enhance documentation for cleanUp.ps1 and winget-update.ps1 by adding…
Evilazaro Jan 23, 2026
0018156
Enhance documentation for architecture files by adding navigation det…
Evilazaro Jan 23, 2026
63e969f
Enhance documentation for various scripts by adding descriptions, tar…
Evilazaro Jan 23, 2026
25c241b
Enhance documentation for architecture files by adding titles to diag…
Evilazaro Jan 23, 2026
2c39a01
Enhance documentation for application architecture by adding titles, …
Evilazaro Jan 23, 2026
9c1bc14
Enhance documentation for technology architecture by adding emojis, i…
Evilazaro Jan 23, 2026
7391970
Enhance documentation for network and Dev Box architecture by adding …
Evilazaro Jan 23, 2026
1cce332
Enhance documentation for GitHub Actions and Log Analytics architectu…
Evilazaro Jan 23, 2026
f7b34f8
Enhance security architecture documentation by adding emojis, improvi…
Evilazaro Jan 23, 2026
31ed2b5
Enhance security architecture documentation by adding emojis, improvi…
Evilazaro Jan 23, 2026
3727733
Add comprehensive documentation for DevExp-DevBox, including architec…
Evilazaro Jan 23, 2026
9d7d4ba
Enhance Key Performance Indicators documentation by adding emojis for…
Evilazaro Jan 23, 2026
c246e90
Enhance CI, Deploy, and Release documentation by improving pipeline v…
Evilazaro Jan 23, 2026
cc8aa6d
Enhance setup script documentation by improving flow visualizations w…
Evilazaro Jan 23, 2026
f8eb1c5
Enhance CI/CD pipeline documentation by adding emojis, improving diag…
Evilazaro Jan 23, 2026
fb7f9d3
Enhance flow visualization documentation for createCustomRole.ps1 and…
Evilazaro Jan 23, 2026
417e02d
Enhance flow visualization documentation for deleteDeploymentCredenti…
Evilazaro Jan 23, 2026
4c61939
Enhance flow visualization documentation for createGitHubSecretAzureC…
Evilazaro Jan 23, 2026
5c466bb
Enhance flow visualization documentation for cleanUp.ps1 and winget-u…
Evilazaro Jan 23, 2026
4309ed8
Enhance flow visualization documentation for createGitHubSecretAzureC…
Evilazaro Jan 23, 2026
5edc8fc
Fix link formatting in deleteGitHubSecretAzureCredentials.ps1 documen…
Evilazaro Jan 23, 2026
3bb1bc6
Fix link formatting in cleanUp.ps1 and winget-update.ps1 documentatio…
Evilazaro Jan 23, 2026
91c8fb9
Enhance flow visualization documentation for cleanUp.ps1 and winget-u…
Evilazaro Jan 23, 2026
53b137d
Enhance documentation for Azure scripts by improving link formatting,…
Evilazaro Jan 23, 2026
07d52b5
Add comprehensive documentation for Azure PowerShell scripts, includi…
Evilazaro Jan 23, 2026
6d167a8
Enhance workflow diagram in README.md by adding setup and cleanup pha…
Evilazaro Jan 23, 2026
47b1954
Refine input styles in flowcharts across multiple Azure script docume…
Evilazaro Jan 23, 2026
d0750e5
Fix link formatting in documentation by removing unnecessary characte…
Evilazaro Jan 23, 2026
8d4dec8
Update navigation links in documentation for consistency and clarity …
Evilazaro Jan 23, 2026
2b6ce31
Refactor table of contents links in documentation for improved consis…
Evilazaro Jan 23, 2026
693e635
Enhance documentation across multiple files with tips, warnings, and …
Evilazaro Jan 23, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
206 changes: 206 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,206 @@
---
title: "DevExp-DevBox Documentation"
description: "Complete documentation for the DevExp-DevBox Landing Zone Accelerator"
author: "DevExp Team"
date: 2026-01-23
version: "1.0.0"
tags:
- documentation
- dev-box
- azure
- landing-zone
---

# 📚 DevExp-DevBox Documentation

> **Complete documentation for the DevExp-DevBox Landing Zone Accelerator**

> [!NOTE]
> **Welcome!** This documentation hub provides comprehensive guides for deploying and managing Azure Dev Box environments using the DevExp-DevBox Landing Zone Accelerator.

---

## 📑 Table of Contents

- [🎯 Overview](#-overview)
- [🏗️ Architecture Documentation](#️-architecture-documentation)
- [🔄 DevOps Documentation](#-devops-documentation)
- [📜 Scripts Documentation](#-scripts-documentation)
- [🚀 Quick Start](#-quick-start)
- [📖 Additional Resources](#-additional-resources)

---

## 🎯 Overview

The **DevExp-DevBox Landing Zone Accelerator** is an enterprise-grade Infrastructure-as-Code (IaC) solution that enables organizations to rapidly deploy and manage Microsoft Dev Box environments at scale.

### Key Features

| Feature | Description |
|:--------|:------------|
| 🏢 **Enterprise Ready** | Built on Azure Landing Zone principles with security and governance |
| ⚡ **Rapid Deployment** | Automated provisioning with Azure Developer CLI (azd) |
| 🔒 **Security First** | RBAC, Key Vault integration, and OIDC authentication |
| 📊 **Observability** | Integrated monitoring with Log Analytics |
| 🔄 **CI/CD Ready** | GitHub Actions workflows for automated deployments |

---

[⬆️ Back to Top](#-table-of-contents)

---

## 🏗️ Architecture Documentation

Comprehensive TOGAF-aligned architecture documentation covering business, data, application, technology, security, and deployment aspects.

| Document | Description |
|:---------|:------------|
| 📋 [Business Architecture](architecture/01-business-architecture.md) | Business context, stakeholders, and value propositions |
| 🗄️ [Data Architecture](architecture/02-data-architecture.md) | Configuration data models, secrets management, and telemetry |
| 📦 [Application Architecture](architecture/03-application-architecture.md) | Bicep module catalog, dependencies, and deployment orchestration |
| ☁️ [Technology Architecture](architecture/04-technology-architecture.md) | Azure services, infrastructure design, and technology standards |
| 🔒 [Security Architecture](architecture/05-security-architecture.md) | Identity management, RBAC, and compliance framework |
| 🚀 [Deployment Architecture](architecture/07-deployment-architecture.md) | CI/CD pipeline design and deployment patterns |

---

[⬆️ Back to Top](#-table-of-contents)

---

## 🔄 DevOps Documentation

Detailed documentation for GitHub Actions workflows and CI/CD processes.

| Document | Description |
|:---------|:------------|
| 📖 [DevOps Overview](devops/README.md) | Master pipeline architecture and workflow relationships |
| 🔄 [CI Workflow](devops/ci.md) | Continuous Integration workflow for Bicep validation and build |
| 🚀 [Deploy Workflow](devops/deploy.md) | Azure deployment workflow with OIDC authentication |
| 🏷️ [Release Workflow](devops/release.md) | Branch-based release strategy and semantic versioning |

---

[⬆️ Back to Top](#-table-of-contents)

---

## 📜 Scripts Documentation

PowerShell automation scripts for environment setup, Azure configuration, and GitHub integration.

### 📁 Root Scripts

| Document | Description |
|:---------|:------------|
| 📖 [Scripts Overview](scripts/README.md) | Complete scripts architecture and quick reference |
| ⚙️ [setUp.ps1](scripts/setup.md) | Azure Dev Box environment setup with source control integration |
| 🧹 [cleanSetUp.ps1](scripts/clean-setup.md) | Complete infrastructure cleanup orchestrator |

### ☁️ Azure Scripts

| Document | Description |
|:---------|:------------|
| 🔑 [createCustomRole.ps1](scripts/azure/create-custom-role.md) | Creates custom Azure RBAC role for role assignment management |
| 👥 [createUsersAndAssignRole.ps1](scripts/azure/create-users-and-assign-role.md) | Assigns DevCenter roles to the current user |
| 🗑️ [deleteDeploymentCredentials.ps1](scripts/azure/delete-deployment-credentials.md) | Removes Azure AD service principal and app registration |
| 👥 [deleteUsersAndAssignedRoles.ps1](scripts/azure/delete-users-and-assigned-roles.md) | Removes DevCenter role assignments |
| 🔑 [generateDeploymentCredentials.ps1](scripts/azure/generate-deployment-credentials.md) | Creates service principal and GitHub secret for CI/CD |

### ⚙️ Configuration Scripts

| Document | Description |
|:---------|:------------|
| 🧹 [cleanUp.ps1](scripts/configuration/clean-up.md) | Removes Azure resource groups |
| 📦 [winget-update.ps1](scripts/configuration/winget-update.md) | Updates Microsoft Store applications via winget |

### 🐙 GitHub Scripts

| Document | Description |
|:---------|:------------|
| 🔐 [createGitHubSecretAzureCredentials.ps1](scripts/github/create-github-secret-azure-credentials.md) | Creates GitHub repository secret for Azure credentials |
| 🗑️ [deleteGitHubSecretAzureCredentials.ps1](scripts/github/delete-github-secret-azure-credentials.md) | Removes GitHub repository secret |

---

[⬆️ Back to Top](#-table-of-contents)

---

## 🚀 Quick Start

### Prerequisites

| Tool | Purpose | Installation |
|:-----|:--------|:-------------|
| Azure CLI (`az`) | Azure resource management | [Install Azure CLI](https://docs.microsoft.com/cli/azure/install-azure-cli) |
| Azure Developer CLI (`azd`) | Deployment orchestration | [Install azd](https://learn.microsoft.com/azure/developer/azure-developer-cli/install-azd) |
| GitHub CLI (`gh`) | GitHub integration | [Install GitHub CLI](https://cli.github.com/) |
| PowerShell 5.1+ | Script execution | Pre-installed on Windows |

### Setup Steps

1. **Clone the repository**

```bash
git clone https://github.com/Evilazaro/DevExp-DevBox.git
cd DevExp-DevBox
```

2. **Authenticate with Azure**

```bash
az login
az account set --subscription "<your-subscription-id>"
```

3. **Run the setup script**

```powershell
.\setUp.ps1 -EnvName "demo" -SourceControl "github"
```

4. **Deploy to Azure**

```bash
azd provision
```

---

[⬆️ Back to Top](#-table-of-contents)

---

## 📖 Additional Resources

### External Links

| Resource | Description |
|:---------|:------------|
| [Microsoft Dev Box Documentation](https://learn.microsoft.com/azure/dev-box/) | Official Azure Dev Box documentation |
| [Azure Landing Zones](https://learn.microsoft.com/azure/cloud-adoption-framework/ready/landing-zone/) | Cloud Adoption Framework Landing Zones |
| [Azure Bicep Documentation](https://learn.microsoft.com/azure/azure-resource-manager/bicep/) | Bicep language reference |
| [GitHub Actions Documentation](https://docs.github.com/actions) | GitHub Actions workflows |

### Repository Links

| Resource | Description |
|:---------|:------------|
| [📁 Infrastructure Code](../infra/) | Bicep templates and configuration |
| [📁 Source Modules](../src/) | Reusable Bicep modules |
| [📄 azure.yaml](../azure.yaml) | Azure Developer CLI configuration |

---

[⬆️ Back to Top](#-table-of-contents)

---

<div align="center">

**[⬆️ Back to Repository Root](../README.md)**

</div>
Loading
Loading