add-terraform-module

Add Terraform Module

Scaffold a new Terraform module following project conventions.

Arguments

• {module-name} — Name of the module (required, e.g., redis, service-bus, postgresql)
• {description} — What this module provisions (optional)

Configuration

Read cloudstack.json from the project root at the start of execution. Extract:

• TF_PATH = infrastructure.terraformPath (default: infra/terraform/modules)
• TG_PATH = infrastructure.terragruntPath (default: infra/terragrunt)
• IAC_WRAPPER = infrastructure.iacWrapper (default: none)
• CLOUD = infrastructure.cloud (default: azure)

If cloudstack.json does not exist, auto-detect by scanning the project structure.

Process

1. Read existing modules in {TF_PATH}/ to follow established patterns.

2. Create the module directory:

{TF_PATH}/{module-name}/
├── variables.tf
├── main.tf
├── outputs.tf

1. variables.tf — Always include these standard variables:

variable "environment" {
  description = "Environment name (e.g. dev, staging, prod)"
  type        = string
}

variable "location" {
  description = "Cloud region (e.g. westeurope, us-east-1)"
  type        = string
}

variable "project" {
  description = "Project prefix for resource naming"
  type        = string
}

variable "tags" {
  description = "Common tags applied to all resources"
  type        = map(string)
  default     = {}
}

Add module-specific variables after the standard ones.

1. main.tf — Follow the naming convention from existing modules. Derive a location short code from the region (e.g., westeurope -> weu, us-east-1 -> use1):

locals {
  location_short = # derive from var.location or use a lookup map
  name           = "${var.project}-{resource-abbrev}-${var.environment}-${local.location_short}"
}

Scan existing modules to discover the project's established naming convention and location short mapping. Use that pattern.

1. outputs.tf — Export name, id, and any connection strings or keys needed by downstream modules.