Cluster

• Implements: ICluster

This class encapsulates and extends the ROS resource type ALIYUN::EHPC::Cluster, which is used to create an Elastic High Performance Computing (E-HPC) cluster.

Initializers

import ros_cdk_ehpc
ros_cdk_ehpc.Cluster(
  scope: Construct,
  id: str,
  ecs_order_compute_count: typing.Union[typing.Union[int, float], IResolvable],
  ecs_order_compute_instance_type: typing.Union[str, IResolvable],
  ecs_order_login_count: typing.Union[typing.Union[int, float], IResolvable],
  ecs_order_login_instance_type: typing.Union[str, IResolvable],
  ecs_order_manager_instance_type: typing.Union[str, IResolvable],
  name: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  account_type: typing.Union[str, IResolvable] = None,
  additional_volumes: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AdditionalVolumesProperty]]] = None,
  application: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ApplicationProperty]]] = None,
  auto_renew: typing.Union[bool, IResolvable] = None,
  auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  client_version: typing.Union[str, IResolvable] = None,
  compute_enable_ht: typing.Union[bool, IResolvable] = None,
  compute_spot_price_limit: typing.Union[str, IResolvable] = None,
  compute_spot_strategy: typing.Union[str, IResolvable] = None,
  deploy_mode: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  ecs_charge_type: typing.Union[str, IResolvable] = None,
  ecs_order_manager_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  ehpc_version: typing.Union[str, IResolvable] = None,
  ha_enable: typing.Union[bool, IResolvable] = None,
  image_id: typing.Union[str, IResolvable] = None,
  image_owner_alias: typing.Union[str, IResolvable] = None,
  input_file_url: typing.Union[str, IResolvable] = None,
  is_compute_ess: typing.Union[bool, IResolvable] = None,
  job_queue: typing.Union[str, IResolvable] = None,
  key_pair_name: typing.Union[str, IResolvable] = None,
  network_interface_traffic_mode: typing.Union[str, IResolvable] = None,
  os_tag: typing.Union[str, IResolvable] = None,
  password: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  post_install_script: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, PostInstallScriptProperty]]] = None,
  ram_node_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  ram_role_name: typing.Union[str, IResolvable] = None,
  remote_directory: typing.Union[str, IResolvable] = None,
  remote_vis_enable: typing.Union[bool, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  scc_cluster_id: typing.Union[str, IResolvable] = None,
  scheduler_type: typing.Union[str, IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  security_group_name: typing.Union[str, IResolvable] = None,
  system_disk_level: typing.Union[str, IResolvable] = None,
  system_disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  system_disk_type: typing.Union[str, IResolvable] = None,
  volume_id: typing.Union[str, IResolvable] = None,
  volume_mountpoint: typing.Union[str, IResolvable] = None,
  volume_protocol: typing.Union[str, IResolvable] = None,
  volume_type: typing.Union[str, IResolvable] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  without_elastic_ip: typing.Union[bool, IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

ecs_order_compute_count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property ecsOrderComputeCount: Computing node number, which ranges from: 0-99.

ecs_order_compute_instance_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ecsOrderComputeInstanceType: Cluster computing node instance specifications.

ecs_order_login_count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property ecsOrderLoginCount: Login node number can only be 1.

ecs_order_login_instance_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ecsOrderLoginInstanceType: Log cluster node instance specifications.

ecs_order_manager_instance_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ecsOrderManagerInstanceType: Cluster control node instance specifications.

name^Required

• Type: typing.Union[str, 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.

v_switch_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vSwitchId: VPC in switch ID.

Products currently only supports VPC network.

account_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property accountType: The service type of the domain account.

Valid values: nis ldap Default value: nis

additional_volumes^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AdditionalVolumesProperty]]]

Property additionalVolumes:.

application^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ApplicationProperty]]]

Property application: Application software tag (SoftwareTag) list, You can call ListSoftwares API to query.

auto_renew^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property autoRenew: true: automatic renewals;

false: no automatic renewals.

auto_renew_period^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property autoRenewPeriod: Duration of each automatic renewals, AutoRenew take effect when AutoRenew is True.

client_version^Optional

• Type: typing.Union[str, 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.

compute_enable_ht^Optional

• Type: typing.Union[bool, 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

compute_spot_price_limit^Optional

• Type: typing.Union[str, 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.

compute_spot_strategy^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

deploy_mode^Optional

• Type: typing.Union[str, 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

description^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: Cluster description, 2 to 128 characters.

ecs_charge_type^Optional

• Type: typing.Union[str, 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.

ecs_order_manager_count^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property ecsOrderManagerCount: Control node number can be 1, 2.

ehpc_version^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ehpcVersion: The version of E-HPC.

By default, the parameter is set to the latest version number.

ha_enable^Optional

• Type: typing.Union[bool, 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.

image_id^Optional

• Type: typing.Union[str, 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.

image_owner_alias^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property imageOwnerAlias: Mirror type: system, self, others or marketplace.

input_file_url^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property inputFileUrl: The URL of the job files that are uploaded to an Object Storage Service (OSS) bucket.

is_compute_ess^Optional

• Type: typing.Union[bool, 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

job_queue^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property jobQueue: The queue to which the compute nodes are added.

key_pair_name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property keyPairName: Key pair name.

network_interface_traffic_mode^Optional

• Type: typing.Union[str, 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.

os_tag^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property osTag: Operating system image tag.

You can call ListImages API to query.

password^Optional

• Type: typing.Union[str, 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.?.

period^Optional

• Type: typing.Union[typing.Union[int, float], 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.

period_unit^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property periodUnit: The purchase of long-resources unit.

Alternatively value Week / Month / year.

post_install_script^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, PostInstallScriptProperty]]]

Property postInstallScript:.

ram_node_types^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, 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.

ram_role_name^Optional

• Type: typing.Union[str, 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.

remote_directory^Optional

• Type: typing.Union[str, 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

remote_vis_enable^Optional

• Type: typing.Union[bool, 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

resource_group_id^Optional

• Type: typing.Union[str, 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.

scc_cluster_id^Optional

• Type: typing.Union[str, 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.

scheduler_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property schedulerType: The type of the scheduler.

Valid values: pbs slurm opengridscheduler deadline Default value: pbs

security_group_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property securityGroupId: Security group ID.

security_group_name^Optional

• Type: typing.Union[str, 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.

system_disk_level^Optional

• Type: typing.Union[str, 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

system_disk_size^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property systemDiskSize: The size of the system disk.

Unit: GB Valid values: 40 to 500 Default value: 40

system_disk_type^Optional

• Type: typing.Union[str, 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

volume_id^Optional

• Type: typing.Union[str, 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.

volume_mountpoint^Optional

• Type: typing.Union[str, 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.

volume_protocol^Optional

• Type: typing.Union[str, 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

volume_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property volumeType: The type of the shared storage.

Only Apsara File Storage nas file systems are supported.

vpc_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vpcId: The ID of the virtual private cloud (VPC) to which the E-HPC cluster belongs.

without_elastic_ip^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property withoutElasticIp: Specifies whether the logon node uses an elastic IP address (EIP).

Default value: false

zone_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property zoneId: Available area ID.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_ehpc
ros_cdk_ehpc.Cluster.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_cluster_id^Required

attr_cluster_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ClusterId: Cluster Id.

attr_ecs_info^Required

attr_ecs_info: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute EcsInfo: A data structure describing the number and specifications of ECS for various components of the cluster.

You will get results similar to the following: EcsInfo: {"Manager": {"Count": 2, "InstanceType": "ecs.n1.large"}, "Compute": {"Count": 8, "InstanceType": "ecs.n1.large"}, "Login": {"Count": 1, "InstanceType": "ecs.n1.large"}}

attr_name^Required

attr_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Name: Cluster name.

attr_security_group_id^Required

attr_security_group_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute SecurityGroupId: Security group ID.

props^Required

props: ClusterProps

• Type: ClusterProps