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 ca5771d..32aa096 100644 --- a/api-ref/source/apis/cluster_management/accepting_a_node.rst +++ b/api-ref/source/apis/cluster_management/accepting_a_node.rst @@ -44,15 +44,19 @@ Request Parameters .. table:: **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 :ref:`AddNode ` objects | List of the nodes to be accepted. | - +------------+-----------+-----------------------------------------------------------------------------------------+--------------------------------------------+ + +-----------------+-----------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------------+ + | 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 :ref:`AddNode ` objects | List of the nodes to be accepted. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | Nodes must have 2-core or higher CPU, 4 GB or larger memory. | + +-----------------+-----------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------------+ .. _addnode__en-us_topic_0000001417516392_request_addnode: diff --git a/api-ref/source/apis/cluster_management/creating_a_cluster.rst b/api-ref/source/apis/cluster_management/creating_a_cluster.rst index 452334b..821e3cf 100644 --- a/api-ref/source/apis/cluster_management/creating_a_cluster.rst +++ b/api-ref/source/apis/cluster_management/creating_a_cluster.rst @@ -13,7 +13,7 @@ This API is used to create an empty cluster, which has only master nodes but do .. note:: - 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. - - Info collect agent (ICAgent) is an O&M data collection agent used by Application Performance Management (APM) service. It runs on each server to collect data from probes in real time. When this API is called to create a cluster, ICAgent is not installed by default. To automatically install ICAgent during cluster creation, add **"cluster.install.addons.external/install": "[{\\"addonTemplateName\\":\\"icagent\\"}]"** to the **annotations** field in the request body. + - Info collect agent (ICAgent) is an O&M data collection agent. It runs on each server to collect data from probes in real time. When this API is called to create a cluster, ICAgent is not installed by default. To automatically install ICAgent during cluster creation, add **"cluster.install.addons.external/install": "[{\\"addonTemplateName\\":\\"icagent\\"}]"** to the **annotations** field in the request body. - Before creating a cluster, :ref:`Creating a VPC and Subnet `. If a VPC and subnet already exists, you do not need to create them again. - By default, an account can create a maximum of five clusters in each region. diff --git a/api-ref/source/apis/cluster_management/creating_a_node.rst b/api-ref/source/apis/cluster_management/creating_a_node.rst index 12665e0..7aa176d 100644 --- a/api-ref/source/apis/cluster_management/creating_a_node.rst +++ b/api-ref/source/apis/cluster_management/creating_a_node.rst @@ -126,7 +126,8 @@ Request | | | | | | | | | .. note:: | | | | | | - | | | | When adding a BMS node, check whether the flavor of the node to be added supports local disks. If local disks are not supported, add at least one 100 GB EVS disk. | + | | | | - When adding a BMS node, check whether the flavor of the node to be added supports local disks. If local disks are not supported, add at least one 100 GB EVS disk. | + | | | | - Nodes must have 2-core or higher CPU, 4 GB or larger memory. | +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | az | Yes | String | AZ of the node. For details, see the description of the **availability_zone** parameter in `Creating an ECS `__. | +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -592,7 +593,7 @@ CCE cluster: } }, "spec": { - "flavor": "s1.medium", + "flavor": "c4.large.2", "az": "eu-de-01", "login": { "sshKey": "Keypair-demo" @@ -601,6 +602,10 @@ CCE cluster: "size": 40, "volumetype": "SAS" }, + "dataVolumes" : [ { + "size" : 100, + "volumetype" : "SAS" + } ], "storage": { "storageSelectors": [ { @@ -633,7 +638,6 @@ CCE cluster: } ] }, - ], "userTags": [ { "key": "tag1", @@ -1197,6 +1201,12 @@ Response "volumetype": "SAS", "size": 40 }, + "dataVolumes": [ + { + "volumetype": "SAS", + "size": 100 + } + ], "storage": { "storageSelectors": [ { @@ -1281,6 +1291,13 @@ CCE Turbo cluster: "volumetype": "SAS", "hw:passthrough": true }, + "dataVolumes": [ + { + "size": 100, + "volumetype": "SAS", + "hw:passthrough": true + } + ], "storage": { "storageSelectors": [ { 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 6632f3e..d6752d1 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 @@ -113,104 +113,114 @@ Request .. table:: **Table 6** Data structure of the **nodeTemplate** field - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==============================================================+====================================================================================================================================================================================================================================================================================+ - | flavor | Yes | String | Node specifications. For details, see the description of the **flavorRef** parameter in `Creating an ECS `__. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | When adding a BMS node, check whether the flavor of the node to be added supports local disks. If local disks are not supported, add at least one 100 GB EVS disk. | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | az | Yes | String | AZ of the node. For details, see the description of the **availability_zone** parameter in `Creating an ECS `__. | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | os | No | String | - Nodes in clusters of Kubernetes v1.11 or earlier support EulerOS 2.2. | - | | | | - Nodes in clusters of Kubernetes v1.13 or v1.15 support EulerOS 2.5. | - | | | | - Nodes in clusters of Kubernetes v1.17 support EulerOS 2.5 and CentOS 7.7. | - | | | | - Nodes in clusters of Kubernetes v1.19, v1.21 or v1.23 support EulerOS 2.5, EulerOS 2.9 and CentOS 7.7. | - | | | | - Nodes using **kata** runtime in CCE Turbo cluster support EulerOS 2.9. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | If the **alpha.cce/NodeImageID** parameter in **extendParam** is specified during node creation, you do not need to set this field. | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | login | Yes | :ref:`login ` object | Node login mode, which can be key pair or password. | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rootVolume | Yes | :ref:`Volume ` object | System disk parameters of the node. | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataVolumes | Yes | Array of :ref:`Volume ` object | Data disk parameters of the node. | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | publicIP | No | :ref:`publicIP ` object | EIP used by the node to access public networks. | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | billingMode | No | Integer | Billing mode of a node. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This field is not supported for the current version. | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | count | Yes | Integer | Number of nodes to be created in a batch. The value must be a positive integer greater than or equal to 1 and less than or equal to the defined limit. This field can be set to **0** for a node pool. | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extendParam | No | :ref:`extendParam ` object | Extended parameter. Format: Key-value pair. | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | userTags | No | Object | Tag of a VM. | - | | | | | - | | | | The format is key-value pair. The number of key-value pairs cannot exceed 20. | - | | | | | - | | | | - **Key**: Only letters, digits, hyphens (-), underscores (_), and at signs (@) are supported. | - | | | | - **Value**: Only letters, digits, hyphens (-), underscores (_), and at signs (@) are supported. | - | | | | | - | | | | Example: | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | "userTags": [ | - | | | | { | - | | | | "key": "tag1", | - | | | | "value": "aaaa" | - | | | | }, | - | | | | { | - | | | | "key": "tag2", | - | | | | "value": "bbbb" | - | | | | } | - | | | | ] | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | k8sTags | No | Object | Tag of a Kubernetes node. | - | | | | | - | | | | The format is key-value pair. The number of key-value pairs cannot exceed 20. | - | | | | | - | | | | - **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 a string of 1 to 63 characters starting with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed in the character string. | - | | | | | - | | | | Example: | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | "k8sTags": { | - | | | | "key": "value" | - | | | | } | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | taints | No | Object | You can add taints to created nodes to configure anti-affinity. 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: | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | "taints": [{ | - | | | | "key": "status", | - | | | | "value": "unavailable", | - | | | | "effect": "NoSchedule" | - | | | | }, { | - | | | | "key": "looks", | - | | | | "value": "bad", | - | | | | "effect": "NoSchedule" | - | | | | }] | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nodeNicSpec | No | :ref:`nodeNicSpec ` object | Description about the node NIC. | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+===================================================================================+====================================================================================================================================================================================================================================================================================+ + | flavor | Yes | String | Node specifications. For details, see the description of the **flavorRef** parameter in `Creating an ECS `__. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | When adding a BMS node, check whether the flavor of the node to be added supports local disks. If local disks are not supported, add at least one 100 GB EVS disk. | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | az | Yes | String | AZ of the node. For details, see the description of the **availability_zone** parameter in `Creating an ECS `__. | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | os | No | String | - Nodes in clusters of Kubernetes v1.11 or earlier support EulerOS 2.2. | + | | | | - Nodes in clusters of Kubernetes v1.13 or v1.15 support EulerOS 2.5. | + | | | | - Nodes in clusters of Kubernetes v1.17 support EulerOS 2.5 and CentOS 7.7. | + | | | | - Nodes in clusters of Kubernetes v1.19, v1.21 or v1.23 support EulerOS 2.5, EulerOS 2.9 and CentOS 7.7. | + | | | | - Nodes using **kata** runtime in CCE Turbo cluster support EulerOS 2.9. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | If the **alpha.cce/NodeImageID** parameter in **extendParam** is specified during node creation, you do not need to set this field. | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | login | Yes | :ref:`login ` object | Node login mode, which can be key pair or password. | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | rootVolume | Yes | :ref:`Volume ` object | System disk parameters of the node. | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dataVolumes | Yes | Array of :ref:`Volume ` object | Data disk parameters of the node. | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | storage | No | :ref:`Storage ` object | Disk initialization management parameter. | + | | | | | + | | | | This parameter is complex to configure. For details, see :ref:`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. | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | publicIP | No | :ref:`publicIP ` object | EIP used by the node to access public networks. | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | billingMode | No | Integer | Billing mode of a node. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | This field is not supported for the current version. | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | count | Yes | Integer | Number of nodes to be created in a batch. The value must be a positive integer greater than or equal to 1 and less than or equal to the defined limit. This field can be set to **0** for a node pool. | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extendParam | No | :ref:`extendParam ` object | Extended parameter. Format: Key-value pair. | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | userTags | No | Object | Tag of a VM. | + | | | | | + | | | | The format is key-value pair. The number of key-value pairs cannot exceed 20. | + | | | | | + | | | | - **Key**: Only letters, digits, hyphens (-), underscores (_), and at signs (@) are supported. | + | | | | - **Value**: Only letters, digits, hyphens (-), underscores (_), and at signs (@) are supported. | + | | | | | + | | | | Example: | + | | | | | + | | | | .. code-block:: | + | | | | | + | | | | "userTags": [ | + | | | | { | + | | | | "key": "tag1", | + | | | | "value": "aaaa" | + | | | | }, | + | | | | { | + | | | | "key": "tag2", | + | | | | "value": "bbbb" | + | | | | } | + | | | | ] | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | k8sTags | No | Object | Tag of a Kubernetes node. | + | | | | | + | | | | The format is key-value pair. The number of key-value pairs cannot exceed 20. | + | | | | | + | | | | - **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 a string of 1 to 63 characters starting with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed in the character string. | + | | | | | + | | | | Example: | + | | | | | + | | | | .. code-block:: | + | | | | | + | | | | "k8sTags": { | + | | | | "key": "value" | + | | | | } | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | taints | No | Object | You can add taints to created nodes to configure anti-affinity. 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: | + | | | | | + | | | | .. code-block:: | + | | | | | + | | | | "taints": [{ | + | | | | "key": "status", | + | | | | "value": "unavailable", | + | | | | "effect": "NoSchedule" | + | | | | }, { | + | | | | "key": "looks", | + | | | | "value": "bad", | + | | | | "effect": "NoSchedule" | + | | | | }] | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | nodeNicSpec | No | :ref:`nodeNicSpec ` object | Description about the node NIC. | + +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _cce_02_0354__table10946114617286: @@ -462,6 +472,112 @@ 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__en-us_topic_0000001417516392_request_storage: + +.. table:: **Table 18** Storage + + +------------------+-----------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+===========+===============================================================================================================+=============================================================================================+ + | storageSelectors | Yes | Array of :ref:`StorageSelectors ` objects | Disk selection. Matched disks are managed according to **matchLabels** and **storageType**. | + +------------------+-----------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | storageGroups | Yes | Array of :ref:`StorageGroups ` objects | A storage group consists of multiple storage devices. It is used to divide storage space. | + +------------------+-----------+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + +.. _cce_02_0354__en-us_topic_0000001417516392_request_storageselectors: + +.. table:: **Table 19** 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 | :ref:`matchLabels ` object | Matching field of an EVS volume. The **size**, **volumeType**, **metadataEncrypted**, **metadataCmkid** and **count** fields are supported. | + +-------------+-----------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0354__en-us_topic_0000001417516392_request_matchlabels: + +.. table:: **Table 20** 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. | + +-------------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0354__en-us_topic_0000001417516392_request_storagegroups: + +.. table:: **Table 21** 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 :ref:`VirtualSpace ` objects | Detailed management of space configuration in a group. | + +---------------+-----------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0354__en-us_topic_0000001417516392_request_virtualspace: + +.. table:: **Table 22** 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 | :ref:`LVMConfig ` object | LVM configurations, applicable to **kubernetes** and **user** spaces. Note that one virtual space supports only one config. | + +-----------------+-----------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | runtimeConfig | No | :ref:`RuntimeConfig ` object | runtime configurations, applicable to the **runtime** space. Note that one virtual space supports only one config. | + +-----------------+-----------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0354__en-us_topic_0000001417516392_request_lvmconfig: + +.. table:: **Table 23** 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. | + +-----------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0354__en-us_topic_0000001417516392_request_runtimeconfig: + +.. table:: **Table 24** 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. | + +-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + **Example Request** CCE cluster: @@ -595,11 +711,11 @@ Response **Response parameters:** -:ref:`Table 18 ` describes the response parameters. +:ref:`Table 25 ` describes the response parameters. .. _cce_02_0354__table835415466262: -.. table:: **Table 18** Response parameters +.. table:: **Table 25** Response parameters +------------+------------------------------------------------------------+-----------------------------------------------+ | Parameter | Type | Description | @@ -617,7 +733,7 @@ Response .. _cce_02_0354__table173551146152616: -.. table:: **Table 19** Data structure of the metadata field +.. table:: **Table 26** Data structure of the metadata field ========= ====== ====================== Parameter Type Description @@ -628,7 +744,7 @@ Response .. _cce_02_0354__table1735515465260: -.. table:: **Table 20** Data structure of the spec field +.. table:: **Table 27** Data structure of the spec field +------------------+----------------------------------------------------------------+----------------------------------------------------+ | Parameter | Type | Description | @@ -646,7 +762,7 @@ Response .. _cce_02_0354__table14356154632610: -.. table:: **Table 21** Data structure of the autoscaling field +.. table:: **Table 28** Data structure of the autoscaling field +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -672,7 +788,7 @@ Response .. _cce_02_0354__table1778609171919: -.. table:: **Table 22** Data structure of the nodeManagement field +.. table:: **Table 29** Data structure of the nodeManagement field +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -682,7 +798,7 @@ Response .. _cce_02_0354__table19851129411: -.. table:: **Table 23** Data structure of the status field +.. table:: **Table 30** Data structure of the status field +-----------------------+-----------------------+---------------------------------------------------------------+ | Parameter | Type | Description | @@ -753,6 +869,38 @@ CCE cluster: } } ], + "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": {} @@ -851,6 +999,38 @@ CCE Turbo cluster: "hw:passthrough": true } ], + "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%" + } + ] + } + ] + }, "runtime": { "name":"containerd" }, @@ -867,11 +1047,11 @@ CCE Turbo cluster: Status Code ----------- -:ref:`Table 24 ` describes the status code of this API. +:ref:`Table 31 ` describes the status code of this API. .. _cce_02_0354__zh-cn_topic_0079614900_table46761928: -.. table:: **Table 24** Status code +.. table:: **Table 31** Status code +-------------+-------------------------------------------------------------------------------+ | Status Code | Description | diff --git a/api-ref/source/apis/cluster_management/deleting_a_node.rst b/api-ref/source/apis/cluster_management/deleting_a_node.rst index fde312e..376266a 100644 --- a/api-ref/source/apis/cluster_management/deleting_a_node.rst +++ b/api-ref/source/apis/cluster_management/deleting_a_node.rst @@ -160,6 +160,38 @@ Response "size": 100 } ], + "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": {} 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 fdb68a7..cbe457b 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 @@ -152,6 +152,16 @@ Response +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dataVolumes | Array of :ref:`Volume ` objects | Data disk parameters of the node. Currently, you can add the second data disk for your node on the CCE console. | +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | storage | :ref:`Storage ` object | Disk initialization management parameter. | + | | | | + | | | This parameter is complex to configure. For details, see :ref:`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. | + +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | publicIP | :ref:`V3NodePublicIP ` object | EIP of the node. | +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | nodeNicSpec | :ref:`NodeNicSpec ` object | NIC information of the node. | @@ -511,6 +521,112 @@ Response | jobId | String | ID of the job to delete the node pool. | +-----------------------+-----------------------+----------------------------------------------------------------------------+ +.. _cce_02_0357__response_storage: + +.. table:: **Table 20** Storage + + +------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+===================================================================================+=============================================================================================+ + | storageSelectors | Array of :ref:`StorageSelectors ` objects | Disk selection. Matched disks are managed according to **matchLabels** and **storageType**. | + +------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | storageGroups | Array of :ref:`StorageGroups ` objects | A storage group consists of multiple storage devices. It is used to divide storage space. | + +------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + +.. _cce_02_0357__response_storageselectors: + +.. table:: **Table 21** StorageSelectors + + +-------------+---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============+===============================================================+=====================================================================================================================================================================================================================================================================+ + | name | String | Selector name, used as the index of **selectorNames** in **storageGroup**. Therefore, the name of each selector must be unique. | + +-------------+---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | storageType | 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 | :ref:`matchLabels ` object | Matching field of an EVS volume. The **size**, **volumeType**, **metadataEncrypted**, **metadataCmkid** and **count** fields are supported. | + +-------------+---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0357__response_matchlabels: + +.. table:: **Table 22** matchLabels + + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===================+========+=============================================================================================================================+ + | size | String | Matched disk size. If this parameter is left unspecified, the disk size is not limited. Example: 100 | + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + | volumeType | String | EVS disk type. Currently, SSD, GPSSD and SAS are supported. | + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + | metadataEncrypted | String | Disk encryption identifier. **0** indicates that the disk is not encrypted, and **1** indicates that the disk is encrypted. | + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + | metadataCmkid | String | Customer master key ID of an encrypted disk. The value is a 36-byte string. | + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + | count | String | Number of disks to be selected. If this parameter is left blank, all disks of this type are selected. | + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0357__response_storagegroups: + +.. table:: **Table 23** StorageGroups + + +---------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===============+===========================================================================+===================================================================================================================================================================+ + | name | String | Name of a virtual storage group, which must be unique. | + +---------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cceManaged | 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 | 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 | Array of :ref:`VirtualSpace ` objects | Detailed management of space configuration in a group. | + +---------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0357__response_virtualspace: + +.. table:: **Table 24** VirtualSpace + + +-----------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+===================================================================+=============================================================================================================================+ + | name | 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 | 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 | :ref:`LVMConfig ` object | LVM configurations, applicable to **kubernetes** and **user** spaces. Note that one virtual space supports only one config. | + +-----------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | runtimeConfig | :ref:`RuntimeConfig ` object | runtime configurations, applicable to the **runtime** space. Note that one virtual space supports only one config. | + +-----------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0357__response_lvmconfig: + +.. table:: **Table 25** LVMConfig + + +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+========================================================================================================================================================================================================+ + | 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. | + +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | path | 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. | + +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0357__response_runtimeconfig: + +.. table:: **Table 26** RuntimeConfig + + +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+=============================================================================================================================================================================+ + | 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:: @@ -607,11 +723,11 @@ Response Status Code -:ref:`Table 20 ` describes the status code of this API. +:ref:`Table 27 ` describes the status code of this API. .. _cce_02_0357__en-us_topic_0079614900_table46761928: -.. table:: **Table 20** Status code +.. table:: **Table 27** Status code +-------------+---------------------------------------------------------------------------+ | Status Code | Description | @@ -625,7 +741,7 @@ Error Codes See :ref:`Error Codes `. -For details about the response parameters, see :ref:`Table 18 `. +For details about the response parameters, see :ref:`Table 25 `. **Example response:** @@ -666,6 +782,38 @@ For details about the response parameters, see :ref:`Table 18 ` describes the status code of this API. +:ref:`Table 28 ` describes the status code of this API. .. _cce_02_0357__zh-cn_topic_0079614900_table46761928: -.. table:: **Table 21** Status code +.. table:: **Table 28** Status code =========== =========================================================== Status Code Description diff --git a/api-ref/source/apis/cluster_management/listing_all_node_pools_in_a_specified_cluster.rst b/api-ref/source/apis/cluster_management/listing_all_node_pools_in_a_specified_cluster.rst index 527ee1e..0ebf6e6 100644 --- a/api-ref/source/apis/cluster_management/listing_all_node_pools_in_a_specified_cluster.rst +++ b/api-ref/source/apis/cluster_management/listing_all_node_pools_in_a_specified_cluster.rst @@ -187,6 +187,16 @@ Response +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dataVolumes | Array of :ref:`Volume ` objects | Data disk parameters of the node. Currently, you can add the second data disk for your node on the CCE console. | +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | storage | :ref:`Storage ` object | Disk initialization management parameter. | + | | | | + | | | This parameter is complex to configure. For details, see :ref:`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. | + +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | publicIP | :ref:`V3NodePublicIP ` object | EIP of the node. | +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | nodeNicSpec | :ref:`NodeNicSpec ` object | NIC information of the node. | @@ -546,6 +556,112 @@ Response | jobId | String | ID of the job to delete the node pool. | +-----------------------+-----------------------+----------------------------------------------------------------------------+ +.. _cce_02_0269__response_storage: + +.. table:: **Table 22** Storage + + +------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+===================================================================================+=============================================================================================+ + | storageSelectors | Array of :ref:`StorageSelectors ` objects | Disk selection. Matched disks are managed according to **matchLabels** and **storageType**. | + +------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | storageGroups | Array of :ref:`StorageGroups ` objects | A storage group consists of multiple storage devices. It is used to divide storage space. | + +------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + +.. _cce_02_0269__response_storageselectors: + +.. table:: **Table 23** StorageSelectors + + +-------------+---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============+===============================================================+=====================================================================================================================================================================================================================================================================+ + | name | String | Selector name, used as the index of **selectorNames** in **storageGroup**. Therefore, the name of each selector must be unique. | + +-------------+---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | storageType | 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 | :ref:`matchLabels ` object | Matching field of an EVS volume. The **size**, **volumeType**, **metadataEncrypted**, **metadataCmkid** and **count** fields are supported. | + +-------------+---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0269__response_matchlabels: + +.. table:: **Table 24** matchLabels + + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===================+========+=============================================================================================================================+ + | size | String | Matched disk size. If this parameter is left unspecified, the disk size is not limited. Example: 100 | + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + | volumeType | String | EVS disk type. Currently, SSD, GPSSD and SAS are supported. | + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + | metadataEncrypted | String | Disk encryption identifier. **0** indicates that the disk is not encrypted, and **1** indicates that the disk is encrypted. | + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + | metadataCmkid | String | Customer master key ID of an encrypted disk. The value is a 36-byte string. | + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + | count | String | Number of disks to be selected. If this parameter is left blank, all disks of this type are selected. | + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0269__response_storagegroups: + +.. table:: **Table 25** StorageGroups + + +---------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===============+===========================================================================+===================================================================================================================================================================+ + | name | String | Name of a virtual storage group, which must be unique. | + +---------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cceManaged | 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 | 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 | Array of :ref:`VirtualSpace ` objects | Detailed management of space configuration in a group. | + +---------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0269__response_virtualspace: + +.. table:: **Table 26** VirtualSpace + + +-----------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+===================================================================+=============================================================================================================================+ + | name | 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 | 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 | :ref:`LVMConfig ` object | LVM configurations, applicable to **kubernetes** and **user** spaces. Note that one virtual space supports only one config. | + +-----------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | runtimeConfig | :ref:`RuntimeConfig ` object | runtime configurations, applicable to the **runtime** space. Note that one virtual space supports only one config. | + +-----------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0269__response_lvmconfig: + +.. table:: **Table 27** LVMConfig + + +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+========================================================================================================================================================================================================+ + | 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. | + +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | path | 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. | + +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0269__response_runtimeconfig: + +.. table:: **Table 28** RuntimeConfig + + +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+=============================================================================================================================================================================+ + | 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:: @@ -585,6 +701,38 @@ Response } } ], + "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": {} @@ -643,11 +791,11 @@ Response Status Code ----------- -:ref:`Table 22 ` describes the status code of this API. +:ref:`Table 29 ` describes the status code of this API. .. _cce_02_0269__en-us_topic_0079614900_table46761928: -.. table:: **Table 22** Status code +.. table:: **Table 29** Status code +-------------+---------------------------------------------------------------------------+ | Status Code | Description | diff --git a/api-ref/source/apis/cluster_management/listing_all_nodes_in_a_cluster.rst b/api-ref/source/apis/cluster_management/listing_all_nodes_in_a_cluster.rst index a83663f..6acb4eb 100644 --- a/api-ref/source/apis/cluster_management/listing_all_nodes_in_a_cluster.rst +++ b/api-ref/source/apis/cluster_management/listing_all_nodes_in_a_cluster.rst @@ -113,6 +113,38 @@ Response "size": 100 } ], + "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": {} diff --git a/api-ref/source/apis/cluster_management/migrating_a_node.rst b/api-ref/source/apis/cluster_management/migrating_a_node.rst index 8d11282..0c73a30 100644 --- a/api-ref/source/apis/cluster_management/migrating_a_node.rst +++ b/api-ref/source/apis/cluster_management/migrating_a_node.rst @@ -55,8 +55,6 @@ Request Parameters +------------+-----------+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------+ | spec | Yes | :ref:`MigrateNodesSpec ` object | Configuration data. | +------------+-----------+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------+ - | status | No | :ref:`TaskStatus ` object | Job status. | - +------------+-----------+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------+ .. _migratenode__en-us_topic_0000001467833433_request_migratenodesspec: @@ -143,22 +141,12 @@ Request Parameters uid Yes String Node ID. ========= ========= ====== =========== -.. _migratenode__en-us_topic_0000001467833433_request_taskstatus: - -.. table:: **Table 8** TaskStatus - - +-----------+-----------+--------+----------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+================================================================+ - | jobID | No | String | Job ID, which is used by the caller to query the job progress. | - +-----------+-----------+--------+----------------------------------------------------------------+ - Response Parameters ------------------- **Status code: 200** -.. table:: **Table 9** Response body parameters +.. table:: **Table 8** Response body parameters +------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ | Parameter | Type | Description | @@ -174,7 +162,7 @@ Response Parameters .. _migratenode__en-us_topic_0000001467833433_response_migratenodesspec: -.. table:: **Table 10** MigrateNodesSpec +.. table:: **Table 9** MigrateNodesSpec +-------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -190,7 +178,7 @@ Response Parameters .. _migratenode__en-us_topic_0000001467833433_response_migratenodeextendparam: -.. table:: **Table 11** MigrateNodeExtendParam +.. table:: **Table 10** MigrateNodeExtendParam +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -233,7 +221,7 @@ Response Parameters .. _migratenode__en-us_topic_0000001467833433_response_login: -.. table:: **Table 12** Login +.. table:: **Table 11** Login +-----------------------+-----------------------+---------------------------------------------------------+ | Parameter | Type | Description | @@ -249,7 +237,7 @@ Response Parameters .. _migratenode__en-us_topic_0000001467833433_response_nodeitem: -.. table:: **Table 13** NodeItem +.. table:: **Table 12** NodeItem ========= ====== =========== Parameter Type Description @@ -259,7 +247,7 @@ Response Parameters .. _migratenode__en-us_topic_0000001467833433_response_taskstatus: -.. table:: **Table 14** TaskStatus +.. table:: **Table 13** TaskStatus +-----------+--------+----------------------------------------------------------------+ | Parameter | Type | 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 2da6bc6..2543e8c 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 @@ -173,6 +173,16 @@ Response +-----------------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dataVolumes | Array of :ref:`Volume ` object | Data disk parameters of the node. | +-----------------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | storage | :ref:`Storage ` object | Disk initialization management parameter. | + | | | | + | | | This parameter is complex to configure. For details, see :ref:`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. | + +-----------------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | publicIP | :ref:`publicIP ` object | EIP used by the node to access public networks. | +-----------------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | nodeNicSpec | :ref:`nodeNicSpec ` object | Node NIC description. | @@ -499,6 +509,112 @@ Response | jobId | String | ID of the job to delete the node pool. | +-----------------------+-----------------------+---------------------------------------------------------------+ +.. _cce_02_0355__response_storage: + +.. table:: **Table 21** Storage + + +------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+===================================================================================+=============================================================================================+ + | storageSelectors | Array of :ref:`StorageSelectors ` objects | Disk selection. Matched disks are managed according to **matchLabels** and **storageType**. | + +------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | storageGroups | Array of :ref:`StorageGroups ` objects | A storage group consists of multiple storage devices. It is used to divide storage space. | + +------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + +.. _cce_02_0355__response_storageselectors: + +.. table:: **Table 22** StorageSelectors + + +-------------+---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============+===============================================================+=====================================================================================================================================================================================================================================================================+ + | name | String | Selector name, used as the index of **selectorNames** in **storageGroup**. Therefore, the name of each selector must be unique. | + +-------------+---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | storageType | 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 | :ref:`matchLabels ` object | Matching field of an EVS volume. The **size**, **volumeType**, **metadataEncrypted**, **metadataCmkid** and **count** fields are supported. | + +-------------+---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0355__response_matchlabels: + +.. table:: **Table 23** matchLabels + + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===================+========+=============================================================================================================================+ + | size | String | Matched disk size. If this parameter is left unspecified, the disk size is not limited. Example: 100 | + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + | volumeType | String | EVS disk type. Currently, SSD, GPSSD and SAS are supported. | + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + | metadataEncrypted | String | Disk encryption identifier. **0** indicates that the disk is not encrypted, and **1** indicates that the disk is encrypted. | + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + | metadataCmkid | String | Customer master key ID of an encrypted disk. The value is a 36-byte string. | + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + | count | String | Number of disks to be selected. If this parameter is left blank, all disks of this type are selected. | + +-------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0355__response_storagegroups: + +.. table:: **Table 24** StorageGroups + + +---------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===============+===========================================================================+===================================================================================================================================================================+ + | name | String | Name of a virtual storage group, which must be unique. | + +---------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cceManaged | 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 | 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 | Array of :ref:`VirtualSpace ` objects | Detailed management of space configuration in a group. | + +---------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0355__response_virtualspace: + +.. table:: **Table 25** VirtualSpace + + +-----------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+===================================================================+=============================================================================================================================+ + | name | 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 | 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 | :ref:`LVMConfig ` object | LVM configurations, applicable to **kubernetes** and **user** spaces. Note that one virtual space supports only one config. | + +-----------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | runtimeConfig | :ref:`RuntimeConfig ` object | runtime configurations, applicable to the **runtime** space. Note that one virtual space supports only one config. | + +-----------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0355__response_lvmconfig: + +.. table:: **Table 26** LVMConfig + + +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+========================================================================================================================================================================================================+ + | 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. | + +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | path | 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. | + +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _cce_02_0355__response_runtimeconfig: + +.. table:: **Table 27** RuntimeConfig + + +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+=============================================================================================================================================================================+ + | 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:: @@ -538,6 +654,38 @@ Response } } ], + "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": {} @@ -594,11 +742,11 @@ Response Status Code ----------- -:ref:`Table 21 ` describes the status code of this API. +:ref:`Table 28 ` describes the status code of this API. .. _cce_02_0355__zh-cn_topic_0079614900_table46761928: -.. table:: **Table 21** Status code +.. table:: **Table 28** Status code =========== ================================================ Status Code Description diff --git a/api-ref/source/apis/cluster_management/reading_a_specified_node.rst b/api-ref/source/apis/cluster_management/reading_a_specified_node.rst index b19ff15..1eca39f 100644 --- a/api-ref/source/apis/cluster_management/reading_a_specified_node.rst +++ b/api-ref/source/apis/cluster_management/reading_a_specified_node.rst @@ -494,6 +494,38 @@ Response "size": 100 } ], + "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": {} diff --git a/api-ref/source/apis/cluster_management/removing_a_node.rst b/api-ref/source/apis/cluster_management/removing_a_node.rst index f5b52a5..7726266 100644 --- a/api-ref/source/apis/cluster_management/removing_a_node.rst +++ b/api-ref/source/apis/cluster_management/removing_a_node.rst @@ -53,8 +53,6 @@ Request Parameters +------------+-----------+--------------------------------------------------------------------------------------------------+------------------------------------------------------+ | spec | Yes | :ref:`RemoveNodesSpec ` object | Configuration information. | +------------+-----------+--------------------------------------------------------------------------------------------------+------------------------------------------------------+ - | status | No | :ref:`TaskStatus ` object | Job status. | - +------------+-----------+--------------------------------------------------------------------------------------------------+------------------------------------------------------+ .. _removenode__en-us_topic_0000001417833320_request_removenodesspec: @@ -94,22 +92,12 @@ Request Parameters uid Yes String Node ID. ========= ========= ====== =========== -.. _removenode__en-us_topic_0000001417833320_request_taskstatus: - -.. table:: **Table 7** TaskStatus - - +-----------+-----------+--------+----------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+================================================================+ - | jobID | No | String | Job ID, which is used by the caller to query the job progress. | - +-----------+-----------+--------+----------------------------------------------------------------+ - Response Parameters ------------------- **Status code: 200** -.. table:: **Table 8** Response body parameters +.. table:: **Table 7** Response body parameters +------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------+ | Parameter | Type | Description | @@ -125,7 +113,7 @@ Response Parameters .. _removenode__en-us_topic_0000001417833320_response_removenodesspec: -.. table:: **Table 9** RemoveNodesSpec +.. table:: **Table 8** RemoveNodesSpec +-----------+-----------------------------------------------------------------------------------------------+-------------------------------+ | Parameter | Type | Description | @@ -137,7 +125,7 @@ Response Parameters .. _removenode__en-us_topic_0000001417833320_response_login: -.. table:: **Table 10** Login +.. table:: **Table 9** Login +-----------------------+-----------------------+---------------------------------------------------------+ | Parameter | Type | Description | @@ -153,7 +141,7 @@ Response Parameters .. _removenode__en-us_topic_0000001417833320_response_nodeitem: -.. table:: **Table 11** NodeItem +.. table:: **Table 10** NodeItem ========= ====== =========== Parameter Type Description @@ -163,7 +151,7 @@ Response Parameters .. _removenode__en-us_topic_0000001417833320_response_taskstatus: -.. table:: **Table 12** TaskStatus +.. table:: **Table 11** TaskStatus +-----------+--------+----------------------------------------------------------------+ | Parameter | Type | Description | diff --git a/api-ref/source/apis/cluster_management/updating_a_specified_node.rst b/api-ref/source/apis/cluster_management/updating_a_specified_node.rst index d3d3f16..7638f2b 100644 --- a/api-ref/source/apis/cluster_management/updating_a_specified_node.rst +++ b/api-ref/source/apis/cluster_management/updating_a_specified_node.rst @@ -123,6 +123,38 @@ For the description of the response parameters, see :ref:`Table 4 ` describes the response parameters. +:ref:`Table 25 ` describes the response parameters. **Response example**: @@ -299,6 +331,38 @@ Response } } ], + "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": {} diff --git a/api-ref/source/examples/attaching_disks_to_a_node.rst b/api-ref/source/appendix/attaching_disks_to_a_node.rst similarity index 100% rename from api-ref/source/examples/attaching_disks_to_a_node.rst rename to api-ref/source/appendix/attaching_disks_to_a_node.rst diff --git a/api-ref/source/appendix/index.rst b/api-ref/source/appendix/index.rst index 68d51f4..474de4f 100644 --- a/api-ref/source/appendix/index.rst +++ b/api-ref/source/appendix/index.rst @@ -15,6 +15,7 @@ Appendix - :ref:`API Permissions ` - :ref:`Creating a VPC and Subnet ` - :ref:`Creating a Key Pair ` +- :ref:`Attaching Disks to a Node ` .. toctree:: :maxdepth: 1 @@ -30,3 +31,4 @@ Appendix api_permissions creating_a_vpc_and_subnet creating_a_key_pair + attaching_disks_to_a_node diff --git a/api-ref/source/examples/index.rst b/api-ref/source/examples/index.rst deleted file mode 100644 index 9debfa4..0000000 --- a/api-ref/source/examples/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -:original_name: cce_02_0237.html - -.. _cce_02_0237: - -Examples -======== - -- :ref:`Attaching Disks to a Node ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - attaching_disks_to_a_node diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index b022e15..0b06d8f 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -6,7 +6,6 @@ Cloud Container Engine - API Reference :maxdepth: 1 api_usage_guidelines - examples/index apis/index kubernetes_apis/index permissions_policies_and_supported_actions