Container Service for Kubernetes:nodepool

Specifies whether to enable auto scaling for the node pool. Valid values:

• true: enables auto scaling for the node pool.
• false: disables auto scaling for the node pool. 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 instances that can be created in a scaling group.

The minimum number of instances that must be kept in a scaling group.

The instance types that can be used for the auto scaling of the 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 elastic IP Address (EIP) with the 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 Elastic Compute Service (ECS) nodes. After the CloudMonitor agent is installed on ECS nodes, you can view the 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 of nodes in the node pool. 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 with enhanced CPU affinity and exclusivity.
• none: specifies that the default CPU affinity is used.

Default value: none.

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

The container runtime. Valid values:

• containerd: supports all Kubernetes versions. We recommend that you set the parameter to this value.
• Sandboxed-Container.runv: Sandboxed container provides higher isolation and supports Kubernetes 1.24 and earlier.
• docker: supports Kubernetes 1.22 and earlier.

Default value: containerd.

The version of the container runtime.

The configurations of the taints.

The user data on the node.

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

• The prefix and the 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 is the complete private IP address of the node.

Set the parameter to a value that is 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 the node pool belongs.

The type of node pool. Valid values:

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

Specifies whether to enable auto-renewal for the node pool. This parameter takes effect only if you set instance_charge_type to PrePaid. Valid values:

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

Default value: true

The auto-renewal duration of the nodes in the node pool. This parameter is available and required only if you set instance_charge_type to PrePaid.

If you set period_unit to Month, the valid values of auto_renew_period 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 the node pool.

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

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

• PrePaid: subscription.
• PostPaid: pay-as-you-go.

Default value: PostPaid.

The instance type.

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

The password for SSH logon. You must specify 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.

Specifies whether to allow a non-root user to log on to an ECS instance that is added to the node pool.

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

Default value: 1.

The billing cycle of the nodes in the node pool. This parameter is required if you set instance_charge_type to PrePaid.

Valid value: Month.

The distribution 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: non-preemptible.
• SpotWithPriceLimit: a preemptible instance that is configured with the highest bid price.
• SpotAsPriceGo: bids based on the up-to-date market price are submitted.

For more information, see Preemptible Instance.

The instance type of preemptible instances and the price cap for 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 that are attached with local disks.

Default value: release.

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

The IDs of security groups. You must specify this parameter or security_group_id. We recommend that you specify security_group_ids. If you specify both security_group_id and security_group_ids, security_group_ids is used.

The type of the system disk. Valid values:

• cloud_efficiency: ultra disk.
• cloud_ssd: standard SSD
• cloud_essd: Enterprise SSD (ESSD).
• cloud_auto: ESSD AutoPL disk.
• cloud_essd_entry: ESSD Entry disk.

Default value: cloud_efficiency.

The system disk types. The system creates system disks of a disk type with a lower priority if the disk type with a higher priority is unavailable. Valid values: cloud (basic disk), cloud_efficiency (ultra disk), cloud_ssd (standard SSD), and cloud_essd: (ESSD).

The size of the system disk. Unit: GiB.

Valid values: 40 to 500.

The performance level (PL) of the system disk. This parameter takes effect only for an ESSD. Valid values:

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

Specifies whether to encrypt the system disk. Valid values: true: encrypts the system disk. false: does not encrypt the system disk.

The ID of the Key Management Service (KMS) key that is used to encrypt the system disk.

The algorithm that you want to use to encrypt the system disk. Set the value to aes-256.

The preset read/write IOPS of the 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 available only if SystemDiskCategory is set to cloud_auto. For more information, see ESSD AutoPL disks.

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

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

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

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

The tag key must be unique and can be up to 128 characters in length. The tag key and value must not start with aliyun or acs: or contain https:// or http://.

The IDs of vSwitches.

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

• PRIORITY: ECS instances are scaled based on the VSwitchIds.N parameter. If an ECS instance cannot be created in the zone in which the vSwitch that has the highest priority resides, Auto Scaling creates the ECS instance in the zone in which 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 if preemptible instance types are specified in the scaling configurations. You can set CompensateWithOnDemand to specify whether to automatically create pay-as-you-go instances when preemptible instances cannot be created due to insufficient inventory.

  **

  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 the distribution of ECS instances across zones is not balanced due to reasons such as insufficient inventory, you can call the RebalanceInstances operation to evenly distribute the ECS instances across 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 smaller 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.

Indicates whether preemptible instances can be supplemented. If you set this parameter to true, when the scaling group receives a system message indicating that a preemptible instance is to be reclaimed, the scaling group creates a new instance to replace this instance. Valid values:

• true: supplements preemptible instances.
• false: does not supplement 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 cost or insufficient inventory. This parameter takes effect if 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 billing 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. Unit: Mbit/s. Valid values: 1 to 100.

The type of the operating system image. You must specify this parameter or the platform parameter. Valid values:

• AliyunLinux: Alibaba Cloud Linux 2.
• AliyunLinux3: Alibaba Cloud Linux 3
• AliyunLinux3Arm64: Alibaba Cloud Linux 3 (ARM).
• AliyunLinuxUEFI: Alibaba Cloud Linux UEFI 2.
• 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 configurations of the private node pool.

The name of the worker Resource Access Management (RAM) role. This parameter is available only to users in the whitelist. To use this parameter, submit a ticket.

Specifies whether to enable confidential computing for the node pool.

Indicates whether the managed node pool feature is enabled. Valid values:

• true: enables the managed node pool feature.
• false: disables the managed node pool feature. Other parameters in this section take effect only if you set enable to true.

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 configurations of auto update. This parameter takes effect only if enable is set to true.

The auto node repair policy.

Indicates whether CVE vulnerabilities are automatically patched.

The automatic CVE patching policy.

Indicates whether auto update is enabled.

The auto update policy.

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 in which the CCN instance that is associated with the enhanced edge node pool resides.

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.

The parameter settings of the kubelet.