feat: added prefix as an optional input for the DA solution (#181)

Author: iamar7

common-dev-assets

@@ -1,17 +1,33 @@
+#######################################################################################################################
+# Local Variables
+#######################################################################################################################
+
 locals {
   existing_kms_instance_crn_split = var.existing_kms_instance_crn != null ? split(":", var.existing_kms_instance_crn) : null
   existing_kms_instance_guid      = var.existing_kms_instance_crn != null ? element(local.existing_kms_instance_crn_split, length(local.existing_kms_instance_crn_split) - 3) : null
   existing_kms_instance_region    = var.existing_kms_instance_crn != null ? element(local.existing_kms_instance_crn_split, length(local.existing_kms_instance_crn_split) - 5) : null
+
+  elasticsearch_key_name      = var.prefix != null ? "${var.prefix}-${var.elasticsearch_key_name}" : var.elasticsearch_key_name
+  elasticsearch_key_ring_name = var.prefix != null ? "${var.prefix}-${var.elasticsearch_key_ring_name}" : var.elasticsearch_key_ring_name
+
+  kms_key_crn = var.existing_kms_key_crn != null ? var.existing_kms_key_crn : module.kms[0].keys[format("%s.%s", local.elasticsearch_key_ring_name, local.elasticsearch_key_name)].crn
 }
 
+#######################################################################################################################
+# Resource Group
+#######################################################################################################################
+
 module "resource_group" {
   source                       = "terraform-ibm-modules/resource-group/ibm"
   version                      = "1.1.5"
-  resource_group_name          = var.existing_resource_group == false ? var.resource_group_name : null
+  resource_group_name          = var.existing_resource_group == false ? (var.prefix != null ? "${var.prefix}-${var.resource_group_name}" : var.resource_group_name) : null
   existing_resource_group_name = var.existing_resource_group == true ? var.resource_group_name : null
 }
 
+#######################################################################################################################
 # KMS root key for Elasticsearch
+#######################################################################################################################
+
 module "kms" {
   providers = {
     ibm = ibm.kms
@@ -26,12 +42,12 @@ module "kms" {
   key_endpoint_type           = var.kms_endpoint_type
   keys = [
     {
-      key_ring_name         = var.elasticsearch_key_ring_name
+      key_ring_name         = local.elasticsearch_key_ring_name
       existing_key_ring     = false
       force_delete_key_ring = true
       keys = [
         {
-          key_name                 = var.elasticsearch_key_name
+          key_name                 = local.elasticsearch_key_name
           standard_key             = false
           rotation_interval_month  = 3
           dual_auth_delete_enabled = false
@@ -42,14 +58,14 @@ module "kms" {
   ]
 }
 
-locals {
-  kms_key_crn = var.existing_kms_key_crn != null ? var.existing_kms_key_crn : module.kms[0].keys[format("%s.%s", var.elasticsearch_key_ring_name, var.elasticsearch_key_name)].crn
-}
+#######################################################################################################################
+# Elasticsearch
+#######################################################################################################################
 
 module "elasticsearch" {
   source                        = "../../modules/fscloud"
   resource_group_id             = module.resource_group.resource_group_id
-  name                          = var.name
+  name                          = var.prefix != null ? "${var.prefix}-${var.name}" : var.name
   region                        = var.region
   plan                          = var.plan
   skip_iam_authorization_policy = var.skip_iam_authorization_policy

solutions/secure/main.tf

@@ -11,12 +11,19 @@ variable "existing_resource_group" {
 
 variable "resource_group_name" {
   type        = string
-  description = "The name of a new or an existing resource group in which to provision the Databases for Elasicsearch in."
+  description = "The name of a new or an existing resource group in which to provision the Databases for Elasicsearch in.  If a `prefix` input variable is specified, it is added to this name in the `<prefix>-value` format."
+}
+
+variable "prefix" {
+  type        = string
+  description = "Prefix to add to all resources created by this solution."
+  default     = null
 }
 
 variable "name" {
-  description = "The name of the Elasticsearch instance"
   type        = string
+  description = "The name of the Databases for Elasticsearch instance. If a `prefix` input variable is specified, it is added to this name in the `<prefix>-value` format."
+  default     = "elasticsearch"
 }
 
 variable "region" {
@@ -129,13 +136,13 @@ variable "skip_iam_authorization_policy" {
 variable "elasticsearch_key_ring_name" {
   type        = string
   default     = "elasticsearch-key-ring"
-  description = "The name to give the Key Ring which will be created for the Elasticsearch Key. Not used if supplying an existing Key."
+  description = "The name to give the key ring that is created for the Databases for Elasticsearch key. Not used if `existing_kms_key_crn` is specified. If a `prefix` input variable is specified, it is added to this name in the `<prefix>-value` format."
 }
 
 variable "elasticsearch_key_name" {
   type        = string
   default     = "elasticsearch-key"
-  description = "The name to give the Key which will be created for the Elasticsearch. Not used if supplying an existing Key."
+  description = "The name to give the key that is created for the Databases for Elasticsearch key. Not used if `existing_kms_key_crn` is specified. If a `prefix` input variable is specified, it is added to this name in the `<prefix>-value` format."
 }
 
 variable "auto_scaling" {

solutions/secure/variables.tf

@@ -93,7 +93,7 @@ func setupOptionsSecureSolution(t *testing.T, prefix string) *testhelper.TestOpt
 		"existing_kms_instance_crn": permanentResources["hpcs_south_crn"],
 		"kms_endpoint_type":         "public",
 		"resource_group_name":       options.Prefix,
-		"name":                      options.Prefix,
+		"prefix":                    options.Prefix,
 	}
 
 	return options