tests: update test code

Author: Jordan-Williams2

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "go.sum|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2025-01-24T16:49:18Z",
+  "generated_at": "2025-02-11T22:49:03Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -76,18 +76,7 @@
       "name": "TwilioKeyDetector"
     }
   ],
-  "results": {
-    "solutions/deploy/README.md": [
-      {
-        "hashed_secret": "2254481e1661d8f017a712b0d1ad9a14fd9460a3",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 134,
-        "type": "Secret Keyword",
-        "verified_result": null
-      }
-    ]
-  },
+  "results": {},
   "version": "0.13.1+ibm.62.dss",
   "word_list": {
     "file": null,

solutions/deploy/README.md

@@ -129,23 +129,23 @@ You need the following permissions to run this module:
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_cloud_pak_deployer_image"></a> [cloud\_pak\_deployer\_image](#input\_cloud\_pak\_deployer\_image) | Cloud Pak Deployer image location. If not defined, it will build the image via code engine | `string` | `null` | no |
+| <a name="input_cloud_pak_deployer_image"></a> [cloud\_pak\_deployer\_image](#input\_cloud\_pak\_deployer\_image) | Cloud Pak Deployer image to use. If null, the image will be built using Code Engine. | `string` | `null` | no |
 | <a name="input_cloud_pak_deployer_release"></a> [cloud\_pak\_deployer\_release](#input\_cloud\_pak\_deployer\_release) | Release of Cloud Pak Deployer version to use. View releases at: https://github.com/IBM/cloud-pak-deployer/releases. | `string` | `"v3.1.2"` | no |
-| <a name="input_cloud_pak_deployer_secret"></a> [cloud\_pak\_deployer\_secret](#input\_cloud\_pak\_deployer\_secret) | Image pull secret for the cloud pak deployer image | <pre>object({<br/>    username = string<br/>    password = string<br/>    server   = string<br/>    email    = string<br/>  })</pre> | `null` | no |
-| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | Name of Red Hat OpenShift cluster to install watsonx onto | `string` | n/a | yes |
+| <a name="input_cloud_pak_deployer_secret"></a> [cloud\_pak\_deployer\_secret](#input\_cloud\_pak\_deployer\_secret) | Secret for accessing the Cloud Pak Deployer image. If null, a default secret will be created. | `map(string)` | `null` | no |
+| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | Name of the OpenShift cluster. | `string` | n/a | yes |
 | <a name="input_code_engine_project_id"></a> [code\_engine\_project\_id](#input\_code\_engine\_project\_id) | If you want to use an existing project, you can pass the code engine project id and the cloud pak deployer build will be built within the existing project vs a new one being created. | `string` | `null` | no |
 | <a name="input_code_engine_project_name"></a> [code\_engine\_project\_name](#input\_code\_engine\_project\_name) | If the variable cloud\_pak\_deployer\_image is null, it will build the image with code engine and store it within a private icr registry.  Provide a name if you want to set the name.  If not defined, default will be {prefix}-cpd-{random-suffix} | `string` | `null` | no |
-| <a name="input_cpd_accept_license"></a> [cpd\_accept\_license](#input\_cpd\_accept\_license) | When set to 'true', it is understood that the user has read the terms of the Cloud Pak license(s) and agrees to the terms outlined | `bool` | `false` | no |
-| <a name="input_cpd_admin_password"></a> [cpd\_admin\_password](#input\_cpd\_admin\_password) | Password to be used by the admin user to access the Cloud Pak for Data UI. | `string` | n/a | yes |
-| <a name="input_cpd_entitlement_key"></a> [cpd\_entitlement\_key](#input\_cpd\_entitlement\_key) | Cloud Pak for Data entitlement key for access to the IBM Entitled Registry. Can be fetched from https://myibm.ibm.com/products-services/containerlibrary. | `string` | n/a | yes |
+| <a name="input_cpd_accept_license"></a> [cpd\_accept\_license](#input\_cpd\_accept\_license) | Accept the Cloud Pak for Data license. | `bool` | `false` | no |
+| <a name="input_cpd_admin_password"></a> [cpd\_admin\_password](#input\_cpd\_admin\_password) | Password for the Cloud Pak for Data admin user. | `string` | n/a | yes |
+| <a name="input_cpd_entitlement_key"></a> [cpd\_entitlement\_key](#input\_cpd\_entitlement\_key) | Entitlement key for Cloud Pak for Data. | `string` | n/a | yes |
 | <a name="input_cpd_version"></a> [cpd\_version](#input\_cpd\_version) | Cloud Pak for Data version to install.  Only version 5.x.x is supported | `string` | `"5.0.3"` | no |
-| <a name="input_ibmcloud_api_key"></a> [ibmcloud\_api\_key](#input\_ibmcloud\_api\_key) | APIkey that's associated with the account to use | `string` | n/a | yes |
+| <a name="input_ibmcloud_api_key"></a> [ibmcloud\_api\_key](#input\_ibmcloud\_api\_key) | The IBM Cloud platform API key needed to deploy IAM enabled resources. | `string` | n/a | yes |
 | <a name="input_install_odf_cluster_addon"></a> [install\_odf\_cluster\_addon](#input\_install\_odf\_cluster\_addon) | Install the odf cluster addon | `bool` | `true` | no |
 | <a name="input_odf_config"></a> [odf\_config](#input\_odf\_config) | Version of ODF to install | `map(string)` | <pre>{<br/>  "addSingleReplicaPool": "false",<br/>  "billingType": "essentials",<br/>  "clusterEncryption": "false",<br/>  "disableNoobaaLB": "false",<br/>  "enableNFS": "false",<br/>  "encryptionInTransit": "false",<br/>  "hpcsBaseUrl": "",<br/>  "hpcsEncryption": "false",<br/>  "hpcsInstanceId": "",<br/>  "hpcsSecretName": "",<br/>  "hpcsServiceName": "",<br/>  "hpcsTokenUrl": "",<br/>  "ignoreNoobaa": "true",<br/>  "numOfOsd": "1",<br/>  "ocsUpgrade": "false",<br/>  "odfDeploy": "true",<br/>  "osdDevicePaths": "",<br/>  "osdSize": "512Gi",<br/>  "osdStorageClassName": "ibmc-vpc-block-metro-10iops-tier",<br/>  "prepareForDisasterRecovery": "false",<br/>  "resourceProfile": "balanced",<br/>  "taintNodes": "false",<br/>  "useCephRBDAsDefaultStorageClass": "false",<br/>  "workerNodes": "all",<br/>  "workerPool": ""<br/>}</pre> | no |
 | <a name="input_odf_version"></a> [odf\_version](#input\_odf\_version) | Version of ODF to install | `string` | `"4.16.0"` | no |
-| <a name="input_prefix"></a> [prefix](#input\_prefix) | A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters. | `string` | n/a | yes |
-| <a name="input_region"></a> [region](#input\_region) | Region where resources wills be created. To find your VPC region, use `ibmcloud is regions` command to find available regions. | `string` | n/a | yes |
-| <a name="input_resource_group"></a> [resource\_group](#input\_resource\_group) | Resource group to provision services within.  If not defined, a resource group called {prefix}-cpd will be created | `string` | `null` | no |
+| <a name="input_prefix"></a> [prefix](#input\_prefix) | A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 13 or fewer characters. | `string` | `"lz-roks-cp4d"` | no |
+| <a name="input_region"></a> [region](#input\_region) | Region where resources will be created. To find your VPC region, use `ibmcloud is regions` command to find available regions. | `string` | n/a | yes |
+| <a name="input_resource_group"></a> [resource\_group](#input\_resource\_group) | Resource group to provision services within. If not defined, a resource group called {prefix}-cpd will be created. | `string` | `null` | no |
 | <a name="input_resource_group_exists"></a> [resource\_group\_exists](#input\_resource\_group\_exists) | Resource group exists or not within the account. | `bool` | `false` | no |
 | <a name="input_watson_assistant_install"></a> [watson\_assistant\_install](#input\_watson\_assistant\_install) | If watsonx.ai is being installed, also install watson assistant | `bool` | `false` | no |
 | <a name="input_watson_discovery_install"></a> [watson\_discovery\_install](#input\_watson\_discovery\_install) | If watsonx.ai is being installed, also install watson discovery | `bool` | `false` | no |
@@ -155,7 +155,11 @@ You need the following permissions to run this module:
 
 ### Outputs
 
-No outputs.
+| Name | Description |
+|------|-------------|
+| <a name="output_cloud_pak_deployer_image"></a> [cloud\_pak\_deployer\_image](#output\_cloud\_pak\_deployer\_image) | The Cloud Pak Deployer image used. |
+| <a name="output_cloud_pak_deployer_secret"></a> [cloud\_pak\_deployer\_secret](#output\_cloud\_pak\_deployer\_secret) | The secret used for accessing the Cloud Pak Deployer image. |
+| <a name="output_cluster_name"></a> [cluster\_name](#output\_cluster\_name) | The name of the OpenShift cluster. |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
 <!-- Leave this section as is so that your module has a link to local development environment set-up steps for contributors to follow -->

solutions/deploy/main.tf

@@ -16,7 +16,7 @@ data "ibm_container_vpc_cluster" "cluster_info" {
 }
 
 module "build_cpd_image" {
-  count                      = var.cloud_pak_deployer_image == null ? 1 : 0
+  for_each                   = var.cloud_pak_deployer_image == null ? { "build" = 1 } : {}
   source                     = "./cpd-image-build"
   ibmcloud_api_key           = var.ibmcloud_api_key
   prefix                     = var.prefix
@@ -29,7 +29,7 @@ module "build_cpd_image" {
 }
 
 resource "ibm_container_addons" "odf_cluster_addon" {
-  count             = var.install_odf_cluster_addon ? 1 : 0
+  for_each          = var.install_odf_cluster_addon ? { "odf" = 1 } : {}
   cluster           = var.cluster_name
   manage_all_addons = false
   addons {
@@ -55,8 +55,12 @@ module "watsonx_data" {
 }
 
 module "cloud_pak_deployer" {
-  depends_on = [module.watsonx_ai, module.watsonx_data, module.build_cpd_image]
-  source     = "./cloud-pak-deployer"
+  depends_on = [
+    module.watsonx_ai,
+    module.watsonx_data,
+    module.build_cpd_image
+  ]
+  source = "./cloud-pak-deployer"
   cloud_pak_deployer_config = merge(
     module.config.cloud_pak_deployer_config_base,
     {
@@ -72,10 +76,10 @@ module "cloud_pak_deployer" {
       )]
     }
   )
-  cloud_pak_deployer_image = var.cloud_pak_deployer_image != null ? var.cloud_pak_deployer_image : module.build_cpd_image[0].container_registry_output_image
+  cloud_pak_deployer_image = var.cloud_pak_deployer_image != null ? var.cloud_pak_deployer_image : module.build_cpd_image["build"].container_registry_output_image
 
   cloud_pak_deployer_secret = var.cloud_pak_deployer_secret != null ? var.cloud_pak_deployer_secret : (var.cloud_pak_deployer_image == null ?
-  { username : "iamapikey", password : var.ibmcloud_api_key, server : module.build_cpd_image[0].container_registry_server, email : "none" } : null)
+  { username : "iamapikey", password : var.ibmcloud_api_key, server : module.build_cpd_image["build"].container_registry_server, email : "none" } : null)
 
   cluster_name        = var.cluster_name
   cpd_accept_license  = var.cpd_accept_license

solutions/deploy/outputs.tf

@@ -0,0 +1,17 @@
+output "cloud_pak_deployer_image" {
+  description = "The Cloud Pak Deployer image used."
+  value       = var.cloud_pak_deployer_image != null ? var.cloud_pak_deployer_image : module.build_cpd_image["build"].container_registry_output_image
+
+}
+
+output "cloud_pak_deployer_secret" {
+  description = "The secret used for accessing the Cloud Pak Deployer image."
+  value = var.cloud_pak_deployer_secret != null ? var.cloud_pak_deployer_secret : (var.cloud_pak_deployer_image == null ?
+  { username : "iamapikey", password : var.ibmcloud_api_key, server : module.build_cpd_image["build"].container_registry_server, email : "none" } : null)
+  sensitive = true
+}
+
+output "cluster_name" {
+  description = "The name of the OpenShift cluster."
+  value       = var.cluster_name
+}

solutions/deploy/variables.tf

@@ -1,26 +1,27 @@
 variable "ibmcloud_api_key" {
-  description = "APIkey that's associated with the account to use"
+  description = "The IBM Cloud platform API key needed to deploy IAM enabled resources."
   type        = string
   sensitive   = true
 }
 
 variable "prefix" {
-  description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 16 or fewer characters."
+  description = "A unique identifier for resources that is prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number. Must be 13 or fewer characters."
   type        = string
+  default     = "lz-roks-cp4d"
 
   validation {
-    error_message = "Prefix must begin and end with a letter and contain only letters, numbers, and - characters."
-    condition     = can(regex("^([A-z]|[a-z][-a-z0-9]*[a-z0-9])$", var.prefix))
+    error_message = "Prefix must begin with a letter and contain only lowercase letters, numbers, and - characters. Prefixes must end with a lowercase letter or number and be 13 or fewer characters."
+    condition     = can(regex("^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", var.prefix)) && length(var.prefix) <= 13
   }
 }
 
 variable "region" {
-  description = "Region where resources wills be created. To find your VPC region, use `ibmcloud is regions` command to find available regions."
+  description = "Region where resources will be created. To find your VPC region, use `ibmcloud is regions` command to find available regions."
   type        = string
 }
 
 variable "resource_group" {
-  description = "Resource group to provision services within.  If not defined, a resource group called {prefix}-cpd will be created"
+  description = "Resource group to provision services within. If not defined, a resource group called {prefix}-cpd will be created."
   type        = string
   default     = null
 }
@@ -44,7 +45,7 @@ variable "code_engine_project_id" {
 }
 
 variable "cloud_pak_deployer_image" {
-  description = "Cloud Pak Deployer image location. If not defined, it will build the image via code engine"
+  description = "Cloud Pak Deployer image to use. If null, the image will be built using Code Engine."
   type        = string
   default     = null
 }
@@ -56,19 +57,13 @@ variable "cloud_pak_deployer_release" {
 }
 
 variable "cloud_pak_deployer_secret" {
-  description = "Image pull secret for the cloud pak deployer image"
-  type = object({
-    username = string
-    password = string
-    server   = string
-    email    = string
-  })
-
-  default = null
+  description = "Secret for accessing the Cloud Pak Deployer image. If null, a default secret will be created."
+  type        = map(string)
+  default     = null
 }
 
 variable "cluster_name" {
-  description = "Name of Red Hat OpenShift cluster to install watsonx onto"
+  description = "Name of the OpenShift cluster."
   type        = string
 }
 
@@ -116,21 +111,20 @@ variable "odf_config" {
   }
 }
 
-
 variable "cpd_accept_license" {
-  default     = false
-  description = "When set to 'true', it is understood that the user has read the terms of the Cloud Pak license(s) and agrees to the terms outlined"
+  description = "Accept the Cloud Pak for Data license."
   type        = bool
+  default     = false
 }
 
 variable "cpd_admin_password" {
-  description = "Password to be used by the admin user to access the Cloud Pak for Data UI."
+  description = "Password for the Cloud Pak for Data admin user."
   sensitive   = true
   type        = string
 }
 
 variable "cpd_entitlement_key" {
-  description = "Cloud Pak for Data entitlement key for access to the IBM Entitled Registry. Can be fetched from https://myibm.ibm.com/products-services/containerlibrary."
+  description = "Entitlement key for Cloud Pak for Data."
   sensitive   = true
   type        = string
 }