Help Center/ Cloud Container Engine/ API Reference/ APIs/ Add-on Instance Parameters/ Kubernetes Dashboard
Updated on 2024-11-06 GMT+08:00
View PDF
Share

Kubernetes Dashboard

Add-on Overview

Kubernetes Dashboard is a general purpose, web-based UI designed for managing Kubernetes clusters. With this tool, you can easily manage applications running within the clusters, troubleshoot issues, and even run commands to manage the clusters themselves.

Add-on Parameters

Table 1 Parameters

Parameter

Mandatory

Type

Description

basic

No

object

Basic configuration parameters, which do not need to be specified

flavor

Yes

Table 2 object

Flavor parameters

custom

Yes

Table 3 object

Custom parameters
Table 2 Configuration of flavor

Parameter

Mandatory

Type

Description

replicas

Yes

String

Number of pods. The default value is 1.

resources

Yes

Array of resources object

Container resource (CPU and memory) quotas
Table 3 Configuration of custom

Parameter

Mandatory

Type

Description

serviceType

Yes

String

External access type. The value can be NodePort or ELB and defaults to NodePort.

port

No

int

Port number of the kubernetes-dashboard Service. The default value is 8443.

loadBalancerIP

No

String

IP address of the ELB when external access type is ELB.

elbClass

No

String

ELB type when external access type is ELB. The value can be union (shared load balancer) or performance (dedicated load balancer) and defaults to union.

elbID

No

String

ID of the ELB when external access type is ELB.

certUploaded

No

bool

Whether to use a custom certificate. The default value is true.

cert

No

String

Cert of a custom certificate

key

No

String

Key of a custom certificate
Table 4 Data structure of the resources field

Parameter

Mandatory

Type

Description

limitsCpu

Yes

String

CPU size limit (unit: m)

limitsMem

Yes

String

Memory size limit (unit: Mi)

name

Yes

String

Add-on name. The value is fixed at dashboard.

requestsCpu

Yes

String

Requested CPU size (unit: m)

requestsMem

Yes

String

Requested memory size (unit: Mi)

Example Request

{
	"kind": "Addon",
	"apiVersion": "v3",
	"metadata": {
		"annotations": {
			"addon.install/type": "install"
		}
	},
	"spec": {
		"clusterID": "2292498e-d169-**-9151-***1001ba",
		"version": "2.2.27",
		"addonTemplateName": "dashboard",
		"values": {

                        "basic": {
				"basickey":"val"
			},
			"flavor": {


				"replicas": 1,
				"resources": [{
					"limitsCpu": "100m",
					"limitsMem": "512Mi",
					"name": "dashboard",
					"requestsCpu": "50m",
					"requestsMem": "256Mi"
				}]


			},
			"custom": {
				"cert": "***",
				"certUploaded": true,
				"elbClass": "union",
				"elbID": 0,
				"key": "***",
				"loadBalancerIP": "",
				"port": 8443,
				"serviceType": "NodePort",
				"cluster_id": "2292498e-d169-**-9151-***1001ba",
				"tenant_id": "********"
			}
		}
	}
}
Parent Topic: Add-on Instance Parameters