Updates based on style guide

Signed-off-by: Michael Ethridge <[email protected]>

Author: methridge

.pre-commit-config.yaml

@@ -9,12 +9,12 @@ repos:
         pass_filenames: false
         stages: ["commit", "push"]
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: check-merge-conflict
       - id: end-of-file-fixer
   - repo: https://github.com/antonbabenko/pre-commit-terraform
-    rev: v1.83.6
+    rev: v1.88.4
     hooks:
       - id: terraform_fmt
       - id: terraform_validate

README.md

@@ -1,7 +1,9 @@
 # Template repo for Terraform modules
 
 This repository contains my template for creating Terraform modules, yes even my
-root modules.
+root modules. This template is based on the best practices I have learned and
+the
+[HashiCorp style guide](https://developer.hashicorp.com/terraform/language/style).
 
 ## Tools that I use
 
@@ -49,13 +51,14 @@ commit process.
   JSON processor. required for `terraform_validate` with
   `--retry-once-with-cleanup` flag, and for `infracost_breakdown` hook.
   - `brew install jq`
+- [TFLint](https://github.com/terraform-linters/tflint): A Terraform linter that
+  checks for best practices and errors in your Terraform code.
+  - `brew install tflint`
 - One or more of these terraform security scanning tools
   - [checkov](https://github.com/bridgecrewio/checkov)
     - `brew install checkov`
   - [terrascan](https://github.com/tenable/terrascan)
     - `brew install terrascan`
-  - [TFLint](https://github.com/terraform-linters/tflint)
-    - `brew install tflint`
   - [TFSec](https://tfsec.dev)
     - `brew install tfsec`
 

backend.tf

@@ -0,0 +1,33 @@
+###############################################################################
+# backend.tf
+#
+# Contains your backend configuration
+###############################################################################
+
+# Documentation
+# https://developer.hashicorp.com/terraform/language/settings/backends/configuration
+
+# terraform {
+#   backend "remote" {
+#     organization = "example_corp"
+
+#     workspaces {
+#       name = "my-app-prod"
+#     }
+#   }
+# }
+
+# Terraform Cloud storage block for CLI driven
+# https://developer.hashicorp.com/terraform/language/settings/terraform-cloud
+
+# terraform {
+#   cloud {
+#     organization = "example_corp"
+#     ## Required for Terraform Enterprise; Defaults to app.terraform.io for Terraform Cloud
+#     hostname = "app.terraform.io"
+
+#     workspaces {
+#       tags = ["app"]
+#     }
+#   }
+# }

outputs.tf

@@ -1,5 +1,11 @@
-############################
+###############################################################################
 # outputs.tf
 #
-# Module outputs
-############################
+# Module outputs in alphabetical order
+###############################################################################
+
+# output "web_public_ip" {
+#  description = "Public IP of the web instance"
+#  value       = aws_instance.web.public_ip
+#  sensitive   = true
+# }

providers.tf

@@ -0,0 +1,21 @@
+###############################################################################
+# providers.tf
+#
+# Contains all provider blocks and configuration.
+###############################################################################
+
+provider "google" {
+  # Configuration options
+  # Environment variables needed for auth
+  # GOOGLE_OAUTH_ACCESS_TOKEN="..."
+  # GOOGLE_PROJECT="..."
+  # GOOGLE_REGION="..."
+  # GOOGLE_ZONE="..."
+}
+
+provider "hcp" {
+  # Configuration options
+  # Environment variables needed for auth
+  # HCP_CLIENT_ID="..."
+  # HCP_CLIENT_SECRET="..."
+}

terraform.tf

@@ -1,7 +1,8 @@
 ###############################################################################
 # terraform.tf
 #
-# Terraform and Provider blocks
+# Contains a single terraform block which defines your required_version and
+# required_providers.
 ###############################################################################
 
 terraform {
@@ -17,19 +18,3 @@ terraform {
     }
   }
 }
-
-provider "google" {
-  # Configuration options
-  # Environment variables needed for auth
-  # GOOGLE_OAUTH_ACCESS_TOKEN="..."
-  # GOOGLE_PROJECT="..."
-  # GOOGLE_REGION="..."
-  # GOOGLE_ZONE="..."
-}
-
-provider "hcp" {
-  # Configuration options
-  # Environment variables needed for auth
-  # HCP_CLIENT_ID="..."
-  # HCP_CLIENT_SECRET="..."
-}

variables.tf

@@ -1,16 +1,28 @@
 ###############################################################################
 # variables.tf
 #
-# Variable definitions
+# Contains all variable blocks in alphabetical order
+#
+# Two groups Required (no default values)
+# Optional (has a default value)
 ###############################################################################
 
+###############################################################################
 # Required Variables (no default values)
-# variable "environment" {
+###############################################################################
+# variable "image_id" {
 #   type        = string
-#   description = "Application Environment (dev|prod)"
+#   description = "The id of the machine image (AMI) to use for the server."
+
+#   validation {
+#     condition     = length(var.image_id) > 4 && substr(var.image_id, 0, 4) == "ami-"
+#     error_message = "The image_id value must be a valid AMI id, starting with \"ami-\"."
+#   }
 # }
 
-# Variables with Defaults
+###############################################################################
+# Optional Variables (has a default value)
+###############################################################################
 # variable "instance_type" {
 #   type        = string
 #   description = "Instance Type"