feat: added support for creating a new PostgreSQL instance pointing to a PITR (#114)

Author: Ak-sky

README.md

@@ -54,6 +54,7 @@ You need the following permissions to run this module.
 - [ Complete example with byok encryption, CBR rules and storing credentials in secrets manager](examples/complete)
 - [ Default example](examples/default)
 - [ Financial Services Cloud profile example](examples/fscloud)
+- [ Point in time recovery example (PITR)](examples/pitr)
 - [ Replica example](examples/replica)
 <!-- END EXAMPLES HOOK -->
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
@@ -94,6 +95,8 @@ You need the following permissions to run this module.
 | <a name="input_members"></a> [members](#input\_members) | Number of members | `number` | `3` | no |
 | <a name="input_name"></a> [name](#input\_name) | Name of the Postgresql instance | `string` | n/a | yes |
 | <a name="input_pg_version"></a> [pg\_version](#input\_pg\_version) | Version of the postgresql instance | `string` | `null` | no |
+| <a name="input_pitr_id"></a> [pitr\_id](#input\_pitr\_id) | (Optional) The ID of the postgresql instance that you want to recover back to. Here ID of the postgresql instance is expected to be up and in running state. | `string` | `null` | no |
+| <a name="input_pitr_time"></a> [pitr\_time](#input\_pitr\_time) | (Optional) The timestamp in UTC format (%Y-%m-%dT%H:%M:%SZ) that you want to restore to. To retrieve the timestamp, run the command (ibmcloud cdb postgresql earliest-pitr-timestamp <deployment name or CRN>) | `string` | `null` | no |
 | <a name="input_plan_validation"></a> [plan\_validation](#input\_plan\_validation) | Enable or disable validating the database parameters for postgres during the plan phase | `bool` | `true` | no |
 | <a name="input_region"></a> [region](#input\_region) | The region postgresql is to be created on. The region must support BYOK if key\_protect\_key\_crn is used | `string` | `"us-south"` | no |
 | <a name="input_remote_leader_crn"></a> [remote\_leader\_crn](#input\_remote\_leader\_crn) | The CRN of the leader database to make the replica(read-only) deployment. | `string` | `null` | no |

examples/pitr/README.md

@@ -0,0 +1,7 @@
+# Point in time recovery example (PITR)
+
+This example provides an end-to-end creation of a new PostgreSQL instance, then creating a new PostgreSQL instance pointing to a PITR time. This example uses the IBM Cloud terraform provider to:
+
+- Create a new resource group if one is not passed in.
+- Create a new ICD Postgresql database instance.
+- Create a new PostgreSQL instance pointing to a PITR time.

examples/pitr/main.tf

@@ -0,0 +1,29 @@
+##############################################################################
+# Resource Group
+##############################################################################
+
+module "resource_group" {
+  source = "git::https://github.com/terraform-ibm-modules/terraform-ibm-resource-group.git?ref=v1.0.5"
+  # 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_point_in_time_recovery" "database_pitr" {
+  deployment_id = var.pitr_id
+}
+
+# New ICD postgresql database instance pointing to a PITR time
+module "postgresql_db_pitr" {
+  source            = "../.."
+  resource_group_id = module.resource_group.resource_group_id
+  name              = "${var.prefix}-postgres-pitr"
+  region            = var.region
+  resource_tags     = var.resource_tags
+  configuration     = var.configuration
+  member_memory_mb  = var.member_memory_mb
+  member_disk_mb    = var.member_disk_mb
+  member_cpu_count  = var.member_cpu_count
+  pitr_id           = var.pitr_id
+  pitr_time         = data.ibm_database_point_in_time_recovery.database_pitr.earliest_point_in_time_recovery_time
+}

examples/pitr/outputs.tf

@@ -0,0 +1,18 @@
+##############################################################################
+# Outputs
+##############################################################################
+
+output "pitr_postgresql_db_id" {
+  description = "PITR Postgresql instance id"
+  value       = module.postgresql_db_pitr.id
+}
+
+output "pitr_postgresql_db_version" {
+  description = "PITR Postgresql instance version"
+  value       = module.postgresql_db_pitr.version
+}
+
+output "pitr_time" {
+  description = "PITR timestamp in UTC format (%Y-%m-%dT%H:%M:%SZ) used to create PITR instance"
+  value       = data.ibm_database_point_in_time_recovery.database_pitr.earliest_point_in_time_recovery_time
+}

examples/pitr/provider.tf

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

examples/pitr/variables.tf

@@ -0,0 +1,91 @@
+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     = "pg"
+}
+
+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 "configuration" {
+  description = "(Optional, Json String) Database Configuration in JSON format."
+  type = object({
+    max_connections            = optional(number)
+    max_prepared_transactions  = optional(number)
+    deadlock_timeout           = optional(number)
+    effective_io_concurrency   = optional(number)
+    max_replication_slots      = optional(number)
+    max_wal_senders            = optional(number)
+    shared_buffers             = optional(number)
+    synchronous_commit         = optional(string)
+    wal_level                  = optional(string)
+    archive_timeout            = optional(number)
+    log_min_duration_statement = optional(number)
+  })
+  default = null
+}
+
+variable "pitr_id" {
+  type        = string
+  description = "The ID of the postgresql instance that you want to recover back to. Here ID of the postgresql instance is expected to be up and in running state."
+}
+
+variable "member_memory_mb" {
+  type        = string
+  description = "Memory allocation required for postgresql read-only replica database"
+  default     = "7680"
+  validation {
+    condition = alltrue([
+      var.member_memory_mb >= 3072,
+      var.member_memory_mb <= 114688
+    ])
+    error_message = "member group memory must be >= 3072 and <= 114688 in increments of 384"
+  }
+}
+
+variable "member_disk_mb" {
+  type        = string
+  description = "Disk allocation required for postgresql read-only replica database"
+  default     = "15360"
+  validation {
+    condition = alltrue([
+      var.member_disk_mb >= 15360,
+      var.member_disk_mb <= 4194304
+    ])
+    error_message = "member group disk must be >= 15360 and <= 4194304 in increments of 1536"
+  }
+}
+
+variable "member_cpu_count" {
+  type        = string
+  description = "CPU allocation required for the postgresql read-only replica database"
+  default     = "9"
+  validation {
+    condition = alltrue([
+      var.member_cpu_count >= 9,
+      var.member_cpu_count <= 28
+    ])
+    error_message = "member group cpu must be >= 9 and <= 28 in increments of 1"
+  }
+}

examples/pitr/version.tf

@@ -0,0 +1,10 @@
+terraform {
+  required_version = ">= 1.3.0"
+  required_providers {
+    # Pin to the lowest provider version of the range defined in the main module's version.tf to ensure lowest version still works
+    ibm = {
+      source  = "IBM-Cloud/ibm"
+      version = "1.49.0"
+    }
+  }
+}

main.tf

@@ -27,6 +27,9 @@ resource "ibm_database" "postgresql_db" {
   key_protect_key           = var.key_protect_key_crn
   backup_encryption_key_crn = local.kp_backup_crn
 
+  point_in_time_recovery_deployment_id = var.pitr_id
+  point_in_time_recovery_time          = var.pitr_time
+
   dynamic "allowlist" {
     for_each = (var.allowlist != null ? var.allowlist : [])
     content {

module-metadata.json

@@ -150,6 +150,30 @@
       "immutable": true,
       "computed": true
     },
+    "pitr_id": {
+      "name": "pitr_id",
+      "type": "string",
+      "description": "(Optional) The ID of the postgresql instance that you want to recover back to. Here ID of the postgresql instance is expected to be up and in running state.",
+      "source": [
+        "ibm_database.postgresql_db.point_in_time_recovery_deployment_id"
+      ],
+      "pos": {
+        "filename": "variables.tf",
+        "line": 240
+      }
+    },
+    "pitr_time": {
+      "name": "pitr_time",
+      "type": "string",
+      "description": "(Optional) The timestamp in UTC format (%Y-%m-%dT%H:%M:%SZ) that you want to restore to. To retrieve the timestamp, run the command (ibmcloud cdb postgresql earliest-pitr-timestamp \u003cdeployment name or CRN\u003e)",
+      "source": [
+        "ibm_database.postgresql_db.point_in_time_recovery_time"
+      ],
+      "pos": {
+        "filename": "variables.tf",
+        "line": 246
+      }
+    },
     "plan_validation": {
       "name": "plan_validation",
       "type": "bool",
@@ -351,6 +375,8 @@
         "location": "region",
         "name": "name",
         "plan_validation": "plan_validation",
+        "point_in_time_recovery_deployment_id": "pitr_id",
+        "point_in_time_recovery_time": "pitr_time",
         "remote_leader_id": "remote_leader_crn",
         "resource_group_id": "resource_group_id",
         "service_endpoints": "service_endpoints",
@@ -378,7 +404,7 @@
       },
       "pos": {
         "filename": "main.tf",
-        "line": 145
+        "line": 148
       }
     }
   },
@@ -457,7 +483,7 @@
       },
       "pos": {
         "filename": "main.tf",
-        "line": 107
+        "line": 110
       }
     }
   }

tests/pr_test.go

@@ -2,10 +2,12 @@
 package test
 
 import (
-	"testing"
-
 	"github.com/stretchr/testify/assert"
+	"github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper/common"
 	"github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper/testhelper"
+	"log"
+	"os"
+	"testing"
 )
 
 // Use existing resource group
@@ -15,10 +17,13 @@ const autoscaleExampleTerraformDir = "examples/autoscale"
 const fsCloudTerraformDir = "examples/fscloud"
 const completeExampleTerraformDir = "examples/complete"
 const replicaExampleTerraformDir = "examples/replica"
+const pitrTerraformDir = "examples/pitr"
 
 // Restricting due to limited availability of BYOK in certain regions
 const regionSelectionPath = "../common-dev-assets/common-go-assets/icd-region-prefs.yaml"
 
+const yamlLocation = "../common-dev-assets/common-go-assets/common-permanent-resources.yaml"
+
 func TestRunDefaultExample(t *testing.T) {
 	t.Parallel()
 
@@ -119,3 +124,35 @@ func TestRunUpgradeExample(t *testing.T) {
 		assert.NotNil(t, output, "Expected some output")
 	}
 }
+
+var permanentResources map[string]interface{}
+
+// TestMain will be run before any parallel tests, used to read data from yaml for use with tests
+func TestMain(m *testing.M) {
+
+	var err error
+	permanentResources, err = common.LoadMapFromYaml(yamlLocation)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	os.Exit(m.Run())
+}
+
+func TestRunPointInTimeRecoveryDBExample(t *testing.T) {
+	t.Parallel()
+
+	options := testhelper.TestOptionsDefaultWithVars(&testhelper.TestOptions{
+		Testing:       t,
+		TerraformDir:  pitrTerraformDir,
+		Prefix:        "pg-pitr",
+		ResourceGroup: resourceGroup,
+		TerraformVars: map[string]interface{}{
+			"pitr_id": permanentResources["postgresqlCrn"],
+		},
+	})
+
+	output, err := options.RunTestConsistency()
+	assert.Nil(t, err, "This should not have errored")
+	assert.NotNil(t, output, "Expected some output")
+}