Repository files navigation

Please note that this Terraform provider and its modules are open source and will continue to iterate features, gradually maturing this code.If you encounter any issues, please report them in this repo.

The Red Hat Cloud Services Terraform provider allows Terraform to manage Red Hat OpenShift Service on AWS (ROSA) clusters and relevant resources.

For more information about ROSA, see the Red Hat documentationhere.

• GoLang version 1.20 or newer
• Terraform version 1.4.6 or newer
• An offlineOCM token
• AWS account
• Completedthe ROSA getting started requirements
• ROSA CLI
• Optional: Aconfigured*.tfvars file.

Seethe Terraform Registry documentation for instructions on using this provider.

The following items are limitations with the current release of the OCM Terraform provider:

• The latest version is not backward compatible with version 1.0.1.
• When creating a cluster, the cluster uses AWS credentials configured on your local machine. These credentials provide access to the AWS API for validating your account.
• When creating a machine pool, you need to specify your replica count. You must define either thereplicas= "<count>" variable or provide values for the following variables to build the machine pool:
  • min_replicas = "<count>"
  • max_replicas="<count>"
  • autoscaling_enabled=true
• The htpasswd identity provider does not support creating the identity provider with multiple users or adding additional users to the existing identity provider.
• The S3 bucket that is created as part of the OIDC configuration must be created in the same region as your OIDC provider.
• The Terraform provider does not support auto-generatedoperator_role_prefix. You must provide youroperator_role_prefix when creating the account roles.

The example Terraform files are all considered in development:

• Account Roles Terraform

• Create a ROSA cluster that uses STS and has a managed OIDC configuration
• Create a ROSA cluster that uses STS and has an unmanaged OIDC configuration

• Modifying default machine pools
• The followingidentity providers are supported:
  • Github
  • Gitlab
  • HTPasswd
  • Google
  • LDAP
• Upgrading or updating your cluster

If you want to build a local Red Hat Cloud Services provider to develop improvements for the Red Hat Cloud Services provider, you can runterraform plan against your local build with:

1. Runmake install in the repository root directory. After runningmake install you will find the rhcs provider binary file in the directory:

   <HOME>/.terraform.d/plugins/terraform.local/local/rhcs/<VERSION>/<TARGET_ARCH>

   For example, the following location would contain theterraform-rhcs-provider binary file:

   ~/.terraform.d/plugins/terraform.local/local/rhcs/0.0.1/linux_amd64

2. You now need to update yourmain.tf to the location of the local provider by pointing the required_providers rhcs to the local terraform directory.

   terraform {  required_providers {    rhcs = {      source  = "terraform.local/local/rhcs"      version = ">=0.0.1"    }  }}provider "rhcs" {  token = var.token  url = var.url}

If you want to locally test the provider binary without building from sources, you can pull thelatest binary container image and copy the binary file to your local by runningmake binary or the whole background command if you need to make custom changes:

    podman run --pull=always --rm registry.ci.openshift.org/ci/rhcs-tf-bin:latest cat /root/terraform-provider-rhcs > ~/terraform-provider-rhcs && chmod +x ~/terraform-provider-rhcs

You can also use specific commit images by substitutinglatest for the desired commit SHA.Binary image only runs on AMD64 architectures up to now.

Detailed documentation for developing and contributing to RHCS provider can be found in ourcontribution guide.