Skip to content

rhythmictech/terraform-terraform-template

Repository files navigation

terraform-terraform-template

Template repository for terraform modules. Good for any cloud and any provider.

tflint trivy yamllint misspell pre-commit-check follow on Twitter

Example

Here's what using the module will look like

module "example" {
  source = "rhythmictech/terraform-mycloud-mymodule
}

About

A bit about this module

Requirements

No requirements.

Providers

No providers.

Modules

Name Source Version
tags rhythmictech/tags/terraform ~> 1.1

Resources

No resources.

Inputs

Name Description Type Default Required
name Moniker to apply to all resources in the module string n/a yes
tags User-Defined tags map(string) {} no

Outputs

Name Description
tags_module Tags Module in it's entirety

Getting Started

This workflow has a few prerequisites which are installed through the ./bin/install-x.sh scripts and are linked below. The install script will also work on your local machine.

We use tfenv to manage terraform versions, so the version is defined in the versions.tf and tfenv installs the latest compliant version. pre-commit is like a package manager for scripts that integrate with git hooks. We use them to run the rest of the tools before apply. terraform-docs creates the beautiful docs (above), tfsec scans for security no-nos, tflint scans for best practices.