Modified prefix/resources naming management

examples/complete/main.tf

@@ -2,9 +2,13 @@
 # Resource Group
 ########################################################################################################################
 
+locals {
+  prefix = var.prefix != null ? trimspace(var.prefix) != "" ? "${var.prefix}-" : "" : ""
+}
+
 module "tfe" {
   source                       = "../.."
-  prefix                       = var.prefix
+  instance_name                = "${local.prefix}${var.instance_name}"
   region                       = var.region
   existing_resource_group_name = var.resource_group
   resource_tags                = var.resource_tags

examples/complete/variables.tf

@@ -10,14 +10,32 @@ variable "ibmcloud_api_key" {
 
 variable "prefix" {
   type        = string
-  description = "Prefix for name of all resource created by this example"
+  nullable    = true
+  description = "The prefix for the TFE instance name. The resources will be created starting from this, i.e. cluster will be named '[prefix_][instancename]_cluster'. Default set to empty string."
   validation {
-    error_message = "Prefix must begin and end with a letter and contain only letters, numbers, and - characters."
-    condition     = can(regex("^([A-z]|[a-z][-a-z0-9]*[a-z0-9])$", var.prefix))
+    error_message = "var.prefix must begin and end with a letter and contain only letters, numbers, and - characters."
+    condition = (var.prefix == null || var.prefix == "" ? true :
+      alltrue([
+        can(regex("^[a-z][-a-z0-9]*[a-z0-9]$", var.prefix)),
+        length(regexall("--", var.prefix)) == 0
+      ])
+    )
   }
-  default = "tfe"
+  default = ""
 }
 
+variable "instance_name" {
+  type        = string
+  nullable    = false
+  description = "The TFE instance name. The resources will be created starting from this, i.e. cluster will be named '[instance_name]_cluster'. Default set to tfe_instance"
+  validation {
+    error_message = "var.instance_name must begin and end with a letter and contain only letters, numbers, and - characters."
+    condition     = can(regex("^([A-z]|[a-z][-a-z0-9]*[a-z0-9])$", var.instance_name))
+  }
+  default = "tfeinstance"
+}
+
+
 variable "region" {
   type        = string
   description = "Region where resources are created"

ibm_catalog.json

@@ -161,7 +161,7 @@
             "features": [
               {
                 "title": "Minimal Inputs Required",
-                "description": "Just provide a few key values—like region, admin credentials, and a name prefix—and the automation takes care of the rest."
+                "description": "Just provide a few key values—like region, admin credentials, and a name for the instance the automation takes care of the rest."
               },
               {
                 "title": "Lightweight OpenShift Cluster",
@@ -211,12 +211,15 @@
               "value_constraints": [
                 {
                   "type": "regex",
-                  "description": "Prefix must begin with a lowercase letter and may contain only lowercase letters, digits, and hyphens '-'. It must not end with a hyphen('-'), and cannot contain consecutive hyphens ('--'). It should not exceed 16 characters.",
+                  "description": "prefix must begin with a lowercase letter and may contain only lowercase letters, digits, and hyphens '-'. It must not end with a hyphen('-'), and cannot contain consecutive hyphens ('--'). It should not exceed 16 characters.",
                   "value": "^$|^__NULL__$|^[a-z](?!.*--)(?:[a-z0-9-]{0,14}[a-z0-9])?$"
                 }
               ],
               "virtual": false
             },
+            {
+              "key": "instance_name"
+            },
             {
               "key": "region",
               "type": "string",

main.tf

@@ -6,7 +6,7 @@ module "resource_group" {
   source  = "terraform-ibm-modules/resource-group/ibm"
   version = "1.4.0"
   # if an existing resource group is not set (null) create a new one using prefix
-  resource_group_name          = var.existing_resource_group_name == null ? "${var.prefix}-resource-group" : null
+  resource_group_name          = var.existing_resource_group_name == null ? "${var.instance_name}-rg" : null
   existing_resource_group_name = var.existing_resource_group_name
 }
 
@@ -21,9 +21,9 @@ module "cos" {
   region                   = var.region
   create_cos_instance      = var.existing_cos_instance_id != null ? false : true
   existing_cos_instance_id = var.existing_cos_instance_id
-  cos_instance_name        = var.cos_instance_name != null ? var.cos_instance_name : "${var.prefix}-tfe"
+  cos_instance_name        = var.cos_instance_name != null ? var.cos_instance_name : "${var.instance_name}-cos"
   cos_tags                 = var.resource_tags
-  bucket_name              = var.cos_bucket_name != null ? var.cos_bucket_name : "${var.prefix}-tfe-bucket"
+  bucket_name              = var.cos_bucket_name != null ? var.cos_bucket_name : "${var.instance_name}-bucket"
   add_bucket_name_suffix   = true
   create_cos_bucket        = true
   retention_enabled        = var.cos_retention # disable retention for test environments - enable for stage/prod
@@ -45,7 +45,7 @@ module "cos" {
 module "ocp_vpc" {
   source            = "./modules/ocp-vpc"
   region            = var.region
-  prefix            = var.prefix
+  instance_name     = var.instance_name
   resource_group_id = module.resource_group.resource_group_id
   resource_tags     = var.resource_tags
   access_tags       = var.access_tags
@@ -62,7 +62,7 @@ module "icd_postgres" {
   source             = "terraform-ibm-modules/icd-postgresql/ibm"
   version            = "4.4.0"
   resource_group_id  = module.resource_group.resource_group_id
-  name               = var.postgres_instance_name != null ? var.postgres_instance_name : "${var.prefix}-data-store"
+  name               = var.postgres_instance_name != null ? var.postgres_instance_name : "${var.instance_name}-data-store"
   postgresql_version = "16" # TFE supports up to Postgres 16 (not 17)
   region             = var.region
   service_endpoints  = "public-and-private"
@@ -122,7 +122,7 @@ module "tfe_install" {
 ########################################################################################################################
 
 locals {
-  terraform_enterprise_engine_name = var.terraform_enterprise_engine_name != null ? var.terraform_enterprise_engine_name : "${var.prefix}-tfe"
+  terraform_enterprise_engine_name = var.terraform_enterprise_engine_name != null ? var.terraform_enterprise_engine_name : "${var.instance_name}-engine"
 }
 
 resource "ibm_cm_account" "cm_account_instance" {

modules/ocp-vpc/main.tf

@@ -9,8 +9,7 @@ module "vpc" {
   region            = var.region
   create_vpc        = var.existing_vpc_id == null ? true : false
   existing_vpc_id   = var.existing_vpc_id
-  prefix            = var.prefix
-  name              = "${var.prefix}-vpc"
+  name              = "${var.instance_name}-vpc"
   tags              = []
   address_prefixes = {
     zone-1 = ["10.10.10.0/24"]
@@ -104,7 +103,7 @@ module "openshift" {
   count                               = var.existing_cluster_id == null ? 1 : 0
   source                              = "terraform-ibm-modules/base-ocp-vpc/ibm"
   version                             = "3.73.5"
-  cluster_name                        = var.prefix
+  cluster_name                        = "${var.instance_name}-cluster"
   resource_group_id                   = var.resource_group_id
   region                              = var.region
   force_delete_storage                = true

modules/ocp-vpc/variables.tf

@@ -2,26 +2,21 @@
 # Input Variables
 ########################################################################################################################
 
-# variable "ibmcloud_api_key" {
-#   type        = string
-#   description = "The IBM Cloud api key"
-#   sensitive   = true
-# }
-
 variable "resource_group_id" {
   type        = string
   description = "The Resource Group ID to use for all resources created in this solution (VPC and cluster)"
   default     = null
 }
 
-variable "prefix" {
+variable "instance_name" {
   type        = string
-  description = "Prefix for name of all resource created by this example"
+  nullable    = false
+  description = "The TFE instance name. The resources will be created starting from this, i.e. cluster will be named '[instance_name]_cluster'. Default set to tfe_instance"
+  default     = "tfe_instance"
   validation {
-    error_message = "Prefix must begin and end with a letter and contain only letters, numbers, and - characters."
-    condition     = can(regex("^([A-z]|[a-z][-a-z0-9]*[a-z0-9])$", var.prefix))
+    error_message = "instance_name must begin and end with a letter and contain only letters, numbers, and - characters."
+    condition     = can(regex("^([A-z]|[a-z][-a-z0-9]*[a-z0-9])$", var.instance_name))
   }
-  default = "tfe"
 }
 
 variable "region" {

modules/tfe-install/main.tf

@@ -34,7 +34,7 @@ resource "kubernetes_secret" "tfe_pull_secret" {
 
 locals {
   route_name   = "tfe"
-  tfe_hostname = "${local.route_name}-${var.namespace}.${data.ibm_container_vpc_cluster.cluster.ingress_hostname}" # Compute the TFE hostname based on the namespace and cluster ingress hostname. Not putting a depenency on the route resource here, as it is created after the helm release.
+  tfe_hostname = "${local.route_name}-${var.namespace}.${data.ibm_container_vpc_cluster.cluster.ingress_hostname}" # Compute the TFE hostname based on the namespace and cluster ingress hostname. Not putting a dependency on the route resource here, as it is created after the helm release.
 }
 
 

solutions/demo/catalogValidationValues.json.template

@@ -1,7 +1,7 @@
 {
   "ibmcloud_api_key": $VALIDATION_APIKEY,
   "existing_resource_group_name": $RG_NAME,
-  "prefix": $PREFIX,
+  "instance_name": $PREFIX,
   "tfe_license": $TFE_LICENSE,
   "admin_email": "validation@example.com",
   "admin_password": $RAND_PASSWORD,

solutions/demo/main.tf

@@ -2,9 +2,13 @@
 # Resource Group
 ########################################################################################################################
 
+locals {
+  prefix = var.prefix != null ? trimspace(var.prefix) != "" ? "${var.prefix}-" : "" : ""
+}
+
 module "tfe" {
   source                       = "../.."
-  prefix                       = var.prefix
+  instance_name                = "${local.prefix}${var.instance_name}"
   region                       = var.region
   existing_resource_group_name = var.existing_resource_group_name
   resource_tags                = var.resource_tags

solutions/demo/variables.tf

@@ -35,6 +35,13 @@ variable "prefix" {
   }
 }
 
+variable "instance_name" {
+  type        = string
+  description = "The name to use for TFE instance resources. If a prefix input variable is specified, the prefix is added to the name in the `<prefix>-<name>` format."
+  default     = "tfeinstance"
+  nullable    = false
+}
+
 variable "region" {
   type        = string
   description = "Region where resources are created"

tests/pr_test.go

@@ -80,6 +80,7 @@ func setupOptions(t *testing.T, prefix string, dir string) *testhelper.TestOptio
 		ResourceGroup:      resourceGroup,
 		BestRegionYAMLPath: regionSelectionPath,
 		TerraformVars: map[string]interface{}{
+			"instance_name":                "dev",
 			"add_to_catalog":               false,
 			"postgres_deletion_protection": false,
 		},
@@ -107,7 +108,7 @@ func setupOptions(t *testing.T, prefix string, dir string) *testhelper.TestOptio
 func TestRunCompleteExample(t *testing.T) {
 	t.Parallel()
 
-	options := setupOptions(t, "tfe-complete", completeExampleDir)
+	options := setupOptions(t, "compl", completeExampleDir)
 
 	output, err := options.RunTestConsistency()
 	assert.Nil(t, err, "This should not have errored")
@@ -119,7 +120,7 @@ func TestRunUpgradeExample(t *testing.T) {
 	t.Parallel()
 	t.Skip("Skip upgrade test while in Alpha release stage - resume upon official release")
 
-	options := setupOptions(t, "tfe-complete-upg", completeExampleDir)
+	options := setupOptions(t, "compl-upg", completeExampleDir)
 
 	output, err := options.RunTestUpgrade()
 	if !options.UpgradeTestSkipped {

variables.tf

@@ -2,36 +2,29 @@
 # Input Variables
 ########################################################################################################################
 
-# variable "ibmcloud_api_key" {
-#   type        = string
-#   description = "The IBM Cloud api key"
-#   sensitive   = true
-# }
-
-variable "prefix" {
+variable "instance_name" {
   type        = string
-  nullable    = true
-  description = "The prefix to add to all resources that this solution creates (e.g `prod`, `test`, `dev`). To skip using a prefix, set this value to null or an empty string. [Learn more](https://terraform-ibm-modules.github.io/documentation/#/prefix.md)."
+  nullable    = false
+  description = "The TFE instance name. The resources will be created starting from this, i.e. cluster will be named '[instance_name]_cluster'. Default set to tfe_instance"
+  default     = "tfe_instance"
 
   validation {
-    # - null and empty string is allowed
-    # - Must not contain consecutive hyphens (--): length(regexall("--", var.prefix)) == 0
+    # - Must not contain consecutive hyphens (--): length(regexall("--", var.instance_name)) == 0
     # - Starts with a lowercase letter: [a-z]
     # - Contains only lowercase letters (a–z), digits (0–9), and hyphens (-)
     # - Must not end with a hyphen (-): [a-z0-9]
-    condition = (var.prefix == null || var.prefix == "" ? true :
-      alltrue([
-        can(regex("^[a-z][-a-z0-9]*[a-z0-9]$", var.prefix)),
-        length(regexall("--", var.prefix)) == 0
-      ])
-    )
-    error_message = "Prefix must begin with a lowercase letter and may contain only lowercase letters, digits, and hyphens '-'. It must not end with a hyphen('-'), and cannot contain consecutive hyphens ('--')."
+    condition = alltrue([
+      can(regex("^[a-z][-a-z0-9]*[a-z0-9]$", var.instance_name)),
+      length(regexall("--", var.instance_name)) == 0
+    ])
+
+    error_message = "var.instance_name must begin with a lowercase letter and may contain only lowercase letters, digits, and hyphens '-'. It must not end with a hyphen('-'), and cannot contain consecutive hyphens ('--')."
   }
 
   validation {
     # must not exceed 16 characters in length
-    condition     = var.prefix == null || var.prefix == "" ? true : length(var.prefix) <= 16
-    error_message = "Prefix must not exceed 16 characters."
+    condition     = var.instance_name == null || var.instance_name == "" ? true : length(var.instance_name) <= 16
+    error_message = "instance_name must not exceed 16 characters."
   }
 }
 
@@ -109,7 +102,7 @@ variable "add_to_catalog" {
 
 variable "terraform_enterprise_engine_name" {
   type        = string
-  description = "Name to give to the Terraform Enterprise engine in account catalog settings. Defaults to '{prefix}-tfe' if not set."
+  description = "Name to give to the Terraform Enterprise engine in account catalog settings. Defaults to '{instance_name}-engine' if not set."
   default     = null
 }
 
@@ -150,7 +143,7 @@ variable "existing_cos_instance_id" {
 }
 
 variable "cos_instance_name" {
-  description = "Name of COS instance to create. If set to `null`, name will be `{prefix}-tfe`"
+  description = "Name of COS instance to create. If set to `null`, name will be `{instance_name}-cos`"
   type        = string
   default     = null
   validation {
@@ -160,7 +153,7 @@ variable "cos_instance_name" {
 }
 
 variable "cos_bucket_name" {
-  description = "Name of the bucket to create in COS instance. If set to `null`, name will be `{prefix}-tfe-bucket`"
+  description = "Name of the bucket to create in COS instance. If set to `null`, name will be `{instance_name}-bucket`"
   type        = string
   default     = null
 }
@@ -176,7 +169,7 @@ variable "cos_retention" {
 ##############################################################################
 
 variable "postgres_instance_name" {
-  description = "Name of postgres instance to create. If set to `null`, name will be `{prefix}-data-store`"
+  description = "Name of postgres instance to create. If set to `null`, name will be `{instance_name}-data-store`"
   type        = string
   default     = null
 }