feat: Module updates (#336)

Author: Aditya-ranjan-16

README.md

@@ -108,23 +108,23 @@ To attach access management tags to resources in this module, you need the follo
 | <a name="input_backup_encryption_key_crn"></a> [backup\_encryption\_key\_crn](#input\_backup\_encryption\_key\_crn) | The CRN of a Key Protect or Hyper Protect Crypto Services encryption key that you want to use for encrypting the disk that holds deployment backups. Applies only if `use_ibm_owned_encryption_key` is false and `use_same_kms_key_for_backups` is false. If no value is passed, and `use_same_kms_key_for_backups` is true, the value of `kms_key_crn` is used. Alternatively set `use_default_backup_encryption_key` to true to use the IBM Cloud Databases default encryption. Bare in mind that backups encryption is only available in certain regions. See [Bring your own key for backups](https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-key-protect&interface=ui#key-byok) and [Using the HPCS Key for Backup encryption](https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-hpcs#use-hpcs-backups). | `string` | `null` | no |
 | <a name="input_cbr_rules"></a> [cbr\_rules](#input\_cbr\_rules) | (Optional, list) List of CBR rules to create | <pre>list(object({<br/>    description = string<br/>    account_id  = string<br/>    rule_contexts = list(object({<br/>      attributes = optional(list(object({<br/>        name  = string<br/>        value = string<br/>    }))) }))<br/>    enforcement_mode = string<br/>  }))</pre> | `[]` | no |
 | <a name="input_configuration"></a> [configuration](#input\_configuration) | Database configuration. [Learn more](https://cloud.ibm.com/apidocs/cloud-databases-api/cloud-databases-api-v4#setdatabaseconfiguration-request) | <pre>object({<br/>    max_connections            = optional(number)<br/>    max_prepared_transactions  = optional(number)<br/>    deadlock_timeout           = optional(number)<br/>    effective_io_concurrency   = optional(number)<br/>    max_replication_slots      = optional(number)<br/>    max_wal_senders            = optional(number)<br/>    shared_buffers             = optional(number)<br/>    synchronous_commit         = optional(string)<br/>    wal_level                  = optional(string)<br/>    archive_timeout            = optional(number)<br/>    log_min_duration_statement = optional(number)<br/>  })</pre> | `null` | no |
+| <a name="input_cpu_count"></a> [cpu\_count](#input\_cpu\_count) | Allocated dedicated CPU per member. Minimum number of CPU allowed is 3. [Learn more](https://cloud.ibm.com/docs/databases-for-enterprisedb?topic=databases-for-enterprisedb-resources-scaling) | `number` | `3` | no |
+| <a name="input_disk_mb"></a> [disk\_mb](#input\_disk\_mb) | Allocated disk per member. [Learn more](https://cloud.ibm.com/docs/databases-for-enterprisedb?topic=databases-for-enterprisedb-resources-scaling) | `number` | `20480` | no |
 | <a name="input_edb_version"></a> [edb\_version](#input\_edb\_version) | Version of the Enterprise DB instance to provision. If no value is passed, the current preferred version of IBM Cloud Databases is used. For our version policy, see https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-versioning-policy for more details | `string` | `null` | no |
 | <a name="input_kms_key_crn"></a> [kms\_key\_crn](#input\_kms\_key\_crn) | The CRN of a Key Protect or Hyper Protect Crypto Services encryption key to encrypt your data. Applies only if `use_ibm_owned_encryption_key` is false. By default this key is used for both deployment data and backups, but this behaviour can be altered using the `use_same_kms_key_for_backups` and `backup_encryption_key_crn` inputs. Bare in mind that backups encryption is only available in certain regions. See [Bring your own key for backups](https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-key-protect&interface=ui#key-byok) and [Using the HPCS Key for Backup encryption](https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-hpcs#use-hpcs-backups). | `string` | `null` | no |
-| <a name="input_member_cpu_count"></a> [member\_cpu\_count](#input\_member\_cpu\_count) | Allocated dedicated CPU per member. Minimum number of CPU allowed is 3. [Learn more](https://cloud.ibm.com/docs/databases-for-enterprisedb?topic=databases-for-enterprisedb-resources-scaling) | `number` | `3` | no |
-| <a name="input_member_disk_mb"></a> [member\_disk\_mb](#input\_member\_disk\_mb) | Allocated disk per member. [Learn more](https://cloud.ibm.com/docs/databases-for-enterprisedb?topic=databases-for-enterprisedb-resources-scaling) | `number` | `20480` | no |
 | <a name="input_member_host_flavor"></a> [member\_host\_flavor](#input\_member\_host\_flavor) | Allocated host flavor per member. [Learn more](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/database#host_flavor). | `string` | `null` | no |
-| <a name="input_member_memory_mb"></a> [member\_memory\_mb](#input\_member\_memory\_mb) | Allocated memory per member. [Learn more](https://cloud.ibm.com/docs/databases-for-enterprisedb?topic=databases-for-enterprisedb-resources-scaling) | `number` | `4096` | no |
 | <a name="input_members"></a> [members](#input\_members) | Allocated number of members. Members can be scaled up but not down. | `number` | `3` | no |
+| <a name="input_memory_mb"></a> [memory\_mb](#input\_memory\_mb) | Allocated memory per member. [Learn more](https://cloud.ibm.com/docs/databases-for-enterprisedb?topic=databases-for-enterprisedb-resources-scaling) | `number` | `4096` | no |
 | <a name="input_name"></a> [name](#input\_name) | The name given to the Enterprise DB instance. | `string` | n/a | yes |
 | <a name="input_pitr_id"></a> [pitr\_id](#input\_pitr\_id) | (Optional) The ID of the source deployment EDB instance that you want to recover back to. The EDB instance is expected to be in an 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>). For more info on Point-in-time Recovery, see https://cloud.ibm.com/docs/databases-for-enterprisedb?topic=databases-for-enterprisedb-pitr | `string` | `null` | no |
 | <a name="input_region"></a> [region](#input\_region) | The region where you want to deploy your instance. | `string` | `"us-south"` | no |
 | <a name="input_remote_leader_crn"></a> [remote\_leader\_crn](#input\_remote\_leader\_crn) | A CRN of the leader database to make the replica(read-only) deployment. The leader database is created by a database deployment with the same service ID. A read-only replica is set up to replicate all of your data from the leader deployment to the replica deployment by using asynchronous replication. For more information, see https://cloud.ibm.com/docs/databases-for-enterprisedb?topic=databases-for-enterprisedb-read-only-replicas | `string` | `null` | no |
 | <a name="input_resource_group_id"></a> [resource\_group\_id](#input\_resource\_group\_id) | The resource group ID where Enterprise DB instance will be created. | `string` | n/a | yes |
-| <a name="input_resource_tags"></a> [resource\_tags](#input\_resource\_tags) | Optional list of tags to be added to the Enterprise DB instance. | `list(string)` | `[]` | no |
 | <a name="input_service_credential_names"></a> [service\_credential\_names](#input\_service\_credential\_names) | Map of name, role for service credentials that you want to create for the database | `map(string)` | `{}` | no |
 | <a name="input_service_endpoints"></a> [service\_endpoints](#input\_service\_endpoints) | Specify whether you want to enable the public, private, or both service endpoints. Supported values are 'public', 'private', or 'public-and-private'. | `string` | `"private"` | no |
 | <a name="input_skip_iam_authorization_policy"></a> [skip\_iam\_authorization\_policy](#input\_skip\_iam\_authorization\_policy) | Set to true to skip the creation of IAM authorization policies that permits all Databases for EnterpriseDB instances in the given resource group 'Reader' access to the Key Protect or Hyper Protect Crypto Services key that was provided in the `kms_key_crn` and `backup_encryption_key_crn` inputs. This policy is required in order to enable KMS encryption, so only skip creation if there is one already present in your account. No policy is created if `use_ibm_owned_encryption_key` is true. | `bool` | `false` | no |
+| <a name="input_tags"></a> [tags](#input\_tags) | Optional list of tags to be added to the Enterprise DB instance. | `list(string)` | `[]` | no |
 | <a name="input_use_default_backup_encryption_key"></a> [use\_default\_backup\_encryption\_key](#input\_use\_default\_backup\_encryption\_key) | When `use_ibm_owned_encryption_key` is set to false, backups will be encrypted with either the key specified in `kms_key_crn`, or in `backup_encryption_key_crn` if a value is passed. If you do not want to use your own key for backups encryption, you can set this to `true` to use the IBM Cloud Databases default encryption for backups. Alternatively set `use_ibm_owned_encryption_key` to true to use the default encryption for both backups and deployment data. | `bool` | `false` | no |
 | <a name="input_use_ibm_owned_encryption_key"></a> [use\_ibm\_owned\_encryption\_key](#input\_use\_ibm\_owned\_encryption\_key) | IBM Cloud Databases will secure your deployment's data at rest automatically with an encryption key that IBM hold. Alternatively, you may select your own Key Management System instance and encryption key (Key Protect or Hyper Protect Crypto Services) by setting this to false. If setting to false, a value must be passed for the `kms_key_crn` input. | `bool` | `true` | no |
 | <a name="input_use_same_kms_key_for_backups"></a> [use\_same\_kms\_key\_for\_backups](#input\_use\_same\_kms\_key\_for\_backups) | Set this to false if you wan't to use a different key that you own to encrypt backups. When set to false, a value is required for the `backup_encryption_key_crn` input. Alternatiely set `use_default_backup_encryption_key` to true to use the IBM Cloud Databases default encryption. Applies only if `use_ibm_owned_encryption_key` is false. Bare in mind that backups encryption is only available in certain regions. See [Bring your own key for backups](https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-key-protect&interface=ui#key-byok) and [Using the HPCS Key for Backup encryption](https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-hpcs#use-hpcs-backups). | `bool` | `true` | no |

examples/backup/main.tf

@@ -10,32 +10,18 @@ module "resource_group" {
   existing_resource_group_name = var.resource_group
 }
 
-module "enterprise_db" {
-  count              = var.enterprise_db_backup_crn != null ? 0 : 1
-  source             = "../.."
-  resource_group_id  = module.resource_group.resource_group_id
-  name               = "${var.prefix}-edb"
-  edb_version        = var.edb_version
-  region             = var.region
-  resource_tags      = var.resource_tags
-  access_tags        = var.access_tags
-  member_host_flavor = "b3c.4x16.encrypted"
-}
-
 data "ibm_database_backups" "backup_database" {
-  count         = var.enterprise_db_backup_crn != null ? 0 : 1
-  deployment_id = module.enterprise_db[0].id
+  deployment_id = var.existing_database_crn
 }
-
 # New enterprise db instance pointing to the backup instance
-module "restored_enterprise_db" {
+module "restored_icd_enterprise_db" {
   source             = "../.."
   resource_group_id  = module.resource_group.resource_group_id
   name               = "${var.prefix}-edb-restored"
   edb_version        = var.edb_version
   region             = var.region
-  resource_tags      = var.resource_tags
+  tags               = var.resource_tags
   access_tags        = var.access_tags
   member_host_flavor = "b3c.4x16.encrypted"
-  backup_crn         = var.enterprise_db_backup_crn == null ? data.ibm_database_backups.backup_database[0].backups[0].backup_id : var.enterprise_db_backup_crn
+  backup_crn         = data.ibm_database_backups.backup_database.backups[0].backup_id
 }

examples/backup/outputs.tf

@@ -1,17 +1,12 @@
 ##############################################################################
 # Outputs
 ##############################################################################
-output "id" {
-  description = "Enterprise DB instance id"
-  value       = var.enterprise_db_backup_crn == null ? module.enterprise_db[0].id : null
-}
-
-output "restored_enterprise_db_id" {
+output "restored_icd_enterprise_db_id" {
   description = "Restored Enterprise DB instance id"
-  value       = module.restored_enterprise_db.id
+  value       = module.restored_icd_enterprise_db.id
 }
 
-output "restored_enterprise_db_version" {
+output "restored_icd_enterprise_db_version" {
   description = "Restored Enterprise DB instance version"
-  value       = module.restored_enterprise_db.version
+  value       = module.restored_icd_enterprise_db.version
 }

examples/backup/variables.tf

@@ -40,7 +40,7 @@ variable "access_tags" {
   default     = []
 }
 
-variable "enterprise_db_backup_crn" {
+variable "existing_database_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/basic/main.tf

@@ -14,14 +14,21 @@ module "resource_group" {
 # ICD Enterprise database
 ##############################################################################
 
-module "enterprise_db" {
+module "database" {
   source            = "../.."
   resource_group_id = module.resource_group.resource_group_id
   name              = "${var.prefix}-edb"
   edb_version       = var.edb_version
   region            = var.region
-  resource_tags     = var.resource_tags
+  tags              = var.resource_tags
   access_tags       = var.access_tags
+  service_endpoints = var.service_endpoints
+  service_credential_names = {
+    "enterprisedb_admin" : "Administrator",
+    "enterprisedb_operator" : "Operator",
+    "enterprisedb_viewer" : "Viewer",
+    "enterprisedb_editor" : "Editor",
+  }
 }
 
 ##############################################################################
@@ -34,10 +41,10 @@ module "read_only_replica_enterprise_db" {
   resource_group_id = module.resource_group.resource_group_id
   name              = "${var.prefix}-read-only-replica-${count.index}"
   region            = var.region
-  resource_tags     = var.resource_tags
+  tags              = var.resource_tags
   access_tags       = var.access_tags
   edb_version       = var.edb_version
-  remote_leader_crn = module.enterprise_db.crn
-  member_memory_mb  = 4096  # The minimum size of a read-only replica is 3 GB RAM
-  member_disk_mb    = 61440 # The minimum size of a read-only replica is 60 GB of disk
+  remote_leader_crn = module.database.crn
+  memory_mb         = 4096  # The minimum size of a read-only replica is 3 GB RAM
+  disk_mb           = 61440 # The minimum size of a read-only replica is 60 GB of disk
 }

examples/basic/outputs.tf

@@ -3,31 +3,36 @@
 ##############################################################################
 output "id" {
   description = "Enterprise DB instance id"
-  value       = module.enterprise_db.id
+  value       = module.database.id
+}
+
+output "enterprise_db_crn" {
+  description = "Enterprise database CRN"
+  value       = module.database.crn
 }
 
 output "version" {
   description = "Enterprise DB instance version"
-  value       = module.enterprise_db.version
+  value       = module.database.version
 }
 
 output "adminuser" {
   description = "Database admin user name"
-  value       = module.enterprise_db.adminuser
+  value       = module.database.adminuser
 }
 
 output "hostname" {
   description = "Database connection hostname"
-  value       = module.enterprise_db.hostname
+  value       = module.database.hostname
 }
 
 output "port" {
   description = "Database connection port"
-  value       = module.enterprise_db.port
+  value       = module.database.port
 }
 
 output "certificate_base64" {
   description = "Database connection certificate"
-  value       = module.enterprise_db.certificate_base64
+  value       = module.database.certificate_base64
   sensitive   = true
 }

examples/basic/variables.tf

@@ -40,6 +40,17 @@ variable "access_tags" {
   default     = []
 }
 
+variable "service_endpoints" {
+  type        = string
+  description = "The type of endpoint of the database instance. Possible values: `public`, `private`, `public-and-private`."
+  default     = "public"
+
+  validation {
+    condition     = can(regex("public|public-and-private|private", var.service_endpoints))
+    error_message = "Valid values for service_endpoints are 'public', 'public-and-private', and 'private'"
+  }
+}
+
 variable "read_only_replicas_count" {
   type        = number
   description = "Number of read-only replicas per leader"

examples/complete/main.tf

@@ -96,7 +96,7 @@ module "enterprise_db" {
   edb_version       = var.edb_version
   admin_pass        = var.admin_pass
   users             = var.users
-  resource_tags     = var.resource_tags
+  tags              = var.resource_tags
   # Example of how to use different KMS keys for data and backups
   use_ibm_owned_encryption_key = false
   use_same_kms_key_for_backups = false

examples/complete/outputs.tf

@@ -28,11 +28,6 @@ output "service_credentials_object" {
   sensitive   = true
 }
 
-output "cbr_rule_ids" {
-  description = "CBR rule ids created to restrict Enterprise DB"
-  value       = module.enterprise_db.cbr_rule_ids
-}
-
 output "hostname" {
   description = "EnterpriseDB instance hostname"
   value       = module.enterprise_db.hostname

examples/fscloud/main.tf

@@ -59,7 +59,7 @@ module "enterprise_db" {
   name                      = "${var.prefix}-edb"
   region                    = var.region
   edb_version               = var.edb_version
-  resource_tags             = var.resource_tags
+  tags                      = var.resource_tags
   kms_key_crn               = var.kms_key_crn
   backup_encryption_key_crn = var.backup_encryption_key_crn
   backup_crn                = var.backup_crn