chore: Terraform Example Code Optimized (#504)

Author: marifse

cra-config.yaml

@@ -4,6 +4,9 @@ CRA_TARGETS:
   - CRA_TARGET: "examples/default" # Target directory for CRA scan. If not provided, the CRA Scan will not be run.
     CRA_IGNORE_RULES_FILE: "cra-tf-validate-ignore-rules.json" # CRA Ignore file to use. If not provided, it checks the repo root directory for `cra-tf-validate-ignore-rules.json`
     PROFILE_ID: "0e6e7b5a-817d-4344-ab6f-e5d7a9c49520" # SCC profile ID (currently set to the FSCloud 1.4.0 profile).
+    CRA_ENVIRONMENT_VARIABLES:
+      TF_VAR_region: "us-south"
+      TF_VAR_prefix: "vpe"
     # SCC_INSTANCE_ID: "" # The SCC instance ID to use to download profile for CRA scan. If not provided, a default global value will be used.
     # SCC_REGION: "" # The IBM Cloud region that the SCC instance is in. If not provided, a default global value will be used.
     # CRA_ENVIRONMENT_VARIABLES:  # An optional map of environment variables for CRA, where the key is the variable name and value is the value. Useful for providing TF_VARs.

examples/default/main.tf

@@ -21,7 +21,7 @@ module "vpc" {
   resource_group_id = module.resource_group.resource_group_id
   region            = var.region
   prefix            = var.prefix
-  name              = var.vpc_name
+  name              = "vpc-instance"
   tags              = var.resource_tags
 }
 
@@ -79,7 +79,7 @@ module "vpes" {
   source             = "../../"
   region             = var.region
   prefix             = var.prefix
-  vpc_name           = var.vpc_name
+  vpc_name           = "vpc-instance"
   vpc_id             = var.vpc_id != null ? var.vpc_id : module.vpc[0].vpc_id
   subnet_zone_list   = var.vpc_id != null ? var.subnet_zone_list : module.vpc[0].subnet_zone_list
   resource_group_id  = module.resource_group.resource_group_id

examples/default/variables.tf

@@ -7,13 +7,11 @@ variable "ibmcloud_api_key" {
 variable "region" {
   description = "The region where VPC and services are deployed"
   type        = string
-  default     = "us-south"
 }
 
 variable "prefix" {
   description = "The prefix that you would like to append to your resources"
   type        = string
-  default     = "vpe"
 }
 
 variable "resource_group" {
@@ -26,12 +24,6 @@ variable "resource_group" {
 # VPC Variables
 ##############################################################################
 
-variable "vpc_name" {
-  description = "Name of the VPC where the Endpoint Gateways will be created. This value is used to dynamically generate VPE names. It is also used to create a VPC when the vpc_id input is set to null."
-  type        = string
-  default     = "vpc-instance"
-}
-
 variable "vpc_id" {
   description = "ID of the VPC where the Endpoint Gateways will be created. Creates a VPC if set to null."
   type        = string

examples/default/versions.tf

@@ -4,11 +4,13 @@
 
 terraform {
   required_version = ">= 1.3.0, <1.7.0"
+  # Ensure that there is always 1 example locked into the lowest provider version of the range defined in the main
+  # module's version.tf (basic or default), and 1 example that will always use the latest provider version.
   required_providers {
     ibm = {
       source = "IBM-Cloud/ibm"
       # pin above lowest vesion, required for postgresql and IAM auth policy
-      version = ">=1.61.0, <2.0.0"
+      version = "1.61.0"
     }
     time = {
       source  = "hashicorp/time"

examples/every-mt-vpe/variables.tf

@@ -7,13 +7,11 @@ variable "ibmcloud_api_key" {
 variable "region" {
   description = "The region where VPC and services are deployed"
   type        = string
-  default     = "us-south"
 }
 
 variable "prefix" {
   description = "The prefix that you would like to append to your resources"
   type        = string
-  default     = "vpe"
 }
 
 variable "resource_group" {

examples/every-mt-vpe/versions.tf

@@ -4,11 +4,13 @@
 
 terraform {
   required_version = ">= 1.3.0, <1.7.0"
+  # Ensure that there is always 1 example locked into the lowest provider version of the range defined in the main
+  # module's version.tf (basic or default), and 1 example that will always use the latest provider version.
   required_providers {
     ibm = {
       source = "IBM-Cloud/ibm"
       # pin above lowest vesion, required for postgresql and IAM auth policy
-      version = ">=1.61.0, <2.0.0"
+      version = ">=1.61.0"
     }
   }
 }