Container Service for Kubernetes:nodepool

Specifies whether to enable auto scaling for a node pool.

• true: enables auto scaling.
• false: disables auto scaling. If you set this parameter to false, other parameters in the auto_scaling section do not take effect.

Default value: false.

The maximum number of Elastic Compute Service (ECS) instances that can be created in a node pool.

The minimum number of ECS instances that must be kept in a node pool.

The instance types that can be used for the auto scaling of a node pool. Valid values:

• cpu: regular instance.
• gpu: GPU-accelerated instance.
• gpushare: shared GPU-accelerated instance.
• spot: preemptible instance.

Default value: cpu.

This parameter is deprecated.

Specifies whether to associate an EIP with a node pool. Valid values:

• true: associates an EIP with the node pool.
• false: does not associate an EIP with the node pool.

Default value: false.

This parameter is deprecated.

The metering method of the EIP. Valid values:

• PayByBandwidth: pay-by-bandwidth.
• PayByTraffic: pay-by-data-transfer.

Default value: PayByBandwidth.

This parameter is deprecated.

The maximum bandwidth of the EIP. Unit: Mbit/s.

Specifies whether to install the CloudMonitor agent on ECS nodes. After the CloudMonitor agent is installed on ECS nodes, you can view monitoring information about the instances in the CloudMonitor console. We recommend that you install the CloudMonitor agent. Valid values:

• true: installs the CloudMonitor agent on ECS nodes.
• false: does not install the CloudMonitor agent on ECS nodes.

Default value: false.

The CPU management policy. The following policies are supported if the Kubernetes version of the cluster is 1.12.6 or later.

• static: allows pods with specific resource characteristics on the node to be granted enhanced CPU affinity and exclusivity.
• none: specifies that the default CPU affinity is used.

Default value: none.

The labels of the nodes in a node pool. You can add labels to the nodes in the cluster.

The container runtime. Valid values:

• containerd: supports all Kubernetes versions. We recommend that you use containerd.
• Sandboxed-Container.runv: allows you to run applications in sandboxed containers, which provide higher security. Only Kubernetes 1.24 and earlier support Sandboxed-Container.
• docker: supports Kubernetes 1.22 and earlier.

Default value: containerd.

The version of the container runtime.

The configurations of the taints.

The user-defined data on a node.

A custom node name consists of a prefix, a node IP address, and a suffix.

• The prefix and suffix can contain multiple parts that are separated by periods (.). Each part can contain lowercase letters, digits, and hyphens (-). A custom node name must start and end with a digit or lowercase letter.
• The node IP address in a custom node name is the private IP address of the node.

Set the value in the customized,aliyun,ip,com format. The value consists of four parts that are separated by commas (,). customized and ip are fixed content. aliyun is the prefix and com is the suffix. Example: aliyun.192.168.xxx.xxx.com.

The name of the node pool.

The ID of the resource group to which a node pool belongs.

The type of node pool. Valid values:

• ess: node pool.
• edge: edge node pool.

Specifies whether to enable auto-renewal for a node pool. This parameter takes effect only when instance_charge_type is set to PrePaid. Valid values:

• true: enables auto-renewal.
• false: disables auto-renewal.

Default value: true.

The auto-renewal period for the nodes in a node pool. This parameter takes effect and is required only when instance_charge_type is set to PrePaid.

If you specify PeriodUnit=Month, the valid values are 1, 2, 3, 6, and 12.

Default value: 1.

The configurations of the data disks that you want to attach to the nodes in a node pool.

The ID of a custom image. By default, the image provided by ACK is used.

The billing method of the nodes in a node pool. Valid values:

• PrePaid: the subscription billing method.
• PostPaid: the pay-as-you-go billing method.

Default value: PostPaid.

The instance types.

The name of the key pair. You must set this parameter or the login_password parameter.

The password for SSH logon. You must set this parameter or the key_pair parameter. The password must be 8 to 30 characters in length, and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.

The subscription duration of the nodes in a node pool. This parameter takes effect and is required only when instance_charge_type is set to PrePaid. The valid values of period are 1, 2, 3, 6, and 12 when period_unit is set to Month.

Default value: 1.

The unit of the subscription duration. This parameter is required when instance_charge_type is set to PrePaid.

Valid value: Month.

The release version of the operating system. Valid values:

• CentOS
• AliyunLinux
• Windows
• WindowsCore

Default value: AliyunLinux.

A list of ApsaraDB RDS instances.

The type of preemptible instance. Valid values:

• NoSpot: a non-preemptible instance.
• SpotWithPriceLimit: a preemptible instance that is configured with the highest bid price.
• SpotAsPriceGo: a preemptible instance for which the system automatically bids based on the current market price.

For more information, see Preemptible instances.

The instance type for preemptible instances and the price limit of the instance type.

The scaling mode of the scaling group. Valid values:

• release: the standard mode. ECS instances are created and released based on resource usage.
• recycle: the swift mode. ECS instances are created, stopped, or started during scaling events. This reduces the time required for the next scale-out event. When the instance is stopped, you are charged only for the storage service. This does not apply to ECS instances attached with local disks.

Default value: release.

Specifies the ID of the security group to which you want to add the node pool. You must set this parameter or security_group_ids. We recommend that you set security_group_ids.

Specifies the IDs of security groups to which you want to add the node pool. You must set this parameter or security_group_id. We recommend that you set security_group_ids. If you set both security_group_id and security_group_ids, security_group_ids is used.

The type of system disk. Valid values:

• cloud_efficiency: ultra disk.
• cloud_ssd: standard SSD.
• cloud_essd: ESSD.
• cloud_auto: ESSD AutoPL.

Default value: cloud_efficiency.

The size of a system disk. Unit: GiB.

Valid values: 40 to 500.

The performance level (PL) of the system disk that you want to use for the node. This parameter takes effect only for ESSDs.

• PL0: moderate maximum concurrent I/O performance and low I/O latency
• PL1: moderate maximum concurrent I/O performance and low I/O latency
• PL2: high maximum concurrent I/O performance and low I/O latency
• PL3: ultra-high maximum concurrent I/O performance and ultra-low I/O latency

The predefined IOPS of a system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}.

This parameter is supported only when SystemDiskCategory is set to cloud_auto. For more information, see ESSD AutoPL disks.

Specifies whether to enable the burst feature for system disks. Valid values:

• true: enables the burst feature.
• false: disables the burst feature.

This parameter is supported only when SystemDiskCategory is set to cloud_auto. For more information, see ESSD AutoPL disks.

The labels that you want to add to the ECS instances.

Each key must be unique and cannot exceed 128 characters in length. Neither keys nor values can start with aliyun or acs:. Neither keys nor values can contain https:// or http://.

The vSwitch IDs.

The ECS instance scaling policy for a multi-zone scaling group. Valid values:

• PRIORITY: the scaling group is scaled based on the VSwitchIds.N parameter. If an ECS instance cannot be created in the zone where the vSwitch that has the highest priority resides, Auto Scaling creates the ECS instance in the zone where the vSwitch that has the next highest priority resides.

• COST_OPTIMIZED: ECS instances are created based on the vCPU unit price in ascending order. Preemptible instances are preferably created when preemptible instance types are specified in the scaling configuration. You can set the CompensateWithOnDemand parameter to specify whether to automatically create pay-as-you-go instances when preemptible instances cannot be created due to insufficient resources.

  **

  Note COST_OPTIMIZED is valid only when multiple instance types are specified or at least one preemptible instance type is specified.

• BALANCE: ECS instances are evenly distributed across multiple zones specified by the scaling group. If ECS instances become imbalanced among multiple zones due to insufficient inventory, you can call the RebalanceInstances operation of Auto Scaling to balance the instance distribution among zones. For more information, see RebalanceInstances .

Default value: PRIORITY.

The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.

The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by on_demand_base_capacity. Valid values: 0 to 100.

The number of instance types that are available for creating preemptible instances. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10.

Specifies whether to supplement preemptible instances. If this parameter is set to true, when the scaling group receives a system message that a preemptible instance is to be reclaimed, the scaling group attempts to create a new instance to replace this instance. Valid values:

• true: enables the supplementation of preemptible instances.
• false: disables the supplementation of preemptible instances.

Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as the cost or insufficient inventory. This parameter takes effect when you set multi_az_policy to COST_OPTIMIZED. Valid values:

• true: automatically creates pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.
• false: does not create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.

The metering method of the public IP address. Valid values:

• PayByBandwidth: pay-by-bandwidth.
• PayByTraffic: pay-by-data-transfer.

The maximum outbound bandwidth of the public IP address of the node. Unit: Mbit/s. Valid values: 1 to 100.

The type of OS image. Configure this parameter or the platform parameter. Valid values:

• AliyunLinux: Alinux2
• AliyunLinux3: Alinux3
• AliyunLinux3Arm64: Alinux3 ARM
• AliyunLinuxUEFI: Alinux2 UEFI
• CentOS: CentOS
• Windows: Windows
• WindowsCore: Windows Core
• ContainerOS: ContainerOS

The ID of the deployment set.

The expected number of nodes in the node pool.

The configuration of the private node pool.

Specifies whether to enable confidential computing for the node pool.

Specifies whether to enable the managed node pool feature. Valid values:

• true: enables the managed node pool feature.
• false: disables the managed node pool feature. Other parameters in this section take effect only when enable=true is specified.

Specifies whether to enable auto repair. This parameter takes effect only when you specify enable=true.

• true: enables auto repair
• false: disables auto repair.

The configuration of auto update. The configuration take effects only when enable=true is specified.

This parameter is deprecated.

The ID of the Cloud Enterprise Network (CEN) instance that is associated with the enhanced edge node pool.

This parameter is deprecated.

The ID of the Cloud Connect Network (CCN) instance that is associated with the enhanced edge node pool.

This parameter is deprecated.

The region to which the CCN instance that is associated with the enhanced edge node pool belongs.

This parameter is deprecated.

The bandwidth of the enhanced edge node pool. Unit: Mbit/s.

This parameter is deprecated.

The subscription duration of the enhanced edge node pool. The duration is measured in months.