Skip to content

Commit ef38dec

Browse files
committed
General TF Updates
1 parent aa7ee0a commit ef38dec

File tree

4 files changed

+38
-127
lines changed

4 files changed

+38
-127
lines changed

docs/guides/cluster-admin.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
page_title: "Creating Cluster Admin ROSA Cluster"
3+
subcategory: ""
4+
description: |-
5+
Instructions on how to create a Rosa Openshift cluster admin when you create your cluster with the terraform provider.
6+
---
7+
8+
# Creating a cluster admin user for your ROSA cluster
9+
10+
You can create a Cluster Admin user for your cluster using Terraform.
11+
12+
## Prerequisites
13+
14+
1. You created your [account roles using Terraform](../examples/create_rosa_cluster/create_rosa_sts_cluster/classic_sts/account_roles/README.md).
15+
16+
## Creating a cluster administrator by using Terraform
17+
18+
You must implement the following parameters to create your Cluster Admin role on cluster creation using the htpsswd identity provider.
19+
20+
| Parameter | Type | Description |
21+
|-----------|------|-------------|
22+
| `admin_credentials` | Attributes | This attribute list defines the user name and password for a cluster admin user. |
23+
| `password` | Case-sensitive String | Enter the cluster admin's password that will be created with the cluster. NOTE: This field is case sensitive. |
24+
| `username` | String | Enter your cluster admin's username that will be created with the cluster. |
25+
26+
1. Add these parameters to your cluster creation `variables.tf` and `main.tf` files.
27+
1. Run `terraform apply` to upgrade your cluster.
28+
29+
## OpenShift documentation
30+
31+
- [Configuring an htpasswd identity provider](https://docs.openshift.com/rosa/rosa_install_access_delete_clusters/rosa-sts-config-identity-providers.html#config-htpasswd-idp_rosa-sts-config-identity-providers)

docs/guides/machine-pool.md

Lines changed: 0 additions & 101 deletions
This file was deleted.

docs/index.md

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -62,35 +62,16 @@ This provider is currently under development, and new releases are regularly mad
6262

6363
There are two distinct types of releases:
6464

65-
* Stable releases: Any release identified by a version number without any preffix, such as 1.2.0. These versions are officially supported by RedHat.
65+
* Stable releases: Any release identified by a version number without any prefix, such as 1.2.0. These versions are officially supported by RedHat.
6666
* Pre-release versions: These are beta versions of the provider, identified by a version number with a suffix introduced by a dash, such as 1.2.0-beta. While users can utilize these pre-release versions, it's important to note that doing so comes with the responsibility of the user, as they may not be as stable or fully supported as official releases.
6767

6868
## Prerequisites
6969

7070
To use the Red Hat Cloud Services provider inside your Terraform configuration you must meet the following:
7171

72-
* Completed [the ROSA getting started](https://console.redhat.com/openshift/create/rosa/getstarted) requirements
73-
74-
You must complete some AWS account and local configurations to create and managed ROSA clusters.
75-
76-
* An offline [OCM token](https://console.redhat.com/openshift/token/rosa)
77-
78-
This token is generated through the Red Hat Hybrid Cloud Console. The purpose of this token is to verify that you have access and permission to create and upgrade clusters. This token is unique to your account and should not be shared.
79-
80-
* [GoLang version 1.20 or newer](https://go.dev/doc/install)
81-
82-
To build components with Terraform, you must have the latest version of Go installed and usable on your system.
83-
84-
* [Terraform version 1.4.6 or newer](https://developer.hashicorp.com/terraform/downloads)
85-
86-
You need to have Terraform configured for your local system. The Terraform website contains installation options for MacOS, Windows, and Linux.
87-
88-
* [ROSA account roles](https://access.redhat.com/documentation/en-us/red_hat_openshift_service_on_aws/4/html/introduction_to_rosa/rosa-sts-about-iam-resources)
89-
90-
You need to have created the AWS account-wide roles. The specific account-wide IAM roles and policies provide the STS permissions required for ROSA support, installation, control plane, and compute functionality. This includes account-wide Operator policies.
91-
92-
To create the account roles using Terraform, see the [Account Roles Terraform example](https://github.com/terraform-redhat/terraform-provider-rhcs/tree/v1.4.0/examples/create_account_roles/).
93-
72+
* You completed [the ROSA getting started](https://console.redhat.com/openshift/create/rosa/getstarted) requirements.
73+
* You generated an offline [OCM token](https://console.redhat.com/openshift/token/rosa). This token is generated through the Red Hat Hybrid Cloud Console. Do not share this token.
74+
* You have [Terraform version 1.4.6 or newer](https://developer.hashicorp.com/terraform/downloads) installed.
9475
* AWS Permissions
9576

9677
The following excerpt lists the minimum AWS permissions required to run Terraform.

docs/resources/cluster_rosa_classic.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ resource "rhcs_cluster_rosa_classic" "rosa_sts_cluster" {
5353

5454
### Optional
5555

56-
- `admin_credentials` (Attributes) Admin user credentials (see [below for nested schema](#nestedatt--admin_credentials))
56+
- `admin_credentials` (Attributes) This attribute list defines the user name and password for a cluster admin user. (see [below for nested schema](#nestedatt--admin_credentials))
5757
- `autoscaling_enabled` (Boolean) Enables autoscaling.
5858
- `availability_zones` (List of String) Availability zones.
5959
- `aws_private_link` (Boolean) Provides private connectivity from your cluster's VPC to Red Hat SRE, without exposing traffic to the public internet.
@@ -105,8 +105,8 @@ resource "rhcs_cluster_rosa_classic" "rosa_sts_cluster" {
105105

106106
Required:
107107

108-
- `password` (String, Sensitive) Admin password that will be created with the cluster.
109-
- `username` (String) Admin username that will be created with the cluster.
108+
- `password` (String, Sensitive) Enter the cluster admin's password that will be created with the cluster. NOTE: This field is case sensitive.
109+
- `username` (String) Enter your cluster admin's username that will be created with the cluster.
110110

111111

112112
<a id="nestedatt--private_hosted_zone"></a>

0 commit comments

Comments
 (0)