container-platform
cloud-native-toolkit/container-platform/ibm
Terraform module to create or connect to a IBM Cloud cluster
IBM Cloud Cluster Module This module interacts with a kubernetes cluster on IBM Cloud public. It can be used to create a new cluster or to connect with an existing cluster. When creating a new cluster, the type can be set to either kubernetes or openshift. Note: This module follows the Terraform conventions regarding how provider configuration is defined within the Terraform template and passed into the module - https://www.terraform.io/docs/language/modules/develop/providers.html. The default provider configuration flows through to the module. If different configuration is required for a module, it can be explicitly passed in the providers block of the module - https://www.terraform.io/docs/language/modules/develop/providers.html#passing-providers-explicitly. Pre-requisites This module ha
| Name | Type | Description | Default |
|---|---|---|---|
| cluster_type | string | The type of cluster that should be created (openshift or ocp3 or ocp4 or kuberne | required |
| cluster_name | string | The name of the cluster that will be created within the resource group | required |
| cluster_region | string | The IBM Cloud region where the cluster will be/has been installed. | required |
| resource_group_name | string | The name of the IBM Cloud resource group where the cluster will be created/can b | required |
| ibmcloud_api_key | string | The IBM Cloud api token | required |
| cluster_exists | bool | Flag indicating if the cluster already exists (true or false) | required |
| public_vlan_id | string | (Deprecated, use VPC) The public vlan id that should be used for classic infrast | "" |
| is_vpc | bool | Flag indicating that the cluster uses vpc infrastructure | false |
| private_vlan_id | string | (Deprecated, use VPC) The private vlan id that should be used for classic infras | "" |
| vpc_zone_count | number | Number of vpc zones | 0 |
| login_user | string | The username to log in to openshift | "apikey" |
| ocp_entitlement | string | Value that is applied to the entitlements for OCP cluster provisioning | "cloud_pak" |
| gitops_dir | string | Directory where the gitops repo content should be written | "" |
| cluster_hardware | string | The type of hardware for the cluster (shared, dedicated) | "shared" |
| cos_name | string | (optional) The name of the cos instance that will be used for the OCP 4 vpc inst | "" |
| provision_cos | bool | Flag indicating that the cos instance should be provisioned, if necessary | true |
| cluster_worker_count | number | The number of worker nodes that should be provisioned for classic infrastructure | 3 |
| vlan_datacenter | string | (Deprecated, use VPC) The datacenter that should be used for classic infrastruct | "" |
| name_prefix | string | The prefix name for the service. If not provided it will default to the resource | "" |
| cluster_machine_type | string | (Deprecated, use VPC) The machine type that will be provisioned for classic infr | "b3c.4x16" |
| flavor | string | (Deprecated, use VPC) The machine type that will be provisioned for classic infr | "b3c.4x16" |
ingress_hostname — (Deprecated) Ingress hostname of the cluster.config_file_path — (Deprecated) Path to the config file for the cluster.login_user — (Deprecated) The username used to log into the openshift clilogin_password — (Deprecated) The password used to log into the openshift clitag — The tag based on the cluster typeid — ID of the cluster.resource_group_name — Name of the resource group containing the cluster.name — Name of the cluster.region — Region containing the cluster.server_url — The url of the control server.version — (Deprecated, use platform.version) The point release version number of cluster (3.11 or 4.3 or 1.16)tls_secret_name — (Deprecated) The name of the secret containin the tls information for the clustertype — (Deprecated, use platform.type) The type of cluster (openshift or ocp4 or ocp3 or kubernetes)type_code — (Deprecated, use platform.type_code) The type of cluster (openshift or ocp4 or ocp3 or kubernetes)platform — Configuration values for the cluster platform