Get Kubernetes Node Pools Nodepool
Constructors
Properties
The automatic renewal period of nodes in the node pool takes effect only when you select Prepaid and Automatic Renewal, and is a required value. When PeriodUnit = Month
, the value range is {1, 2, 3, 6, 12}. Default value: 1.
Whether enable worker node to support cis security reinforcement, its valid value true
or false
. Default to false
and apply to AliyunLinux series. Use security_hardening_os
instead.
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 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.
Node CPU management policies. Default value: none
. When the cluster version is 1.12.6 or later, the following two policies are supported:- static
: allows pods with certain resource characteristics on the node to enhance its CPU affinity and exclusivity.- none
: Enables the existing default CPU affinity scheme.
Configure the data disk of the node in the node pool.
The deployment set of node pool. Specify the deploymentSet to ensure that the nodes in the node pool can be distributed on different physical machines.
Number of expected nodes in the node pool.
The operating system image type and the platform
parameter can be selected from the following values:- AliyunLinux
: Alinux2 image.- AliyunLinux3
: Alinux3 image.- AliyunLinux3Arm64
: Alinux3 mirror ARM version.- AliyunLinuxUEFI
: Alinux2 Image UEFI version.- CentOS
: CentOS image.- Windows
: Windows image.- WindowsCore
: WindowsCore image.- ContainerOS
: container-optimized image.- Ubuntu
: Ubuntu image.
Whether to install cloud monitoring on the ECS node. After installation, you can view the monitoring information of the created ECS instance in the cloud monitoring console and recommend enable it. Default value: false
. Valid values:- true
: install cloud monitoring on the ECS node.- false
: does not install cloud monitoring on the ECS node.
Node payment type. Valid values: PostPaid
, PrePaid
, default is PostPaid
. If value is PrePaid
, the arguments period
, period_unit
, auto_renew
and auto_renew_period
are required.
In the node instance specification list, you can select multiple instance specifications as alternatives. When each node is created, it will try to purchase from the first specification until it is created successfully. The final purchased instance specifications may vary with inventory changes.
The billing method for network usage. Valid values PayByBandwidth
and PayByTraffic
. Conflict with eip_internet_charge_type
, EIP and public network IP can only choose one.
The maximum bandwidth of the public IP address of the node. The unit is Mbps(Mega bit per second). The value range is:\[1,100\]
Kubelet configuration parameters for worker nodes. See kubelet_configuration
below. More information in Kubelet Configuration.
A List of Kubernetes labels to assign to the nodes . Only labels that are applied with the ACK API are managed by this argument. Detailed below. More information in Labels.
Whether the ECS instance is logged on as a ecs-user user. Valid value: true
and false
.
Managed node pool configuration.
The scaling policy for ECS instances in a multi-zone scaling group. Valid value: PRIORITY
, COST_OPTIMIZED
and BALANCE
. PRIORITY
: scales the capacity according to the virtual switches you define (VSwitchIds.N). When an ECS instance cannot be created in the zone where the higher-priority vSwitch is located, the next-priority vSwitch is automatically used to create an ECS instance. COST_OPTIMIZED
: try to create by vCPU unit price from low to high. When the scaling configuration is configured with multiple instances of preemptible billing, preemptible instances are created first. You can continue to use the CompensateWithOnDemand
parameter to specify whether to automatically try to create a preemptible instance by paying for it. It takes effect only when the scaling configuration has multi-instance specifications or preemptible instances. BALANCE
: distributes ECS instances evenly among the multi-zone specified by the scaling group. If the zones become unbalanced due to insufficient inventory, you can use the API RebalanceInstances to balance resources.
Each node name consists of a prefix, its private network IP, and a suffix, separated by commas. The input format is customized,,ip,
.- The prefix and suffix can be composed of one or more parts separated by '.', each part can use lowercase letters, numbers and '-', and the beginning and end of the node name must be lowercase letters and numbers.- The node IP address is the complete private IP address of the node.- For example, if the string customized,aliyun,ip,com
is passed in (where 'customized' and 'ip' are fixed strings, 'aliyun' is the prefix, and 'com' is the suffix), the name of the node is aliyun192.168.xxx.xxxcom
.
The first ID of the resource.
The name of node pool.
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.
Node payment period unit, valid value: Month
. Default is Month
.
Node pre custom data, base64-encoded, the script executed before the node is initialized.
Private node pool configuration.
The name of the Worker RAM role.* If it is empty, the default Worker RAM role created in the cluster will be used.* If the specified RAM role is not empty, the specified RAM role must be a Common Service role, and its trusted service configuration must be cloud server. For more information, see Create a common service role. If the specified RAM role is not the default Worker RAM role created in the cluster, the role name cannot start with 'KubernetesMasterRole-'or 'KubernetesWorkerRole.>NOTE: This parameter is only supported for ACK-managed clusters of 1.22 or later versions.
The list of RDS instances.
The ID of the resource group
The runtime name of containers. If not set, the cluster runtime will be used as the node pool runtime. If you select another container runtime, see Comparison of Docker, containerd, and Sandboxed-Container.
The runtime version of containers. If not set, the cluster runtime will be used as the node pool runtime.
Automatic scaling configuration.
The ID of the scaling group.
Scaling group mode, default value: release
. Valid values:- release
: in the standard mode, scaling is performed by creating and releasing ECS instances based on the usage of the application resource value.- recycle
: in the speed mode, scaling is performed through creation, shutdown, and startup to increase the speed of scaling again (computing resources are not charged during shutdown, only storage fees are charged, except for local disk models).
The security group ID of the node pool. This field has been replaced by security_group_ids
, please use the security_group_ids
field instead.
Multiple security groups can be configured for a node pool. If both security_group_ids
and security_group_id
are configured, security_group_ids
takes effect. This field cannot be modified.
Alibaba Cloud OS security reinforcement. Default value: false
. Value:-true
: enable Alibaba Cloud OS security reinforcement.-false
: does not enable Alibaba Cloud OS security reinforcement.
Whether enable worker node to support soc security reinforcement, its valid value true
or false
. Default to false
and apply to AliyunLinux series. See SOC Reinforcement.> It is forbidden to set both security_hardening_os
and soc_enabled
to true
at the same time.
The number of instance types that are available. 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 when the number of preemptible instances drops below the specified minimum number. If you set the value to true, Auto Scaling attempts to create a new preemptible instance when the system notifies that an existing preemptible instance is about to be reclaimed. Valid values: true
: enables the supplementation of preemptible instances. false
: disables the supplementation of preemptible instances.
The current single preemptible instance type market price range configuration.
The preemptible instance type. Value:- NoSpot
: Non-preemptible instance.- SpotWithPriceLimit
: Set the upper limit of the preemptible instance price.- SpotAsPriceGo
: The system automatically bids, following the actual price of the current market.
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 system_disk_category
is set to cloud_auto
.
The multi-disk categories of the system disk. When a high-priority disk type cannot be used, Auto Scaling automatically tries to create a system disk with the next priority disk category. Valid values see system_disk_category
.
The category of the system disk for nodes. Default value: cloud_efficiency
. Valid values:- cloud
: basic disk.- cloud_efficiency
: ultra disk.- cloud_ssd
: standard SSD.- cloud_essd
: ESSD.- cloud_auto
: ESSD AutoPL disk.- cloud_essd_entry
: ESSD Entry disk.
The encryption algorithm used by the system disk. Value range: aes-256.
Whether to encrypt the system disk. Value range: true
: encryption. false
: Do not encrypt.
The ID of the KMS key used by the system disk.
The system disk performance of the node takes effect only for the ESSD disk.- PL0
: maximum random read/write IOPS 10000 for a single disk.- PL1
: maximum random read/write IOPS 50000 for a single disk.- PL2
: highest random read/write IOPS 100000 for a single disk.- PL3
: maximum random read/write IOPS 1 million for a single disk.
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 system_disk_category
is set to cloud_auto
.
The size of the system disk. Unit: GiB. The value of this parameter must be at least 1 and greater than or equal to the image size. Default value: 40 or the size of the image, whichever is larger.- Basic disk: 20 to 500.- ESSD (cloud_essd): The valid values vary based on the performance level of the ESSD. PL0 ESSD: 1 to 2048. PL1 ESSD: 20 to 2048. PL2 ESSD: 461 to 2048. PL3 ESSD: 1261 to 2048.- ESSD AutoPL disk (cloud_auto): 1 to 2048.- Other disk categories: 20 to 2048.
The ID of the automatic snapshot policy used by the system disk.
A List of Kubernetes taints to assign to the nodes. Detailed below. More information in Taints and Toleration.
The configuration about confidential computing for the cluster.
Whether the node after expansion can be scheduled.
The vswitches used by node pool workers.