Terraform Module Standards Reference

Reference documentation defining the structure, naming, and versioning conventions ScaleCloud’s Terraform modules follow, so any team consuming our modules or contributing new ones has a consistent standard to work against.

Module structure

Every module follows the same file layout — main.tf, variables.tf, outputs.tf, and a versions.tf pinning provider versions — with every variable documented with a description and, where applicable, a validation block.

Versioning

Modules are semantically versioned, and any change that alters a resource’s default behavior (not just adds a new optional variable) is treated as a major version bump, even if it’s technically backward compatible in most cases.