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

Parameter

Type

Required

Example

Description

name

String

Yes

demo-edge-cluster

The name of the cluster.

The name must be 1 to 63 characters in length, and can contain digits, letters, and hyphens (-). The name cannot start with a hyphen (-).

cluster_type

String

Yes

ManagedKubernetes

The type of the cluster. Set the value to ManagedKubernetes to create an ACK Edge cluster.

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: false.

timeout_mins

Long

No

60

The timeout period during which a resource must be created. Unit: minutes. Default value: 60.

kubernetes_version

String

No

1.30.1-aliyun.1

The Kubernetes version of the cluster. The Kubernetes versions supported by Container Service 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 set this parameter, the latest Kubernetes version is used.

You can create clusters of the latest two Kubernetes versions in the ACK console. You can create clusters of earlier Kubernetes versions by calling API operations. 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 container runtime that you want to use. The containerd and docker runtimes are supported.

This parameter specifies the following information:

• name: the name of the container runtime.

• version: the version of the container runtime.

region_id

String

Yes

cn-beijing

The region ID of the cluster.

key_pair

String

Yes

demo-key

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

login_password

String

Yes

HelloWorld123

The password for SSH logon. You must set this parameter or 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.

num_of_nodes

Long

Yes

1

The number of worker nodes. Valid values: 0 to 100.

profile

String

Yes

Edge

Specifies whether the cluster is an ACK Edge cluster. Default value: Edge.

logging_type

String

No

SLS

Specifies whether to enable Simple Log Service for the cluster. Set the value to SLS. This parameter takes effect only for ACK Serverless clusters.

snat_entry

Boolean

No

true

Specifies whether to configure SNAT rules for the virtual private cloud (VPC) in which you want to deploy the cluster.

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

• If the VPC does not provide access to the Internet, the following values are valid:

  • true: configures SNAT rules. This enables the cluster to access the Internet from the VPC.

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

If your applications deployed in the cluster need to access the Internet, we recommend that you set the value to true.

Default value: false.

vswitch_ids

Array of String

Yes

vsw-2ze48rkq464rsdts1****

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

worker_system_disk_category

String

Yes

cloud_efficiency

The type of system disk that you want to use for worker nodes. Valid values:

• cloud_efficiency: ultra disk.

• cloud_ssd: standard SSD.

Default value: cloud_ssd.

worker_system_disk_size

Long

Yes

100

The size of the system disk that you want to use for worker nodes. Unit: GiB.

Valid values: 40 to 500

The value of this parameter must be at least 40 and no less than the image size.

Default value: 120.

container_cidr

String

No

172.20.0.0

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.

cloud_monitor_flags

Boolean

No

true

Specifies whether to install the CloudMonitor agent. Valid values:

• true: installs the CloudMonitor agent.

• false: does not install the CloudMonitor agent.

Default value: false.

endpoint_public_access

Boolean

No

true

Specifies whether to enable Internet access for the API server. Valid values:

• true: enables Internet access for the API server.

• false: disables Internet access for the API server. The API server is accessible only within the internal network.

Default value: true.

service_cidr

String

Yes

172.21.0.0

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 you want to deploy the cluster. If the VPC is automatically created by the system, the default CIDR block of Services is 172.19.0.0/20.

addons

Array of addon

No

[{"name":"flannel","config":""},{"name":"logtail-ds-docker","config":""},{"name":"alibaba-log-controller","config":"{"IngressDashboardEnabled":"false"}"}]

The components that you want to install in the cluster. Parameter description:

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

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

• disabled: optional. This parameter 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. This parameter specifies the volume plug-in that you want to use. The Container Storage Interface (CSI) plug-in is supported.

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

Log Service component: optional.

• 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 Ingress controller 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 event centers to store and query events, and configure alert rules. You can use the Logstores that are associated with event centers for free within 90 days. For more information, see Create and use an event center.

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

your_sls_project_name\"}"}].

tags

Array of tag

No

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

The labels that you want to add to the cluster.

• key: the key of the label.

• value: the value of the label.

vpcid

String

Yes

vpc-2zeik9h3ahvv2zz95****

The VPC in which you want to deploy the cluster. You must specify a VPC when you create the cluster.

worker_data_disks

Array of data_disk

No

The configuration of the data disk that is mounted to worker nodes. The configuration includes the disk type and disk size.

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 deletion protection for the cluster. This way, the cluster cannot be deleted in the ACK console or by calling API operations.

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

Default value: false.

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.

worker_instance_types

Array of String

Yes

ecs.n4.large

The Elastic Compute Service (ECS) instance types of worker nodes. You must specify at least one instance type. For more information, see Overview of instance families.

worker_instance_charge_type

String

Yes

PrePaid

The billing method of worker nodes. Valid values:

• PrePaid: subscription.

• PostPaid: pay-as-you-go.

Default value: PostPaid.

security_group_id

String

No

sg-bp1bdue0qc1g7k****

The ID of the existing security group that you want to use for the cluster. You must set this parameter or is_enterprise_security_group. Nodes in the cluster are automatically added to the specified 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.

rds_instances

rds_instances

No

rm-2zev748xi27xc****

The names of the ApsaraDB RDS instances.

cluster_spec

String

No

ack.pro.small

The type of ACK managed cluster. Valid values:

• ack.pro.small: ACK Edge Pro cluster.

• ack.standard: ACK Edge Basic cluster.

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

For more information, see the introduction to ACK Edge Pro clusters.

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.

Parameter

Type

Example

Description