From c6b29cd94825598b82fe8d8a26b957efc90939fd Mon Sep 17 00:00:00 2001 From: OpenTelekomCloud Proposal Bot Date: Thu, 16 Mar 2023 02:44:46 +0000 Subject: [PATCH] Update content --- .../cluster_management/accepting_a_node.rst | 15 +- .../creating_a_node_pool.rst | 52 ++++-- .../deleting_a_node_pool.rst | 150 +++-------------- ..._all_node_pools_in_a_specified_cluster.rst | 94 +++++++---- .../querying_a_specified_node_pool.rst | 38 ++++- .../cluster_management/resetting_a_node.rst | 15 +- .../updating_a_specified_node_pool.rst | 159 ++++-------------- 7 files changed, 202 insertions(+), 321 deletions(-) diff --git a/api-ref/source/apis/cluster_management/accepting_a_node.rst b/api-ref/source/apis/cluster_management/accepting_a_node.rst index 32aa096..092c7ee 100644 --- a/api-ref/source/apis/cluster_management/accepting_a_node.rst +++ b/api-ref/source/apis/cluster_management/accepting_a_node.rst @@ -324,11 +324,16 @@ Request Parameters .. table:: **Table 19** Runtime - ========= ========= ====== ========================================== - Parameter Mandatory Type Description - ========= ========= ====== ========================================== - name No String Container runtime. Defaults to **docker**. - ========= ========= ====== ========================================== + +-----------------+-----------------+-----------------+--------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================+ + | name | No | String | Container runtime. Defaults to **docker**. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - docker | + | | | | - containerd | + +-----------------+-----------------+-----------------+--------------------------------------------+ .. _addnode__en-us_topic_0000001417516392_request_reinstallk8soptionsconfig: diff --git a/api-ref/source/apis/cluster_management/creating_a_node_pool.rst b/api-ref/source/apis/cluster_management/creating_a_node_pool.rst index d6752d1..2effd13 100644 --- a/api-ref/source/apis/cluster_management/creating_a_node_pool.rst +++ b/api-ref/source/apis/cluster_management/creating_a_node_pool.rst @@ -221,6 +221,8 @@ Request +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | nodeNicSpec | No | :ref:`nodeNicSpec ` object | Description about the node NIC. | +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | runtime | No | :ref:`Runtime ` object | Container runtime. The default value is **docker**. | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _cce_02_0354__table10946114617286: @@ -472,9 +474,24 @@ Request | serverGroupReference | No | String | ECS group ID. If this parameter is specified, all nodes in the node pool will be created in this ECS group. | +----------------------+-----------+--------+-------------------------------------------------------------------------------------------------------------+ +.. _cce_02_0354__table163721555105015: + +.. table:: **Table 18** Runtime + + +-----------------+-----------------+-----------------+-----------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=====================================================+ + | name | No | String | Container runtime. The default value is **docker**. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - docker | + | | | | - containerd | + +-----------------+-----------------+-----------------+-----------------------------------------------------+ + .. _cce_02_0354__en-us_topic_0000001417516392_request_storage: -.. table:: **Table 18** Storage +.. table:: **Table 19** Storage +------------------+-----------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -486,7 +503,7 @@ Request .. _cce_02_0354__en-us_topic_0000001417516392_request_storageselectors: -.. table:: **Table 19** StorageSelectors +.. table:: **Table 20** StorageSelectors +-------------+-----------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -500,7 +517,7 @@ Request .. _cce_02_0354__en-us_topic_0000001417516392_request_matchlabels: -.. table:: **Table 20** matchLabels +.. table:: **Table 21** matchLabels +-------------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -518,7 +535,7 @@ Request .. _cce_02_0354__en-us_topic_0000001417516392_request_storagegroups: -.. table:: **Table 21** StorageGroups +.. table:: **Table 22** StorageGroups +---------------+-----------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -534,7 +551,7 @@ Request .. _cce_02_0354__en-us_topic_0000001417516392_request_virtualspace: -.. table:: **Table 22** VirtualSpace +.. table:: **Table 23** VirtualSpace +-----------------+-----------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -558,7 +575,7 @@ Request .. _cce_02_0354__en-us_topic_0000001417516392_request_lvmconfig: -.. table:: **Table 23** LVMConfig +.. table:: **Table 24** LVMConfig +-----------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -570,7 +587,7 @@ Request .. _cce_02_0354__en-us_topic_0000001417516392_request_runtimeconfig: -.. table:: **Table 24** RuntimeConfig +.. table:: **Table 25** RuntimeConfig +-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -711,11 +728,11 @@ Response **Response parameters:** -:ref:`Table 25 ` describes the response parameters. +:ref:`Table 26 ` describes the response parameters. .. _cce_02_0354__table835415466262: -.. table:: **Table 25** Response parameters +.. table:: **Table 26** Response parameters +------------+------------------------------------------------------------+-----------------------------------------------+ | Parameter | Type | Description | @@ -733,7 +750,7 @@ Response .. _cce_02_0354__table173551146152616: -.. table:: **Table 26** Data structure of the metadata field +.. table:: **Table 27** Data structure of the metadata field ========= ====== ====================== Parameter Type Description @@ -744,7 +761,7 @@ Response .. _cce_02_0354__table1735515465260: -.. table:: **Table 27** Data structure of the spec field +.. table:: **Table 28** Data structure of the spec field +------------------+----------------------------------------------------------------+----------------------------------------------------+ | Parameter | Type | Description | @@ -762,7 +779,7 @@ Response .. _cce_02_0354__table14356154632610: -.. table:: **Table 28** Data structure of the autoscaling field +.. table:: **Table 29** Data structure of the autoscaling field +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -788,7 +805,7 @@ Response .. _cce_02_0354__table1778609171919: -.. table:: **Table 29** Data structure of the nodeManagement field +.. table:: **Table 30** Data structure of the nodeManagement field +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -798,7 +815,7 @@ Response .. _cce_02_0354__table19851129411: -.. table:: **Table 30** Data structure of the status field +.. table:: **Table 31** Data structure of the status field +-----------------------+-----------------------+---------------------------------------------------------------+ | Parameter | Type | Description | @@ -901,6 +918,9 @@ CCE cluster: } ] }, + "runtime": { + "name":"docker" + }, "publicIP": { "eip": { "bandwidth": {} @@ -1047,11 +1067,11 @@ CCE Turbo cluster: Status Code ----------- -:ref:`Table 31 ` describes the status code of this API. +:ref:`Table 32 ` describes the status code of this API. .. _cce_02_0354__zh-cn_topic_0079614900_table46761928: -.. table:: **Table 31** Status code +.. table:: **Table 32** Status code +-------------+-------------------------------------------------------------------------------+ | Status Code | Description | diff --git a/api-ref/source/apis/cluster_management/deleting_a_node_pool.rst b/api-ref/source/apis/cluster_management/deleting_a_node_pool.rst index cbe457b..6cdeec6 100644 --- a/api-ref/source/apis/cluster_management/deleting_a_node_pool.rst +++ b/api-ref/source/apis/cluster_management/deleting_a_node_pool.rst @@ -268,6 +268,8 @@ Response | | | | | | | - **alpha.cce/NodeImageID**: This field is required when a custom image is used to create a BMS node. | +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | runtime | :ref:`Runtime ` object | Container runtime. The default value is **docker**. | + +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _cce_02_0357__response_login: @@ -521,9 +523,24 @@ Response | jobId | String | ID of the job to delete the node pool. | +-----------------------+-----------------------+----------------------------------------------------------------------------+ +.. _cce_02_0357__table163721555105015: + +.. table:: **Table 20** Runtime + + +-----------------+-----------------+-----------------+-----------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=====================================================+ + | name | No | String | Container runtime. The default value is **docker**. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - docker | + | | | | - containerd | + +-----------------+-----------------+-----------------+-----------------------------------------------------+ + .. _cce_02_0357__response_storage: -.. table:: **Table 20** Storage +.. table:: **Table 21** Storage +------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -535,7 +552,7 @@ Response .. _cce_02_0357__response_storageselectors: -.. table:: **Table 21** StorageSelectors +.. table:: **Table 22** StorageSelectors +-------------+---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -549,7 +566,7 @@ Response .. _cce_02_0357__response_matchlabels: -.. table:: **Table 22** matchLabels +.. table:: **Table 23** matchLabels +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -567,7 +584,7 @@ Response .. _cce_02_0357__response_storagegroups: -.. table:: **Table 23** StorageGroups +.. table:: **Table 24** StorageGroups +---------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -583,7 +600,7 @@ Response .. _cce_02_0357__response_virtualspace: -.. table:: **Table 24** VirtualSpace +.. table:: **Table 25** VirtualSpace +-----------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -607,7 +624,7 @@ Response .. _cce_02_0357__response_lvmconfig: -.. table:: **Table 25** LVMConfig +.. table:: **Table 26** LVMConfig +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -619,7 +636,7 @@ Response .. _cce_02_0357__response_runtimeconfig: -.. table:: **Table 26** RuntimeConfig +.. table:: **Table 27** RuntimeConfig +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -627,122 +644,6 @@ Response | lvType | 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. | +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -**Response example**: - -.. code-block:: - - { - "kind": "List", - "apiVersion": "v3", - "items": [ - { - "kind": "NodePool", - "apiVersion": "v3", - "metadata": { - "name": "nodepool-name-change", - "uid": "feec6013-cd7e-11ea-8c7a-0255ac100be7" - }, - "spec": { - "initialNodeCount": 0, - "type": "vm", - "nodeTemplate": { - "flavor": "s6.large.2", - "az": "eu-de-02", - "os": "EulerOS 2.5", - "login": { - "sshKey": "KeyPair-nodepool", - "userPassword": {} - }, - "rootVolume": { - "volumetype": "SAS", - "size": 40 - }, - "dataVolumes": [ - { - "volumetype": "SAS", - "size": 100, - "extendParam": { - "useType": "docker" - } - } - ], - "publicIP": { - "eip": { - "bandwidth": {} - } - }, - "nodeNicSpec": { - "primaryNic": { - "subnetId": "31be174a-0c7f-4b71-bb0d-d325fecb90ef" - } - }, - "billingMode": 0, - "taints": [ - { - "key": "change-taints", - "value": "value1", - "effect": "NoExecute" - } - ], - "k8sTags": { - "cce.cloud.com/cce-nodepool": "nodepool-name-change", - "change-tag": "value2" - }, - "userTags": [ - { - "key": "change-resource-tag", - "value": "value3" - } - ], - "extendParam": { - "DockerLVMConfigOverride": "dockerThinpool=vgpaas/90%VG;kubernetesLV=vgpaas/10%VG;diskType=evs;lvType=linear", - "alpha.cce/NodeImageID": "85bd7ec5-bca4-4f5f-947b-6c1bf02599d3", - "alpha.cce/postInstall": "bHMgLWwK", - "alpha.cce/preInstall": "bHMgLWw=", - "maxPods": 110 - } - }, - "autoscaling": { - "enable": true, - "minNodeCount": 2, - "maxNodeCount": 4, - "scaleDownCooldownTime": 10, - "priority": 2 - }, - "nodeManagement": { - "serverGroupReference": "2129f95a-f233-4cd8-a1b2-9c0acdf918d3" - } - }, - "status": { - "currentNode": 0, - "phase": "" - } - } - ] - } - -Status Code - -:ref:`Table 27 ` describes the status code of this API. - -.. _cce_02_0357__en-us_topic_0079614900_table46761928: - -.. table:: **Table 27** Status code - - +-------------+---------------------------------------------------------------------------+ - | Status Code | Description | - +=============+===========================================================================+ - | 200 | Information about all node pools in the cluster is successfully obtained. | - +-------------+---------------------------------------------------------------------------+ - -For details about error status codes, see :ref:`Status Code `. - -Error Codes - -See :ref:`Error Codes `. - -For details about the response parameters, see :ref:`Table 25 `. - **Example response:** .. code-block:: @@ -814,6 +715,9 @@ For details about the response parameters, see :ref:`Table 25 ` object | Container runtime. The default value is **docker**. | + +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _cce_02_0269__response_login: @@ -556,9 +558,24 @@ Response | jobId | String | ID of the job to delete the node pool. | +-----------------------+-----------------------+----------------------------------------------------------------------------+ +.. _cce_02_0269__table163721555105015: + +.. table:: **Table 22** Runtime + + +-----------------+-----------------+-----------------+-----------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=====================================================+ + | name | No | String | Container runtime. The default value is **docker**. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - docker | + | | | | - containerd | + +-----------------+-----------------+-----------------+-----------------------------------------------------+ + .. _cce_02_0269__response_storage: -.. table:: **Table 22** Storage +.. table:: **Table 23** Storage +------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -570,7 +587,7 @@ Response .. _cce_02_0269__response_storageselectors: -.. table:: **Table 23** StorageSelectors +.. table:: **Table 24** StorageSelectors +-------------+---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -584,7 +601,7 @@ Response .. _cce_02_0269__response_matchlabels: -.. table:: **Table 24** matchLabels +.. table:: **Table 25** matchLabels +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -602,7 +619,7 @@ Response .. _cce_02_0269__response_storagegroups: -.. table:: **Table 25** StorageGroups +.. table:: **Table 26** StorageGroups +---------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -618,7 +635,7 @@ Response .. _cce_02_0269__response_virtualspace: -.. table:: **Table 26** VirtualSpace +.. table:: **Table 27** VirtualSpace +-----------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -642,7 +659,7 @@ Response .. _cce_02_0269__response_lvmconfig: -.. table:: **Table 27** LVMConfig +.. table:: **Table 28** LVMConfig +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -654,7 +671,7 @@ Response .. _cce_02_0269__response_runtimeconfig: -.. table:: **Table 28** RuntimeConfig +.. table:: **Table 29** RuntimeConfig +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -701,38 +718,41 @@ Response } } ], - "storage": { - "storageSelectors": [ - { - "name": "cceUse", - "storageType": "evs", - "matchLabels": { - "size": "100", - "volumeType": "SAS", - "count": "1" - } - } - ], - "storageGroups": [ - { - "name": "vgpaas", - "selectorNames": [ - "cceUse" + "storage": { + "storageSelectors": [ + { + "name": "cceUse", + "storageType": "evs", + "matchLabels": { + "size": "100", + "volumeType": "SAS", + "count": "1" + } + } ], - "cceManaged": true, - "virtualSpaces": [ + "storageGroups": [ { - "name": "runtime", - "size": "90%" - }, - { - "name": "kubernetes", - "size": "10%" + "name": "vgpaas", + "selectorNames": [ + "cceUse" + ], + "cceManaged": true, + "virtualSpaces": [ + { + "name": "runtime", + "size": "90%" + }, + { + "name": "kubernetes", + "size": "10%" + } + ] } ] - } - ] - }, + }, + "runtime": { + "name": "docker" + }, "publicIP": { "eip": { "bandwidth": {} @@ -791,11 +811,11 @@ Response Status Code ----------- -:ref:`Table 29 ` describes the status code of this API. +:ref:`Table 30 ` describes the status code of this API. .. _cce_02_0269__en-us_topic_0079614900_table46761928: -.. table:: **Table 29** Status code +.. table:: **Table 30** Status code +-------------+---------------------------------------------------------------------------+ | Status Code | Description | diff --git a/api-ref/source/apis/cluster_management/querying_a_specified_node_pool.rst b/api-ref/source/apis/cluster_management/querying_a_specified_node_pool.rst index 2543e8c..15818ae 100644 --- a/api-ref/source/apis/cluster_management/querying_a_specified_node_pool.rst +++ b/api-ref/source/apis/cluster_management/querying_a_specified_node_pool.rst @@ -258,6 +258,8 @@ Response | | | "effect": "NoSchedule" | | | | }] | +-----------------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | runtime | :ref:`Runtime ` object | Container runtime. The default value is **docker**. | + +-----------------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _cce_02_0355__table10946114617286: @@ -509,9 +511,24 @@ Response | jobId | String | ID of the job to delete the node pool. | +-----------------------+-----------------------+---------------------------------------------------------------+ +.. _cce_02_0355__table163721555105015: + +.. table:: **Table 21** Runtime + + +-----------------+-----------------+-----------------+-----------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=====================================================+ + | name | No | String | Container runtime. The default value is **docker**. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - docker | + | | | | - containerd | + +-----------------+-----------------+-----------------+-----------------------------------------------------+ + .. _cce_02_0355__response_storage: -.. table:: **Table 21** Storage +.. table:: **Table 22** Storage +------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -523,7 +540,7 @@ Response .. _cce_02_0355__response_storageselectors: -.. table:: **Table 22** StorageSelectors +.. table:: **Table 23** StorageSelectors +-------------+---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -537,7 +554,7 @@ Response .. _cce_02_0355__response_matchlabels: -.. table:: **Table 23** matchLabels +.. table:: **Table 24** matchLabels +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -555,7 +572,7 @@ Response .. _cce_02_0355__response_storagegroups: -.. table:: **Table 24** StorageGroups +.. table:: **Table 25** StorageGroups +---------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -571,7 +588,7 @@ Response .. _cce_02_0355__response_virtualspace: -.. table:: **Table 25** VirtualSpace +.. table:: **Table 26** VirtualSpace +-----------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -595,7 +612,7 @@ Response .. _cce_02_0355__response_lvmconfig: -.. table:: **Table 26** LVMConfig +.. table:: **Table 27** LVMConfig +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -607,7 +624,7 @@ Response .. _cce_02_0355__response_runtimeconfig: -.. table:: **Table 27** RuntimeConfig +.. table:: **Table 28** RuntimeConfig +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -686,6 +703,9 @@ Response } ] }, + "runtime": { + "name":"docker" + }, "publicIP": { "eip": { "bandwidth": {} @@ -742,11 +762,11 @@ Response Status Code ----------- -:ref:`Table 28 ` describes the status code of this API. +:ref:`Table 29 ` describes the status code of this API. .. _cce_02_0355__zh-cn_topic_0079614900_table46761928: -.. table:: **Table 28** Status code +.. table:: **Table 29** Status code =========== ================================================ Status Code Description diff --git a/api-ref/source/apis/cluster_management/resetting_a_node.rst b/api-ref/source/apis/cluster_management/resetting_a_node.rst index 8a2426b..fc35706 100644 --- a/api-ref/source/apis/cluster_management/resetting_a_node.rst +++ b/api-ref/source/apis/cluster_management/resetting_a_node.rst @@ -320,11 +320,16 @@ Request Parameters .. table:: **Table 19** Runtime - ========= ========= ====== ========================================== - Parameter Mandatory Type Description - ========= ========= ====== ========================================== - name No String Container runtime. Defaults to **docker**. - ========= ========= ====== ========================================== + +-----------------+-----------------+-----------------+--------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================+ + | name | No | String | Container runtime. Defaults to **docker**. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - docker | + | | | | - containerd | + +-----------------+-----------------+-----------------+--------------------------------------------+ .. _resetnode__en-us_topic_0000001467713153_request_reinstallk8soptionsconfig: diff --git a/api-ref/source/apis/cluster_management/updating_a_specified_node_pool.rst b/api-ref/source/apis/cluster_management/updating_a_specified_node_pool.rst index c65fe2f..2278c9c 100644 --- a/api-ref/source/apis/cluster_management/updating_a_specified_node_pool.rst +++ b/api-ref/source/apis/cluster_management/updating_a_specified_node_pool.rst @@ -61,17 +61,13 @@ Request .. table:: **Table 3** NodePool structure - +------------+-----------+--------------------------------------------------------+-------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========================================================+===========================================+ - | kind | Yes | String | API type, which is fixed at **NodePool**. | - +------------+-----------+--------------------------------------------------------+-------------------------------------------+ - | apiVersion | Yes | String | API version, which is fixed at **v3**. | - +------------+-----------+--------------------------------------------------------+-------------------------------------------+ - | metadata | Yes | :ref:`metadata ` object | Metadata of the node pool. | - +------------+-----------+--------------------------------------------------------+-------------------------------------------+ - | spec | Yes | :ref:`spec ` object | Parameters of the node pool. | - +------------+-----------+--------------------------------------------------------+-------------------------------------------+ + +-----------+-----------+--------------------------------------------------------+------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+========================================================+==============================+ + | metadata | Yes | :ref:`metadata ` object | Metadata of the node pool. | + +-----------+-----------+--------------------------------------------------------+------------------------------+ + | spec | Yes | :ref:`spec ` object | Parameters of the node pool. | + +-----------+-----------+--------------------------------------------------------+------------------------------+ .. _cce_02_0356__table13456192212: @@ -94,11 +90,6 @@ Request +==================+=================+=====================+=====================================================================================================================================================================================================================================================================================================================================+ | initialNodeCount | Yes | Integer | Expected number of nodes in this node pool. The value cannot be greater than the maximum number of nodes allowed for the cluster. | +------------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | String | Node pool type. If this parameter is left blank, the value **vm** is used by default. | - | | | | | - | | | | - **vm**: ECS | - | | | | - **ElasticBMS**: BMS. This value is valid in CCE Turbo cluster. | - +------------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | autoscaling | No | autoscaling object | Auto scaling parameters. | +------------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | nodeTemplate | Yes | nodeTemplate object | Parameters of the node pool template. | @@ -176,117 +167,30 @@ Request .. code-block:: { - "kind": "NodePool", - "apiVersion": "v3", - "metadata": { - "name": "nodepool-name-change", - "uid": "feec6013-cd7e-11ea-8c7a-0255ac100be7" + "metadata" : { + "name" : "nodepool-name-change" + }, + "spec" : { + "nodeTemplate" : { + "k8sTags" : { + "cce.cloud.com/cce-nodepool": "nodepool-name-change", + "change-tag": "value2" }, - "spec": { - "initialNodeCount": 0, - "type": "vm", - "nodeTemplate": { - "flavor": "s6.large.2", - "az": "eu-de-01", - "os": "EulerOS 2.5", - "login": { - "sshKey": "KeyPair-nodepool", - "userPassword": {} - }, - "rootVolume": { - "volumetype": "SATA", - "size": 40 - }, - "dataVolumes": [ - { - "volumetype": "SATA", - "size": 100, - "extendParam": { - "useType": "docker" - } - } - ], - "storage": { - "storageSelectors": [ - { - "name": "cceUse", - "storageType": "evs", - "matchLabels": { - "size": "100", - "volumeType": "SAS", - "count": "1" - } - } - ], - "storageGroups": [ - { - "name": "vgpaas", - "selectorNames": [ - "cceUse" - ], - "cceManaged": true, - "virtualSpaces": [ - { - "name": "runtime", - "size": "90%" - }, - { - "name": "kubernetes", - "size": "10%" - } - ] - } - ] - }, - "publicIP": { - "eip": { - "bandwidth": {} - } - }, - "nodeNicSpec": { - "primaryNic": { - "subnetId": "31be174a-0c7f-4b71-bb0d-d325fecb90ef" - } - }, - "billingMode": 0, - "taints": [ - { - "key": "change-taints", - "value": "value1", - "effect": "NoExecute" - } - ], - "k8sTags": { - "change-tag": "value2" - }, - "userTags": [ - { - "key": "change-resource-tag", - "value": "value3" - } - ], - "extendParam": { - "DockerLVMConfigOverride": "dockerThinpool=vgpaas/90%VG;kubernetesLV=vgpaas/10%VG;diskType=evs;lvType=linear", - "alpha.cce/postInstall": "bHMgLWwK", - "alpha.cce/preInstall": "bHMgLWw=", - "maxPods": 110 - } - }, - "autoscaling": { - "enable": true, - "minNodeCount": 2, - "maxNodeCount": 4, - "scaleDownCooldownTime": 10, - "priority": 2 - }, - "nodeManagement": { - "serverGroupReference": "2129f95a-f233-4cd8-a1b2-9c0acdf918d3" - } + "taints" : [ { + "key" : "status", + "value" : "unavailable", + "effect" : "NoSchedule" + } ], }, - "status": { - "currentNode": 0, - "phase": "" - } + "autoscaling" : { + "enable" : true, + "minNodeCount" : 2, + "maxNodeCount" : 4, + "scaleDownCooldownTime" : 10, + "priority" : 2 + }, + "initialNodeCount" : 1 + } } Response @@ -294,7 +198,7 @@ Response **Response parameters**: -:ref:`Table 25 ` describes the response parameters. +:ref:`Table 26 ` describes the response parameters. **Response example**: @@ -363,6 +267,9 @@ Response } ] }, + "runtime": { + "name":"docker" + }, "publicIP": { "eip": { "bandwidth": {}