Skip to content

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.
osTag string | @alicloud/ros-cdk-core.IResolvable Property osTag: Operating system image tag.
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:.
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: true: automatic renewals;
autoRenewPeriod number | @alicloud/ros-cdk-core.IResolvable Property autoRenewPeriod: Duration of each automatic renewals, AutoRenew take effect when AutoRenew is True.
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: Set an example of the highest price per hour, are floating-point values, in the range of the current price range.
computeSpotStrategy string | @alicloud/ros-cdk-core.IResolvable Property computeSpotStrategy: Compute nodes bidding strategy, value NoSpot, SpotWithPriceLimit or SpotAsPriceGo.
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: Cluster description, 2 to 128 characters.
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: Mirror Id, if ImageType a system, based on the image ID is determined only according OsTag;
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.
password string | @alicloud/ros-cdk-core.IResolvable Property password: Root password of jump server (login node).
period number | @alicloud/ros-cdk-core.IResolvable Property period: The purchase of long resources, units: week \/ month \/ year.
periodUnit string | @alicloud/ros-cdk-core.IResolvable Property periodUnit: The purchase of long-resources unit.
postInstallScript @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | PostInstallScriptProperty[] Property postInstallScript:.
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: When SCC models, if you pass this field, then the specified SccCluster create Scc instance, otherwise it will create an instance for the user.
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 (SecurityGroupId is empty), then use this name to create a new security group, the default policy.
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.

osTagRequired 

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.

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[];

Property additionalVolumes:.

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: true: automatic renewals;

false: no automatic renewals.

autoRenewPeriodOptional 

public readonly autoRenewPeriod: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property autoRenewPeriod: Duration of each automatic renewals, AutoRenew take effect when AutoRenew is 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: Set an example of the highest price per hour, are floating-point values, in the range of the current price range.

computeSpotStrategyOptional 

public readonly computeSpotStrategy: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property computeSpotStrategy: Compute nodes bidding strategy, value NoSpot, SpotWithPriceLimit or SpotAsPriceGo.

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: Cluster description, 2 to 128 characters.

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: Mirror Id, if ImageType a system, based on the image ID is determined only according OsTag;

if self, others, or marketplace, ImageId is mandatory.

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.

passwordOptional 

public readonly password: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property password: Root password of jump server (login node).

8 to 30 characters, must contain three (upper and lower case letters, numbers and special symbols). ! Supports the following special characters :() `~ @ # $% ^ & * - + = | {} []:; '<>, \/ Be sure to use the HTTPS protocol API call to avoid password leaks that may occur.?.

periodOptional 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property period: The purchase of long resources, units: week \/ month \/ year.

When the value of the parameter EcsChargeType when PrePaid take effect and for the selected value will be.

periodUnitOptional 

public readonly periodUnit: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property periodUnit: The purchase of long-resources unit.

Alternatively value Week \/ Month \/ year.

postInstallScriptOptional 

public readonly postInstallScript: IResolvable | IResolvable | PostInstallScriptProperty[];

Property postInstallScript:.

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: When SCC models, if you pass this field, then the specified SccCluster create Scc instance, otherwise it will create an instance for the user.

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 (SecurityGroupId is empty), then use this name to create a new security group, the default policy.

Format Requirements Reference ECS security group name.

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.