feat: added adminuser and certificate_base64 outputs and updated the logic to always output hostname and port details (#333)

Author: shemau

README.md

@@ -49,7 +49,7 @@ You need the following permissions to run this module.
 | Name | Version |
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0, <1.7.0 |
-| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.61.0, < 2.0.0 |
+| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.64.2, < 2.0.0 |
 | <a name="requirement_time"></a> [time](#requirement\_time) | >= 0.9.1, < 1.0.0 |
 
 ### Modules
@@ -102,12 +102,14 @@ You need the following permissions to run this module.
 
 | Name | Description |
 |------|-------------|
+| <a name="output_adminuser"></a> [adminuser](#output\_adminuser) | Database admin user name |
 | <a name="output_cbr_rule_ids"></a> [cbr\_rule\_ids](#output\_cbr\_rule\_ids) | CBR rule ids created to restrict MongoDB |
+| <a name="output_certificate_base64"></a> [certificate\_base64](#output\_certificate\_base64) | Database connection certificate |
 | <a name="output_crn"></a> [crn](#output\_crn) | MongoDB instance crn |
 | <a name="output_guid"></a> [guid](#output\_guid) | MongoDB instance guid |
-| <a name="output_hostname"></a> [hostname](#output\_hostname) | Database hostname. Only contains value when var.service\_credential\_names or var.users are set. |
+| <a name="output_hostname"></a> [hostname](#output\_hostname) | Database connection hostname |
 | <a name="output_id"></a> [id](#output\_id) | MongoDB instance ID |
-| <a name="output_port"></a> [port](#output\_port) | Database port. Only contains value when var.service\_credential\_names or var.users are set. |
+| <a name="output_port"></a> [port](#output\_port) | Database connection port |
 | <a name="output_service_credentials_json"></a> [service\_credentials\_json](#output\_service\_credentials\_json) | Service credentials json map |
 | <a name="output_service_credentials_object"></a> [service\_credentials\_object](#output\_service\_credentials\_object) | Service credentials object |
 | <a name="output_version"></a> [version](#output\_version) | MongoDB instance version |

examples/basic/outputs.tf

@@ -1,7 +1,6 @@
 ##############################################################################
 # Outputs
 ##############################################################################
-
 output "id" {
   description = "Mongodb instance id"
   value       = module.mongodb.id
@@ -11,3 +10,24 @@ output "version" {
   description = "Mongodb instance version"
   value       = module.mongodb.version
 }
+
+output "adminuser" {
+  description = "Database admin user name"
+  value       = module.mongodb.adminuser
+}
+
+output "hostname" {
+  description = "Database connection hostname"
+  value       = module.mongodb.hostname
+}
+
+output "port" {
+  description = "Database connection port"
+  value       = module.mongodb.port
+}
+
+output "certificate_base64" {
+  description = "Database connection certificate"
+  value       = module.mongodb.certificate_base64
+  sensitive   = true
+}

examples/basic/version.tf

@@ -4,7 +4,7 @@ terraform {
     # 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.61.0"
+      version = "1.64.2"
     }
   }
 }

examples/complete/version.tf

@@ -4,7 +4,7 @@ terraform {
     # Use latest version of provider in non-basic examples to verify latest version works with module
     ibm = {
       source  = "IBM-Cloud/ibm"
-      version = ">=1.61.0, <2.0.0"
+      version = ">=1.64.2, <2.0.0"
     }
   }
 }

examples/fscloud/version.tf

@@ -4,7 +4,7 @@ terraform {
     # Use latest version of provider in non-basic examples to verify latest version works with module
     ibm = {
       source  = "IBM-Cloud/ibm"
-      version = ">=1.61.0, <2.0.0"
+      version = ">=1.64.2, <2.0.0"
     }
   }
 }

main.tf

@@ -209,9 +209,8 @@ locals {
 }
 
 data "ibm_database_connection" "database_connection" {
-  count         = length(var.users) > 0 ? 1 : 0
   endpoint_type = var.endpoints
   deployment_id = ibm_database.mongodb.id
-  user_id       = var.users[0].name
-  user_type     = var.users[0].type
+  user_id       = ibm_database.mongodb.adminuser
+  user_type     = "database"
 }

modules/fscloud/README.md

@@ -14,7 +14,7 @@ The IBM Cloud Framework for Financial Services mandates the application of an in
 | Name | Version |
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0, <1.7.0 |
-| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >=1.61.0, <2.0.0 |
+| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >=1.64.2, <2.0.0 |
 
 ### Modules
 
@@ -55,12 +55,14 @@ No resources.
 
 | Name | Description |
 |------|-------------|
+| <a name="output_adminuser"></a> [adminuser](#output\_adminuser) | Database admin user name |
 | <a name="output_cbr_rule_ids"></a> [cbr\_rule\_ids](#output\_cbr\_rule\_ids) | CBR rule ids created to restrict MongoDB |
+| <a name="output_certificate_base64"></a> [certificate\_base64](#output\_certificate\_base64) | Database connection certificate |
 | <a name="output_crn"></a> [crn](#output\_crn) | MongoDB instance crn |
 | <a name="output_guid"></a> [guid](#output\_guid) | MongoDB instance guid |
-| <a name="output_hostname"></a> [hostname](#output\_hostname) | MongoDB instance hostname |
+| <a name="output_hostname"></a> [hostname](#output\_hostname) | Database connection hostname |
 | <a name="output_id"></a> [id](#output\_id) | MongoDB instance id |
-| <a name="output_port"></a> [port](#output\_port) | MongoDB instance port |
+| <a name="output_port"></a> [port](#output\_port) | Database connection port |
 | <a name="output_service_credentials_json"></a> [service\_credentials\_json](#output\_service\_credentials\_json) | Service credentials json map |
 | <a name="output_service_credentials_object"></a> [service\_credentials\_object](#output\_service\_credentials\_object) | Service credentials object |
 | <a name="output_version"></a> [version](#output\_version) | MongoDB instance version |

modules/fscloud/outputs.tf

@@ -39,12 +39,23 @@ output "service_credentials_object" {
   sensitive   = true
 }
 
+output "adminuser" {
+  description = "Database admin user name"
+  value       = module.mongodb.adminuser
+}
+
 output "hostname" {
-  description = "MongoDB instance hostname"
+  description = "Database connection hostname"
   value       = module.mongodb.hostname
 }
 
 output "port" {
-  description = "MongoDB instance port"
+  description = "Database connection port"
   value       = module.mongodb.port
 }
+
+output "certificate_base64" {
+  description = "Database connection certificate"
+  value       = module.mongodb.certificate_base64
+  sensitive   = true
+}

modules/fscloud/version.tf

@@ -8,7 +8,7 @@ terraform {
     ibm = {
       source = "IBM-Cloud/ibm"
       # Use "greater than or equal to" range in modules
-      version = ">=1.61.0, <2.0.0"
+      version = ">=1.64.2, <2.0.0"
     }
   }
 }

outputs.tf

@@ -39,12 +39,23 @@ output "service_credentials_object" {
   sensitive   = true
 }
 
+output "adminuser" {
+  description = "Database admin user name"
+  value       = ibm_database.mongodb.adminuser
+}
+
 output "hostname" {
-  description = "Database hostname. Only contains value when var.service_credential_names or var.users are set."
-  value       = length(var.service_credential_names) > 0 ? nonsensitive(ibm_resource_key.service_credentials[keys(var.service_credential_names)[0]].credentials["connection.mongodb.hosts.0.hostname"]) : length(var.users) > 0 ? data.ibm_database_connection.database_connection[0].mongodb[0].hosts[0].hostname : null
+  description = "Database connection hostname"
+  value       = data.ibm_database_connection.database_connection.mongodb[0].hosts[0].hostname
 }
 
 output "port" {
-  description = "Database port. Only contains value when var.service_credential_names or var.users are set."
-  value       = length(var.service_credential_names) > 0 ? nonsensitive(ibm_resource_key.service_credentials[keys(var.service_credential_names)[0]].credentials["connection.mongodb.hosts.0.port"]) : length(var.users) > 0 ? data.ibm_database_connection.database_connection[0].mongodb[0].hosts[0].port : null
+  description = "Database connection port"
+  value       = data.ibm_database_connection.database_connection.mongodb[0].hosts[0].port
+}
+
+output "certificate_base64" {
+  description = "Database connection certificate"
+  value       = data.ibm_database_connection.database_connection.mongodb[0].certificate[0].certificate_base64
+  sensitive   = true
 }