Skip to content

ManagedEdgeKubernetesClusterProps

Properties for defining a ManagedEdgeKubernetesCluster.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cs-managededgekubernetescluster

Initializer 

import { ManagedEdgeKubernetesClusterProps } from '@alicloud/ros-cdk-cs'
const managedEdgeKubernetesClusterProps: ManagedEdgeKubernetesClusterProps = { ... }

Properties

Name Type Description
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the cluster.
numOfNodes number | @alicloud/ros-cdk-core.IResolvable Property numOfNodes: Number of worker nodes.
addons @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | AddonsProperty[] Property addons: The add-ons to be installed for the cluster.
autoRenew boolean | @alicloud/ros-cdk-core.IResolvable Property autoRenew: Whether the cluster automatically renews.
autoRenewPeriod number | @alicloud/ros-cdk-core.IResolvable Property autoRenewPeriod: Automatic renewal cycle, which takes effect when prepaid and automatic renewal are selected, and is required: When PeriodUnit = Week, the values are: {"1", "2", "3"} When PeriodUnit = Month, the value is {"1", "2", "3", "6", "12"} Default to 1.
chargeType string | @alicloud/ros-cdk-core.IResolvable Property chargeType: cluster payment type.
cloudMonitorFlags boolean | @alicloud/ros-cdk-core.IResolvable Property cloudMonitorFlags: Whether to install the cloud monitoring plugin: true: indicates installation false: Do not install Default to false.
clusterSpec string | @alicloud/ros-cdk-core.IResolvable Property clusterSpec: The edge managed cluster spec.
containerCidr string | @alicloud/ros-cdk-core.IResolvable Property containerCidr: The container network segment cannot conflict with the VPC network segment.
deletionProtection boolean | @alicloud/ros-cdk-core.IResolvable Property deletionProtection: Specifies whether to enable deletion protection for the cluster.
disableRollback boolean | @alicloud/ros-cdk-core.IResolvable Property disableRollback: Whether the failure was rolled back: true: indicates that it fails to roll back false: rollback failed The default is true.
endpointPublicAccess boolean | @alicloud/ros-cdk-core.IResolvable Property endpointPublicAccess: Whether to enable the public network API Server: true: which means that the public network API Server is open.
isEnterpriseSecurityGroup boolean | @alicloud/ros-cdk-core.IResolvable Property isEnterpriseSecurityGroup: Specifies whether to create an advanced security group.
keyPair string | @alicloud/ros-cdk-core.IResolvable Property keyPair: Key pair name.
loginPassword string | @alicloud/ros-cdk-core.IResolvable Property loginPassword: SSH login password.
nodeCidrMask string | @alicloud/ros-cdk-core.IResolvable Property nodeCidrMask: The maximum number of IP addresses that can be assigned to nodes.
period number | @alicloud/ros-cdk-core.IResolvable Property period: The duration of the annual subscription and monthly subscription.
periodUnit string | @alicloud/ros-cdk-core.IResolvable Property periodUnit: When you specify PrePaid, you need to specify the period.
profile string | @alicloud/ros-cdk-core.IResolvable Property profile: Edge cluster ID.
proxyMode string | @alicloud/ros-cdk-core.IResolvable Property proxyMode: kube-proxy proxy mode, supports both iptables and ipvs modes.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of resource group.
serviceCidr string | @alicloud/ros-cdk-core.IResolvable Property serviceCidr: The service network segment cannot conflict with the VPC network segment and the container network segment.
snatEntry boolean | @alicloud/ros-cdk-core.IResolvable Property snatEntry: Whether to configure SNAT for the network.
tags TagsProperty[] Property tags: Tag the cluster.
timeoutMins number | @alicloud/ros-cdk-core.IResolvable Property timeoutMins: Cluster resource stack creation timeout, in minutes.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: VPC ID.
vSwitchIds any[] | @alicloud/ros-cdk-core.IResolvable Property vSwitchIds: The virtual switch ID of the worker node.
workerDataDisk boolean | @alicloud/ros-cdk-core.IResolvable Property workerDataDisk: Whether to mount the data disk.
workerDataDiskCategory string | @alicloud/ros-cdk-core.IResolvable Property workerDataDiskCategory: Data disk type.
workerDataDisks @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | WorkerDataDisksProperty[] Property workerDataDisks: A combination of configurations such as worker data disk type and size.
workerDataDiskSize number | @alicloud/ros-cdk-core.IResolvable Property workerDataDiskSize: Data disk size in GiB.
workerInstanceTypes @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property workerInstanceTypes: Worker node ECS specification type code.
workerSystemDiskCategory string | @alicloud/ros-cdk-core.IResolvable Property workerSystemDiskCategory: Worker node system disk type.
workerSystemDiskSize number | @alicloud/ros-cdk-core.IResolvable Property workerSystemDiskSize: Worker disk system disk size, the unit is GiB.
zoneIds @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property zoneIds: Zone ids of worker node virtual switches belongs to.

nameRequired 

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

Property name: The name of the cluster.

The cluster name can use uppercase and lowercase letters, Chinese characters, numbers, and dashes.

numOfNodesRequired 

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

Property numOfNodes: Number of worker nodes.

The range is [0,300]

addonsOptional 

public readonly addons: IResolvable | IResolvable | AddonsProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | AddonsProperty[]

Property addons: The add-ons to be installed for the cluster.

autoRenewOptional 

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

Property autoRenew: Whether the cluster automatically renews.

It takes effect when the value of ChargeType is PrePaid. The optional values are: true: automatic renewal false: do not renew automatically Default to true.

autoRenewPeriodOptional 

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

Property autoRenewPeriod: Automatic renewal cycle, which takes effect when prepaid and automatic renewal are selected, and is required: When PeriodUnit = Week, the values are: {"1", "2", "3"} When PeriodUnit = Month, the value is {"1", "2", "3", "6", "12"} Default to 1.

chargeTypeOptional 

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

Property chargeType: cluster payment type.

The optional values are: PrePaid: prepaid PostPaid: Pay as you go Default to PostPaid.

cloudMonitorFlagsOptional 

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

Property cloudMonitorFlags: Whether to install the cloud monitoring plugin: true: indicates installation false: Do not install Default to false.

clusterSpecOptional 

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

Property clusterSpec: The edge managed cluster spec.

Value: ack.pro.small: Professional hosting cluster, namely: "ACK Pro version cluster". ack.standard: Standard hosting cluster. Default value: ack.standard. The value can be empty. When it is empty, a standard managed cluster will be created.

containerCidrOptional 

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

Property containerCidr: The container network segment cannot conflict with the VPC network segment.

When the system is selected to automatically create a VPC, the network segment 172.16.0.0\/16 is used by default.

deletionProtectionOptional 

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

Property deletionProtection: Specifies whether to enable deletion protection for the cluster.

After deletion protection is enabled, the cluster cannot be deleted in the ACK console or by calling API operations. Valid values:true: enables deletion protection for the cluster. false: disables deletion protection for the cluster. Default value: false.

disableRollbackOptional 

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

Property disableRollback: Whether the failure was rolled back: true: indicates that it fails to roll back false: rollback failed The default is true.

If rollback fails, resources produced during the creation process will be released. False is not recommended.

endpointPublicAccessOptional 

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

Property endpointPublicAccess: Whether to enable the public network API Server: true: which means that the public network API Server is open.

false: If set to false, the API server on the public network will not be created, only the API server on the private network will be created.Default to true.

isEnterpriseSecurityGroupOptional 

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

Property isEnterpriseSecurityGroup: Specifies whether to create an advanced security group.

This parameter takes effect only if security_group_id is left empty. Note You must specify an advanced security group for a cluster that has Terway installed. true: creates an advanced security group. false: does not create an advanced security group. Default value: false.

keyPairOptional 

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

Property keyPair: Key pair name.

Specify one of KeyPair or LoginPassword.

loginPasswordOptional 

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

Property loginPassword: SSH login password.

Password rules are 8-30 characters and contain three items (upper and lower case letters, numbers, and special symbols). Specify one of KeyPair or LoginPassword.

nodeCidrMaskOptional 

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

Property nodeCidrMask: The maximum number of IP addresses that can be assigned to nodes.

This number is determined by the specified pod CIDR block. This parameter takes effect only if the cluster uses the Flannel plug-in.Default value: 25.

periodOptional 

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

Property period: The duration of the annual subscription and monthly subscription.

It takes effect when the ChargeType value is PrePaid and is a required value. The value range is: When PeriodUnit = Week, Period values are: {"1", "2", "3", "4"} When PeriodUnit = Month, Period values are: {"1", "2", "3", "4", "5", "6", "7", "8", "9", "12", "24", "36", "48", "60"} When PeriodUnit = Year, Period values are: {"1", "2", "3", "4", "5"} Default to 1.

periodUnitOptional 

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

Property periodUnit: When you specify PrePaid, you need to specify the period.

The options are: Week: Time is measured in weeks Month: time in months Year: time in years Default to Month

profileOptional 

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

Property profile: Edge cluster ID.

The default value is Edge.

proxyModeOptional 

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

Property proxyMode: kube-proxy proxy mode, supports both iptables and ipvs modes.

The default is iptables.

resourceGroupIdOptional 

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

Property resourceGroupId: The ID of resource group.

serviceCidrOptional 

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

Property serviceCidr: The service network segment cannot conflict with the VPC network segment and the container network segment.

When the system is selected to automatically create a VPC, the network segment 172.19.0.0\/20 is used by default.

snatEntryOptional 

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

Property snatEntry: Whether to configure SNAT for the network.

When a VPC can access the public network environment, set it to false. When an existing VPC cannot access the public network environment: When set to True, SNAT is configured and the public network environment can be accessed at this time. If set to false, it means that SNAT is not configured and the public network environment cannot be accessed at this time. Default to true.

tagsOptional 

public readonly tags: TagsProperty[];

Property tags: Tag the cluster.

timeoutMinsOptional 

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

Property timeoutMins: Cluster resource stack creation timeout, in minutes.

The default value is 60.

vpcIdOptional 

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

Property vpcId: VPC ID.

If not set, the system will automatically create a VPC, and the VPC network segment created by the system is 192.168.0.0\/16. VpcId and VSwitchId can only be empty at the same time or set the corresponding values at the same time.

vSwitchIdsOptional 

public readonly vSwitchIds: any[] | IResolvable;
  • Type: any[] | @alicloud/ros-cdk-core.IResolvable

Property vSwitchIds: The virtual switch ID of the worker node.

workerDataDiskOptional 

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

Property workerDataDisk: Whether to mount the data disk.

The options are as follows: true: indicates that the worker node mounts data disks. false: indicates that the worker node does not mount data disks. Default to false.

workerDataDiskCategoryOptional 

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

Property workerDataDiskCategory: Data disk type.

workerDataDisksOptional 

public readonly workerDataDisks: IResolvable | IResolvable | WorkerDataDisksProperty[];

Property workerDataDisks: A combination of configurations such as worker data disk type and size.

This parameter is valid only when the worker node data disk is mounted.

workerDataDiskSizeOptional 

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

Property workerDataDiskSize: Data disk size in GiB.

workerInstanceTypesOptional 

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

Property workerInstanceTypes: Worker node ECS specification type code.

For more details, see Instance Specification Family.

workerSystemDiskCategoryOptional 

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

Property workerSystemDiskCategory: Worker node system disk type.

Default to cloud_efficiency.

workerSystemDiskSizeOptional 

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

Property workerSystemDiskSize: Worker disk system disk size, the unit is GiB.

Default to 120.

zoneIdsOptional 

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

Property zoneIds: Zone ids of worker node virtual switches belongs to.