Skip to content

ClusterProps

Properties for defining a Cluster.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-acs-cluster

Initializer 

import { ClusterProps } from '@alicloud/ros-cdk-acs'
const clusterProps: ClusterProps = { ... }

Properties

Name Type Description
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the cluster.
addons @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | AddonsProperty[] Property addons: The add-ons to be installed for the cluster.
clusterSpec string | @alicloud/ros-cdk-core.IResolvable Property clusterSpec: The managed cluster spec.
deletionProtection boolean | @alicloud/ros-cdk-core.IResolvable Property deletionProtection: Specifies whether to enable deletion protection for the cluster.
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.
ipStack string | @alicloud/ros-cdk-core.IResolvable Property ipStack: The IP stack of the cluster.
kubernetesVersion string | @alicloud/ros-cdk-core.IResolvable Property kubernetesVersion: The version of the Kubernetes cluster.
loadBalancerSpec string | @alicloud/ros-cdk-core.IResolvable Property loadBalancerSpec: The specification of the Server Load Balancer instance.
loggingType string | @alicloud/ros-cdk-core.IResolvable Property loggingType: The logging type of the cluster.
maintenanceWindow @alicloud/ros-cdk-core.IResolvable | MaintenanceWindowProperty Property maintenanceWindow: The maintenance window of the cluster.
podVSwitchIds @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property podVSwitchIds: The list of pod vSwitches.
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.
serviceDiscoveryTypes @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property serviceDiscoveryTypes: Intra-cluster service discovery type, used to specify the service discovery method in the ASK cluster.
slsProjectName string | @alicloud/ros-cdk-core.IResolvable Property slsProjectName: The SLS project name of the cluster.
snatEntry boolean | @alicloud/ros-cdk-core.IResolvable Property snatEntry: Whether to configure SNAT for the network.
tags TagsProperty[] Property tags: Tag the cluster.
timeZone string | @alicloud/ros-cdk-core.IResolvable Property timeZone: The time zone of the cluster.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: VPC ID.
vSwitchIds @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property vSwitchIds: The IDs of VSwitches.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The zone ID.

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.

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.

clusterSpecOptional 

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

Property clusterSpec: The managed cluster spec.

Value: ack.pro.small: Professional hosting cluster, namely: "ACK Pro version cluster". ack.standard: Standard hosting cluster. Default value: ack.pro.small.

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.

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 false.

ipStackOptional 

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

Property ipStack: The IP stack of the cluster.

kubernetesVersionOptional 

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

Property kubernetesVersion: The version of the Kubernetes cluster.

loadBalancerSpecOptional 

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

Property loadBalancerSpec: The specification of the Server Load Balancer instance.

Allowed value: slb.s1.small|slb.s2.small|slb.s2.medium|slb.s3.small|slb.s3.medium|slb.s3.large

loggingTypeOptional 

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

Property loggingType: The logging type of the cluster.

By default, no logging service is used.

maintenanceWindowOptional 

public readonly maintenanceWindow: IResolvable | MaintenanceWindowProperty;

Property maintenanceWindow: The maintenance window of the cluster.

podVSwitchIdsOptional 

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

Property podVSwitchIds: The list of pod vSwitches.

For each vSwitch that is allocated to nodes, you must specify at least one pod vSwitch in the same zone. The pod vSwitches cannot be the same as the node vSwitches. We recommend that you set the mask length of the CIDR block to a value no greater than 19 for the pod vSwitches. The pod_vswitch_ids parameter is required when the Terway network plug-in is selected for the cluster.

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.

serviceDiscoveryTypesOptional 

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

Property serviceDiscoveryTypes: Intra-cluster service discovery type, used to specify the service discovery method in the ASK cluster.

CoreDNS: To use Kubernetes native standard service discovery component CoreDNS, a set of containers needs to be deployed in the cluster for DNS resolution. By default, two ECI instances with a size of 0.25 Core and 512 MiB are used. PrivateZone: To use Alibaba Cloud PrivateZone products to provide service discovery capabilities, the PrivateZone service needs to be enabled. Default value: off

slsProjectNameOptional 

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

Property slsProjectName: The SLS project name of the cluster.

If LoggingType is set to SLS and SlsProjectName is empty, a new Project is created.

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.

timeZoneOptional 

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

Property timeZone: The time zone of the cluster.

vpcIdOptional 

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

Property vpcId: VPC ID.

vSwitchIdsOptional 

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

Property vSwitchIds: The IDs of VSwitches.

If you leave this property empty, the system automatically creates a VSwitch. Note You must specify both the VpcId and VSwitchIds or leave both of them empty.

zoneIdOptional 

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

Property zoneId: The zone ID.