Accepting a Node

project_id

Yes

String

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

cluster_id

Yes

String

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Content-Type

Yes

String

Message body type (format).

X-Auth-Token

Yes

String

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

apiVersion

Yes

String

API version. The value is fixed at v3.

kind

Yes

String

API type. The value is fixed at List.

nodeList

Yes

Array of AddNode objects

List of nodes to be managed. A maximum of 200 nodes can be managed simultaneously.

serverID

Yes

String

Server ID. For details about how to obtain the server ID, see the ECS or BMS documentation.

spec

Yes

ReinstallNodeSpec object

Node reinstallation configuration parameters. Currently, accepted nodes cannot be added into node pools.

os

Yes

String

Operating system. If you specify a custom image, the actual OS version in the IMS image is used. Select an OS version supported by the current cluster, for example, EulerOS 2.5, CentOS 7.6, or EulerOS 2.8.

login

Yes

Login object

Node login mode. Either the key pair or password must be used for login.

name

No

String

Node name.

serverConfig

No

ReinstallServerConfig object

Server configuration.

volumeConfig

No

ReinstallVolumeConfig object

Volume management configuration.

runtimeConfig

No

ReinstallRuntimeConfig object

Container runtime configuration.

k8sOptions

No

ReinstallK8sOptionsConfig object

Kubernetes node configuration.

lifecycle

No

NodeLifecycleConfig object

Customized lifecycle configuration of a node.

initializedConditions

No

Array of strings

Custom initialization flag.

Before CCE nodes are initialized, they are tainted with node.cloudprovider.kubernetes.io/uninitialized to prevent pods from being scheduled to them.

CCE supports custom initialization flags. After receiving the initializedConditions parameter, CCE converts the parameter value into a node label and provisions the label with the node, for example, cloudprovider.openvessel.io/inject-initialized-conditions=CCEInitial_CustomedInitial.

After the node is labeled, its status.Conditions is polled to check whether the type of conditions has a flag name, such as CCEInitial and CustomedInitial. If all input flags exist and their status is True, the node initialization is complete and the initialization taint is removed.

• Use only letters and digits. Max. characters: 20.

• Max. flags: 2.

extendParam

No

ReinstallExtendParam object

Extended reinstallation parameter, which is discarded.

hostnameConfig

No

HostnameConfig object

Kubernetes node name configuration parameter, which is supported by clusters of v1.23.6-r0 to v1.25 or clusters of v1.25.2-r0 or later versions.

sshKey

No

String

Name of the key pair used for login.

username

No

String

Login account. Defaults to root.

password

Yes

String

If a username and a password are used to create a node, this field is shielded in the response body. A password must meet the following complexity requirements:

• Contains 8 to 26 characters.

• Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@$%^-_=+[{}]:,./?~#*)

• Cannot contain the username or the username spelled backwards. The password field must be salted during node creation. For details, see Adding a Salt in the password Field When Creating a Node.

userTags

No

Array of UserTag objects

Cloud server labels. The key of a label must be unique. The maximum number of user-defined labels supported by CCE depends on the region. In the region that supports the least number of labels, you can still create up to 5 labels for a cloud server.

rootVolume

No

ReinstallVolumeSpec object

System disk configurations used in reinstallation.

key

No

String

Key of the cloud server label. The value cannot start with CCE- or __type_baremetal.

value

No

String

Value of the cloud server label.

imageID

No

String

Custom image ID.

cmkID

No

String

User master key ID. If this parameter is left blank by default, the EVS disk is not encrypted.

lvmConfig

No

String

Docker data disk configurations.

The following is an example default configuration:

"lvmConfig":"dockerThinpool=vgpaas/90%VG;kubernetesLV=vgpaas/10%VG;diskType=evs;lvType=linear"

The following fields are included:

• userLV: size of the user space, for example, vgpaas/20%VG.

• userPath: mount path of the user space, for example, /home/wqt-test.

• diskType: disk type. Currently, only evs, hdd, and ssd are supported.

• lvType: type of a logic volume. The value can be linear or striped.

• dockerThinpool: Docker space size, for example, vgpaas/60%VG.

• kubernetesLV: kubelet space size, for example, vgpaas/20%VG.

storage

No

Storage object

Disk initialization management parameter.

This parameter is complex to configure. For details, see Attaching Disks to a Node.

If this parameter retains its default, disks are managed based on the DockerLVMConfigOverride (discarded) parameter in extendParam. This parameter is supported by clusters of version 1.15.11 and later.

storageSelectors

Yes

Array of StorageSelectors objects

Disk selection. Matched disks are managed according to matchLabels and storageType.

storageGroups

Yes

Array of StorageGroups objects

A storage group consists of multiple storage devices. It is used to divide storage space.

name

Yes

String

Selector name, used as the index of selectorNames in storageGroup. Therefore, the name of each selector must be unique.

storageType

Yes

String

Specifies the storage type. Currently, only evs (EVS volumes) and local (local volumes) are supported. The local storage does not support disk selection. All local disks will form a VG. Therefore, only one storageSelector of the local type is allowed.

matchLabels

No

matchLabels object

Matching field of an EVS volume. The size, volumeType, metadataEncrypted, metadataCmkid and count fields are supported.

size

No

String

Matched disk size. If this parameter is left unspecified, the disk size is not limited. Example: 100

volumeType

No

String

EVS disk type. SSD, GPSSD, SAS, ESSD, and SATA are supported.

metadataEncrypted

No

String

Disk encryption identifier. 0 indicates that the disk is not encrypted, and 1 indicates that the disk is encrypted.

metadataCmkid

No

String

Customer master key ID of an encrypted disk. The value is a 36-byte string.

count

No

String

Number of disks to be selected. If this parameter is left blank, all disks of this type are selected.

name

Yes

String

Name of a virtual storage group, which must be unique.

cceManaged

No

Boolean

Storage space for Kubernetes and runtime components. Only one group can be set to true. If this parameter is left blank, the default value false is used.

selectorNames

Yes

Array of strings

This parameter corresponds to name in storageSelectors. A group can match multiple selectors, but a selector can match only one group.

virtualSpaces

Yes

Array of VirtualSpace objects

Detailed management of space configuration in a group.

name

Yes

String

Name of a virtualSpace.

• Kubernetes: Kubernetes space configuration. lvmConfig needs to be configured.

• runtime: runtime space configuration. runtimeConfig needs to be configured.

• user: user space configuration. lvmConfig needs to be configured.

size

Yes

String

Size of a virtualSpace. The value must be an integer in percentage. Example: 90%.

lvmConfig

No

LVMConfig object

LVM configurations, applicable to kubernetes and user spaces. Note that one virtual space supports only one config.

runtimeConfig

No

RuntimeConfig object

runtime configurations, applicable to the runtime space. Note that one virtual space supports only one config.

lvType

Yes

String

LVM write mode. linear indicates the linear mode. striped indicates the striped mode, in which multiple disks are used to form a strip to improve disk performance.

path

No

String

Path to which the disk is attached. This parameter takes effect only in user configuration. The value is an absolute path. Digits, letters, periods (.), hyphens (-), and underscores (_) are allowed.

lvType

Yes

String

LVM write mode. linear indicates the linear mode. striped indicates the striped mode, in which multiple disks are used to form a strip to improve disk performance.

dockerBaseSize

No

Integer

Available disk space of a single container on a node, in GB.

If this parameter is left blank or is set to 0, the default value is used. In Device Mapper mode, the default value is 10. In OverlayFS mode, the available space of a single container is not limited by default, and the dockerBaseSize setting takes effect only on EulerOS nodes in the cluster of the new version.

For details about how to allocate the space for the container runtime, see Data Disk Space Allocation.

When Device Mapper is used, you are advised to set dockerBaseSize to a value less than or equal to 80 GB. If the value is too large, the container runtime may fail to be started due to long initialization. If there are special requirements for the container disk space, you can mount an external or local storage device.

runtime

No

Runtime object

Container runtime:

• Clusters of v1.25 or earlier: docker.

• Clusters of v1.25 or later: Container runtime varies with the OS. For nodes running EulerOS 2.5 or EulerOS 2.8, the default container runtime is docker. For nodes running other OSs, the default container runtime is containerd.

name

No

String

Container runtime. Default value:

• Clusters earlier than v1.25: The default value is docker.

• Clusters of v1.25 or later: The default container runtime varies depending on the OS. For nodes running EulerOS 2.5, the default container runtime is docker; for nodes running other OSs, the default container runtime is containerd.

labels

No

Map<String,String>

Defined in key-value pairs. A maximum of 20 key-value pairs are allowed.

• Key: Enter 1 to 63 characters, starting with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. A DNS subdomain can be prefixed to a key and contain a maximum of 253 characters. Example DNS subdomain: example.com/my-key

• Value: The value can be left blank or contain 1 to 63 characters that start with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed in the character string.

Example:

"k8sTags": {
  "key": "value"
}

taints

No

Array of Taint objects

Taints can be added for anti-affinity when creating nodes. A maximum of 20 taints can be added. Each taint contains the following parameters:

• Key: A key must contain 1 to 63 characters starting with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. A DNS subdomain name can be used as the prefix of a key.

• Value: A value must start with a letter or digit and can contain a maximum of 63 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

• Effect: Available options are NoSchedule, PreferNoSchedule, and NoExecute.

Example:

"taints": [{
  "key": "status",
  "value": "unavailable",
  "effect": "NoSchedule"
}, {
  "key": "looks",
  "value": "bad",
  "effect": "NoSchedule"
}]

maxPods

No

Integer

Maximum number of pods that can be created on a node, including the default system pods. Value range: 16 to 256. This limit prevents the node from being overloaded of pods.

key

Yes

String

Key.

value

No

String

Value.

effect

Yes

String

Effect.

preInstall

No

String

Pre-installation script.

postInstall

No

String

Post-installation script.

alpha.cce/NodeImageID

No

String

(Discarded) ID of the user image to run the target OS. Specifying this parameter is equivalent to specifying imageID in ReinstallVolumeSpec. The original value will be overwritten.

type

Yes

String

Configuration type of the Kubernetes node name. The default value is privateIp.

• privateIp: The Kubernetes node is named after its IP address.

• cceNodeName: The Kubernetes node is named after the CCE node.

jobid

String

Job ID returned after the job is delivered. The job ID can be used to query the job execution status.

200

The job for accepting a node into a specified cluster is successfully delivered.