Container Service for Kubernetes:nodepool

Specifies whether to enable auto scaling.

• true: Enables the auto scaling feature for the node pool.

• false: Disables auto scaling. If this parameter is set to false, other configuration parameters in auto_scaling do not take effect.

Default value: false.

The maximum number of instances in the auto scaling group.

The minimum number of instances in the auto scaling group.

The auto scaling type, classified by instance type. Valid values:

• cpu: regular instance type.

• gpu: GPU instance type.

• gpushare: GPU sharing type.

• spot: spot instance type.

Default value: cpu.

[Deprecated]

Specifies whether to associate an EIP. Valid values:

• true: Associates an EIP.

• false: Does not associate an EIP.

Default value: false.

[Deprecated]

The billing method of the EIP. Valid values:

• PayByBandwidth: pay-by-fixed-bandwidth.

• PayByTraffic: pay-by-data-transfer.

Default value: PayByBandwidth.

[Deprecated]

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

Specifies whether to install the CloudMonitor agent on ECS nodes. After installation, you can view monitoring information about the created ECS instances in the CloudMonitor console. We recommend that you enable this feature. 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 for nodes. The following two policies are supported for clusters of version 1.12.6 or later:

• static: Allows pods with certain resource characteristics on the node to be granted enhanced CPU affinity and exclusivity.

• none: Enables the existing default CPU affinity scheme.

Default value: none.

The container runtime. Valid values:

• containerd: Recommended. Supports all cluster versions.

• Sandboxed-Container.runv: Sandboxed container that provides higher isolation. Supports clusters of version 1.24 or earlier.

• docker: Supports clusters of version 1.22 or earlier.

Default value: containerd

The container runtime version.

The node custom data.

The node name consists of three parts: prefix + node IP + suffix:

• Both the prefix and suffix can consist of one or more parts separated by ".". Each part can contain lowercase letters, digits, and hyphens (-). The node name must start and end with a lowercase letter or digit.

• The node IP is the complete private IP address of the node.

The parameter contains four parts separated by commas. For example, if you pass in the string "customized,aliyun,ip,com" (where "customized" and "ip" are fixed strings, "aliyun" is the prefix, and "com" is the suffix), the node name is: aliyun.192.168.xxx.xxx.com.

The node pool name.

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

The node pool type. Valid values:

• ess: node pool.

• edge: edge node pool.

Specifies whether to enable auto-renewal for the 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 epoch of the node pool. This parameter takes effect and is required only when instance_charge_type is set to PrePaid.

When PeriodUnit=Month, valid values: {1, 2, 3, 6, 12}.

Default value: 1.

The custom image ID. The system-provided image is used by default.

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

• PrePaid: subscription.

• PostPaid: pay-as-you-go.

Default value: PostPaid.

The key pair name. Mutually exclusive with login_password.

The SSH logon password. Mutually exclusive with key_pair. 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 the scaled-out ECS instance uses a non-root user for logon.

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

Default value: 1.

The billing period unit for nodes in the node pool. This parameter must be specified when instance_charge_type is set to PrePaid.

Month: Currently, only month is supported as the unit.

The operating system distribution. Valid values:

• CentOS

• AliyunLinux

• Windows

• WindowsCore

Default value: AliyunLinux.

The type of spot instance. Valid values:

• NoSpot: non-spot instance.

• SpotWithPriceLimit: spot instance with a price limit.

• SpotAsPriceGo: system automatically bids at the current market price.

For more information, see Spot instances.

The scaling group pattern. Valid values:

• release: standard pattern. Scales in or out by creating or releasing ECS instances based on resource usage.

• recycle: swift pattern. Scales in or out by creating, stopping, or starting ECS instances, which improves the speed of subsequent scaling operations. Stopped instances do not incur compute resource charges, but storage charges still apply, except for instances with local disks.

Default value: release.

The security group ID of the node pool. Specify either this parameter or security_group_ids. We recommend that you use security_group_ids.

The type of the node system cloud disk. Valid values:

• cloud_efficiency: ultra cloud disk.

• cloud_ssd: standard SSD.

• cloud_essd: ESSD.

• cloud_auto: ESSD AutoPL.

• cloud_essd_entry: ESSD Entry disk.

Default value: cloud_efficiency.

The size of the node system cloud disk. Unit: GiB.

Valid values: [40,500].

The performance level of the node system cloud disk. This parameter takes effect only for ESSD disks.

• PL0: moderate maximum concurrent I/O performance with relatively stable read/write latency.

• PL1: moderate maximum concurrent I/O performance with relatively stable read/write latency.

• PL2: high maximum concurrent I/O performance with stable read/write latency.

• PL3: ultra-high maximum concurrent I/O performance with extremely stable read/write latency.

Specifies whether to encrypt the system cloud disk. Valid values: true: encrypt. false: do not encrypt.

The KMS key ID used for the node system cloud disk.

The encryption algorithm used for the node system cloud disk. Valid values: aes-256.

The provisioned read/write IOPS for the node system cloud disk. Valid values: 0~min{50,000, 1000*capacity-baseline performance}. Baseline performance=min{1,800+50*capacity, 50000}.

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

Specifies whether to enable burst (performance bursting) for the node system cloud disk. Valid values:

• true: Enable.

• false: Disable.

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

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

• PRIORITY: Scales based on the vSwitches (VSwitchIds.N) you define. When ECS instances cannot be created in the zone of the highest-priority vSwitch, the system automatically uses the next-priority vSwitch to create ECS instances.

• COST_OPTIMIZED: Attempts to create instances in order of vCPU unit price from lowest to highest. When the scaling configuration sets multiple instance types with spot billing methods, spot instances are created first. You can use the CompensateWithOnDemand parameter to specify whether the system is allowed to automatically attempt to create pay-as-you-go instances when spot instances cannot be created due to insufficient inventory.

  Note

  COST_OPTIMIZED takes effect only when the scaling configuration sets multiple instance types or uses spot instances.

• BALANCE: Allocates ECS instances evenly across the multiple active zones specified in the scaling group. If zones become unbalanced due to insufficient inventory, you can call the RebalanceInstances API operation to rebalance resources. For more information, see RebalanceInstances.

Default value: PRIORITY.

The minimum number of pay-as-you-go instances required in the scaling group. Valid values: [0,1000]. When the number of pay-as-you-go instances is less than this value, pay-as-you-go instances are created first.

The percentage of pay-as-you-go instances among the instances that exceed the minimum number of pay-as-you-go instances (on_demand_base_capacity) in the scaling group. Valid values: [0,100].

The number of available instance types. The scaling group creates spot instances across multiple types with the lowest cost. Valid values: [1,10].

Specifies whether to enable supplementing spot instances. When enabled, the scaling group attempts to create new instances to replace spot instances that are about to be reclaimed. Valid values:

• true: Enable supplementing spot instances.

• false: Disable supplementing spot instances.

When multi_az_policy is set to COST_OPTIMIZED, specifies whether to allow automatic creation of pay-as-you-go instances to meet ECS instance quantity requirements when spot instances cannot be created due to price or inventory reasons. Valid values:

• true: Allow automatic creation of pay-as-you-go instances to meet ECS instance quantity requirements.

• false: Do not allow automatic creation of pay-as-you-go instances to meet ECS instance quantity requirements.

The billing type for public IP addresses. Valid values:

• PayByBandwidth: billed by fixed bandwidth.

• PayByTraffic: billed by traffic usage.

The maximum outbound bandwidth for node public IP. Unit: Mbps (Mega bit per second). Valid values: [1,100].

The operating system image type. Specify either this parameter or the platform parameter. Valid values:

• AliyunLinux: Alinux2 image.

• AliyunLinux3: Alinux3 image.

• AliyunLinux3Arm64: Alinux3 ARM64 image.

• AliyunLinuxUEFI: Alinux2 UEFI image.

• CentOS: CentOS image.

• Windows: Windows image.

• WindowsCore: WindowsCore image.

• ContainerOS: container-optimized image.

The deployment set ID.

The desired number of nodes in the node pool.

The Worker RAM role name.

The metadata access configuration for ECS instances. This parameter is currently available only to users in the whitelist. Submit a ticket to request access.

Specifies whether the node pool is a confidential computing node pool.

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

• true: enables the managed node pool.

• false: does not enable the managed node pool. Other related configurations take effect only when enable=true.

Specifies whether to enable auto repair. This parameter takes effect only when enable=true. Valid values:

• true: enables auto repair.

• false: does not enable auto repair.

Specifies whether to automatically fix CVEs.

Specifies whether to enable auto upgrade.

Specifies whether to enable ECS fault detection for node self-healing.

Specifies whether to enable node rotation. Only intelligent managed node pools support this feature, and it is enabled by default. Common node pools do not support this feature.

[Deprecated]

The instance ID of the Cloud Enterprise Network (CEN) attached to the enhanced edge node pool.

[Deprecated]

The instance ID of the Cloud Connect Network (CCN) attached to the enhanced edge node pool.

[Deprecated]

The region of the Cloud Connect Network (CCN) instance bound to the enhanced edge node pool.

[Deprecated]

The network bandwidth of the enhanced edge node pool. Unit: Mbps.

[Deprecated]

The purchase duration of the enhanced edge node pool. Unit: months.

The Kubelet parameter settings.