00:00.0 / 00:00.0
README.md2.8 KB
View on GitHubExample: Scaffolds
Concrete, ready-to-run scaffold templates, organized by cloud. These are the
same templates atmos init's catalog pulls from (aws/app, aws/landing-zone,
gcp/landing-zone, azure/landing-zone) — this directory is their source of
truth.
Learn more in the Init Command Documentation and the Scaffold Command Documentation.
What You'll See
- A real, emulator-provable landing zone generated from a local template
directory with
atmos scaffold generate - How the generated project's
!terraform.statedependency (kmsfirst, then everything that reads its key) drives apply order
Try It
cd examples/scaffolds# See the templates this directory providesatmos scaffold generate ./aws/landing-zone ./my-landing-zone --set project_name=my-landing-zone --dry-run# Or generate for realatmos scaffold generate ./aws/landing-zone ./my-landing-zone --set project_name=my-landing-zoneatmos --chdir=./my-landing-zone emulator up aws -s devatmos --chdir=./my-landing-zone terraform apply kms -s dev -auto-approveatmos --chdir=./my-landing-zone terraform apply audit-trail -s dev -auto-approveatmos --chdir=./my-landing-zone terraform apply baseline -s dev -auto-approveatmos --chdir=./my-landing-zone terraform apply monitoring -s dev -auto-approveatmos --chdir=./my-landing-zone terraform apply iam-baseline -s dev -auto-approveatmos --chdir=./my-landing-zone terraform output monitoring -s devatmos --chdir=./my-landing-zone emulator down aws -s dev
The same templates are also reachable by name through the catalog once
published (atmos init aws/landing-zone ./my-landing-zone or
atmos scaffold generate aws/landing-zone ./my-landing-zone).
Templates
| Directory | Purpose |
|---|---|
aws/app | Application SDLC repository for AWS |
aws/landing-zone | AWS landing zone environments (audit trail, KMS, SSM, monitoring, IAM) |
gcp/landing-zone | GCP landing zone environments (GCS, Secret Manager, service accounts) |
azure/landing-zone | Azure landing zone environments (resource group, VNet, subnet, NSG) |
Creating Custom Templates
For a minimal walkthrough of scaffold-template mechanics (prompts, Go
templating, atmos.yaml-registered templates), see
examples/scaffolding instead — these templates are meant
to be used, not edited as a tutorial.