ClusterProps
Properties for defining a Cluster.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ehpc-cluster
Initializer
import { ClusterProps } from '@alicloud/ros-cdk-ehpc'
const clusterProps: ClusterProps = { ... }
Properties
| Name | Type | Description |
|---|---|---|
ecsOrderComputeCount | number | @alicloud/ros-cdk-core.IResolvable | Property ecsOrderComputeCount: Computing node number, which ranges from: 0-99. |
ecsOrderComputeInstanceType | string | @alicloud/ros-cdk-core.IResolvable | Property ecsOrderComputeInstanceType: Cluster computing node instance specifications. |
ecsOrderLoginCount | number | @alicloud/ros-cdk-core.IResolvable | Property ecsOrderLoginCount: Login node number can only be 1. |
ecsOrderLoginInstanceType | string | @alicloud/ros-cdk-core.IResolvable | Property ecsOrderLoginInstanceType: Log cluster node instance specifications. |
ecsOrderManagerInstanceType | string | @alicloud/ros-cdk-core.IResolvable | Property ecsOrderManagerInstanceType: Cluster control node instance specifications. |
name | string | @alicloud/ros-cdk-core.IResolvable | Property name: Cluster name. |
vSwitchId | string | @alicloud/ros-cdk-core.IResolvable | Property vSwitchId: VPC in switch ID. |
accountType | string | @alicloud/ros-cdk-core.IResolvable | Property accountType: The service type of the domain account. |
additionalVolumes | @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | AdditionalVolumesProperty[] | Property additionalVolumes: The information of the NAS file system. |
application | @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ApplicationProperty[] | Property application: Application software tag (SoftwareTag) list, You can call ListSoftwares API to query. |
autoRenew | boolean | @alicloud/ros-cdk-core.IResolvable | Property autoRenew: Specifies whether to enable auto-renewal. |
autoRenewPeriod | number | @alicloud/ros-cdk-core.IResolvable | Property autoRenewPeriod: The auto-renewal period of the subscription compute nodes. |
clientVersion | string | @alicloud/ros-cdk-core.IResolvable | Property clientVersion: The version of the E-HPC client. |
computeEnableHt | boolean | @alicloud/ros-cdk-core.IResolvable | Property computeEnableHt: Specifies whether the compute nodes support hyper-threading. |
computeSpotPriceLimit | string | @alicloud/ros-cdk-core.IResolvable | Property computeSpotPriceLimit: The maximum hourly price of the compute nodes. |
computeSpotStrategy | string | @alicloud/ros-cdk-core.IResolvable | Property computeSpotStrategy: The bidding method of the compute nodes. |
deployMode | string | @alicloud/ros-cdk-core.IResolvable | Property deployMode: The mode in which the cluster is deployed. |
description | string | @alicloud/ros-cdk-core.IResolvable | Property description: The description of the E-HPC cluster. |
ecsChargeType | string | @alicloud/ros-cdk-core.IResolvable | Property ecsChargeType: ECS instance payment type, PostPaid: Pay-As-You-Go.PrePaid: Subscription.If you choose PrePaid, automatic renewal will be enabled by default, and closed when node is released. |
ecsOrderManagerCount | number | @alicloud/ros-cdk-core.IResolvable | Property ecsOrderManagerCount: Control node number can be 1, 2. |
ehpcVersion | string | @alicloud/ros-cdk-core.IResolvable | Property ehpcVersion: The version of E-HPC. |
haEnable | boolean | @alicloud/ros-cdk-core.IResolvable | Property haEnable: Specifies whether to enable the high availability feature. |
imageId | string | @alicloud/ros-cdk-core.IResolvable | Property imageId: The image IDs. |
imageOwnerAlias | string | @alicloud/ros-cdk-core.IResolvable | Property imageOwnerAlias: Mirror type: system, self, others or marketplace. |
inputFileUrl | string | @alicloud/ros-cdk-core.IResolvable | Property inputFileUrl: The URL of the job files that are uploaded to an Object Storage Service (OSS) bucket. |
isComputeEss | boolean | @alicloud/ros-cdk-core.IResolvable | Property isComputeEss: Specifies whether to enable auto scaling. |
jobQueue | string | @alicloud/ros-cdk-core.IResolvable | Property jobQueue: The queue to which the compute nodes are added. |
keyPairName | string | @alicloud/ros-cdk-core.IResolvable | Property keyPairName: Key pair name. |
networkInterfaceTrafficMode | string | @alicloud/ros-cdk-core.IResolvable | Property networkInterfaceTrafficMode: Communication mode of an elastic NIC. |
osTag | string | @alicloud/ros-cdk-core.IResolvable | Property osTag: Operating system image tag. |
password | string | @alicloud/ros-cdk-core.IResolvable | Property password: The root password of the logon node. |
period | number | @alicloud/ros-cdk-core.IResolvable | Property period: The duration of the subscription. |
periodUnit | string | @alicloud/ros-cdk-core.IResolvable | Property periodUnit: The unit of the subscription duration. |
postInstallScript | @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | PostInstallScriptProperty[] | Property postInstallScript: The information of the post-installation script. |
ramNodeTypes | @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] | Property ramNodeTypes: When authorizing instance configuration, the node type to which the RAM role is bound. |
ramRoleName | string | @alicloud/ros-cdk-core.IResolvable | Property ramRoleName: The name of the Resource Access Management (RAM) role. |
remoteDirectory | string | @alicloud/ros-cdk-core.IResolvable | Property remoteDirectory: Mount shared storage remote directory. |
remoteVisEnable | boolean | @alicloud/ros-cdk-core.IResolvable | Property remoteVisEnable: Specifies whether to enable Virtual Network Computing (VNC). |
resourceGroupId | string | @alicloud/ros-cdk-core.IResolvable | Property resourceGroupId: The ID of the resource group. |
sccClusterId | string | @alicloud/ros-cdk-core.IResolvable | Property sccClusterId: The Super Computing Cluster (SCC) instance ID. |
schedulerType | string | @alicloud/ros-cdk-core.IResolvable | Property schedulerType: The type of the scheduler. |
securityGroupId | string | @alicloud/ros-cdk-core.IResolvable | Property securityGroupId: Security group ID. |
securityGroupName | string | @alicloud/ros-cdk-core.IResolvable | Property securityGroupName: If you do not use an existing security group, set the parameter to the name of a new security group. |
systemDiskLevel | string | @alicloud/ros-cdk-core.IResolvable | Property systemDiskLevel: The performance level of the ESSD that is created as the system disk. |
systemDiskSize | number | @alicloud/ros-cdk-core.IResolvable | Property systemDiskSize: The size of the system disk. |
systemDiskType | string | @alicloud/ros-cdk-core.IResolvable | Property systemDiskType: The type of the system disk. |
volumeId | string | @alicloud/ros-cdk-core.IResolvable | Property volumeId: The ID of the file system. |
volumeMountpoint | string | @alicloud/ros-cdk-core.IResolvable | Property volumeMountpoint: The mount target of the file system. |
volumeProtocol | string | @alicloud/ros-cdk-core.IResolvable | Property volumeProtocol: The type of the protocol that is used by the file system. |
volumeType | string | @alicloud/ros-cdk-core.IResolvable | Property volumeType: The type of the shared storage. |
vpcId | string | @alicloud/ros-cdk-core.IResolvable | Property vpcId: The ID of the virtual private cloud (VPC) to which the E-HPC cluster belongs. |
withoutElasticIp | boolean | @alicloud/ros-cdk-core.IResolvable | Property withoutElasticIp: Specifies whether the logon node uses an elastic IP address (EIP). |
zoneId | string | @alicloud/ros-cdk-core.IResolvable | Property zoneId: Available area ID. |
ecsOrderComputeCountRequired
public readonly ecsOrderComputeCount: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
Property ecsOrderComputeCount: Computing node number, which ranges from: 0-99.
ecsOrderComputeInstanceTypeRequired
public readonly ecsOrderComputeInstanceType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property ecsOrderComputeInstanceType: Cluster computing node instance specifications.
ecsOrderLoginCountRequired
public readonly ecsOrderLoginCount: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
Property ecsOrderLoginCount: Login node number can only be 1.
ecsOrderLoginInstanceTypeRequired
public readonly ecsOrderLoginInstanceType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property ecsOrderLoginInstanceType: Log cluster node instance specifications.
ecsOrderManagerInstanceTypeRequired
public readonly ecsOrderManagerInstanceType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property ecsOrderManagerInstanceType: Cluster control node instance specifications.
nameRequired
public readonly name: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property name: Cluster name.
2-64 characters in length, allowing only include Chinese, letters, numbers, dashes (-) and underscore (_), must begin with a letter or Chinese.
vSwitchIdRequired
public readonly vSwitchId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property vSwitchId: VPC in switch ID.
Products currently only supports VPC network.
accountTypeOptional
public readonly accountType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property accountType: The service type of the domain account.
Valid values: nis ldap Default value: nis
additionalVolumesOptional
public readonly additionalVolumes: IResolvable | IResolvable | AdditionalVolumesProperty[];
- Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | AdditionalVolumesProperty[]
Property additionalVolumes: The information of the NAS file system.
applicationOptional
public readonly application: IResolvable | IResolvable | ApplicationProperty[];
- Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ApplicationProperty[]
Property application: Application software tag (SoftwareTag) list, You can call ListSoftwares API to query.
autoRenewOptional
public readonly autoRenew: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
Property autoRenew: Specifies whether to enable auto-renewal.
Valid values: * true * false Default value: false.
autoRenewPeriodOptional
public readonly autoRenewPeriod: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
Property autoRenewPeriod: The auto-renewal period of the subscription compute nodes.
The parameter takes effect when AutoRenew is set to true.
clientVersionOptional
public readonly clientVersion: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property clientVersion: The version of the E-HPC client.
By default, the parameter is set to the latest version number. You can call the ListCurrentClientVersion operation to query the current version of the E-HPC client.
computeEnableHtOptional
public readonly computeEnableHt: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
Property computeEnableHt: Specifies whether the compute nodes support hyper-threading.
Valid values: true: Hyper-threading is supported. false: Hyper-threading is not supported. Default value: true
computeSpotPriceLimitOptional
public readonly computeSpotPriceLimit: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property computeSpotPriceLimit: The maximum hourly price of the compute nodes.
A maximum of three decimal places can be used in the value of the parameter. The parameter is valid only when the ComputeSpotStrategy parameter is set to SpotWithPriceLimit.
computeSpotStrategyOptional
public readonly computeSpotStrategy: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property computeSpotStrategy: The bidding method of the compute nodes.
Valid values: * NoSpot: The compute nodes are pay-as-you-go instances. * SpotWithPriceLimit: The compute nodes are preemptible instances that have a user-defined maximum hourly price. * SpotAsPriceGo: The compute nodes are preemptible instances for which the market price at the time of purchase is used as the bid price. Default value: NoSpot.
deployModeOptional
public readonly deployMode: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property deployMode: The mode in which the cluster is deployed.
Valid values: Standard: An account node, a scheduling node, a logon node, and multiple compute nodes are separately deployed. Simple: A management node, a logon node, and multiple compute nodes are deployed. The management node consists of an account node and a scheduling node. The logon node and compute nodes are separately deployed. Tiny: A management node and multiple compute nodes are deployed. The management node consists of an account node, a scheduling node, and a logon node. The compute nodes are separately deployed. Default value: Standard
descriptionOptional
public readonly description: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property description: The description of the E-HPC cluster.
The description must be 2 to 256 characters in length and cannot start with http:\/\/ or https:\/\/.
ecsChargeTypeOptional
public readonly ecsChargeType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property ecsChargeType: ECS instance payment type, PostPaid: Pay-As-You-Go.PrePaid: Subscription.If you choose PrePaid, automatic renewal will be enabled by default, and closed when node is released.
ecsOrderManagerCountOptional
public readonly ecsOrderManagerCount: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
Property ecsOrderManagerCount: Control node number can be 1, 2.
ehpcVersionOptional
public readonly ehpcVersion: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property ehpcVersion: The version of E-HPC.
By default, the parameter is set to the latest version number.
haEnableOptional
public readonly haEnable: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
Property haEnable: Specifies whether to enable the high availability feature.
Valid values: true: enables the high availability feature false: disables the high availability feature Default value: false Note If high availability is enabled, primary management nodes and secondary management nodes are used.
imageIdOptional
public readonly imageId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property imageId: The image IDs.
You can call the ListImages and ListCustomImages operations to query the images that are supported by E-HPC.
imageOwnerAliasOptional
public readonly imageOwnerAlias: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property imageOwnerAlias: Mirror type: system, self, others or marketplace.
inputFileUrlOptional
public readonly inputFileUrl: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property inputFileUrl: The URL of the job files that are uploaded to an Object Storage Service (OSS) bucket.
isComputeEssOptional
public readonly isComputeEss: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
Property isComputeEss: Specifies whether to enable auto scaling.
Valid values: true: enables auto scaling false: disables auto scaling Default value: false
jobQueueOptional
public readonly jobQueue: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property jobQueue: The queue to which the compute nodes are added.
keyPairNameOptional
public readonly keyPairName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property keyPairName: Key pair name.
networkInterfaceTrafficModeOptional
public readonly networkInterfaceTrafficMode: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property networkInterfaceTrafficMode: Communication mode of an elastic NIC.
Value values: - Standard: The TCP communication mode is used. - HighPerformance: Enables the Elastic RDMA Interface (ERI) and uses the RDMA communication mode.
osTagOptional
public readonly osTag: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property osTag: Operating system image tag.
You can call ListImages API to query.
passwordOptional
public readonly password: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property password: The root password of the logon node.
The password must be 8 to 30 characters in length and contain at least three of the following items: uppercase letters, lowercase letters, digits, and special characters. Special characters include: ( ) ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ‘ < > , . ? \/ You must specify either Password or KeyPairName. If both are specified, the Password parameter prevails.
We recommend that you use HTTPS to call the API operation to prevent password leakage.
periodOptional
public readonly period: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
Property period: The duration of the subscription.
The unit of the duration is specified by the PeriodUnit parameter. * Valid values if PriceUnit is set to Year: 1, 2, and 3. * Valid values if PriceUnit is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, and 9. * Valid value if PriceUnit is set to Hour: 1. Default value: 1.
periodUnitOptional
public readonly periodUnit: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property periodUnit: The unit of the subscription duration.
Valid values: * Year * Month * Hour Default value: Month.
postInstallScriptOptional
public readonly postInstallScript: IResolvable | IResolvable | PostInstallScriptProperty[];
- Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | PostInstallScriptProperty[]
Property postInstallScript: The information of the post-installation script.
ramNodeTypesOptional
public readonly ramNodeTypes: IResolvable | string | IResolvable[];
- Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]
Property ramNodeTypes: When authorizing instance configuration, the node type to which the RAM role is bound.
When the value of DeployMode is Standard, the value range: scheduler, account, login, compute. When the value of DeployMode is Simple, the value range: manager, login, compute. When the value of DeployMode is Tiny, the value range: manager, compute.
ramRoleNameOptional
public readonly ramRoleName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property ramRoleName: The name of the Resource Access Management (RAM) role.
You can call the ListRoles operation provided by RAM to query the created RAM roles.
remoteDirectoryOptional
public readonly remoteDirectory: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property remoteDirectory: Mount shared storage remote directory.
The final path to the mount point and mount the remote directory composition: NasMountpoint: \/ RemoteDirectory
remoteVisEnableOptional
public readonly remoteVisEnable: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
Property remoteVisEnable: Specifies whether to enable Virtual Network Computing (VNC).
Valid values: true: enables VNC false: disables VNC Default value: false
resourceGroupIdOptional
public readonly resourceGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property resourceGroupId: The ID of the resource group.
You can call the ListResourceGroups operation to obtain the ID of the resource group.
sccClusterIdOptional
public readonly sccClusterId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property sccClusterId: The Super Computing Cluster (SCC) instance ID.
If you specify the parameter, the SCC instance is moved to a new SCC cluster.
schedulerTypeOptional
public readonly schedulerType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property schedulerType: The type of the scheduler.
Valid values: pbs slurm opengridscheduler deadline Default value: pbs
securityGroupIdOptional
public readonly securityGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property securityGroupId: Security group ID.
securityGroupNameOptional
public readonly securityGroupName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property securityGroupName: If you do not use an existing security group, set the parameter to the name of a new security group.
A default policy is applied to the new security group.
systemDiskLevelOptional
public readonly systemDiskLevel: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property systemDiskLevel: The performance level of the ESSD that is created as the system disk.
Valid values: PL0: A single ESSD can deliver up to 10,000 input\/output operations per second (IOPS) of random read\/write. PL1: A single ESSD can deliver up to 50,000 IOPS of random read\/write. PL2: A single ESSD can deliver up to 100,000 IOPS of random read\/write. PL3: A single ESSD can deliver up to 1,000,000 IOPS of random read\/write. Default value: PL1
systemDiskSizeOptional
public readonly systemDiskSize: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
Property systemDiskSize: The size of the system disk.
Unit: GB Valid values: 40 to 500 Default value: 40
systemDiskTypeOptional
public readonly systemDiskType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property systemDiskType: The type of the system disk.
Valid values: cloud_efficiency: ultra disk. cloud_ssd: SSD. cloud_essd: ESSD. Default value: cloud_ssd
volumeIdOptional
public readonly volumeId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property volumeId: The ID of the file system.
If you leave the parameter empty, a Performance NAS file system is created by default.
volumeMountpointOptional
public readonly volumeMountpoint: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property volumeMountpoint: The mount target of the file system.
Take note of the following information: If you do not specify the VolumeId parameter, you can leave the VolumeMountpoint parameter empty. A mount target is created by default. If you specify the VolumeId parameter, the VolumeMountpoint parameter is required.
volumeProtocolOptional
public readonly volumeProtocol: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property volumeProtocol: The type of the protocol that is used by the file system.
Valid values: nfs smb Default value: nfs
volumeTypeOptional
public readonly volumeType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property volumeType: The type of the shared storage.
Only Apsara File Storage nas file systems are supported.
vpcIdOptional
public readonly vpcId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property vpcId: The ID of the virtual private cloud (VPC) to which the E-HPC cluster belongs.
withoutElasticIpOptional
public readonly withoutElasticIp: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
Property withoutElasticIp: Specifies whether the logon node uses an elastic IP address (EIP).
Default value: false
zoneIdOptional
public readonly zoneId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property zoneId: Available area ID.