refactor(examples/complete): extract locals to variables

Author: saumitra-dev

examples/complete/.header.md

@@ -5,6 +5,56 @@ Configuration in this directory creates:
 - ECS Cluster using self-managed EC2
 - Autoscaling Group with self-managed EC2 for the created ECS Cluster
 
+## Example tfvars file
+
+```text
+cluster_name = "cluster"
+cluster_setting = [
+  {
+    name  = "containerInsights"
+    value = "enabled"
+  }
+]
+cluster_tags = {
+  Project = "project"
+}
+
+# Autoscaling Group Variables
+asg_name                = "my-asg"
+asg_vpc_zone_identifier = ["subnet-1341324123", "subnet-13241234123"]
+asg_desired_capacity    = 2
+asg_min_size            = 1
+asg_max_size            = 3
+asg_instances_tags = {
+  Name = "instance"
+}
+asg_tags = {
+  Project = "project"
+}
+
+# Launch Template Variables
+asg_create_launch_template = true
+asg_launch_template = {
+  image_id           = "ami-068e0f1a600cd311c"
+  instance_type      = "t2.micro"
+  key_name           = "<actual-key-name>"
+  security_group_ids = []
+}
+asg_launch_template_version = "<actual-version>"
+
+# IAM Role Variables
+asg_iam_role_name = "asg-role"
+asg_iam_role_tags = {
+  Project = "project"
+}
+
+# IAM Instance Profile Variables
+asg_iam_instance_profile_name = "asg-instance-profile"
+asg_iam_instance_profile_tags = {
+  Project = "project"
+}
+```
+
 ## Usage
 
 To run this example, you will need to execute the commands:

examples/complete/locals.tf

@@ -1,29 +1,29 @@
 module "ecs" {
   source = "../../"
 
-  cluster_name    = local.cluster_name
-  cluster_setting = local.cluster_setting
-  cluster_tags    = local.cluster_tags
+  cluster_name    = var.cluster_name
+  cluster_setting = var.cluster_setting
+  cluster_tags    = var.cluster_tags
 
   # ASG Variables
-  asg_name                = local.asg_name
-  asg_vpc_zone_identifier = local.asg_vpc_zone_identifier
-  asg_desired_capacity    = local.asg_desired_capacity
-  asg_min_size            = local.asg_min_size
-  asg_max_size            = local.asg_max_size
-  asg_instances_tags      = local.asg_instances_tags
-  asg_tags                = local.asg_tags
+  asg_name                = var.asg_name
+  asg_vpc_zone_identifier = var.asg_vpc_zone_identifier
+  asg_desired_capacity    = var.asg_desired_capacity
+  asg_min_size            = var.asg_min_size
+  asg_max_size            = var.asg_max_size
+  asg_instances_tags      = var.asg_instances_tags
+  asg_tags                = var.asg_tags
 
   # Launch Template
-  asg_create_launch_template  = local.asg_create_launch_template
-  asg_launch_template         = local.asg_launch_template
-  asg_launch_template_version = local.asg_launch_template_version
+  asg_create_launch_template  = var.asg_create_launch_template
+  asg_launch_template         = var.asg_launch_template
+  asg_launch_template_version = var.asg_launch_template_version
 
   # IAM Role
-  asg_iam_role_name = local.asg_iam_role_name
-  asg_iam_role_tags = local.asg_iam_role_tags
+  asg_iam_role_name = var.asg_iam_role_name
+  asg_iam_role_tags = var.asg_iam_role_tags
 
   # IAM Instance Profile
-  asg_iam_instance_profile_name = local.asg_iam_instance_profile_name
-  asg_iam_instance_profile_tags = local.asg_iam_instance_profile_tags
+  asg_iam_instance_profile_name = var.asg_iam_instance_profile_name
+  asg_iam_instance_profile_tags = var.asg_iam_instance_profile_tags
 }

examples/complete/main.tf

@@ -0,0 +1,100 @@
+################################################################################
+# ECS Cluster
+################################################################################
+
+variable "cluster_name" {
+  description = "The name of the ECS cluster."
+  type        = string
+}
+
+variable "cluster_setting" {
+  description = "The settings to use when creating the cluster."
+  type = list(object({
+    name  = string
+    value = string
+  }))
+}
+
+variable "cluster_tags" {
+  description = "A map of tags to assign to the cluster."
+  type        = map(string)
+}
+
+################################################################################
+# Autoscaling Group
+################################################################################
+
+variable "asg_name" {
+  description = "The name of the Auto Scaling Group."
+  type        = string
+}
+
+variable "asg_vpc_zone_identifier" {
+  description = "A list of subnet IDs to launch resources in."
+  type        = list(string)
+}
+
+variable "asg_desired_capacity" {
+  description = "The number of Amazon EC2 instances that should be running in the Auto Scaling Group."
+  type        = number
+}
+
+variable "asg_min_size" {
+  description = "The minimum size of the Auto Scaling Group."
+  type        = number
+}
+
+variable "asg_max_size" {
+  description = "The maximum size of the Auto Scaling Group."
+  type        = number
+}
+
+variable "asg_instances_tags" {
+  description = "A map of tags to assign to the instances within the Auto Scaling Group."
+  type        = map(string)
+}
+
+variable "asg_tags" {
+  description = "A map of tags to assign to the Auto Scaling Group."
+  type        = map(string)
+}
+
+variable "asg_create_launch_template" {
+  description = "Whether to create a launch template."
+  type        = bool
+}
+
+variable "asg_launch_template" {
+  description = "The configuration of the launch template."
+  type = object({
+    image_id           = string
+    instance_type      = string
+    key_name           = string
+    security_group_ids = list(string)
+  })
+}
+
+variable "asg_launch_template_version" {
+  description = "The version of the launch template to use."
+  type        = string
+}
+
+variable "asg_iam_role_name" {
+  description = "The name of the IAM role for the Auto Scaling Group."
+  type        = string
+}
+
+variable "asg_iam_role_tags" {
+  description = "A map of tags to assign to the IAM role."
+  type        = map(string)
+}
+
+variable "asg_iam_instance_profile_name" {
+  description = "The name of the IAM instance profile for the Auto Scaling Group."
+  type        = string
+}
+
+variable "asg_iam_instance_profile_tags" {
+  description = "A map of tags to assign to the IAM instance profile."
+  type        = map(string)
+}