Help Center> Cloud Container Engine> API Reference> APIs> Add-on Instance Parameter Description> virtual-kubelet
View PDF

virtual-kubelet

Introduction

The virtual-kubelet add-on is an implementation of the open-source Virtual Kubelet project. When momentary traffic spikes occur in CCE clusters, virtual-kubelet uses HUAWEI CLOUD CCI to create pods for Deployments, StatefulSets, and jobs, eliminating the overhead of resizing CCE clusters. For details, see virtual-kubelet.

Parameter Description

Table 1 Parameter description

Parameter

Mandatory

Type

Description

basic

Yes

Table 2 object

Basic add-on configuration parameters.

flavor

Yes

Table 3 object

Add-on specifications.

custom

Yes

Table 4 object

Custom add-on parameters.
Table 2 basic

Parameter

Mandatory

Type

Description

available_zone

Yes

String

AZ where the add-on is deployed.

Example: cn-north-4a

cci_address

Yes

String

Access address and port number of CCI.

Example: https://cci.cn-north-4.myhuaweicloud.com:443

euleros_version

Yes

String

EulerOS version. The value is fixed at 2.2.5.

iam_address

Yes

String

Access address and port number of IAM.

Example: https://iam.cn-north-4.myhuaweicloud.com:443

swr_addr

Yes

String

Access address of SWR.

Example: swr.cn-north-4.myhuaweicloud.com

swr_user

Yes

String

SWR user name. The default value is hwofficial.

rbac_enabled

Yes

String

Whether RBAC is supported. If RBAC is supported, the value is true.

cluster_id

Yes

String

Cluster ID

cluster_name

Yes

String

Cluster name

vpc_id

Yes

String

VPC ID

network_id

Yes

String

Subnet ID

security_group_id

Yes

String

Security group ID

project_id

Yes

String

Project ID

region

Yes

String

Region

Example: cn-north-4
Table 3 flavor

Parameter

Mandatory

Type

Description

description

No

String

Add-on description.

name

Yes

String

Add-on flavor name. The value is fixed at Single-instance.

replicas

Yes

String

Number of pods. The default value is 1.

resources

Yes

resources object

Container resource (CPU and memory) quotas.
Table 4 custom

Parameter

Mandatory

Type

Description

isInstallProxy

No

String

Cross-service interworking.

true: Pods in a Cloud Container Engine (CCE) cluster can communicate with pods in a Cloud Container Instance (CCI) cluster through Kubernetes Service.
Table 5 Data structure of the resources field

Parameter

Mandatory

Type

Description

limitsCpu

Yes

String

CPU size limit (unit: MB).

Default value: 250m

limitsMem

Yes

String

Memory size limit (unit: Mi).

Default value: 512Mi

name

Yes

String

Add-on name. The value is fixed at virtual-kubelet.

requestsCpu

Yes

String

Requested CPU size (unit: MB).

Default value: 250m

requestsMem

Yes

String

Requested memory size (unit: Mi).

Default value: 512Mi

Example Request

{
	"metadata": {
		"annotations": {
			"addon.install/type": "install"
		}
	},
	"spec": {
		"clusterID": "ccbe7bdf-4**9-3**b-b**4-0********78",
		"version": "1.0.3",
		"addonTemplateName": "virtual-kubelet",
		"values": {
			"basic": {
				"available_zone": "cn-north-4a",
				"cci_address": "https://cci.cn-north-4.myhuaweicloud.com:443",
				"euleros_version": "2.2.5",
				"iam_address": "https://iam.cn-north-4.myhuaweicloud.com:443",
				"swr_addr": "swr.cn-north-4.myhuaweicloud.com",
				"swr_user": "hwofficial",
				"rbac_enabled": true,
				"cluster_id": "ccbe7bdf-4**9-3**b-b**4-0********78",
				"cluster_name": "test-vk",
				"vpc_id": "2372199f-e6e0-48be-9437-e774aae6bd70",
				"network_id": "863a5e6c-e4f5-45f8-80d9-5090f17a767b",
				"security_group_id": "ac3c1a82-f320-495a-b81d-e7aaa6b304a4",
				"project_id": "085a4*********00a9ccf7fba",
				"region": "cn-north-4"
			},
			"flavor": {
				"description": "Redundancy backup is not available for the add-on.",
				"name": "Single-instance",
				"replicas": 1,
				"resources": [{
					"limitsCpu": "250m",
					"limitsMem": "512Mi",
					"name": "virtual-kubelet",
					"requestsCpu": "250m",
					"requestsMem": "512Mi"
				}]
			},
			"custom": {
				"isInstallProxy": true
			}
		}
	}
}