Container Service for Kubernetes:Create an ACK managed cluster by calling an API operation

Category

Parameter

Type

Required

Example

Description

Basic configurations

name

String

Yes

cluster-demo

The cluster name.

The name must be 1 to 63 characters in length, and can contain digits, letters, hyphens (-), and underscores (_). It cannot start with an underscore (_).

region_id

String

Yes

cn-beijing

The ID of the region in which you want to deploy the cluster.

cluster_type

String

Yes

ManagedKubernetes

The cluster type is ManagedKubernetes. Valid value:

• ManagedKubernetes: You can create ACK managed clusters (Basic and Pro editions), ACK Serverless clusters (Basic and Pro editions), and ACK Edge clusters (Basic and Pro editions).

• Kubernetes: ACK dedicated cluster.

• ExternalKubernetes: Registered clusters.

cluster_spec

String

No

ack.pro.small

The type of ACK managed cluster. Valid values:

• ack.pro.small: ACK Pro cluster.

• ack.standard: ACK Basic cluster.

Default value: ack.standard. If you leave this parameter empty, an ACK Basic cluster is created.

For more information, see Overview of ACK Pro clusters.

kubernetes_version

String

No

1.28.9-aliyun.1

The Kubernetes version of the cluster. The Kubernetes versions supported by ACK are the same as the Kubernetes versions supported by open source Kubernetes. We recommend that you specify the latest Kubernetes version. If you do not specify this parameter, the latest Kubernetes version is used.

You can create clusters of the latest two Kubernetes versions in the ACK console. If you want to create clusters of earlier Kubernetes versions, use the API. For more information about the Kubernetes versions supported by ACK, see Support for Kubernetes versions.

runtime

Array of runtime

No

{"name": "containerd", "version": "1.6.20"}

The name of the container runtime. The following types of runtime are supported by ACK.

• containerd: supports all Kubernetes versions. We recommend that you use containerd.

• Sandboxed-Container.runv: runs sandboxed containers, which provide improved isolation for application containers and support Kubernetes 1.24 and earlier.

• docker: supports Kubernetes 1.22 and earlier.

Default value: containerd.

resource_group_id

String

No

rg-acfm3mkrure****

The ID of the resource group to which the cluster belongs. You can use this parameter to isolate different clusters.

charge_type

String

No

PostPaid

period

Long

No

1

This parameter is deprecated.

The subscription duration. The subscription duration. This parameter takes effect and is required only when you set charge_type to PrePaid.

Valid values: 1, 2, 3, 6, 12, 24, 36, 48, and 60.

Default value: 1.

period_unit

String

No

Month

This parameter is deprecated.

The billing cycle. This parameter is required if charge_type is set to PrePaid.

Set the value to Month. Resources are billed only on a monthly basis.

auto_renew

boolean

No

true

This parameter is deprecated.

Specifies whether to enable auto-renewal for the cluster. This parameter takes effect only when you set charge_type to PrePaid. Valid values:

• true: enables auto-renewal.

• false: disables auto-renewal.

Default value: false.

auto_renew_period

long

No

1

This parameter is deprecated.

The auto-renewal cycle of the cluster. This parameter takes effect and is required only when charge_type is set to PrePaid and auto_renew is set to true. If period_unit is set to Month, the valid values are 1, 2, 3, 6, and 12.

Default value: 1.

Network parameters

vpcid

String

Yes

vpc-2zeik9h3ahvv2zz95****

The ID of the virtual private cloud (VPC) in which you want to deploy the cluster.

vswitch_ids

Array of String

Yes

["vsw-2ze48rkq464rsdts1****"]

The IDs of vSwitches. You can specify one to five vSwitches.

pod_vswitch_ids

Array of String

No

["vsw-2ze97jwri7cei0mpw****"]

container_cidr

String

No

172.20.0.0/16

The CIDR block of pods. This CIDR block cannot overlap with the CIDR block of the VPC in which the cluster is deployed. If the VPC is automatically created by the system, the default CIDR block of pods is 172.16.0.0/16.

service_cidr

String

Yes

172.21.0.0/20

The CIDR block of Services. This CIDR block cannot overlap with the CIDR block of pods or the CIDR block of the VPC in which the cluster is deployed. If the VPC is automatically created by the system, the default CIDR block of Services is 172.19.0.0/20.

security_group_id

String

No

sg-bp1bdue0qc1g7k****

The ID of an existing security group. You need to choose between this parameter and the is_enterprise_security_group parameter. Cluster nodes are automatically added to the security group

is_enterprise_security_group

Boolean

No

true

Specifies whether to create an advanced security group. This parameter takes effect only if security_group_id is left empty.

• true: creates an advanced security group.

• false: does not create an advanced security group.

Default value: true.

node_cidr_mask

String

No

25

The maximum number of IP addresses that can be assigned to each node. 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.

snat_entry

Boolean

No

true

Specifies whether to configure SNAT rules for the VPC where your cluster is deployed.

• If the VPC can access the Internet, set the value to false.

• If the VPC cannot access the Internet, the following values are valid:

  • true: configures SNAT rules. This enables Internet access for the cluster.

  • false: does not configure SNAT rules. In this case, the cluster cannot access the Internet.

If your applications require access to the Internet, we recommend that you set the value to true.

Default value: false.

endpoint_public_access

Boolean

No

true

Specifies whether to enable Internet access for the cluster. You can use an elastic IP address (EIP) to expose the API server. This way, you can access the cluster over the Internet.

• true: enables Internet access.

• false: disables Internet access. If you set this parameter to false, the API server cannot be accessed over the Internet.

Default value: true.

load_balancer_spec

String

No

slb.s2.small

The specification of the Server Load Balancer (SLB) instance that is created for the cluster API server. Valid values:

• slb.s1.small

• slb.s2.small

• slb.s2.medium

• slb.s3.small

• slb.s3.medium

• slb.s3.large

Default value: slb.s2.small.

Advanced settings

timezone

String

No

Asia/Shanghai

The time zone of the cluster. For more information, see Time zones.

proxy_mode

String

No

ipvs

The kube-proxy mode. Valid values:

• iptables: iptables is a mature and stable kube-proxy mode. It uses iptables rules to conduct service discovery and load balancing. The performance of this mode is restricted by the size of the Kubernetes cluster. This mode is suitable for Kubernetes clusters that manage a small number of Services.

• ipvs: IPVS is a high-performance kube-proxy mode. It uses Linux Virtual Server (LVS) to conduct service discovery and load balancing. This mode is suitable for clusters that manage a large number of Services. We recommend that you use this mode in scenarios where high-performance load balancing is required.

Default value: ipvs.

enable_rrsa

Boolean

No

true

Specifies whether to enable the RAM Roles for Service Accounts (RRSA) feature.

tags

Array of tag

No

[{"key": "env", "value": "prod"}]

The labels that you want to add to the cluster. A label contains the following information:

• key: the key of the label.

• value: the value of the label.

cluster_domain

String

No

cluster.local

The domain name of the cluster.

The domain name can contain one or more parts that are separated by periods (.). Each part cannot exceed 63 characters in length, and can contain lowercase letters, digits, and hyphens (-). Each part must start and end with a lowercase letter or digit.

custom_san

String

No

cs.aliyun.com

Specifies custom subject alternative names (SANs) for the API server certificate to accept requests from specified IP addresses or domain names. Multiple IP addresses and domain names are separated by commas (,).

service_account_issuer

String

No

kubernetes.default.svc

Service accounts provide identities for pods when pods communicate with the API server of the cluster. service-account-issuer is the issuer of the serviceaccount token, which corresponds to the iss field in the token payload.

For more information about ServiceAccount, see Use ServiceAccount token volume projection.

api_audiences

String

No

kubernetes.default.svc

Service accounts provide identities for pods when pods communicate with the API server of the cluster. api-audiences are used by the API server to check whether the tokens of requests are legitimate. Separate multiple audiences with commas (,).

For more information about ServiceAccount, see Use ServiceAccount token volume projection.

encryption_provider_key

String

No

0fe64791-55eb-4fc7-84c5-c6c7cdca****

timeout_mins

Long

No

60

Specifies the timeout period of cluster creation. Unit: minutes.

Default value: 60.

disable_rollback

Boolean

No

true

Specifies whether to perform a rollback when the cluster fails to be created. Valid values:

• true: performs a rollback when the cluster fails to be created.

• false: does not perform a rollback when the cluster fails to be created.

Default value: true.

deletion_protection

Boolean

No

true

Specifies whether to enable deletion protection for the cluster. If deletion protection is enabled, the cluster cannot be deleted in the ACK console or by calling API operations. Valid values:

• true: enables the deletion protection feature for the cluster. This way, the cluster cannot be deleted in the ACK console or by calling API operations.

• false: disables the deletion protection feature for the cluster. This way, the cluster can be deleted in the ACK console or by calling API operations.

Default value: false.

Component configurations

addons

Array of addon

No

[{"name": "terway-eniip","config": ""}, {"name": "logtail-ds","config": "{\"IngressDashboardEnabled\":\"true\",\"sls_project_name\":\"your_sls_project_name\"}"}, {"name":"nginx-ingress-controller","config":"{\"IngressSlbNetworkType\":\"internet\"}"}]

The components that you want to install in the cluster. When you create a cluster, you can set the addons parameter to install specific components.

• name: required. This parameter specifies the name of the component.

• config: optional. If this parameter is left empty, no configurations are required.

• disabled: optional. It specifies whether to disable automatic installation.

Network plug-in: required. Supported network plug-ins are Flannel and Terway. Select one of the plug-ins for the cluster.

• Specify the Flannel plug-in in the following format: [{"name":"flannel","config":""}].

• Specify the Terway plug-in in the following format: [{"name": "terway-eniip","config": ""}].

Volume plug-in: optional. Supported volume plug-in is CSI.

Specify the CSI plug-in in the following format: [{"name":"csi-plugin","config": ""},{"name": "csi-provisioner","config": ""}].

Simple Log Service component: optional. We recommend that you enable Simple Log Service. If Simple Log Service is disabled, you cannot use the cluster auditing feature.

• To use an existing Simple Log Service project, specify the component in the following format: [{"name": "logtail-ds","config": "{\"IngressDashboardEnabled\":\"true\",\"sls_project_name\":\"your_sls_project_name\"}"}].

• To create a Simple Log Service project, specify the component in the following format: [{"name": "logtail-ds","config": "{\"IngressDashboardEnabled\":\"true\"}"}].

Ingress controller: optional. By default, the nginx-ingress-controller component is installed in ACK dedicated clusters.

• To install nginx-ingress-controller and enable Internet access, specify the Ingress controller in the following format: [{"name":"nginx-ingress-controller","config":"{\"IngressSlbNetworkType\":\"internet\"}"}].

• If you do not want to install nginx-ingress-controller, specify the component in the following format: [{"name": "nginx-ingress-controller","config": "","disabled": true}].

Event center: optional. By default, the event center feature is enabled.

You can use Kubernetes event centers to store and query events, and configure alerting based on events. You can use the Logstores that are associated with Kubernetes event centers for free within 90 days. For more information, see Create and use an event center.

To enable the Kubernetes event center, specify the component in the following format: [{"name":"ack-node-problem-detector","config":"{\"sls_project_name\":\"your_sls_project_name\"}"}].

controlplane_log_ttl

String

No

30

The interval at which the logs of control plane components are collected. Valid values: 1 to 3000. Unit: days.

Default value: 30.

controlplane_log_project

String

No

k8s-log-xxx

The Simple Log Service project that is used to store the logs of control plane components. You can use an existing project or create one. If you choose to create a Simple Log Service project, the created project is named in the k8s-log-{ClusterID} format.

controlplane_log_components

Array of String

No

["apiserver","kcm","scheduler","ccm"]

The list of control plane components for which you want to enable log collection.

By default, the logs of the API server, KCM, scheduler, and cloud controller manager (CCM) are collected.

Node pool configurations

nodepools

Array of nodepool

No

The parameters of node pools.

Parameter

Type

Example

Description