OCM-23123 | feat: add channel parameter support for ROSA HCP clusters

Signed-off-by: oolayink@redhat.com

Author: ssukanmi

README.md

@@ -127,6 +127,7 @@ We recommend you install the following CLI tools:
 | <a name="input_aws_billing_account_id"></a> [aws\_billing\_account\_id](#input\_aws\_billing\_account\_id) | The AWS billing account identifier where all resources are billed. If no information is provided, the data will be retrieved from the currently connected account. | `string` | `null` | no |
 | <a name="input_aws_subnet_ids"></a> [aws\_subnet\_ids](#input\_aws\_subnet\_ids) | The Subnet IDs to use when installing the cluster. | `list(string)` | n/a | yes |
 | <a name="input_base_dns_domain"></a> [base\_dns\_domain](#input\_base\_dns\_domain) | Base DNS domain name previously reserved, e.g. '1vo8.p3.openshiftapps.com'. | `string` | `null` | no |
+| <a name="input_channel"></a> [channel](#input\_channel) | Y-stream specific channel for the cluster version (e.g., 'stable-4.16'). This parameter specifies the upgrade path for the cluster. Cannot be used together with 'version\_channel\_group'. | `string` | `null` | no |
 | <a name="input_cluster_autoscaler_enabled"></a> [cluster\_autoscaler\_enabled](#input\_cluster\_autoscaler\_enabled) | Enable Autoscaler for this cluster. This resource is currently unavailable and using will result in error 'Autoscaler configuration is not available' | `bool` | `false` | no |
 | <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | Name of the cluster. After the creation of the resource, it is not possible to update the attribute value. | `string` | n/a | yes |
 | <a name="input_compute_machine_type"></a> [compute\_machine\_type](#input\_compute\_machine\_type) | Identifies the Instance type used by the default worker machine pool e.g. `m5.xlarge`. Use the `rhcs_machine_types` data source to find the possible values. | `string` | `null` | no |
@@ -171,7 +172,7 @@ We recommend you install the following CLI tools:
 | <a name="input_tags"></a> [tags](#input\_tags) | Apply user defined tags to all cluster resources created in AWS. After the creation of the cluster is completed, it is not possible to update this attribute. | `map(string)` | `null` | no |
 | <a name="input_trust_policy_external_id"></a> [trust\_policy\_external\_id](#input\_trust\_policy\_external\_id) | External ID for trust policy condition in account roles | `string` | `null` | no |
 | <a name="input_upgrade_acknowledgements_for"></a> [upgrade\_acknowledgements\_for](#input\_upgrade\_acknowledgements\_for) | Indicates acknowledgement of agreements required to upgrade the cluster version between minor versions (e.g. a value of "4.12" indicates acknowledgement of any agreements required to upgrade to OpenShift 4.12.z from 4.11 or before). | `string` | `null` | no |
-| <a name="input_version_channel_group"></a> [version\_channel\_group](#input\_version\_channel\_group) | Desired channel group of the version [stable, candidate, fast, nightly]. | `string` | `"stable"` | no |
+| <a name="input_version_channel_group"></a> [version\_channel\_group](#input\_version\_channel\_group) | Desired channel group of the version [stable, candidate, fast, nightly]. Cannot be used together with 'channel'. | `string` | `null` | no |
 | <a name="input_wait_for_create_complete"></a> [wait\_for\_create\_complete](#input\_wait\_for\_create\_complete) | Wait until the cluster is either in a ready state or in an error state. The waiter has a timeout of 20 minutes. (default: true) | `bool` | `true` | no |
 | <a name="input_wait_for_std_compute_nodes_complete"></a> [wait\_for\_std\_compute\_nodes\_complete](#input\_wait\_for\_std\_compute\_nodes\_complete) | Wait until the initial set of machine pools to be available. The waiter has a timeout of 60 minutes. (default: true) | `bool` | `true` | no |
 
@@ -184,6 +185,7 @@ We recommend you install the following CLI tools:
 | <a name="output_cluster_admin_password"></a> [cluster\_admin\_password](#output\_cluster\_admin\_password) | The password of the admin user. |
 | <a name="output_cluster_admin_username"></a> [cluster\_admin\_username](#output\_cluster\_admin\_username) | The username of the admin user. |
 | <a name="output_cluster_api_url"></a> [cluster\_api\_url](#output\_cluster\_api\_url) | The URL of the API server. |
+| <a name="output_cluster_channel"></a> [cluster\_channel](#output\_cluster\_channel) | The Y-stream channel for the cluster version, for example 'stable-4.16'. |
 | <a name="output_cluster_console_url"></a> [cluster\_console\_url](#output\_cluster\_console\_url) | The URL of the console. |
 | <a name="output_cluster_current_version"></a> [cluster\_current\_version](#output\_cluster\_current\_version) | The currently running version of OpenShift on the cluster, for example '4.11.0'. |
 | <a name="output_cluster_domain"></a> [cluster\_domain](#output\_cluster\_domain) | The DNS domain of cluster. |

main.tf

@@ -71,6 +71,7 @@ module "rosa_cluster_hcp" {
   operator_role_prefix              = var.create_operator_roles ? module.operator_roles[0].operator_role_prefix : local.operator_role_prefix
   openshift_version                 = var.openshift_version
   version_channel_group             = var.version_channel_group
+  channel                           = var.channel
   installer_role_arn                = var.create_account_roles ? module.account_iam_resources[0].account_roles_arn["HCP-ROSA-Installer"] : local.sts_roles.installer_role_arn
   support_role_arn                  = var.create_account_roles ? module.account_iam_resources[0].account_roles_arn["HCP-ROSA-Support"] : local.sts_roles.support_role_arn
   worker_role_arn                   = var.create_account_roles ? module.account_iam_resources[0].account_roles_arn["HCP-ROSA-Worker"] : local.sts_roles.worker_role_arn

modules/rosa-cluster-hcp/README.md

@@ -39,14 +39,14 @@ module "rosa_cluster_hcp" {
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
 | <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.38.0 |
-| <a name="requirement_rhcs"></a> [rhcs](#requirement\_rhcs) | >= 1.7.2 |
+| <a name="requirement_rhcs"></a> [rhcs](#requirement\_rhcs) | >= 1.7.5 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
 | <a name="provider_aws"></a> [aws](#provider\_aws) | >= 5.38.0 |
-| <a name="provider_rhcs"></a> [rhcs](#provider\_rhcs) | >= 1.7.2 |
+| <a name="provider_rhcs"></a> [rhcs](#provider\_rhcs) | >= 1.7.5 |
 
 ## Modules
 
@@ -86,6 +86,7 @@ No modules.
 | <a name="input_aws_region"></a> [aws\_region](#input\_aws\_region) | The full name of the AWS region used for the ROSA cluster installation, for example 'us-east-1'. If no information is provided, the data will be retrieved from the currently connected account. | `string` | `null` | no |
 | <a name="input_aws_subnet_ids"></a> [aws\_subnet\_ids](#input\_aws\_subnet\_ids) | The Subnet IDs to use when installing the cluster. | `list(string)` | n/a | yes |
 | <a name="input_base_dns_domain"></a> [base\_dns\_domain](#input\_base\_dns\_domain) | Base DNS domain name previously reserved, e.g. '1vo8.p3.openshiftapps.com'. | `string` | `null` | no |
+| <a name="input_channel"></a> [channel](#input\_channel) | Y-stream specific channel for the cluster version (e.g., 'stable-4.16'). This parameter specifies the upgrade path for the cluster. Cannot be used together with 'version\_channel\_group'. | `string` | `null` | no |
 | <a name="input_cluster_autoscaler_enabled"></a> [cluster\_autoscaler\_enabled](#input\_cluster\_autoscaler\_enabled) | Enable Autoscaler for this cluster. This resource is currently unavailable and using will result in error 'Autoscaler configuration is not available' | `bool` | `false` | no |
 | <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | Name of the cluster. After the creation of the resource, it is not possible to update the attribute value. | `string` | n/a | yes |
 | <a name="input_compute_machine_type"></a> [compute\_machine\_type](#input\_compute\_machine\_type) | Identifies the Instance type used by the default worker machine pool e.g. `m5.xlarge`. Use the `rhcs_machine_types` data source to find the possible values. | `string` | `null` | no |
@@ -120,7 +121,7 @@ No modules.
 | <a name="input_tags"></a> [tags](#input\_tags) | Apply user defined tags to all cluster resources created in AWS. After the creation of the cluster is completed, it is not possible to update this attribute. | `map(string)` | `null` | no |
 | <a name="input_trust_policy_external_id"></a> [trust\_policy\_external\_id](#input\_trust\_policy\_external\_id) | External ID for trust policy condition in account roles | `string` | `null` | no |
 | <a name="input_upgrade_acknowledgements_for"></a> [upgrade\_acknowledgements\_for](#input\_upgrade\_acknowledgements\_for) | Indicates acknowledgement of agreements required to upgrade the cluster version between minor versions (e.g. a value of "4.12" indicates acknowledgement of any agreements required to upgrade to OpenShift 4.12.z from 4.11 or before). | `string` | `null` | no |
-| <a name="input_version_channel_group"></a> [version\_channel\_group](#input\_version\_channel\_group) | Desired channel group of the version [stable, candidate, fast, nightly]. | `string` | `"stable"` | no |
+| <a name="input_version_channel_group"></a> [version\_channel\_group](#input\_version\_channel\_group) | Desired channel group of the version [stable, candidate, fast, nightly]. Cannot be used together with 'channel'. | `string` | `null` | no |
 | <a name="input_wait_for_create_complete"></a> [wait\_for\_create\_complete](#input\_wait\_for\_create\_complete) | Wait until the cluster is either in a ready state or in an error state. The waiter has a timeout of 20 minutes. (default: true) | `bool` | `true` | no |
 | <a name="input_wait_for_std_compute_nodes_complete"></a> [wait\_for\_std\_compute\_nodes\_complete](#input\_wait\_for\_std\_compute\_nodes\_complete) | Wait until the cluster standard compute nodes are available. The waiter has a timeout of 60 minutes. (default: true) | `bool` | `true` | no |
 | <a name="input_worker_role_arn"></a> [worker\_role\_arn](#input\_worker\_role\_arn) | The Amazon Resource Name (ARN) associated with the AWS IAM role that will be used by the cluster's compute instances. | `string` | `null` | no |
@@ -132,6 +133,7 @@ No modules.
 | <a name="output_cluster_admin_password"></a> [cluster\_admin\_password](#output\_cluster\_admin\_password) | The password of the admin user. |
 | <a name="output_cluster_admin_username"></a> [cluster\_admin\_username](#output\_cluster\_admin\_username) | The username of the admin user. |
 | <a name="output_cluster_api_url"></a> [cluster\_api\_url](#output\_cluster\_api\_url) | The URL of the API server. |
+| <a name="output_cluster_channel"></a> [cluster\_channel](#output\_cluster\_channel) | The Y-stream channel for the cluster version, for example 'stable-4.16'. |
 | <a name="output_cluster_console_url"></a> [cluster\_console\_url](#output\_cluster\_console\_url) | The URL of the console. |
 | <a name="output_cluster_current_version"></a> [cluster\_current\_version](#output\_cluster\_current\_version) | The currently running version of OpenShift on the cluster, for example '4.11.0'. |
 | <a name="output_cluster_domain"></a> [cluster\_domain](#output\_cluster\_domain) | The DNS domain of cluster. |

modules/rosa-cluster-hcp/main.tf

@@ -35,8 +35,9 @@ locals {
 }
 
 resource "rhcs_cluster_rosa_hcp" "rosa_hcp_cluster" {
-  name                         = var.cluster_name
-  version                      = var.openshift_version
+  name    = var.cluster_name
+  version = var.openshift_version
+  # channel                      = var.channel
   channel_group                = var.version_channel_group
   upgrade_acknowledgements_for = var.upgrade_acknowledgements_for
   private                      = var.private

modules/rosa-cluster-hcp/outputs.tf

@@ -29,6 +29,11 @@ output "cluster_domain" {
   description = "The DNS domain of cluster."
 }
 
+output "cluster_channel" {
+  value       = null #TODO rhcs_cluster_rosa_hcp.rosa_hcp_cluster.channel
+  description = "The Y-stream channel for the cluster version, for example 'stable-4.16'."
+}
+
 output "cluster_current_version" {
   value       = rhcs_cluster_rosa_hcp.rosa_hcp_cluster.current_version
   description = "The currently running version of OpenShift on the cluster, for example '4.11.0'."

modules/rosa-cluster-hcp/variables.tf

@@ -28,8 +28,19 @@ variable "openshift_version" {
 
 variable "version_channel_group" {
   type        = string
-  default     = "stable"
-  description = "Desired channel group of the version [stable, candidate, fast, nightly]."
+  default     = null
+  description = "Desired channel group of the version [stable, candidate, fast, nightly]. Cannot be used together with 'channel'."
+}
+
+variable "channel" {
+  type        = string
+  default     = null
+  description = "Y-stream specific channel for the cluster version (e.g., 'stable-4.16'). This parameter specifies the upgrade path for the cluster. Cannot be used together with 'version_channel_group'."
+
+  validation {
+    condition     = var.channel == null || var.version_channel_group == null
+    error_message = "The 'channel' and 'version_channel_group' parameters cannot be used together. Please specify only one."
+  }
 }
 
 variable "aws_account_id" {

modules/rosa-cluster-hcp/versions.tf

@@ -7,7 +7,7 @@ terraform {
       version = ">= 5.38.0"
     }
     rhcs = {
-      version = ">= 1.7.2"
+      version = ">= 1.7.5" # TODO: Update to >= 1.7.6 when released (channel parameter support)
       source  = "terraform-redhat/rhcs"
     }
   }

outputs.tf

@@ -31,6 +31,11 @@ output "cluster_domain" {
   description = "The DNS domain of cluster."
 }
 
+output "cluster_channel" {
+  value       = module.rosa_cluster_hcp.cluster_channel
+  description = "The Y-stream channel for the cluster version, for example 'stable-4.16'."
+}
+
 output "cluster_current_version" {
   value       = module.rosa_cluster_hcp.cluster_current_version
   description = "The currently running version of OpenShift on the cluster, for example '4.11.0'."

variables.tf

@@ -16,8 +16,19 @@ variable "openshift_version" {
 
 variable "version_channel_group" {
   type        = string
-  default     = "stable"
-  description = "Desired channel group of the version [stable, candidate, fast, nightly]."
+  default     = null
+  description = "Desired channel group of the version [stable, candidate, fast, nightly]. Cannot be used together with 'channel'."
+}
+
+variable "channel" {
+  type        = string
+  default     = null
+  description = "Y-stream specific channel for the cluster version (e.g., 'stable-4.16'). This parameter specifies the upgrade path for the cluster. Cannot be used together with 'version_channel_group'."
+
+  validation {
+    condition     = var.channel == null || var.version_channel_group == null
+    error_message = "The 'channel' and 'version_channel_group' parameters cannot be used together. Please specify only one."
+  }
 }
 
 variable "oidc_config_id" {