diff --git a/docs/cce/api-ref/.placeholder b/docs/cce/api-ref/.placeholder deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/cce/api-ref/ALL_META.TXT.json b/docs/cce/api-ref/ALL_META.TXT.json index 6312292fa..ef72564ff 100644 --- a/docs/cce/api-ref/ALL_META.TXT.json +++ b/docs/cce/api-ref/ALL_META.TXT.json @@ -230,9 +230,49 @@ "githuburl":"" }, { - "uri":"cce_02_0354.html", + "uri":"AddNode.html", "product_code":"cce", "code":"24", + "des":"This API is used to accept a node into a specified cluster.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource", + "doc_type":"api2", + "kw":"Accepting a Node,Cluster Management,API Reference", + "title":"Accepting a Node", + "githuburl":"" + }, + { + "uri":"ResetNode.html", + "product_code":"cce", + "code":"25", + "des":"This API is used to reset a node in a specified cluster.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource pa", + "doc_type":"api2", + "kw":"Resetting a Node,Cluster Management,API Reference", + "title":"Resetting a Node", + "githuburl":"" + }, + { + "uri":"RemoveNode.html", + "product_code":"cce", + "code":"26", + "des":"This API is used to remove a node from a specified cluster.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource", + "doc_type":"api2", + "kw":"Removing a Node,Cluster Management,API Reference", + "title":"Removing a Node", + "githuburl":"" + }, + { + "uri":"MigrateNode.html", + "product_code":"cce", + "code":"27", + "des":"This API is used to migrate a node from a specified cluster to another cluster (both clusters must in the same VPC). Physical nodes of the ECS service in a CCE Turbo clus", + "doc_type":"api2", + "kw":"Migrating a Node,Cluster Management,API Reference", + "title":"Migrating a Node", + "githuburl":"" + }, + { + "uri":"cce_02_0354.html", + "product_code":"cce", + "code":"28", "des":"This API is used to create a node pool in a specified cluster.POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepoolsTable 1 describes the parameters of the AP", "doc_type":"api2", "kw":"Creating a Node Pool,Cluster Management,API Reference", @@ -242,7 +282,7 @@ { "uri":"cce_02_0355.html", "product_code":"cce", - "code":"25", + "code":"29", "des":"This API is used to query a specified node pool.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that", "doc_type":"api2", "kw":"Querying a Specified Node Pool,Cluster Management,API Reference", @@ -252,7 +292,7 @@ { "uri":"cce_02_0356.html", "product_code":"cce", - "code":"26", + "code":"30", "des":"This API is used to update a specified node pool.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, tha", "doc_type":"api2", "kw":"Updating a Specified Node Pool,Cluster Management,API Reference", @@ -262,7 +302,7 @@ { "uri":"cce_02_0269.html", "product_code":"cce", - "code":"27", + "code":"31", "des":"This API is used to obtain information about all node pools in a specified cluster.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, ur", "doc_type":"api2", "kw":"Listing All Node Pools in a Specified Cluster,Cluster Management,API Reference", @@ -272,7 +312,7 @@ { "uri":"cce_02_0357.html", "product_code":"cce", - "code":"28", + "code":"32", "des":"This API is used to delete a specified node pool.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, tha", "doc_type":"api2", "kw":"Deleting a Node Pool,Cluster Management,API Reference", @@ -282,7 +322,7 @@ { "uri":"cce_02_0320.html", "product_code":"cce", - "code":"29", + "code":"33", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api2", "kw":"Add-on Management", @@ -292,7 +332,7 @@ { "uri":"cce_02_0322.html", "product_code":"cce", - "code":"30", + "code":"34", "des":"This API is used to install an add-on instance by using the add-on template. One or more instances will be created for the installed add-on.The URL for add-on management ", "doc_type":"api2", "kw":"Installing an Add-on Instance,Add-on Management,API Reference", @@ -302,7 +342,7 @@ { "uri":"cce_02_0321.html", "product_code":"cce", - "code":"31", + "code":"35", "des":"This API is used to query add-on information.The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates the clu", "doc_type":"api2", "kw":"Reading Add-on Templates,Add-on Management,API Reference", @@ -312,7 +352,7 @@ { "uri":"cce_02_0323.html", "product_code":"cce", - "code":"32", + "code":"36", "des":"This API is used to update an add-on instance.The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates the cl", "doc_type":"api2", "kw":"Updating an Add-on Instance,Add-on Management,API Reference", @@ -322,7 +362,7 @@ { "uri":"cce_02_0324.html", "product_code":"cce", - "code":"33", + "code":"37", "des":"This API is used to delete an add-on instance.The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates the cl", "doc_type":"api2", "kw":"Deleting an Add-on Instance,Add-on Management,API Reference", @@ -332,7 +372,7 @@ { "uri":"cce_02_0325.html", "product_code":"cce", - "code":"34", + "code":"38", "des":"This API is used to obtain details about an add-on instance.The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} in", "doc_type":"api2", "kw":"Reading an Add-on Instance,Add-on Management,API Reference", @@ -342,7 +382,7 @@ { "uri":"cce_02_0326.html", "product_code":"cce", - "code":"35", + "code":"39", "des":"This API is used to list all add-on instances in the cluster.The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} i", "doc_type":"api2", "kw":"Listing Add-on Instances,Add-on Management,API Reference", @@ -352,7 +392,7 @@ { "uri":"quota_lifecycle_management.html", "product_code":"cce", - "code":"36", + "code":"40", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api2", "kw":"Quota Management", @@ -362,7 +402,7 @@ { "uri":"ShowQuotas.html", "product_code":"cce", - "code":"37", + "code":"41", "des":"This API is used to query CCE resource quotas.GET /api/v3/projects/{project_id}/quotasStatus code: 200NoneStatus code: 200The resource quotas are obtained successfully.Se", "doc_type":"api2", "kw":"Querying Resource Quotas,Quota Management,API Reference", @@ -372,7 +412,7 @@ { "uri":"cce_02_0340.html", "product_code":"cce", - "code":"38", + "code":"42", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api2", "kw":"Kubernetes APIs", @@ -382,7 +422,7 @@ { "uri":"kubernetesapi.html", "product_code":"cce", - "code":"39", + "code":"43", "des":"You can use Kubernetes native APIs to manage your Kubernetes clusters. For details, see Kubernetes API Concepts.To find detailed API definitions for different Kubernetes ", "doc_type":"api2", "kw":"Overview,Kubernetes APIs,API Reference", @@ -392,7 +432,7 @@ { "uri":"cce_02_0327.html", "product_code":"cce", - "code":"40", + "code":"44", "des":"This chapter describes fine-grained permissions management for your CCE. If your cloud account does not need individual IAM users, then you may skip over this chapter.A p", "doc_type":"api2", "kw":"Permissions Policies and Supported Actions,API Reference", @@ -402,7 +442,7 @@ { "uri":"cce_02_0083.html", "product_code":"cce", - "code":"41", + "code":"45", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api2", "kw":"Appendix", @@ -412,7 +452,7 @@ { "uri":"cce_02_0085.html", "product_code":"cce", - "code":"42", + "code":"46", "des":"Kubernetes APIs use the HTTP header \"Content-Type\" to distinguish between patch request method operations.Currently, three types of patch request method operations are su", "doc_type":"api2", "kw":"Patch Request Method Operation Description,Appendix,API Reference", @@ -422,7 +462,7 @@ { "uri":"cce_02_0086.html", "product_code":"cce", - "code":"43", + "code":"47", "des":"This section provides examples of Merge Patch and Strategic Merge Patch method operations.By way of example, Merge Patch and Strategic Merge Patch method operations are p", "doc_type":"api2", "kw":"Patch Request Method Operation Example,Appendix,API Reference", @@ -432,7 +472,7 @@ { "uri":"cce_02_0084.html", "product_code":"cce", - "code":"44", + "code":"48", "des":"Table 1 describes the status codes.", "doc_type":"api2", "kw":"Status Code,Appendix,API Reference", @@ -442,7 +482,7 @@ { "uri":"cce_02_0250.html", "product_code":"cce", - "code":"45", + "code":"49", "des":"If an error occurs in API calling, no result is returned. Identify the cause based on the error code of each API. If an error occurs in API calling, HTTP status code 4xx ", "doc_type":"api2", "kw":"Error Codes,Appendix,API Reference", @@ -452,7 +492,7 @@ { "uri":"cce_02_0341.html", "product_code":"cce", - "code":"46", + "code":"50", "des":"You can obtain the project ID by calling the API used to query project information based on the specified criteria.The API used to obtain a project ID is GET https://{End", "doc_type":"api2", "kw":"Obtaining a Project ID,Appendix,API Reference", @@ -462,27 +502,17 @@ { "uri":"cce_02_0342.html", "product_code":"cce", - "code":"47", + "code":"51", "des":"An account ID is required for some URLs when an API is called. To obtain an account ID, perform the following operations:On the My Credentials page, view account IDs in t", "doc_type":"api2", "kw":"Obtaining the Account ID,Appendix,API Reference", "title":"Obtaining the Account ID", "githuburl":"" }, - { - "uri":"cce_02_0087.html", - "product_code":"cce", - "code":"48", - "des":"This section describes how to use the Elastic Load Balancer (ELB) in a cluster created by CCE.Create a Service. Before enabling sticky session, ensure that the following ", - "doc_type":"api2", - "kw":"How to Use ELB in a Cluster,Appendix,API Reference", - "title":"How to Use ELB in a Cluster", - "githuburl":"" - }, { "uri":"cce_02_0271.html", "product_code":"cce", - "code":"49", + "code":"52", "des":"If you are using Google Chrome, press F12. On the pane displayed on the right, click the Network tab. Enter jobs in the Filter text box to filter the job list. Select a j", "doc_type":"api2", "kw":"How to Obtain Parameters in the API URI,Appendix,API Reference", @@ -492,7 +522,7 @@ { "uri":"cce_02_0272.html", "product_code":"cce", - "code":"50", + "code":"53", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api2", "kw":"API Permissions,Appendix,API Reference", @@ -502,7 +532,7 @@ { "uri":"cce_02_0100.html", "product_code":"cce", - "code":"51", + "code":"54", "des":"To provide a secure and isolated network environment for CCE, create a VPC before creating a cluster.If you have already created a VPC, you do not need to create it again", "doc_type":"api2", "kw":"Creating a VPC and Subnet,Appendix,API Reference", @@ -512,17 +542,27 @@ { "uri":"cce_02_0101.html", "product_code":"cce", - "code":"52", + "code":"55", "des":"Create a key pair before you create a container cluster. Key pairs are used for user identity authentication upon login to a node.If you have already created a key pair, ", "doc_type":"api2", "kw":"Creating a Key Pair,Appendix,API Reference", "title":"Creating a Key Pair", "githuburl":"" }, + { + "uri":"node_storage_example.html", + "product_code":"cce", + "code":"56", + "des":"In disk planning and striped logical disk creation, it is difficult for users to flexibly attach and partition disks when creating a node.During node creation, the storag", + "doc_type":"api2", + "kw":"Attaching Disks to a Node,Appendix,API Reference", + "title":"Attaching Disks to a Node", + "githuburl":"" + }, { "uri":"cce_02_0273.html", "product_code":"cce", - "code":"53", + "code":"57", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api2", "kw":"Change History,API Reference", diff --git a/docs/cce/api-ref/AddNode.html b/docs/cce/api-ref/AddNode.html new file mode 100644 index 000000000..cba07bf03 --- /dev/null +++ b/docs/cce/api-ref/AddNode.html @@ -0,0 +1,1028 @@ + + +

Accepting a Node

+

Function

This API is used to accept a node into a specified cluster.

+

The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the path for API access.

+
+
+

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/add

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

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 API Usage Guidelines.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

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 the nodes to be accepted.

+
NOTE:

Nodes must have 2-core or higher CPU, 4 GB or larger memory.

+
+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 AddNode

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 ReinstallNodeSpec

Parameter

+

Mandatory

+

Type

+

Description

+

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.7, or EulerOS 2.9.

+

login

+

Yes

+

Login object

+

Node login mode.

+

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 letter and not ending with a hyphen (-). Only lowercase letters, digits, and hyphens (-) 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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 Login

Parameter

+

Mandatory

+

Type

+

Description

+

sshKey

+

No

+

String

+

Name of the key pair used for login.

+

userPassword

+

No

+

String

+

Password used for node login.

+
NOTE:

This field is not supported for the current version.

+
+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 7 ReinstallServerConfig

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 8 UserTag

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 9 ReinstallVolumeSpec

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 10 ReinstallVolumeConfig

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
NOTE:

If a node specification involves local disks and EVS disks at the same time, do not retain the default value of this parameter to prevent unexpected disk partitions.

+
+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 11 Storage

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 12 StorageSelectors

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 13 matchLabels

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 14 StorageGroups

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 15 VirtualSpace

Parameter

+

Mandatory

+

Type

+

Description

+

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

+
NOTE:

The sum of the percentages of all virtualSpaces in a group cannot exceed 100%.

+
+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 16 LVMConfig

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + +
Table 17 RuntimeConfig

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 18 ReinstallRuntimeConfig

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+

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. Defaults to docker.

+
+
+ +
+ + + + + + + + + + + +
Table 19 Runtime

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Container runtime. Defaults to docker.

+

Enumeration values:

+
  • docker
  • containerd
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 20 ReinstallK8sOptionsConfig

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+

nicMultiqueue

+

No

+

String

+
  • Number of ENI queues. Example setting:
+
"[{\"queue\":4}]"
+

The following fields are included:

+
  • queue: number of ENI queues.
  • This field can be configured only for BMS nodes in a CCE Turbo cluster.
  • Supported proportions are {"1":128, "2":92, "4":92, "8":32, "16":16, "28":9}. That is, if there is one queue, a maximum of 128 ENIs can be bound. If there are two queues, a maximum of 92 ENIs can be bound for two queues.
  • A larger number of ENI queues indicates higher performance but fewer ENIs can be bound. The queue settings cannot be changed after the node pool is created.
+

nicThreshold

+

No

+

String

+
  • ENI pre-binding thresholds. Example setting:
+
"0.3:0.6"
+
  • Low threshold (L): determines the minimum number of pre-bound ENIs (Min). Formula: Min = Total number of ENIs of the node x L
  • High threshold (H): determines the maximum number of pre-bound ENIs (Max). Formula: Max = Total number of ENIs of the node x H
  • Number of ENIs bound to a BMS node (B) and number of ENIs being used by pods (U): U + Min < B < U + Max
  • If the number of pre-bound ENIs on a BMS node is smaller than the minimum allowed, the system will bind more ENIs to make the numbers equal.
  • If the number of pre-bound ENIs on a BMS node is larger than the maximum allowed, the system periodically unbinds ENIs (about every 2 minutes) to make the numbers equal.
  • Both the thresholds are one-decimal-place values ranging from 0.0 to 1.0. The low threshold must be smaller than or equal to the high one.
  • This field can be configured only for BMS nodes in a CCE Turbo cluster.
  • Pre-binding ENIs can speed up workload creation but occupies IP addresses.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 21 Taint

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Key.

+

value

+

No

+

String

+

Value.

+

effect

+

Yes

+

String

+

Effect.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 22 NodeLifecycleConfig

Parameter

+

Mandatory

+

Type

+

Description

+

preInstall

+

No

+

String

+

Pre-installation script.

+
NOTE:

The input value must be Base64-encoded. (Command: echo -n "Content to be encoded" | base64)

+
+

postInstall

+

No

+

String

+

Post-installation script.

+
NOTE:

The input value must be Base64-encoded. (Command: echo -n "Content to be encoded" | base64)

+
+
+
+ +
+ + + + + + + + + + + +
Table 23 ReinstallExtendParam

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 24 Response body parameters

Parameter

+

Type

+

Description

+

jobid

+

String

+

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

+
+
+
+

Example Requests

Accepting a Node

+
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/add
+
+{
+  "kind" : "List",
+  "apiVersion" : "v3",
+  "nodeList" : [ {
+    "serverID" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+    "spec" : {
+      "name" : "my-ecs-0001",
+      "os" : "EulerOS 2.5",
+      "login" : {
+        "sshKey" : "KeyPair-001"
+      }
+    }
+  } ]
+}
+
+

Example Responses

Status code: 200

+

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

+
{
+  "jobid" : "2ec9b78d-9368-46f3-8f29-d1a95622a568"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

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

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/cce/api-ref/CLASS.TXT.json b/docs/cce/api-ref/CLASS.TXT.json index 47ee557d0..28d9e8ef6 100644 --- a/docs/cce/api-ref/CLASS.TXT.json +++ b/docs/cce/api-ref/CLASS.TXT.json @@ -206,6 +206,42 @@ "p_code":"6", "code":"23" }, + { + "desc":"This API is used to accept a node into a specified cluster.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource", + "product_code":"cce", + "title":"Accepting a Node", + "uri":"AddNode.html", + "doc_type":"api2", + "p_code":"6", + "code":"24" + }, + { + "desc":"This API is used to reset a node in a specified cluster.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource pa", + "product_code":"cce", + "title":"Resetting a Node", + "uri":"ResetNode.html", + "doc_type":"api2", + "p_code":"6", + "code":"25" + }, + { + "desc":"This API is used to remove a node from a specified cluster.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource", + "product_code":"cce", + "title":"Removing a Node", + "uri":"RemoveNode.html", + "doc_type":"api2", + "p_code":"6", + "code":"26" + }, + { + "desc":"This API is used to migrate a node from a specified cluster to another cluster (both clusters must in the same VPC). Physical nodes of the ECS service in a CCE Turbo clus", + "product_code":"cce", + "title":"Migrating a Node", + "uri":"MigrateNode.html", + "doc_type":"api2", + "p_code":"6", + "code":"27" + }, { "desc":"This API is used to create a node pool in a specified cluster.POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepoolsTable 1 describes the parameters of the AP", "product_code":"cce", @@ -213,7 +249,7 @@ "uri":"cce_02_0354.html", "doc_type":"api2", "p_code":"6", - "code":"24" + "code":"28" }, { "desc":"This API is used to query a specified node pool.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that", @@ -222,7 +258,7 @@ "uri":"cce_02_0355.html", "doc_type":"api2", "p_code":"6", - "code":"25" + "code":"29" }, { "desc":"This API is used to update a specified node pool.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, tha", @@ -231,7 +267,7 @@ "uri":"cce_02_0356.html", "doc_type":"api2", "p_code":"6", - "code":"26" + "code":"30" }, { "desc":"This API is used to obtain information about all node pools in a specified cluster.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, ur", @@ -240,7 +276,7 @@ "uri":"cce_02_0269.html", "doc_type":"api2", "p_code":"6", - "code":"27" + "code":"31" }, { "desc":"This API is used to delete a specified node pool.The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, tha", @@ -249,7 +285,7 @@ "uri":"cce_02_0357.html", "doc_type":"api2", "p_code":"6", - "code":"28" + "code":"32" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -258,7 +294,7 @@ "uri":"cce_02_0320.html", "doc_type":"api2", "p_code":"2", - "code":"29" + "code":"33" }, { "desc":"This API is used to install an add-on instance by using the add-on template. One or more instances will be created for the installed add-on.The URL for add-on management ", @@ -266,8 +302,8 @@ "title":"Installing an Add-on Instance", "uri":"cce_02_0322.html", "doc_type":"api2", - "p_code":"29", - "code":"30" + "p_code":"33", + "code":"34" }, { "desc":"This API is used to query add-on information.The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates the clu", @@ -275,8 +311,8 @@ "title":"Reading Add-on Templates", "uri":"cce_02_0321.html", "doc_type":"api2", - "p_code":"29", - "code":"31" + "p_code":"33", + "code":"35" }, { "desc":"This API is used to update an add-on instance.The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates the cl", @@ -284,8 +320,8 @@ "title":"Updating an Add-on Instance", "uri":"cce_02_0323.html", "doc_type":"api2", - "p_code":"29", - "code":"32" + "p_code":"33", + "code":"36" }, { "desc":"This API is used to delete an add-on instance.The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates the cl", @@ -293,8 +329,8 @@ "title":"Deleting an Add-on Instance", "uri":"cce_02_0324.html", "doc_type":"api2", - "p_code":"29", - "code":"33" + "p_code":"33", + "code":"37" }, { "desc":"This API is used to obtain details about an add-on instance.The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} in", @@ -302,8 +338,8 @@ "title":"Reading an Add-on Instance", "uri":"cce_02_0325.html", "doc_type":"api2", - "p_code":"29", - "code":"34" + "p_code":"33", + "code":"38" }, { "desc":"This API is used to list all add-on instances in the cluster.The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} i", @@ -311,8 +347,8 @@ "title":"Listing Add-on Instances", "uri":"cce_02_0326.html", "doc_type":"api2", - "p_code":"29", - "code":"35" + "p_code":"33", + "code":"39" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -321,7 +357,7 @@ "uri":"quota_lifecycle_management.html", "doc_type":"api2", "p_code":"2", - "code":"36" + "code":"40" }, { "desc":"This API is used to query CCE resource quotas.GET /api/v3/projects/{project_id}/quotasStatus code: 200NoneStatus code: 200The resource quotas are obtained successfully.Se", @@ -329,8 +365,8 @@ "title":"Querying Resource Quotas", "uri":"ShowQuotas.html", "doc_type":"api2", - "p_code":"36", - "code":"37" + "p_code":"40", + "code":"41" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -339,7 +375,7 @@ "uri":"cce_02_0340.html", "doc_type":"api2", "p_code":"", - "code":"38" + "code":"42" }, { "desc":"You can use Kubernetes native APIs to manage your Kubernetes clusters. For details, see Kubernetes API Concepts.To find detailed API definitions for different Kubernetes ", @@ -347,8 +383,8 @@ "title":"Overview", "uri":"kubernetesapi.html", "doc_type":"api2", - "p_code":"38", - "code":"39" + "p_code":"42", + "code":"43" }, { "desc":"This chapter describes fine-grained permissions management for your CCE. If your cloud account does not need individual IAM users, then you may skip over this chapter.A p", @@ -357,7 +393,7 @@ "uri":"cce_02_0327.html", "doc_type":"api2", "p_code":"", - "code":"40" + "code":"44" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -366,7 +402,7 @@ "uri":"cce_02_0083.html", "doc_type":"api2", "p_code":"", - "code":"41" + "code":"45" }, { "desc":"Kubernetes APIs use the HTTP header \"Content-Type\" to distinguish between patch request method operations.Currently, three types of patch request method operations are su", @@ -374,8 +410,8 @@ "title":"Patch Request Method Operation Description", "uri":"cce_02_0085.html", "doc_type":"api2", - "p_code":"41", - "code":"42" + "p_code":"45", + "code":"46" }, { "desc":"This section provides examples of Merge Patch and Strategic Merge Patch method operations.By way of example, Merge Patch and Strategic Merge Patch method operations are p", @@ -383,8 +419,8 @@ "title":"Patch Request Method Operation Example", "uri":"cce_02_0086.html", "doc_type":"api2", - "p_code":"41", - "code":"43" + "p_code":"45", + "code":"47" }, { "desc":"Table 1 describes the status codes.", @@ -392,8 +428,8 @@ "title":"Status Code", "uri":"cce_02_0084.html", "doc_type":"api2", - "p_code":"41", - "code":"44" + "p_code":"45", + "code":"48" }, { "desc":"If an error occurs in API calling, no result is returned. Identify the cause based on the error code of each API. If an error occurs in API calling, HTTP status code 4xx ", @@ -401,8 +437,8 @@ "title":"Error Codes", "uri":"cce_02_0250.html", "doc_type":"api2", - "p_code":"41", - "code":"45" + "p_code":"45", + "code":"49" }, { "desc":"You can obtain the project ID by calling the API used to query project information based on the specified criteria.The API used to obtain a project ID is GET https://{End", @@ -410,8 +446,8 @@ "title":"Obtaining a Project ID", "uri":"cce_02_0341.html", "doc_type":"api2", - "p_code":"41", - "code":"46" + "p_code":"45", + "code":"50" }, { "desc":"An account ID is required for some URLs when an API is called. To obtain an account ID, perform the following operations:On the My Credentials page, view account IDs in t", @@ -419,17 +455,8 @@ "title":"Obtaining the Account ID", "uri":"cce_02_0342.html", "doc_type":"api2", - "p_code":"41", - "code":"47" - }, - { - "desc":"This section describes how to use the Elastic Load Balancer (ELB) in a cluster created by CCE.Create a Service. Before enabling sticky session, ensure that the following ", - "product_code":"cce", - "title":"How to Use ELB in a Cluster", - "uri":"cce_02_0087.html", - "doc_type":"api2", - "p_code":"41", - "code":"48" + "p_code":"45", + "code":"51" }, { "desc":"If you are using Google Chrome, press F12. On the pane displayed on the right, click the Network tab. Enter jobs in the Filter text box to filter the job list. Select a j", @@ -437,8 +464,8 @@ "title":"How to Obtain Parameters in the API URI", "uri":"cce_02_0271.html", "doc_type":"api2", - "p_code":"41", - "code":"49" + "p_code":"45", + "code":"52" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -446,8 +473,8 @@ "title":"API Permissions", "uri":"cce_02_0272.html", "doc_type":"api2", - "p_code":"41", - "code":"50" + "p_code":"45", + "code":"53" }, { "desc":"To provide a secure and isolated network environment for CCE, create a VPC before creating a cluster.If you have already created a VPC, you do not need to create it again", @@ -455,8 +482,8 @@ "title":"Creating a VPC and Subnet", "uri":"cce_02_0100.html", "doc_type":"api2", - "p_code":"41", - "code":"51" + "p_code":"45", + "code":"54" }, { "desc":"Create a key pair before you create a container cluster. Key pairs are used for user identity authentication upon login to a node.If you have already created a key pair, ", @@ -464,8 +491,17 @@ "title":"Creating a Key Pair", "uri":"cce_02_0101.html", "doc_type":"api2", - "p_code":"41", - "code":"52" + "p_code":"45", + "code":"55" + }, + { + "desc":"In disk planning and striped logical disk creation, it is difficult for users to flexibly attach and partition disks when creating a node.During node creation, the storag", + "product_code":"cce", + "title":"Attaching Disks to a Node", + "uri":"node_storage_example.html", + "doc_type":"api2", + "p_code":"45", + "code":"56" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -474,6 +510,6 @@ "uri":"cce_02_0273.html", "doc_type":"api2", "p_code":"", - "code":"53" + "code":"57" } ] \ No newline at end of file diff --git a/docs/cce/api-ref/MigrateNode.html b/docs/cce/api-ref/MigrateNode.html new file mode 100644 index 000000000..252ab1322 --- /dev/null +++ b/docs/cce/api-ref/MigrateNode.html @@ -0,0 +1,582 @@ + + +

Migrating a Node

+

Function

This API is used to migrate a node from a specified cluster to another cluster (both clusters must in the same VPC). Physical nodes of the ECS service in a CCE Turbo cluster cannot be migrated.

+

The URL for cluster management is in the format of **https://Endpoint/uri, in which uri indicates the resource path, that is, the path for API access.

+
+
+

URI

PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/operation/migrateto/{target_cluster_id}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+

target_cluster_id

+

Yes

+

String

+

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

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

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 API Usage Guidelines.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

API version. The value is fixed at v3.

+

kind

+

No

+

String

+

API type. The value is fixed at MigrateNodesTask.

+

spec

+

Yes

+

MigrateNodesSpec object

+

Configuration data.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 MigrateNodesSpec

Parameter

+

Mandatory

+

Type

+

Description

+

os

+

Yes

+

String

+

Operating system type, which must be accurate to the version number. When alpha.cce/NodeImageID is specified, the value of os must be the same as the OS of the custom image.

+

extendParam

+

No

+

MigrateNodeExtendParam object

+

Extended parameters for node migration.

+

login

+

Yes

+

Login object

+

Node login mode.

+

nodes

+

Yes

+

Array of NodeItem objects

+

List of nodes to be operated.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 MigrateNodeExtendParam

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+

DockerLVMConfigOverride

+

No

+

String

+

Docker data disk configuration item. (This parameter has been discarded. Use the storage field instead.)

+

The disk type of the nodes to be migrated must be the same as that specified during node creation (that is, the value of diskType in DockerLVMConfigOverride must be the same as that specified during node creation). Ensure that the disk types of the nodes selected for a single API call are the same.

+

Example default configuration:

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

The following fields are included:

+
  • userLV (optional): size of the user space, for example, vgpaas/20%VG.
  • userPath (optional): 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.
+

alpha.cce/preInstall

+

No

+

String

+

Pre-installation script.

+
NOTE:

The input value must be Base64-encoded. (Command: echo -n "Content to be encoded" | base64)

+
+

alpha.cce/postInstall

+

No

+

String

+

Post-installation script.

+
NOTE:

The input value must be Base64-encoded. (Command: echo -n "Content to be encoded" | base64)

+
+

alpha.cce/NodeImageID

+

No

+

String

+

ID of the user image to run the target OS. When alpha.cce/NodeImageID is specified, the value of os must be the same as the OS of the custom image.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 Login

Parameter

+

Mandatory

+

Type

+

Description

+

sshKey

+

No

+

String

+

Name of the key pair used for login.

+

userPassword

+

No

+

String

+

Password used for node login.

+
NOTE:

This field is not supported for the current version.

+
+
+
+ +
+ + + + + + + + + + + +
Table 7 NodeItem

Parameter

+

Mandatory

+

Type

+

Description

+

uid

+

Yes

+

String

+

Node ID.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version. The value is fixed at v3.

+

kind

+

String

+

API type. The value is fixed at MigrateNodesTask.

+

spec

+

MigrateNodesSpec object

+

Configuration data.

+

status

+

TaskStatus object

+

Job status.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 9 MigrateNodesSpec

Parameter

+

Type

+

Description

+

os

+

String

+

Operating system type, which must be accurate to the version number. When alpha.cce/NodeImageID is specified, the value of os must be the same as the OS of the custom image.

+

extendParam

+

MigrateNodeExtendParam object

+

Extended parameters for node migration.

+

login

+

Login object

+

Node login mode.

+

nodes

+

Array of NodeItem objects

+

List of nodes to be operated.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 MigrateNodeExtendParam

Parameter

+

Type

+

Description

+

maxPods

+

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.

+

DockerLVMConfigOverride

+

String

+

Docker data disk configuration item. (This parameter has been discarded. Use the storage field instead.)

+

The disk type of the nodes to be migrated must be the same as that specified during node creation (that is, the value of diskType in DockerLVMConfigOverride must be the same as that specified during node creation). Ensure that the disk types of the nodes selected for a single API call are the same.

+

Example default configuration:

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

The following fields are included:

+
  • userLV (optional): size of the user space, for example, vgpaas/20%VG.
  • userPath (optional): 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.
+

alpha.cce/preInstall

+

String

+

Pre-installation script.

+
NOTE:

The input value must be Base64-encoded. (Command: echo -n "Content to be encoded" | base64)

+
+

alpha.cce/postInstall

+

String

+

Post-installation script.

+
NOTE:

The input value must be Base64-encoded. (Command: echo -n "Content to be encoded" | base64)

+
+

alpha.cce/NodeImageID

+

String

+

ID of the user image to run the target OS. When alpha.cce/NodeImageID is specified, the value of os must be the same as the OS of the custom image.

+
+
+ +
+ + + + + + + + + + + + + +
Table 11 Login

Parameter

+

Type

+

Description

+

sshKey

+

String

+

Name of the key pair used for login.

+

userPassword

+

String

+

Password used for node login.

+
NOTE:

This field is not supported for the current version.

+
+
+
+ +
+ + + + + + + + + +
Table 12 NodeItem

Parameter

+

Type

+

Description

+

uid

+

String

+

Node ID.

+
+
+ +
+ + + + + + + + + +
Table 13 TaskStatus

Parameter

+

Type

+

Description

+

jobID

+

String

+

Job ID, which is used by the caller to query the job progress.

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

The job for migrating a node from a specified cluster to another cluster is successfully delivered.

+
{
+  "spec" : {
+    "os" : "EulerOS 2.5",
+    "login" : {
+      "sshKey" : "KeyPair-001"
+    },
+    "nodes" : [ {
+      "uid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+    }, {
+      "uid" : "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
+    } ]
+  },
+  "status" : {
+    "jobID" : "2ec9b78d-9368-46f3-8f29-d1a95622a568"
+  }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The job for migrating a node from a specified cluster to another cluster is successfully delivered.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/cce/api-ref/RemoveNode.html b/docs/cce/api-ref/RemoveNode.html new file mode 100644 index 000000000..bd9ea3a0d --- /dev/null +++ b/docs/cce/api-ref/RemoveNode.html @@ -0,0 +1,397 @@ + + +

Removing a Node

+

Function

This API is used to remove a node from a specified cluster.

+

The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the path for API access.

+
+
+

URI

PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/operation/remove

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

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 API Usage Guidelines.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

apiVersion

+

No

+

String

+

API version. The value is fixed at v3.

+

kind

+

No

+

String

+

API type. The value is fixed at RemoveNodesTask.

+

spec

+

Yes

+

RemoveNodesSpec object

+

Configuration information.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 RemoveNodesSpec

Parameter

+

Mandatory

+

Type

+

Description

+

login

+

Yes

+

Login object

+

Node login mode.

+

nodes

+

Yes

+

Array of NodeItem objects

+

List of nodes to be operated.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 Login

Parameter

+

Mandatory

+

Type

+

Description

+

sshKey

+

No

+

String

+

Name of the key pair used for login.

+

userPassword

+

No

+

String

+

Password used for node login.

+
NOTE:

This field is not supported for the current version.

+
+
+
+ +
+ + + + + + + + + + + +
Table 6 NodeItem

Parameter

+

Mandatory

+

Type

+

Description

+

uid

+

Yes

+

String

+

Node ID.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

apiVersion

+

String

+

API version. The value is fixed at v3.

+

kind

+

String

+

API type. The value is fixed at RemoveNodesTask.

+

spec

+

RemoveNodesSpec object

+

Configuration information.

+

status

+

TaskStatus object

+

Job status.

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 RemoveNodesSpec

Parameter

+

Type

+

Description

+

login

+

Login object

+

Node login mode.

+

nodes

+

Array of NodeItem objects

+

List of nodes to be operated.

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 Login

Parameter

+

Type

+

Description

+

sshKey

+

String

+

Name of the key pair used for login.

+

userPassword

+

String

+

Password used for node login.

+
NOTE:

This field is not supported for the current version.

+
+
+
+ +
+ + + + + + + + + +
Table 10 NodeItem

Parameter

+

Type

+

Description

+

uid

+

String

+

Node ID.

+
+
+ +
+ + + + + + + + + +
Table 11 TaskStatus

Parameter

+

Type

+

Description

+

jobID

+

String

+

Job ID, which is used by the caller to query the job progress.

+
+
+
+

Example Requests

Removing a Node

+
PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/operation/remove
+
+{
+  "spec" : {
+    "login" : {
+      "sshKey" : "KeyPair-001"
+    },
+    "nodes" : [ {
+      "uid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+    }, {
+      "uid" : "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
+    } ]
+  }
+}
+
+

Example Responses

Status code: 200

+

The job for removing a node in a specified cluster is successfully delivered.

+
{
+  "spec" : {
+    "login" : {
+      "sshKey" : "KeyPair-001"
+    },
+    "nodes" : [ {
+      "uid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+    }, {
+      "uid" : "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
+    } ]
+  },
+  "status" : {
+    "jobID" : "2ec9b78d-9368-46f3-8f29-d1a95622a568"
+  }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The job for removing a node in a specified cluster is successfully delivered.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/cce/api-ref/ResetNode.html b/docs/cce/api-ref/ResetNode.html new file mode 100644 index 000000000..e229a8f9e --- /dev/null +++ b/docs/cce/api-ref/ResetNode.html @@ -0,0 +1,1042 @@ + + +

Resetting a Node

+

Function

This API is used to reset a node in a specified cluster.

+

The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the path for API access.

+
+
+

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/reset

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

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 API Usage Guidelines.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

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 ResetNode objects

+

List of the nodes to be reset.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 ResetNode

Parameter

+

Mandatory

+

Type

+

Description

+

nodeID

+

Yes

+

String

+

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

+

spec

+

Yes

+

ReinstallNodeSpec object

+

Node reinstallation configuration parameters. Nodes in a node pool cannot be specified externally. These nodes will be reinstalled based on the node pool settings. By default, this parameter is mandatory for nodes in a node pool.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 ReinstallNodeSpec

Parameter

+

Mandatory

+

Type

+

Description

+

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.7, or EulerOS 2.9.

+

login

+

Yes

+

Login object

+

Node login mode.

+

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 letter and not ending with a hyphen (-). Only lowercase letters, digits, and hyphens (-) 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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 Login

Parameter

+

Mandatory

+

Type

+

Description

+

sshKey

+

No

+

String

+

Name of the key pair used for login.

+

userPassword

+

No

+

String

+

Password used for node login.

+
NOTE:

This field is not supported for the current version.

+
+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 7 ReinstallServerConfig

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 8 UserTag

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 9 ReinstallVolumeSpec

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 10 ReinstallVolumeConfig

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
NOTE:

If a node specification involves local disks and EVS disks at the same time, do not retain the default value of this parameter to prevent unexpected disk partitions.

+
+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 11 Storage

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 12 StorageSelectors

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 13 matchLabels

Parameter

+

Mandatory

+

Type

+

Description

+

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. Currently, SSD, GPSSD and SAS 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.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 14 StorageGroups

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 15 VirtualSpace

Parameter

+

Mandatory

+

Type

+

Description

+

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

+
NOTE:

The sum of the percentages of all virtualSpaces in a group cannot exceed 100%.

+
+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 16 LVMConfig

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + +
Table 17 RuntimeConfig

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 18 ReinstallRuntimeConfig

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+

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. Defaults to docker.

+
+
+ +
+ + + + + + + + + + + +
Table 19 Runtime

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Container runtime. Defaults to docker.

+

Enumeration values:

+
  • docker
  • containerd
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 20 ReinstallK8sOptionsConfig

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+

nicMultiqueue

+

No

+

String

+
  • Number of ENI queues. Example setting:
+
"[{\"queue\":4}]"
+

The following fields are included:

+
  • queue: number of ENI queues.
  • This field can be configured only for BMS nodes in a CCE Turbo cluster.
  • Supported proportions are {"1":128, "2":92, "4":92, "8":32, "16":16, "28":9}. That is, if there is one queue, a maximum of 128 ENIs can be bound. If there are two queues, a maximum of 92 ENIs can be bound for two queues.
  • A larger number of ENI queues indicates higher performance but fewer ENIs can be bound. The queue settings cannot be changed after the node pool is created.
+

nicThreshold

+

No

+

String

+
  • ENI pre-binding thresholds. Example setting:
+
"0.3:0.6"
+
  • Low threshold (L): determines the minimum number of pre-bound ENIs (Min). Formula: Min = Total number of ENIs of the node x L
  • High threshold (H): determines the maximum number of pre-bound ENIs (Max). Formula: Max = Total number of ENIs of the node x H
  • Number of ENIs bound to a BMS node (B) and number of ENIs being used by pods (U): U + Min < B < U + Max
  • If the number of pre-bound ENIs on a BMS node is smaller than the minimum allowed, the system will bind more ENIs to make the numbers equal.
  • If the number of pre-bound ENIs on a BMS node is larger than the maximum allowed, the system periodically unbinds ENIs (about every 2 minutes) to make the numbers equal.
  • Both the thresholds are one-decimal-place values ranging from 0.0 to 1.0. The low threshold must be smaller than or equal to the high one.
  • This field can be configured only for BMS nodes in a CCE Turbo cluster.
  • Pre-binding ENIs can speed up workload creation but occupies IP addresses.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 21 Taint

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Key.

+

value

+

No

+

String

+

Value.

+

effect

+

Yes

+

String

+

Effect.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 22 NodeLifecycleConfig

Parameter

+

Mandatory

+

Type

+

Description

+

preInstall

+

No

+

String

+

Pre-installation script.

+
NOTE:

The input value must be Base64-encoded. (Command: echo -n "Content to be encoded" | base64)

+
+

postInstall

+

No

+

String

+

Post-installation script.

+
NOTE:

The input value must be Base64-encoded. (Command: echo -n "Content to be encoded" | base64)

+
+
+
+ +
+ + + + + + + + + + + +
Table 23 ReinstallExtendParam

Parameter

+

Mandatory

+

Type

+

Description

+

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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 24 Response body parameters

Parameter

+

Type

+

Description

+

jobid

+

String

+

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

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

The job for resetting a node in a specified cluster is successfully delivered.

+
{
+  "jobid" : "2ec9b78d-9368-46f3-8f29-d1a95622a568"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The job for resetting a node in a specified cluster is successfully delivered.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/cce/api-ref/cce_02_0083.html b/docs/cce/api-ref/cce_02_0083.html index be0c160de..bbbd3d12d 100644 --- a/docs/cce/api-ref/cce_02_0083.html +++ b/docs/cce/api-ref/cce_02_0083.html @@ -16,8 +16,6 @@ - + diff --git a/docs/cce/api-ref/cce_02_0087.html b/docs/cce/api-ref/cce_02_0087.html deleted file mode 100644 index 53e8bbd3f..000000000 --- a/docs/cce/api-ref/cce_02_0087.html +++ /dev/null @@ -1,206 +0,0 @@ - - -

How to Use ELB in a Cluster

-

This section describes how to use the Elastic Load Balancer (ELB) in a cluster created by CCE.

-

Procedure

Create a Service.

Before enabling sticky session, ensure that the following conditions are met:

-
  • The workload protocol is TCP.
  • Anti-affinity has been configured between pods of the workload. That is, all pods of the workload are deployed on different nodes.
-
-
-
Automatically creating an ELB:
apiVersion: v1 
-kind: Service 
-metadata: 
-  annotations:   
-    kubernetes.io/elb.class: union
-    kubernetes.io/session-affinity-mode: SOURCE_IP
-    kubernetes.io/elb.subnet-id: 5083f225-9bf8-48fa-9c8b-67bd9693c4c0
-    kubernetes.io/elb.autocreate: "{\"type\":\"public\",\"bandwidth_name\":\"cce-bandwidth-1551163379627\",\"bandwidth_chargemode\":\"traffic\",\"bandwidth_size\":5,\"bandwidth_sharetype\":\"PER\",\"eip_type\":\"5_bgp\",\"name\":\"james\"}"
-  labels: 
-    app: nginx 
-  name: nginx 
-spec: 
-  externalTrafficPolicy: Local
-  ports: 
-  - name: service0 
-    port: 80
-    protocol: TCP 
-    targetPort: 80
-  selector: 
-    app: nginx 
-  type: LoadBalancer
-
-
Using an existing ELB:
apiVersion: v1 
-kind: Service 
-metadata: 
-  annotations:   
-    kubernetes.io/elb.class: union
-    kubernetes.io/session-affinity-mode: SOURCE_IP
-    kubernetes.io/elb.id: 3c7caa5a-a641-4bff-801a-feace27424b6
-    kubernetes.io/elb.subnet-id: 5083f225-9bf8-48fa-9c8b-67bd9693c4c0
-  labels: 
-    app: nginx 
-  name: nginx 
-spec: 
-  loadBalancerIP: 10.78.42.242
-  externalTrafficPolicy: Local
-  ports: 
-  - name: service0 
-    port: 80
-    protocol: TCP 
-    targetPort: 80
-  selector: 
-    app: nginx 
-  type: LoadBalancer
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Key parameters

Parameter

-

Type

-

Description

-

kubernetes.io/elb.class

-

String

-

Mandatory and must be set to union if an enhanced load balancer is in use.

-

kubernetes.io/session-affinity-mode

-

String

-

Optional. If sticky session is enabled, add this parameter.

-

The value SOURCE_IP indicates that listeners ensure sticky session based on source IP addresses.

-

kubernetes.io/elb.id

-

String

-

Optional. This parameter is mandatory if an existing ELB is used.

-

It indicates the ID of an enhanced load balancer.

-

kubernetes.io/elb.subnet-id

-

String

-

Optional. This parameter is mandatory only if a load balancer will be automatically created. For clusters of v1.11.7-r0 or later, this parameter can be left unspecified.

-

kubernetes.io/elb.autocreate

-

elb.autocreate object

-

Optional. This parameter is mandatory if a public network load balancer will be automatically created. The system will create an enhanced load balancer and an EIP. This parameter is also mandatory if a private network load balancer will be automatically created. The system will create an enhanced load balancer.

-

Example:

-
  • Value for a public network load balancer that is automatically created: "{\"type\":\"public\",\"bandwidth_name\":\"cce-bandwidth-1551163379627\",\"bandwidth_chargemode\":\"traffic\",\"bandwidth_size\":5,\"bandwidth_sharetype\":\"PER\",\"eip_type\":\"5_bgp\",\"name\":\"james\"}"
  • Value for a private network load balancer that is automatically created: "{\"type\":\"inner\"}"
-

loadBalancerIP

-

String

-

Private IP address of a private network load balancer or public IP address of a public network load balancer.

-

externalTrafficPolicy

-

String

-

Optional. If sticky session is enabled, add this parameter so requests are transferred to a fixed node. If a LoadBalancer Service with this parameter set to Local is created for a workload, the workload can be accessed only when the client is installed on the same node as the server.

-

port

-

Integer

-

Access port that is registered on the load balancer and mapped to the cluster-internal IP address.

-

targetPort

-

String

-

Container port on the CCE console.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Data structure of the elb.autocreate field

Parameter

-

Type

-

Description

-

name

-

String

-

Name of the load balancer that is automatically created.

-

The value is a string of 1 to 64 characters that consist of letters, digits, underscores (_), and hyphens (-).

-

type

-

String

-

Network type of the load balancer.

-
  • public: public network load balancer.
  • inner: private network load balancer.
-

bandwidth_name

-

String

-

Bandwidth name. The default value is cce-bandwidth-******.

-

The value is a string of 1 to 64 characters that consist of letters, digits, underscores (_), hyphens (-), and periods (.).

-

bandwidth_chargemode

-

String

-

Bandwidth billing mode.

-

The value is traffic, indicating that the billing is based on traffic.

-

bandwidth_size

-

Integer

-

Bandwidth size.

-

bandwidth_sharetype

-

String

-

Bandwidth sharing mode.

-
  • PER: dedicated bandwidth.
  • WHOLE: shared bandwidth.
-

eip_type

-

String

-

EIP type.

-
-
-
-
-
- -
- diff --git a/docs/cce/api-ref/cce_02_0092.html b/docs/cce/api-ref/cce_02_0092.html index 71dea3102..d4cfa127c 100644 --- a/docs/cce/api-ref/cce_02_0092.html +++ b/docs/cce/api-ref/cce_02_0092.html @@ -38,6 +38,14 @@ + + + +