https://github.com/kewalaka/az-bootstrap
https://github.com/kewalaka/az-bootstrap
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kewalaka/az-bootstrap
- Owner: kewalaka
- License: mit
- Created: 2025-04-28T19:35:12.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-04-29T18:41:11.000Z (5 months ago)
- Last Synced: 2025-04-29T19:38:25.467Z (5 months ago)
- Language: PowerShell
- Size: 27.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- AWESOME-Azure-Bicep - Az-bootstrap - helps to set up Azure and GitHub environments for IaC projects
README
# az-bootstrap
A PowerShell module to bootstrap Azure infrastructure and GitHub repository environments for Infrastructure-as-Code (IaC) projects.
It is designed as a lightweight alternative to subscription vending, suitable for smaller projects and settings up demos.
## What does it do?
```mermaid
flowchart TD
A[Creates a new repository
from a GitHub template] --> B[Clone the repository locally]
B --> C[Create resource group,
managed identity & RBAC]
C --> D[Makes GitHub Environments,
set secrets, reviewers,
and branch protection
in the solution repo]
D --> E[Now you're ready for
IaC development!]
```
## Get started
To get you started you need:
1. PowerShell 7, Az CLI, and the GitHub CLI installed
1. You must be logged in to both Azure and GitHub CLIs before running the module.
1. Azure permissions (Contributor, RBAC Admin), and permission to create GitHub repositories
## Usage Example
```powershell
Install-Module Az-Bootstrap -Scope CurrentUser
# Example assuming you want the new repo 'my-new-iac-project' created under your user account
$params = {
TemplateRepoUrl = "https://github.com/kewalaka/terraform-azure-starter-template"
TargetRepoName = "my-new-iac-project"
PlanEnvName = "plan"
ApplyEnvName = "apply"
ResourceGroupName = "rg-my-new-iac-project"
ManagedIdentityName = "mi-my-new-iac-project"
Location = "newzealandnorth"
# optionally omit these and specify using $env:ARM_TENANT_ID and $env:ARM_SUBSCRIPTION_ID
ArmTenantID = "2c7d1c9d-1ee9-4be3-924a-d4c3466fa22a"
ArmSubscriptionID = "faf579e7-385d-47cd-8990-a6789973ce5f"
}
New-AzBootstrap @params
```
The above will:
- Clones a starter template repository from GitHub (the "source" template repo) into a "target" repository.
- Creates an Azure resource group and managed identity
- Grants Contributor and User Access Administrator (RBAC) roles to the managed identity at the resource group level
- Sets up federated credentials for GitHub environments
- Configures GitHub environments, secrets, and branch protection in the new ("target") repository.
## Next Steps
- See [DESIGN.md](./DESIGN.md) for more details on architecture and extensibility.