You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-1Lines changed: 12 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,6 +34,7 @@ Sub-modules included in this module:
34
34
35
35
- account-iam-resource: Handles the provisioning of Identity and Access Management (IAM) resources required for managing access and permissions in the AWS account associated with the ROSA HCP cluster.
36
36
- idp: Responsible for configuring Identity Providers (IDPs) within the ROSA HCP cluster, faciliting seamless integration with external authentication system such as Github (GH), GitLab, Google, HTPasswd, LDAP and OpenID Connect (OIDC).
37
+
- image-mirrors: Manages the configuration of image digest mirror sets for ROSA HCP clusters, enabling container image mirroring to redirect image pulls from source registries to mirror registries for zero-egress networking and improved performance.
37
38
- machine-pool: Facilitates the management of machine pools within the ROSA HCP cluster, enabling users to scale resources and adjust specifications based on workload demands.
38
39
- oidc-config-and-provider: Manages the configuration of OpenID Connect (OIDC) hosted files and providers for ROSA HCP clusters, enabling secure authentication and access control mechanisms for operator roles.
39
40
- operator-roles: Oversees the management of roles assigned to operators within the ROSA HCP cluster, enabling to perform required actions with appropriate permissions on the lifecyle of a cluster.
@@ -71,6 +72,7 @@ We recommend you install the following CLI tools:
|[aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity)| data source |
93
97
94
98
## Inputs
@@ -103,20 +107,24 @@ We recommend you install the following CLI tools:
103
107
| <aname="input_autoscaler_max_nodes_total"></a> [autoscaler\_max\_nodes\_total](#input\_autoscaler\_max\_nodes\_total)| Maximum number of nodes in all node groups. Cluster autoscaler will not grow the cluster beyond this number. |`number`|`null`| no |
104
108
| <aname="input_autoscaler_max_pod_grace_period"></a> [autoscaler\_max\_pod\_grace\_period](#input\_autoscaler\_max\_pod\_grace\_period)| Gives pods graceful termination time before scaling down. |`number`|`null`| no |
105
109
| <aname="input_autoscaler_pod_priority_threshold"></a> [autoscaler\_pod\_priority\_threshold](#input\_autoscaler\_pod\_priority\_threshold)| To allow users to schedule 'best-effort' pods, which shouldn't trigger Cluster Autoscaler actions, but only run when there are spare resources available. |`number`|`null`| no |
110
+
| <aname="input_aws_additional_allowed_principals"></a> [aws\_additional\_allowed\_principals](#input\_aws\_additional\_allowed\_principals)| The additional allowed principals to use when installing the cluster. |`list(string)`|`null`| no |
106
111
| <aname="input_aws_additional_compute_security_group_ids"></a> [aws\_additional\_compute\_security\_group\_ids](#input\_aws\_additional\_compute\_security\_group\_ids)| The additional security group IDs to be added to the default worker machine pool. |`list(string)`|`null`| no |
107
112
| <aname="input_aws_availability_zones"></a> [aws\_availability\_zones](#input\_aws\_availability\_zones)| The AWS availability zones where instances of the default worker machine pool are deployed. Leave empty for the installer to pick availability zones |`list(string)`|`[]`| no |
108
113
| <aname="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 |
109
114
| <aname="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 |
115
+
| <aname="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 |
110
116
| <aname="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 |
111
117
| <aname="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 |
112
118
| <aname="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 |
113
119
| <aname="input_create_account_roles"></a> [create\_account\_roles](#input\_create\_account\_roles)| Create the aws account roles for rosa |`bool`|`false`| no |
114
120
| <aname="input_create_admin_user"></a> [create\_admin\_user](#input\_create\_admin\_user)| To create cluster admin user with default username `cluster-admin` and generated password. It will be ignored if `admin_credentials_username` or `admin_credentials_password` is set. (default: false) |`bool`|`null`| no |
121
+
| <aname="input_create_dns_domain_reservation"></a> [create\_dns\_domain\_reservation](#input\_create\_dns\_domain\_reservation)| Creates reserves a dns domain domain for the cluster. This value will be created by the install step if not pre created via this configuration. |`bool`|`false`| no |
115
122
| <aname="input_create_oidc"></a> [create\_oidc](#input\_create\_oidc)| Create the oidc resources. This value should not be updated, please create a new resource instead or utilize the submodule to create a new oidc config |`bool`|`false`| no |
116
123
| <aname="input_create_operator_roles"></a> [create\_operator\_roles](#input\_create\_operator\_roles)| Create the aws account roles for rosa |`bool`|`false`| no |
117
124
| <aname="input_default_ingress_listening_method"></a> [default\_ingress\_listening\_method](#input\_default\_ingress\_listening\_method)| Listening Method for ingress. Options are ["internal", "external"]. Default is "external". When empty is set based on private variable. |`string`|`""`| no |
118
125
| <aname="input_destroy_timeout"></a> [destroy\_timeout](#input\_destroy\_timeout)| Maximum duration in minutes to allow for destroying resources. (Default: 60 minutes) |`number`|`null`| no |
119
126
| <aname="input_disable_waiting_in_destroy"></a> [disable\_waiting\_in\_destroy](#input\_disable\_waiting\_in\_destroy)| Disable addressing cluster state in the destroy resource. Default value is false, and so a `destroy` will wait for the cluster to be deleted. |`bool`|`null`| no |
127
+
| <aname="input_domain_prefix"></a> [domain\_prefix](#input\_domain\_prefix)| Creates a domain\_prefix for your ROSA cluster. Defaults to a random string if not set |`string`|`null`| no |
120
128
| <aname="input_ec2_metadata_http_tokens"></a> [ec2\_metadata\_http\_tokens](#input\_ec2\_metadata\_http\_tokens)| Should cluster nodes use both v1 and v2 endpoints or just v2 endpoint of EC2 Instance Metadata Service (IMDS). Available since OpenShift 4.11.0. |`string`|`"optional"`| no |
121
129
| <aname="input_etcd_encryption"></a> [etcd\_encryption](#input\_etcd\_encryption)| Add etcd encryption. By default etcd data is encrypted at rest. This option configures etcd encryption on top of existing storage encryption. |`bool`|`null`| no |
122
130
| <aname="input_etcd_kms_key_arn"></a> [etcd\_kms\_key\_arn](#input\_etcd\_kms\_key\_arn)| The key ARN is the Amazon Resource Name (ARN) of a CMK. It is a unique, fully qualified identifier for the CMK. A key ARN includes the AWS account, Region, and the key ID. |`string`|`null`| no |
@@ -125,6 +133,7 @@ We recommend you install the following CLI tools:
125
133
| <aname="input_https_proxy"></a> [https\_proxy](#input\_https\_proxy)| A proxy URL to use for creating HTTPS connections outside the cluster. |`string`|`null`| no |
126
134
| <aname="input_identity_providers"></a> [identity\_providers](#input\_identity\_providers)| Provides a generic approach to add multiple identity providers after the creation of the cluster. This variable allows users to specify configurations for multiple identity providers in a flexible and customizable manner, facilitating the management of resources post-cluster deployment. For additional details regarding the variables utilized, refer to the [idp sub-module](./modules/idp). For non-primitive variables (such as maps, lists, and objects), supply the JSON-encoded string. |`map(any)`|`{}`| no |
127
135
| <aname="input_ignore_machine_pools_deletion_error"></a> [ignore\_machine\_pools\_deletion\_error](#input\_ignore\_machine\_pools\_deletion\_error)| Ignore machine pool deletion error. Assists when cluster resource is managed within the same file for the destroy use case |`bool`|`false`| no |
136
+
| <aname="input_image_mirrors"></a> [image\_mirrors](#input\_image\_mirrors)| Provides a generic approach to add multiple image mirrors after the creation of the cluster. This variable allows users to specify configurations for multiple image mirrors in a flexible and customizable manner, facilitating the management of resources post-cluster deployment. For additional details regarding the variables utilized, refer to the [image-mirrors sub-module](./modules/image-mirrors). For non-primitive variables (such as maps, lists, and objects), supply the JSON-encoded string. |`map(any)`|`{}`| no |
128
137
| <aname="input_kms_key_arn"></a> [kms\_key\_arn](#input\_kms\_key\_arn)| The key ARN is the Amazon Resource Name (ARN) of a CMK. It is a unique, fully qualified identifier for the CMK. A key ARN includes the AWS account, Region, and the key ID. |`string`|`null`| no |
129
138
| <aname="input_kubelet_configs"></a> [kubelet\_configs](#input\_kubelet\_configs)| Provides a generic approach to add multiple kubelet configs after the creation of the cluster. This variable allows users to specify configurations for multiple kubelet configs in a flexible and customizable manner, facilitating the management of resources post-cluster deployment. For additional details regarding the variables utilized, refer to the [idp sub-module](./modules/kubelet-configs). For non-primitive variables (such as maps, lists, and objects), supply the JSON-encoded string. |`map(any)`|`{}`| no |
130
139
| <aname="input_machine_cidr"></a> [machine\_cidr](#input\_machine\_cidr)| Block of IP addresses used by OpenShift while installing the cluster, for example "10.0.0.0/16". |`string`|`null`| no |
@@ -144,6 +153,7 @@ We recommend you install the following CLI tools:
144
153
| <aname="input_service_cidr"></a> [service\_cidr](#input\_service\_cidr)| Block of IP addresses for services, for example "172.30.0.0/16". |`string`|`null`| no |
145
154
| <aname="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 |
146
155
| <aname="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 |
156
+
| <aname="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 |
147
157
| <aname="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 |
148
158
| <aname="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 |
149
159
@@ -161,9 +171,10 @@ We recommend you install the following CLI tools:
161
171
| <aname="output_cluster_domain"></a> [cluster\_domain](#output\_cluster\_domain)| The DNS domain of cluster. |
162
172
| <aname="output_cluster_id"></a> [cluster\_id](#output\_cluster\_id)| Unique identifier of the cluster. |
163
173
| <aname="output_cluster_state"></a> [cluster\_state](#output\_cluster\_state)| The state of the cluster. |
174
+
| <aname="output_image_mirror_ids"></a> [image\_mirror\_ids](#output\_image\_mirror\_ids)| A map of image mirror names to their unique identifiers. |
164
175
| <aname="output_oidc_config_id"></a> [oidc\_config\_id](#output\_oidc\_config\_id)| The unique identifier associated with users authenticated through OpenID Connect (OIDC) generated by this OIDC config. |
165
176
| <aname="output_oidc_endpoint_url"></a> [oidc\_endpoint\_url](#output\_oidc\_endpoint\_url)| Registered OIDC configuration issuer URL, generated by this OIDC config. |
166
177
| <aname="output_operator_role_prefix"></a> [operator\_role\_prefix](#output\_operator\_role\_prefix)| Prefix used for generated AWS operator policies. |
167
178
| <aname="output_operator_roles_arn"></a> [operator\_roles\_arn](#output\_operator\_roles\_arn)| List of Amazon Resource Names (ARNs) for all operator roles created. |
168
179
| <aname="output_path"></a> [path](#output\_path)| The arn path for the account/operator roles as well as their policies. |
0 commit comments