Deployment values
The following deployment values can be used to configure Red Hat® OpenShift® cluster instance on IBM Cloud®:
| Value | Description | Is it required? | Default value |
|---|---|---|---|
api_key |
The API key for the IBM Cloud account where the Red Hat OpenShift cluster needs to be deployed. For more information on how to create an API key, see Managing user API keys. | Yes | None |
cluster_prefix |
Prefix that is used to name the IBM Cloud resources that are provisioned to build the Red Hat OpenShift cluster. You cannot create more than one instance of the Red Hat OpenShift cluster with the same name. Make sure that the name is unique.
Enter a prefix name, for example, my-openshift. The length of the prefix should be fewer than 13 characters. |
No | hpcc-oc |
enable_logdna |
Specify whether you would like to set up a logging configuration for the Red Hat OpenShift cluster. For more information, see Forwarding cluster and app logs to IBM Log Analysis. | No | true |
enable_monitoring |
Specify whether you would like to set up a monitoring configuration for the Red Hat OpenShift cluster. For more information, see Monitoring cluster health. | No | true |
kube_version |
The Red Hat OpenShift version that you want to set up in your cluster. Available versions: 4.9_openshift and 4.8_openshift. For more information, see Version information and update actions. | No | 4.9_openshift |
login_node_instance_type |
Specify the virtual server instance profile type name to be used to create the login (bastion) node for the Red Hat OpenShift cluster. For more information, see Instance Profiles. | No | bx2-2x8 |
mount_path |
Specify the mount path name for the exported directory on the NFS storage node. For example, if the name provided is data, the exported directory will be /data. |
No | data |
region |
Enter a region from the following list in which the cluster will be deployed: us-south, us-east, eu-gb, eu-de, jp-tok, au-syd, jp-osa, br-sao, ca-tor. For more information, see Region and data center locations for resource deployment. | Yes | None |
resource_group |
Resource group name from your IBM Cloud account where the VPC resources should be deployed. For more information, see Managing resource groups. | No | Default |
ssh_key_name |
Comma-separated list of names of the SSH key configured in your IBM Cloud account that is used to establish a connection to the Red Hat OpenShift login node. Ensure that the SSH key is present in the same resource group and region where the cluster is being provisioned. If you do not have an SSH key in your IBM Cloud account, create one by using the SSH keys instructions. | Yes | None |
storage_node_instance_type |
Specify the virtual server instance profile type to be used to create the NFS storage node for the Red Hat OpenShift cluster. The storage node is used to create an NFS file system instance that is exported and can be mounted for sharing data among the Red Hat OpenShift cluster nodes. For more information, see Instance Profiles. | No | bx2-2x8 |
volume_capacity |
Size in GB for the block storage that will be used to build the NFS file system instance on the storage node. Enter a value in the range 10 - 16,000. For more information, see Block storage capacity and performance. | No | 100 |
volume_iops |
Number to represent the IOPS (Input Output Per Second) configuration for block storage to be used for the NFS storage node (valid only for volume_profile=custom, dependent on volume_capacity. Enter a value in the
range 100 - 48,000). For more information, see Custom IOPS profile. |
No | 100 |
volume_profile |
Name of the block storage volume type to be used for the NFS storage node. For more information, see Block storage profiles. | No | general-purpose |
worker_nodes_per_zone |
The number of worker nodes per zone in the default worker pool. Minimum is one node, and 1,000 is the maximum for each zone. For more information, see Planning your worker node setup. | No | 1 |
worker_pool_flavor |
The flavor of the Red Hat OpenShift worker nodes that you want to create and attach to the cluster. For more information, see Available flavors for VMs. | No | bx2.4x16 |