Deployment values
The following deployment values can be used to configure the IBM Spectrum Symphony cluster instance on IBM Cloud.
| Value | Description | Is it required? | Default value |
|---|---|---|---|
api_key |
This is the IBM Cloud API key for the IBM Cloud account where the IBM Spectrum Symphony cluster needs to be deployed. For more information on how to create an API key, see Managing user API keys. | Yes | None |
cluster_id |
Unique ID of the cluster used by Symphony for configuration of resources. This must be up to 39 alphanumeric characters including the underscore (_), the hyphen (-), and the period (.). Other special characters and spaces are not allowed. Do not use the name of any host or user as the name of your cluster. You cannot change it after installation. | No | HPCCluster |
cluster_prefix |
Prefix that is used to name the IBM Spectrum Symphony cluster and IBM Cloud resources that are provisioned to build the IBM Spectrum Symphony cluster instance. You cannot create more than one instance of the Symphony cluster with the same name. Make sure that the name is unique. | No | spectrum-symphony |
dedicated_host_enabled |
Set to true to use dedicated hosts for compute hosts (default: false). Note that Symphony still dynamically provisions compute hosts at public virtual server instances and dedicated hosts are used only for static compute hosts that are provisioned
at the time the cluster is created. The number of dedicated hosts and the profile names for dedicated hosts are calculated from worker_node_min_count and worker_node_instance_type. |
No | false |
dedicated_host_placement |
Specify 'pack' or 'spread'. The 'pack' option deploys virtual server instances on one dedicated host until full before moving on to the next dedicated host. The 'spread' option deploys virtual server instances in round-robin fashion across all the dedicated hosts. The second option should result in mostly even distribution of instances on the hosts, while the first option might result in one dedicated host being mostly empty. | No | spread |
hyperthreading_enabled |
Setting this to true will enable hyper-threading in the worker nodes of the cluster (default). Otherwise, hyper-threading is disabled. | No | true |
ibm_customer_number |
Comma-separated list of the IBM Customer Number(s) (ICN) that is used for the Bring Your Own License (BYOL) entitlement check. For more information on how to find your ICN, see What is my IBM Customer Number (ICN)?. | Yes | None |
image_name |
Name of the custom image that you want to use to create virtual server instances in your IBM Cloud account to deploy the IBM Spectrum Symphony cluster. By default, the automation uses a base image with additional software packages mentioned here. If you would like to include your application-specific binary files, follow the instructions in Planning for custom images to create your own custom image and use that to build the IBM Spectrum Symphony cluster through this offering. | No | hpcc-symp732-scale5190-rhel88-v1-6 |
login_node_instance_type |
Specifies the virtual server instance profile type to be used to create the login node for the IBM Spectrum Symphony cluster. For choices on profile types, see Instance profiles. | No | bx2-2x8 |
management_node_count |
Number of management nodes. This is the total number of primary, secondary, and management nodes. There is one primary, one secondary, and the rest of the nodes are management nodes. Enter a value in the range 1 - 10. | No | 3 |
management_node_instance_type |
Specify the virtual server instance profile type to be used to create the management nodes for the IBM Spectrum Symphony cluster. For choices on profile types, see Instance profiles. | No | bx2-4x16 |
remote_allowed_ips |
Comma-separated list of IP addresses that can access the Spectrum Symphony instance through an SSH or RDP interface. For security purposes, provide the public IP addresses assigned to the devices that are authorized to establish an SSH or RDP connection (for example, ["169.45.117.34"]). To fetch the IP address of the device, use https://ipv4.icanhazip.com/. | Yes | None |
resource_group |
Resource group name from your IBM Cloud account where the VPC resources should be deployed. Note: Do not modify the "Default" value if you would like to use the auto-scaling capability. For additional information on resource groups, see Managing resource groups. | No | Default |
scale_compute_cluster_filesystem_mountpoint |
Compute cluster (accessingCluster) file system mount point. The accessingCluster is the cluster that accesses the owningCluster. For more information, see Mounting a remote GPFS file system. | No | /gpfs/fs1 |
scale_compute_cluster_gui_password |
Password for compute cluster GUI. Note: Password should be at least 8 characters, must have one number, one lowercase letter, one uppercase letter, and at least one unique character. Password should not contain username. | No | None |
scale_compute_cluster_gui_username |
GUI user to perform system management and monitoring tasks on compute cluster. Note: Username should be at least 4 characters, any combination of lowercase and uppercase letters. | No | None |
scale_filesystem_block_size |
File system block size. Storage Scale supported block sizes (in bytes) include: 256K, 512K, 1M, 2M, 4M, 8M, 16M. | No | 4M |
scale_storage_cluster_filesystem_mountpoint |
Storage Scale storage cluster (owningCluster) file system mount point. The owningCluster is the cluster that owns and serves the file system to be mounted. For more information, see Mounting a remote GPFS file system. | No | /gpfs/fs1 |
scale_storage_cluster_gui_password |
Password for Storage Scale storage cluster GUI. Note: Password should be at least 8 characters, must have one number, one lowercase letter, one uppercase letter, and at least one unique character. Password should not contain username. | No | None |
scale_storage_cluster_gui_username |
GUI user to perform system management and monitoring tasks on storage cluster. Note: Username should be at least 4 characters, any combination of lowercase and uppercase letters. | No | None |
scale_storage_image_name |
Name of the custom image that you would like to use to create virtual machines in your IBM Cloud account to deploy the Storage Scale storage cluster. By default, the automation uses a base image plus the Storage Scale software and any other software packages that it requires. If you'd like, you can follow the instructions for Planning for custom images to create your own custom image with additional software and use that to build the Storage Scale storage cluster through this offering. | No | hpcc-scale5190-rhel88 |
scale_storage_node_count |
Total number of storage cluster instances that you need to provision. A minimum of 3 nodes and a maximum of 18 nodes are supported if the storage_type selected is scratch. A minimum of 3 nodes and a maximum of 10 nodes are supported
if the storage_type selected is persistent. |
No | 3 |
scale_storage_node_instance_type |
Specify the virtual server instance storage profile type name to be used to create the Storage Scale storage nodes for the Spectrum Symphony cluster. For more information, see Instance profiles | No | cx2d-8x16 |
spectrum_scale_enabled |
Setting this to 'true' enables Storage Scale integration with the cluster. Otherwise, Storage Scale integration is disabled (default). By entering 'true' for the property, you have also agreed to one of the two conditions: (1) You are using the software in production and confirm you have sufficient licenses to cover your use under the International Program License Agreement (IPLA). (2) You are evaluating the software and agree to abide by the International License Agreement for Evaluation of Programs (ILAE). Note: Failure to comply with licenses for production use of software is a violation of IBM International Program License Agreement | No | false |
ssh_key_name |
Comma-separated list of names of the SSH key that is configured in your IBM Cloud account and is used to establish a connection to the Symphony management 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 instructions that are given at SSH keys. | Yes | None |
storage_node_instance_type |
Specify the virtual server instance profile type to be used to create the storage nodes for the IBM Spectrum Symphony cluster. The storage nodes are the ones that would be used to create an NFS instance to manage the data for HPC workloads. For choices on profile types, see Instance profiles. | No | bx2-2x8 |
storage_type |
Select the Storage Scale file system deployment method. Note: The Storage Scale scratch type deploys the Storage Scale file system on virtual server instances, and the persistent type deploys the Storage Scale file system on bare metal servers. | No | "scratch" |
volume_capacity |
Size in GB for the block storage that would be used to build the NFS instance and would be available as a mount on the IBM Spectrum Symphony management node. Enter a value in the range 10 - 16,000. | No | 100 |
volume_iops |
Number to represent the IOPS configuration for block storage to be used for the NFS instance (valid only for volume_profile=custom, dependent on volume_capacity). Enter a value in the range 100 - 48,000. For possible
options of IOPS, see Custom IOPS profile. |
No | 300 |
volume_profile |
Name of the block storage volume type to be used for NFS instance. For possible options, see Block storage profiles. | No | general_purpose |
vpc_cidr_block |
Creates the address prefix for the new VPC when the vpc_name variable is empty. Only a single address prefix is allowed. For more information, see Setting IP ranges. |
No | "10.241.0.0/18" |
vpc_cluster_login_private_subnets_cidr_blocks |
The CIDR block that's required for the creation of the login cluster private subnet. Modify the CIDR block if it has already been reserved or used for other applications within the VPC or conflicts with any on-premises CIDR blocks if you are using a hybrid environment. Provide only one CIDR block for the creation of the login subnet. Since the login subnet is used only for the creation of the login virtual server instance, provide a CIDR range of /28. | No | "10.241.4.0/28" |
vpc_cluster_private_subnets_cidr_blocks |
The CIDR block that's required for the creation of the compute and storage cluster private subnet. Modify the CIDR block if it has already been reserved or used for other applications within the VPC or conflicts with any on-premises CIDR blocks if you are using a hybrid environment. Provide only one CIDR block for the creation of the compute and storage subnet. Make sure to select a CIDR block size that accommodates the maximum number of management, storage, and both static and dynamic worker nodes that you expect to have in your cluster. For more information on CIDR block size selection, see Choosing IP ranges for your VPC. | No | "10.241.0.0/22" |
vpc_name |
Name of an existing VPC in which the cluster resources are deployed. If no value is given, then a new VPC is provisioned for the cluster. Learn more. | No | _NOT_SET_ |
vpc_scale_storage_dns_domain |
IBM Cloud DNS Services domain name to be used for the Storage Scale storage cluster. Note: The domain name should not be the same as vpc_worker_dns_domain when spectrum_scale_enabled is set to "true". |
No | "dnsscale.com" |
vpc_worker_dns_domain |
IBM Cloud DNS Services domain name to be used for the compute cluster, for example, "test.example.corp". | No | "dnsworker.com" |
vpn_enabled |
Set the value as true to deploy a VPN gateway for VPC in the cluster. | No | false |
vpn_peer_address |
The peer public IP address to which the VPN is connected. | No | _NOT_SET_ |
vpn_peer_cidrs |
Comma-separated list of peer CIDRs (for example, 192.168.0.0/24) to which the VPN is connected. | No | _NOT_SET_ |
vpn_preshared_key |
The pre-shared key for the VPN | No | _NOT_SET_ |
windows_image_name |
Name of the custom image that you want to use to create Windows® virtual server instances in your IBM Cloud account to deploy the IBM Spectrum Symphony cluster. By default, the solution uses a base image with additional software packages, which are mentioned here. If you want to include your application-specific binary files, follow the instructions in Planning for custom images to create your own custom image and use that to build the IBM Spectrum Symphony cluster through this offering. | No | hpcc-sym732-win2016-v1-1 |
windows_worker_node |
Set to true to deploy Windows® worker nodes in the cluster. By default, the cluster deploys Linux® worker nodes. If the variable is set to true, the values of both worker_node_min_count and worker_node_max_count should be equal because the current implementation doesn't support dynamic creation of worker nodes through Host Factory. |
No | false |
worker_node_instance_type |
Specify the virtual server instance or bare metal server profile type name to be used to create the worker nodes for the Spectrum Symphony cluster based on worker_node_type. The worker nodes are the ones where the workload execution
takes place, and the choice should be made according to the characteristic of the workloads. For more information, see virtual server instance profiles and bare metal server profiles.
Note: If dedicated_host_enabled == true, available instance prefix (for example, bx2 and cx2) can be limited depending on your target region. You can verify with the following IBM Cloud CLI commands: ibmcloud target -r {region_name} and ibmcloud is dedicated-host-profiles. |
No | bx2-4x16 |
worker_node_max_count |
The maximum number of virtual server instance or bare metal server worker nodes that can be provisioned in the cluster. To take advantage of the auto-scale feature from Host Factory, the value needs to be greater than the worker_node_min_count. Enter a value in the range 1 - 500. if you are using bare metal servers, the value needs to match the worker_node_min_count,
and the permitted value is in the range 1 - 16. Note: If you plan to use Storage Scale storage, the value for this parameter should be equal to worker_node_min_count. |
No | 10 |
worker_node_min_count |
The minimum number of virtual server instance or bare metal server worker nodes that will be provisioned at the time the cluster is created. For bare metal servers, enter a value in the range 1 - 16. For virtual server instances with NFS
storage, enter a value in the range 0 - 500. For virtual server instances with Storage Scale storage, enter a value in the range 1 - 64. Note: Storage Scale requires a minimum of 3 compute nodes (combination of primary,
secondary, management, and worker nodes) to establish a quorum and maintain data consistency if a node fails.
Therefore, the minimum value of 1 might need to be larger if the value specified for management_node_count is less than 2. |
No | 0 |
worker_node_type |
The type of server that's used for the worker nodes: virtual server instance or bare metal server. If you choose vsi, the worker nodes are deployed on virtual server instances, or if you choose baremetal, the worker
nodes are deployed on bare metal servers. Note: If baremetal is selected, only static worker nodes are supported; you will not be able to use the Spectrum Symphony Host Factory feature for auto-scaling on
the cluster. |
No | vsi |
zone |
IBM Cloud zone name within the selected region where the IBM Spectrum Symphony cluster should be deployed. To get a full list of zones within a region, see Get zones by using the CLI. | Yes | None |