ManagedKubernetesClusterProps

Properties for defining a ManagedKubernetesCluster.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Cs;
new ManagedKubernetesClusterProps {
    object Name,
    object VpcId,
    object VSwitchIds,
    object Addons = null,
    object AutoRenew = null,
    object AutoRenewPeriod = null,
    object ChargeType = null,
    object CloudMonitorFlags = null,
    object ClusterSpec = null,
    object ContainerCidr = null,
    object DeleteOptions = null,
    object DeletionProtection = null,
    object DisableRollback = null,
    object EncryptionProviderKey = null,
    object EndpointPublicAccess = null,
    object FormatDisk = null,
    object IsEnterpriseSecurityGroup = null,
    object KeepInstanceName = null,
    object KeyPair = null,
    object KubernetesVersion = null,
    object LoadBalancerSpec = null,
    object LoginPassword = null,
    object NodeCidrMask = null,
    object NodeNameMode = null,
    object NodePools = null,
    object NumOfNodes = null,
    object OsType = null,
    object Period = null,
    object PeriodUnit = null,
    object Platform = null,
    object PodVswitchIds = null,
    object ProxyMode = null,
    object ResourceGroupId = null,
    object Runtime = null,
    object SecurityGroupId = null,
    object SecurityHardeningOs = null,
    object ServiceCidr = null,
    object SnatEntry = null,
    object SocEnabled = null,
    TagsProperty[] Tags = null,
    object Taint = null,
    object TimeoutMins = null,
    object UserData = null,
    object WorkerDataDisk = null,
    object WorkerDataDisks = null,
    object WorkerInstanceTypes = null,
    object WorkerSystemDiskCategory = null,
    object WorkerSystemDiskPerformanceLevel = null,
    object WorkerSystemDiskSize = null,
    object ZoneIds = null
};

Properties

Name	Type	Description
Name	object	Property name: The name of the cluster.
VpcId	object	Property vpcId: VPC ID.
VSwitchIds	object	Property vSwitchIds: The virtual switch ID of the worker node.
Addons	object	Property addons: A combination of addon plugins for Kubernetes clusters.
AutoRenew	object	Property autoRenew: Whether the cluster automatically renews.
AutoRenewPeriod	object	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	object	Property chargeType: cluster payment type.
CloudMonitorFlags	object	Property cloudMonitorFlags: Whether to install the cloud monitoring plugin: true: indicates installation false: Do not install Default to false.
ClusterSpec	object	Property clusterSpec: The managed cluster spec.
ContainerCidr	object	Property containerCidr: The container network segment cannot conflict with the VPC network segment.
DeleteOptions	object	Property deleteOptions: Delete options, only work for deleting resource.
DeletionProtection	object	Property deletionProtection: Specifies whether to enable deletion protection for the cluster.
DisableRollback	object	Property disableRollback: Whether the failure was rolled back: true: indicates that it fails to roll back false: rollback failed The default is true.
EncryptionProviderKey	object	Property encryptionProviderKey: The ID of the key that is managed by Key Management Service (KMS).
EndpointPublicAccess	object	Property endpointPublicAccess: Whether to enable the public network API Server: true: which means that the public network API Server is open.
FormatDisk	object	Property formatDisk: Specifies whether to mount a data disk to nodes that are created on existing Elastic Compute Service (ECS) instances.
IsEnterpriseSecurityGroup	object	Property isEnterpriseSecurityGroup: Specifies whether to create an advanced security group.
KeepInstanceName	object	Property keepInstanceName: Specifies whether to retain the names of existing ECS instances that are used in the cluster.
KeyPair	object	Property keyPair: Key pair name.
KubernetesVersion	object	Property kubernetesVersion: The version of the Kubernetes cluster.
LoadBalancerSpec	object	Property loadBalancerSpec: The specification of the Server Load Balancer instance.
LoginPassword	object	Property loginPassword: SSH login password.
NodeCidrMask	object	Property nodeCidrMask: The maximum number of IP addresses that can be assigned to nodes.
NodeNameMode	object	Property nodeNameMode: A custom node name consists of a prefix, an IP substring, and a suffix.
NodePools	object	Property nodePools: The configurations of Node pools.
NumOfNodes	object	Property numOfNodes: Number of worker nodes.
OsType	object	Property osType: The type of operating system.
Period	object	Property period: The duration of the annual subscription and monthly subscription.
PeriodUnit	object	Property periodUnit: When you specify PrePaid, you need to specify the period.
Platform	object	Property platform: The release version of the operating system.
PodVswitchIds	object	Property podVswitchIds: The list of pod vSwitches.
ProxyMode	object	Property proxyMode: kube-proxy proxy mode, supports both iptables and ipvs modes.
ResourceGroupId	object	Property resourceGroupId: The ID of resource group.
Runtime	object	Property runtime: The container runtime of the cluster.
SecurityGroupId	object	Property securityGroupId: Specifies the ID of the security group to which the cluster ECS instance belongs.
SecurityHardeningOs	object	Property securityHardeningOs: Alibaba Cloud OS security hardening.
ServiceCidr	object	Property serviceCidr: The service network segment cannot conflict with the VPC network segment and the container network segment.
SnatEntry	object	Property snatEntry: Whether to configure SNAT for the network.
SocEnabled	object	Property socEnabled: Valid values: true: enables reinforcement based on classified protection.
Tags	TagsProperty[]	Property tags: Tag the cluster.
Taint	object	Property taint: It is used to mark nodes with taints.
TimeoutMins	object	Property timeoutMins: Cluster resource stack creation timeout, in minutes.
UserData	object	Property userData: The user-defined data.
WorkerDataDisk	object	Property workerDataDisk: Whether to mount the data disk.
WorkerDataDisks	object	Property workerDataDisks: A combination of configurations such as worker data disk type and size.
WorkerInstanceTypes	object	Property workerInstanceTypes: Worker node ECS specification type code.
WorkerSystemDiskCategory	object	Property workerSystemDiskCategory: Worker node system disk type.
WorkerSystemDiskPerformanceLevel	object	Property workerSystemDiskPerformanceLevel: The performance level of the enhanced SSD used as the system disk.
WorkerSystemDiskSize	object	Property workerSystemDiskSize: Worker disk system disk size, the unit is GiB.
ZoneIds	object	Property zoneIds: Zone ids of worker node virtual switches belongs to.

---

Name^Required

public object Name { get; set; }

• Type: object

Property name: The name of the cluster.

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

---

VpcId^Required

public object VpcId { get; set; }

• Type: object

Property vpcId: VPC ID.

---

VSwitchIds^Required

public object VSwitchIds { get; set; }

• Type: object

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

---

Addons^Optional

public object Addons { get; set; }

• Type: object

Property addons: A combination of addon plugins for Kubernetes clusters.

Network plug-in: including Flannel and Terway network plug-ins Log service: Optional. If the log service is not enabled, the cluster audit function cannot be used. Ingress: The installation of the Ingress component is enabled by default.

---

AutoRenew^Optional

public object AutoRenew { get; set; }

• Type: object

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.

---

AutoRenewPeriod^Optional

public object AutoRenewPeriod { get; set; }

• Type: object

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^Optional

public object ChargeType { get; set; }

• Type: object

Property chargeType: cluster payment type.

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

---

CloudMonitorFlags^Optional

public object CloudMonitorFlags { get; set; }

• Type: object

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

---

ClusterSpec^Optional

public object ClusterSpec { get; set; }

• Type: object

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.standard. The value can be empty. When it is empty, a standard managed cluster will be created.

---

ContainerCidr^Optional

public object ContainerCidr { get; set; }

• Type: object

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.

---

DeleteOptions^Optional

public object DeleteOptions { get; set; }

• Type: object

Property deleteOptions: Delete options, only work for deleting resource.

---

DeletionProtection^Optional

public object DeletionProtection { get; set; }

• Type: object

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.

---

DisableRollback^Optional

public object DisableRollback { get; set; }

• Type: object

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.

---

EncryptionProviderKey^Optional

public object EncryptionProviderKey { get; set; }

• Type: object

Property encryptionProviderKey: The ID of the key that is managed by Key Management Service (KMS).

This key is used to encrypt data disks.You can use KMS in only professional managed Kubernetes clusters.

---

EndpointPublicAccess^Optional

public object EndpointPublicAccess { get; set; }

• Type: object

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.

---

FormatDisk^Optional

public object FormatDisk { get; set; }

• Type: object

Property formatDisk: Specifies whether to mount a data disk to nodes that are created on existing Elastic Compute Service (ECS) instances.

Valid values: true: stores the data of containers and images on a data disk. The original data on the disk will be overwritten. Back up data before you mount the disk. false: does not store the data of containers and images on a data disk. Default value: false. How to mount a data disk: If the ECS instances have data disks mounted and the file system of the last data disk is not initialized, the system automatically formats the data disk to ext4. Then, the system mounts the data disk to /var/lib/docker and /var/lib/kubelet. The system does not create or mount a new data disk if no data disk has been mounted to the ECS instances.

---

IsEnterpriseSecurityGroup^Optional

public object IsEnterpriseSecurityGroup { get; set; }

• Type: object

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.

---

KeepInstanceName^Optional

public object KeepInstanceName { get; set; }

• Type: object

Property keepInstanceName: Specifies whether to retain the names of existing ECS instances that are used in the cluster.

true: retains the names. false: does not retain the names. The new names are assigned by the system. Default value: true.

---

KeyPair^Optional

public object KeyPair { get; set; }

• Type: object

Property keyPair: Key pair name.

Specify one of KeyPair or LoginPassword.

---

KubernetesVersion^Optional

public object KubernetesVersion { get; set; }

• Type: object

Property kubernetesVersion: The version of the Kubernetes cluster.

---

LoadBalancerSpec^Optional

public object LoadBalancerSpec { get; set; }

• Type: object

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

---

LoginPassword^Optional

public object LoginPassword { get; set; }

• Type: object

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.

---

NodeCidrMask^Optional

public object NodeCidrMask { get; set; }

• Type: object

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.

---

NodeNameMode^Optional

public object NodeNameMode { get; set; }

• Type: object

Property nodeNameMode: A custom node name consists of a prefix, an IP substring, and a suffix.

The format iscustomized,{prefix},{ip_substring},{suffix}, for example: customized,aliyun.com,5,test.

• The prefix and suffix can contain one or more parts that are separated by periods (.). Each part can contain lowercase letters, digits, and hyphens (-). The node name must start and end with a lowercase letter or digit.
• The IP substring length specifies the number of digits to be truncated from the end of the node IP address. Valid values: 5 to 12. For example, if the node IP address is 192.168.0.55, the prefix is aliyun.com, the IP substring length is 5, and the suffix is test, the node name will be aliyun.com00055test.

---

NodePools^Optional

public object NodePools { get; set; }

• Type: object

Property nodePools: The configurations of Node pools.

---

NumOfNodes^Optional

public object NumOfNodes { get; set; }

• Type: object

Property numOfNodes: Number of worker nodes.

The range is [0,300]. Default to 3.

---

OsType^Optional

public object OsType { get; set; }

• Type: object

Property osType: The type of operating system.

Valid values: Windows Linux Default value: Linux.

---

Period^Optional

public object Period { get; set; }

• Type: object

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.

---

PeriodUnit^Optional

public object PeriodUnit { get; set; }

• Type: object

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

---

Platform^Optional

public object Platform { get; set; }

• Type: object

Property platform: The release version of the operating system.

Valid values: CentOS AliyunLinux QbootAliyunLinux Qboot Windows WindowsCore Default value: CentOS.

---

PodVswitchIds^Optional

public object PodVswitchIds { get; set; }

• Type: object

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.

---

ProxyMode^Optional

public object ProxyMode { get; set; }

• Type: object

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

The default is iptables.

---

ResourceGroupId^Optional

public object ResourceGroupId { get; set; }

• Type: object

Property resourceGroupId: The ID of resource group.

---

Runtime^Optional

public object Runtime { get; set; }

• Type: object

Property runtime: The container runtime of the cluster.

The default runtime is Docker.

---

SecurityGroupId^Optional

public object SecurityGroupId { get; set; }

• Type: object

Property securityGroupId: Specifies the ID of the security group to which the cluster ECS instance belongs.

---

SecurityHardeningOs^Optional

public object SecurityHardeningOs { get; set; }

• Type: object

Property securityHardeningOs: Alibaba Cloud OS security hardening.

Value: true: enables security hardening OS. false: disables security hardening OS. Default value: false.

---

ServiceCidr^Optional

public object ServiceCidr { get; set; }

• Type: object

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.

---

SnatEntry^Optional

public object SnatEntry { get; set; }

• Type: object

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.

---

SocEnabled^Optional

public object SocEnabled { get; set; }

• Type: object

Property socEnabled: Valid values: true: enables reinforcement based on classified protection.

false: disables reinforcement based on classified protection. Default value: false.

---

Tags^Optional

public TagsProperty[] Tags { get; set; }

• Type: TagsProperty[]

Property tags: Tag the cluster.

---

Taint^Optional

public object Taint { get; set; }

• Type: object

Property taint: It is used to mark nodes with taints.

It is usually used for the scheduling strategy of Pods. The corresponding concept is: tolerance. If there is a corresponding tolerance mark on the Pods, the stain on the node can be tolerated and scheduled to the node.

---

TimeoutMins^Optional

public object TimeoutMins { get; set; }

• Type: object

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

The default value is 60.

---

UserData^Optional

public object UserData { get; set; }

• Type: object

Property userData: The user-defined data.

[1, 16KB] characters.User data should not be base64 encoded. If you want to pass base64 encoded string to the property, use function Fn::Base64Decode to decode the base64 string first.

---

WorkerDataDisk^Optional

public object WorkerDataDisk { get; set; }

• Type: object

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.

---

WorkerDataDisks^Optional

public object WorkerDataDisks { get; set; }

• Type: object

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.

---

WorkerInstanceTypes^Optional

public object WorkerInstanceTypes { get; set; }

• Type: object

Property workerInstanceTypes: Worker node ECS specification type code.

For more details, see Instance Specification Family.

---

WorkerSystemDiskCategory^Optional

public object WorkerSystemDiskCategory { get; set; }

• Type: object

Property workerSystemDiskCategory: Worker node system disk type.

The value includes: cloud_efficiency: efficient cloud disk cloud_ssd: SSD cloud disk Default to cloud_efficiency.

---

WorkerSystemDiskPerformanceLevel^Optional

public object WorkerSystemDiskPerformanceLevel { get; set; }

• Type: object

Property workerSystemDiskPerformanceLevel: The performance level of the enhanced SSD used as the system disk.

Default value: PL0. Valid values: PL0: A single enhanced SSD delivers up to 10,000 random read/write IOPS. PL1: A single enhanced SSD delivers up to 50,000 random read/write IOPS.

---

WorkerSystemDiskSize^Optional

public object WorkerSystemDiskSize { get; set; }

• Type: object

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

Default to 120.

---

ZoneIds^Optional

public object ZoneIds { get; set; }

• Type: object

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

---