Make template for output file configurable (#38)

* Make template for output file configurable

* Document new variable

* Updated README.md

Co-authored-by: actions-bot <[email protected]>

Author: mabadillamycwt

README.md

@@ -187,6 +187,7 @@ Available targets:
 | tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | map(string) | `<map>` | no |
 | terraform_backend_config_file_name | Name of terraform backend config file | string | `terraform.tf` | no |
 | terraform_backend_config_file_path | The path to terrafrom project directory | string | `` | no |
+| terraform_backend_config_template_file | The path to the template used to generate the config file | string | `` | no |
 | terraform_state_file | The path to the state file inside the bucket | string | `terraform.tfstate` | no |
 | terraform_version | The minimum required terraform version | string | `0.12.2` | no |
 | write_capacity | DynamoDB write capacity units | string | `5` | no |

docs/terraform.md

@@ -31,6 +31,7 @@
 | tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | map(string) | `<map>` | no |
 | terraform_backend_config_file_name | Name of terraform backend config file | string | `terraform.tf` | no |
 | terraform_backend_config_file_path | The path to terrafrom project directory | string | `` | no |
+| terraform_backend_config_template_file | The path to the template used to generate the config file | string | `` | no |
 | terraform_state_file | The path to the state file inside the bucket | string | `terraform.tfstate` | no |
 | terraform_version | The minimum required terraform version | string | `0.12.2` | no |
 | write_capacity | DynamoDB write capacity units | string | `5` | no |

main.tf

@@ -12,6 +12,8 @@ locals {
     var.terraform_backend_config_file_name
   )
 
+  terraform_backend_config_template_file = var.terraform_backend_config_template_file != "" ? var.terraform_backend_config_template_file : "${path.module}/templates/terraform.tf.tpl"
+
   bucket_name = var.s3_bucket_name != "" ? var.s3_bucket_name : module.s3_bucket_label.id
 }
 
@@ -197,7 +199,7 @@ resource "aws_dynamodb_table" "without_server_side_encryption" {
 }
 
 data "template_file" "terraform_backend_config" {
-  template = file("${path.module}/templates/terraform.tf.tpl")
+  template = file(local.terraform_backend_config_template_file)
 
   vars = {
     region = var.region

variables.tf

@@ -191,6 +191,12 @@ variable "terraform_backend_config_file_path" {
   description = "The path to terrafrom project directory"
 }
 
+variable "terraform_backend_config_template_file" {
+  type        = string
+  default     = ""
+  description = "The path to the template used to generate the config file"
+}
+
 variable "terraform_version" {
   type        = string
   default     = "0.12.2"
@@ -207,4 +213,4 @@ variable "s3_bucket_name" {
   type        = string
   default     = ""
   description = "S3 bucket name. If not provided, the name will be generated by the label module in the format namespace-stage-name"
-}
+}