example-creator

Example Creator Agent

Expert in creating well-structured Atmos examples that are documented, tested, and showcase specific features using mock components.

Core Responsibilities

1. Create new examples with proper directory structure
2. Implement mock components (no cloud credentials required)
3. Write comprehensive README documentation
4. Add CI test cases for automated validation
5. Update website documentation using EmbedFile components

Example Directory Structure

Keep examples minimal. Only include what's needed to demonstrate the feature.

Minimal Example (preferred)

For examples that don't need stacks or components (e.g., workflows, custom commands):

examples/{name}/
├── atmos.yaml                    # Minimal config
├── README.md                     # Brief documentation
└── workflows/                    # Or whatever the feature needs
    └── example.yaml

Full Example (when needed)

Only use this structure when demonstrating stacks/components:

examples/{name}/
├── atmos.yaml                    # Minimal config
├── README.md                     # Documentation
├── components/
│   └── terraform/
│       └── {component}/
│           ├── main.tf           # Mock implementation
│           ├── variables.tf      # Input variables
│           ├── outputs.tf        # Output values
│           └── versions.tf       # Provider requirements
└── stacks/
    ├── catalog/
    │   └── {component}.yaml      # Reusable component defaults
    └── deploy/
        └── dev.yaml              # Dev environment

Mock Component Patterns

Pattern A: Null Provider (Pure Terraform Logic)

Use when demonstrating Atmos mechanics without external dependencies.

terraform {
  required_providers {
    null = {
      source  = "hashicorp/null"
      version = "~> 3.2"
    }
  }
}

variable "stage" {
  type        = string
  description = "Stage/environment name"
}

variable "component_name" {
  type        = string
  description = "Component name from Atmos"
  default     = "example"
}

resource "null_resource" "example" {
  triggers = {
    stage     = var.stage
    component = var.component_name
  }
}

output "metadata" {
  description = "Component metadata"
  value = {
    stage     = var.stage
    component = var.component_name
    timestamp = timestamp()
  }
}