feat: added missing examples and plugged test gaps

Author: Aditya-ranjan-16

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "go.sum|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2024-12-09T17:04:45Z",
+  "generated_at": "2025-01-09T06:09:34Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -82,7 +82,7 @@
         "hashed_secret": "33da8d0e8af2efc260f01d8e5edfcc5c5aba44ad",
         "is_secret": true,
         "is_verified": false,
-        "line_number": 35,
+        "line_number": 36,
         "type": "Secret Keyword",
         "verified_result": null
       }

README.md

@@ -16,6 +16,7 @@
     * [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)
+    * [Restore from backup example](./examples/backup-restore)
 * [Contributing](#contributing)
 <!-- END OVERVIEW HOOK -->
 

common-dev-assets

@@ -0,0 +1,7 @@
+# Restore from backup example
+
+This example provides an end-to-end executable flow of how a Elasticsearch DB can be created from a backup instance. This example uses the IBM Cloud terraform provider to:
+
+- Create a new resource group if one is not passed in.
+- Create a new ICD Elasticsearch database instance if no existing backup crn is provided.
+- Create a restored ICD Elasticsearch database instance pointing to the backup of the first instance.

examples/backup-restore/README.MD

@@ -0,0 +1,6 @@
+{
+  "ibmcloud_api_key": $VALIDATION_APIKEY,
+  "region": "us-south",
+  "resource_tags": $TAGS,
+  "prefix": $PREFIX
+}

examples/backup-restore/catalogValidationValues.json.template

@@ -0,0 +1,28 @@
+##############################################################################
+# Resource Group
+##############################################################################
+
+module "resource_group" {
+  source  = "terraform-ibm-modules/resource-group/ibm"
+  version = "1.1.6"
+  # if an existing resource group is not set (null) create a new one using prefix
+  resource_group_name          = var.resource_group == null ? "${var.prefix}-resource-group" : null
+  existing_resource_group_name = var.resource_group
+}
+
+
+data "ibm_database_backups" "backup_database" {
+  deployment_id = var.elasticsearch_db_backup_crn
+}
+# New elasticsearch instance pointing to the backup instance
+module "restored_icd_elasticsearch" {
+  source             = "../.."
+  resource_group_id  = module.resource_group.resource_group_id
+  name               = "${var.prefix}-elasticsearch-restored"
+  elasticsearch_version = var.elasticsearch_version
+  region             = var.region
+  tags      = var.resource_tags
+  access_tags        = var.access_tags
+  member_host_flavor = "multitenant"
+  backup_crn         = data.ibm_database_backups.backup_database.backups[0].backup_id
+}

examples/backup-restore/main.tf

@@ -0,0 +1,12 @@
+##############################################################################
+# Outputs
+##############################################################################
+output "restored_icd_elasticsearch_id" {
+  description = "Restored elasticsearch instance id"
+  value       = module.restored_icd_elasticsearch.id
+}
+
+output "restored_icd_elasticsearch_version" {
+  description = "Restored elasticsearch instance version"
+  value       = module.restored_icd_elasticsearch.version
+}

examples/backup-restore/outputs.tf

@@ -0,0 +1,4 @@
+provider "ibm" {
+  ibmcloud_api_key = var.ibmcloud_api_key
+  region           = var.region
+}

examples/backup-restore/provider.tf

@@ -0,0 +1,46 @@
+variable "ibmcloud_api_key" {
+  type        = string
+  description = "The IBM Cloud API Key"
+  sensitive   = true
+}
+
+variable "region" {
+  type        = string
+  description = "Region to provision all resources created by this example."
+  default     = "us-south"
+}
+
+variable "prefix" {
+  type        = string
+  description = "Prefix to append to all resources created by this example"
+  default = "backup"
+}
+
+variable "elasticsearch_version" {
+  type        = string
+   description = "Version of the elasticsearch instance. If no value passed, the current ICD preferred version is used."
+  default     = null
+}
+variable "resource_group" {
+  type        = string
+  description = "An existing resource group name to use for this example, if unset a new resource group will be created"
+  default     = null
+}
+
+variable "resource_tags" {
+  type        = list(string)
+  description = "Optional list of tags to be added to created resources"
+  default     = []
+}
+
+variable "access_tags" {
+  type        = list(string)
+  description = "A list of access tags to apply to the elasticsearch instance created by the module, see https://cloud.ibm.com/docs/account?topic=account-access-tags-tutorial for more details"
+  default     = []
+}
+
+variable "elasticsearch_db_backup_crn" {
+  type        = string
+  description = "The existing CRN of a backup resource to restore from. If null then it will create a new instance first and then create another instance pointing to the backup of the first instance."
+  default     = null
+}

examples/backup-restore/variables.tf

@@ -0,0 +1,11 @@
+terraform {
+  required_version = ">= 1.3.0"
+  required_providers {
+    # 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 example), and 1 example that will always use the latest provider version (complete example).
+    ibm = {
+      source  = "IBM-Cloud/ibm"
+      version = ">=1.70.0, <2.0.0"
+    }
+  }
+}