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, which can be obtained from the ECS or BMS console

spec

Yes

ReinstallNodeSpec object

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

os

Yes

String

OS. If you specify a custom image, the actual OS version of the IMS image is used. Select an OS version supported by the current cluster.

login

Yes

Login object

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

NOTE:

This parameter cannot be modified when a node pool is being updated.

name

No

String

Node name.

NOTE:

Specifying this field during reinstallation will change the node name, and the server name will change accordingly. By default, the current server name is used as the node name. Enter 1 to 56 characters starting with a lowercase letter. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.

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. The default value is root.

password

Yes

String

Login password. If a username and 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 tag (resource tag). The key of a tag must be unique. The maximum number of custom tags supported by CCE varies depending on regions and cannot exceed 8.

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

Configuration item of a Docker data disk (deprecated).

The following is an example of the 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.

NOTE:

• If a node has both local and EVS disks attached, make sure to not keep the default value for this parameter, or it may result in unexpected disk partitions.

NOTE:

• If you want to change the value range of a data disk to 20 to 32768, do not use the default value.

NOTE:

• If you want to use the shared disk space (with the runtime and Kubernetes partitions cancelled), do not retain the default value of this parameter. For details about the shared disk space, see Data Disk Space Allocation.

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

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

matchLabels

No

matchLabels object

Matching field of an EVS disk. The value can be size, volumeType, metadataEncrypted, metadataCmkid, or count in DataVolume.

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. If this parameter is left blank, there is no restriction on the disk type.

metadataEncrypted

No

String

Disk encryption identifier. If this parameter is set to 0, it specifies that the disk is not encrypted. If this parameter is set to 1, it specifies that the disk is encrypted. If this parameter is left blank, there is no restriction on the disk encryption identifier.

metadataCmkid

No

String

CMK ID of an encrypted disk. The value is a string of 36 bytes. If this parameter is left blank, there is no restriction on the disk key ID.

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.

NOTE:

• If cceManaged is set to true, the name must be set to vgpaas.

• If the data disk is used as a temporary storage volume, the name must be vg-everest-localvolume-ephemeral.

• If the data disk is used as a persistent storage volume, the name must be vg-everest-localvolume-persistent.

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

Corresponds to name in storageSelectors. One group can select multiple selectors, but one selector can be selected by only one group.

virtualSpaces

Yes

Array of VirtualSpace objects

Detailed management of space configuration in a group.

name

Yes

String

Name of a virtualSpace. Options: share, kubernetes, runtime, and user

• share: shared space configuration (with the runtime and Kubernetes partitions cancelled). lvmConfig needs to be configured.

• 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%.

NOTE:

The value ranges from 10 to 90. The sum of percentages of all virtualSpaces in a group cannot exceed 100%.

lvmConfig

No

LVMConfig object

LVM configuration managements, applicable to the share*, 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

Disk mount path. This parameter takes effect only in user configuration. The value is an absolute path. Digits, letters, periods (.), hyphens (-), and underscores (_) are allowed.

NOTE:

Do not leave the path empty or set it to a key OS path such as the root directory. Key OS paths that cannot be specified: /, /home, /home/, /bin, /bin/, /lib, /lib/, /root, /root/, /boot, /boot/, /dev, /dev/, /etc, /etc/, /lost+found, /lost+found/, /mnt, /mnt/, /proc, /proc/,/sbin, /sbin/, /srv, /srv/, /tmp, /tmp/, /var, /var/, /media, /media/, /opt, /opt/, /selinux, /selinux/, /sys, /sys/, /usr, /usr/, /opt/cloud/, /mnt/paas/, /home/paas/, /var/paas/, /var/lib/, /var/script/

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. This parameter has been discarded. Use containerBaseSize.

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 nodes running EulerOS in clusters of the new versions.

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

When Device Mapper is used, it is recommended that dockerBaseSize be set 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.

containerBaseSize

No

Integer

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

If this parameter is left blank or is set to 0, the default value is used. In OverlayFS mode, the available space of a single container is not limited by default. In Device Mapper mode, the default value is 10, and the containerBaseSize setting takes effect only on nodes running EulerOS in clusters v1.23.14-r0, v1.25.9-r0, v1.27.6-r0, v1.28.4-r0 or later.

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

When Device Mapper is used, it is recommended that containerBaseSize be set 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. In new versions, the Device Mapper mode is used only by BMSs in the same resource pool and is being discarded.

NOTE:

This parameter cannot be updated when a node pool is being updated.

runtime

No

Runtime object

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.

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 containing a maximum of 253 characters (such as example.com/my-key) can be prefixed to a key.

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

Example:

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

taints

No

Array of Taint objects

You can add taints to created nodes to configure anti-affinity. A maximum of 20 taints can be added. Each taint contains the following parameters:

• 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.

• Value: Enter 1 to 63 characters starting and ending with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

• 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 scripts. The total number of characters after transcoding cannot exceed 10240.

NOTE:

The input value must be encoded using Base64. The method is as follows:

echo -n "Content to be encoded" | base64

postInstall

No

String

Post-installation scripts. The total number of characters after transcoding cannot exceed 10240.

NOTE:

The input value must be encoded using Base64. The method is as follows:

echo -n "Content to be encoded" | base64

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.

NOTE:

• For a node which is configured using cceNodeName, the name is the same as the Kubernetes node name and the ECS name. The node name cannot be changed. If the ECS name is changed on the ECS console, the node name will retain unchanged after ECS synchronization.

• For a node which is configured using cceNodeName, to avoid a conflict between Kubernetes nodes, the system automatically adds a suffix to each node name. The suffix is in the format of A hyphen (-) Five random characters. The value of the random characters is a lowercase letter or a digit ranging from 0 to 9.

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.