chore: added elasticsearch_index and elasticsearch_cluster_settings resource block to basic example (#246)

Author: Khuzaima05

README.md

@@ -13,8 +13,8 @@
 * [Submodules](./modules)
     * [fscloud](./modules/fscloud)
 * [Examples](./examples)
-    * [Basic example](./examples/basic)
-    * [Complete example with autoscaling, BYOK encryption, service credentials creation, index creation and updates to cluster-wide settings](./examples/complete)
+    * [Basic example with index creation and updates to cluster-wide settings](./examples/basic)
+    * [Complete example with autoscaling, BYOK encryption and service credentials creation](./examples/complete)
     * [Financial Services Cloud profile example with autoscaling enabled](./examples/fscloud)
 * [Contributing](#contributing)
 <!-- END OVERVIEW HOOK -->

examples/basic/README.md

@@ -1,6 +1,8 @@
-# Basic example
+# Basic example with index creation and updates to cluster-wide settings
 
 An end-to-end example that creates the following infrastructure:
 
 - A resource group, if one is not passed in.
 - An ICD Elasticsearch database instance.
+- An Elasticsearch index
+- Updates to the cluster-wide settings

examples/basic/main.tf

@@ -14,11 +14,33 @@ module "resource_group" {
 ##############################################################################
 
 module "icd_elasticsearch" {
-  source                = "../../"
-  resource_group_id     = module.resource_group.resource_group_id
-  name                  = "${var.prefix}-elasticsearch"
-  region                = var.region
-  elasticsearch_version = var.elasticsearch_version
-  tags                  = var.resource_tags
-  access_tags           = var.access_tags
+  source                   = "../../"
+  resource_group_id        = module.resource_group.resource_group_id
+  name                     = "${var.prefix}-elasticsearch"
+  region                   = var.region
+  elasticsearch_version    = var.elasticsearch_version
+  tags                     = var.resource_tags
+  access_tags              = var.access_tags
+  service_credential_names = var.service_credential_names
+}
+
+# wait 15 secs to allow IAM credential access to kick in before configuring instance
+# without the wait, you can intermittently get "Error 401 (Unauthorized)"
+resource "time_sleep" "wait" {
+  depends_on      = [module.icd_elasticsearch]
+  create_duration = "15s"
+}
+
+resource "elasticsearch_index" "test" {
+  depends_on         = [time_sleep.wait]
+  name               = "terraform-test"
+  number_of_shards   = 1
+  number_of_replicas = 1
+  force_destroy      = true
+}
+
+resource "elasticsearch_cluster_settings" "global" {
+  depends_on                  = [time_sleep.wait]
+  cluster_max_shards_per_node = 10
+  action_auto_create_index    = "my-index-000001,index10,-index1*,+ind*"
 }

examples/basic/provider.tf

@@ -2,3 +2,10 @@ provider "ibm" {
   ibmcloud_api_key = var.ibmcloud_api_key
   region           = var.region
 }
+
+provider "elasticsearch" {
+  username    = module.icd_elasticsearch.service_credentials_object.credentials["elasticsearch_admin"].username
+  password    = module.icd_elasticsearch.service_credentials_object.credentials["elasticsearch_admin"].password
+  url         = "https://${module.icd_elasticsearch.service_credentials_object.hostname}:${module.icd_elasticsearch.service_credentials_object.port}"
+  cacert_file = base64decode(module.icd_elasticsearch.service_credentials_object.certificate)
+}

examples/basic/variables.tf

@@ -39,3 +39,14 @@ variable "resource_tags" {
   description = "Optional list of tags to be added to created resources"
   default     = []
 }
+
+variable "service_credential_names" {
+  description = "Map of name, role for service credentials that you want to create for the database"
+  type        = map(string)
+  default = {
+    "elasticsearch_admin" : "Administrator",
+    "elasticsearch_operator" : "Operator",
+    "elasticsearch_viewer" : "Viewer",
+    "elasticsearch_editor" : "Editor",
+  }
+}

examples/basic/version.tf

@@ -6,5 +6,16 @@ terraform {
       source  = "IBM-Cloud/ibm"
       version = "1.65.0"
     }
+    # The elasticsearch provider is not actually required by the module itself, just this example, so OK to use ">=" here instead of locking into a version
+    elasticsearch = {
+      source  = "phillbaker/elasticsearch"
+      version = ">= 2.0.7"
+    }
+
+    # The time provider is not actually required by the module itself, just this example, so OK to use ">=" here instead of locking into a version
+    time = {
+      source  = "hashicorp/time"
+      version = ">= 0.9.1"
+    }
   }
 }

examples/complete/README.md

@@ -1,4 +1,4 @@
-# Complete example with autoscaling, BYOK encryption, service credentials creation, index creation and updates to cluster-wide settings
+# Complete example with autoscaling, BYOK encryption and service credentials creation
 
 An end-to-end example that provisions the following infrastructure:
 
@@ -8,5 +8,3 @@ An end-to-end example that provisions the following infrastructure:
 - A Secrets Manager instance if one is not passed in.
 - Service credentials for the database instance.
 - A Secrets Manager secret containing the service credentials.
-- An Elasticsearch index
-- Updates to the cluster-wide settings

examples/complete/main.tf

@@ -65,26 +65,6 @@ module "icd_elasticsearch" {
   member_memory_mb           = 4096
 }
 
-# wait 15 secs to allow IAM credential access to kick in before configuring instance
-# without the wait, you can intermittently get "Error 401 (Unauthorized)"
-resource "time_sleep" "wait" {
-  depends_on      = [module.icd_elasticsearch]
-  create_duration = "15s"
-}
-
-resource "elasticsearch_index" "test" {
-  depends_on         = [time_sleep.wait]
-  name               = "terraform-test"
-  number_of_shards   = 1
-  number_of_replicas = 1
-  force_destroy      = true
-}
-
-resource "elasticsearch_cluster_settings" "global" {
-  depends_on                  = [time_sleep.wait]
-  cluster_max_shards_per_node = 10
-  action_auto_create_index    = "my-index-000001,index10,-index1*,+ind*"
-}
 
 ##############################################################################
 ## Secrets Manager layer

examples/complete/provider.tf

@@ -2,10 +2,3 @@ provider "ibm" {
   ibmcloud_api_key = var.ibmcloud_api_key
   region           = var.region
 }
-
-provider "elasticsearch" {
-  username    = module.icd_elasticsearch.service_credentials_object.credentials["es_admin"].username
-  password    = module.icd_elasticsearch.service_credentials_object.credentials["es_admin"].password
-  url         = "https://${module.icd_elasticsearch.service_credentials_object.hostname}:${module.icd_elasticsearch.service_credentials_object.port}"
-  cacert_file = base64decode(module.icd_elasticsearch.service_credentials_object.certificate)
-}

examples/complete/version.tf

@@ -6,15 +6,5 @@ terraform {
       source  = "IBM-Cloud/ibm"
       version = ">=1.65.0, <2.0.0"
     }
-    # The elasticsearch provider is not actually required by the module itself, just this example, so OK to use ">=" here instead of locking into a version
-    elasticsearch = {
-      source  = "phillbaker/elasticsearch"
-      version = ">= 2.0.7"
-    }
-    # The time provider is not actually required by the module itself, just this example, so OK to use ">=" here instead of locking into a version
-    time = {
-      source  = "hashicorp/time"
-      version = ">= 0.9.1"
-    }
   }
 }