tests: update test code

Author: Jordan-Williams2

solutions/deploy/README.md

@@ -129,20 +129,20 @@ 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 to use. If null, the image will be built using 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) | Secret for accessing the Cloud Pak Deployer image. If null, a default secret will be created. | `map(string)` | `null` | no |
+| <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) | Accept the Cloud Pak for Data license. | `bool` | `false` | no |
+| <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 instead of creating a new one. | `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 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_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_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) | 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_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) | Configuration for the ODF addon. | `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 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 |

solutions/deploy/main.tf

@@ -10,7 +10,7 @@ locals {
   }
 }
 
-# Retrieve the openshift cluster info
+# Retrieve the OpenShift cluster info
 data "ibm_container_vpc_cluster" "cluster_info" {
   name = var.cluster_name
 }

solutions/deploy/outputs.tf

@@ -1,14 +1,12 @@
 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
+  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" {

solutions/deploy/variables.tf

@@ -33,19 +33,19 @@ variable "resource_group_exists" {
 }
 
 variable "code_engine_project_name" {
-  description = "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}"
+  description = "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}."
   type        = string
   default     = null
 }
 
 variable "code_engine_project_id" {
-  description = "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."
+  description = "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 instead of creating a new one."
   type        = string
   default     = null
 }
 
 variable "cloud_pak_deployer_image" {
-  description = "Cloud Pak Deployer image to use. If null, the image will be built using Code Engine."
+  description = "Cloud Pak Deployer image to use. If `null`, the image will be built using Code Engine."
   type        = string
   default     = null
 }
@@ -57,7 +57,7 @@ variable "cloud_pak_deployer_release" {
 }
 
 variable "cloud_pak_deployer_secret" {
-  description = "Secret for accessing the Cloud Pak Deployer image. If null, a default secret will be created."
+  description = "Secret for accessing the Cloud Pak Deployer image. If `null`, a default secret will be created."
   type        = map(string)
   default     = null
 }
@@ -68,19 +68,19 @@ variable "cluster_name" {
 }
 
 variable "install_odf_cluster_addon" {
-  description = "Install the odf cluster addon"
+  description = "Install the ODF cluster addon."
   type        = bool
   default     = true
 }
 
 variable "odf_version" {
-  description = "Version of ODF to install"
+  description = "Version of ODF to install."
   type        = string
   default     = "4.16.0"
 }
 
 variable "odf_config" {
-  description = "Version of ODF to install"
+  description = "Configuration for the ODF addon."
   type        = map(string)
   default = {
     "odfDeploy"                       = "true"
@@ -112,7 +112,7 @@ variable "odf_config" {
 }
 
 variable "cpd_accept_license" {
-  description = "Accept the Cloud Pak for Data license."
+  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."
   type        = bool
   default     = false
 }
@@ -124,7 +124,7 @@ variable "cpd_admin_password" {
 }
 
 variable "cpd_entitlement_key" {
-  description = "Entitlement key for Cloud Pak for Data."
+  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."
   sensitive   = true
   type        = string
 }