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 092c7ee..b0b48ca 100644 --- a/api-ref/source/apis/cluster_management/accepting_a_node.rst +++ b/api-ref/source/apis/cluster_management/accepting_a_node.rst @@ -377,34 +377,6 @@ Request Parameters +-----------------+-----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | maxPods | No | Integer | Maximum number of pods that can be created on a node, including the default system pods. Value range: 16 to 256. This limit prevents the node from being overloaded of pods. | +-----------------+-----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nicMultiqueue | No | String | - Number of ENI queues. Example setting: | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | "[{\"queue\":4}]" | - | | | | | - | | | | The following fields are included: | - | | | | | - | | | | - **queue**: number of ENI queues. | - | | | | - This field can be configured only for BMS nodes in a CCE Turbo cluster. | - | | | | - Supported proportions are {"1":128, "2":92, "4":92, "8":32, "16":16, "28":9}. That is, if there is one queue, a maximum of 128 ENIs can be bound. If there are two queues, a maximum of 92 ENIs can be bound for two queues. | - | | | | - A larger number of ENI queues indicates higher performance but fewer ENIs can be bound. The queue settings cannot be changed after the node pool is created. | - +-----------------+-----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nicThreshold | No | String | - ENI pre-binding thresholds. Example setting: | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | "0.3:0.6" | - | | | | | - | | | | - Low threshold (L): determines the minimum number of pre-bound ENIs (Min). Formula: Min = Total number of ENIs of the node x L | - | | | | - High threshold (H): determines the maximum number of pre-bound ENIs (Max). Formula: Max = Total number of ENIs of the node x H | - | | | | - Number of ENIs bound to a BMS node (B) and number of ENIs being used by pods (U): U + Min < B < U + Max | - | | | | - If the number of pre-bound ENIs on a BMS node is smaller than the minimum allowed, the system will bind more ENIs to make the numbers equal. | - | | | | - If the number of pre-bound ENIs on a BMS node is larger than the maximum allowed, the system periodically unbinds ENIs (about every 2 minutes) to make the numbers equal. | - | | | | - Both the thresholds are one-decimal-place values ranging from 0.0 to 1.0. The low threshold must be smaller than or equal to the high one. | - | | | | - This field can be configured only for BMS nodes in a CCE Turbo cluster. | - | | | | - Pre-binding ENIs can speed up workload creation but occupies IP addresses. | - +-----------------+-----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addnode__en-us_topic_0000001417516392_request_taint: 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 699cfdf..d7f1810 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 @@ -82,32 +82,38 @@ Request .. table:: **Table 5** Data structure of the **spec** field - +------------------+-----------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==================+=================+===============================================================+=====================================================================================================================================================================================================================================================================================================================================+ - | type | No | String | Node pool type. If this parameter is left blank, the value **vm** is used by default. | - | | | | | - | | | | - **vm**: ECS | - | | | | - **ElasticBMS**: BMS. This value is valid in CCE Turbo cluster. | - +------------------+-----------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nodeTemplate | Yes | :ref:`nodeTemplate ` object | Parameters of the node pool template. | - | | | | | - | | | | If **az** is set to **random**, when you create a node pool or update the number of nodes in a node pool, a scaling task is triggered. The system selects an AZ from all AZs where scaling is allowed to add nodes based on priorities. | - | | | | | - | | | | AZs with a smaller number of existing nodes have a higher priority. If AZs have the same number of nodes, the system selects the AZ based on the AZ sequence. Example: | - | | | | | - | | | | - Creating nodes in a node pool for the first time: Assume that AZ 1, AZ 2, and AZ 3 have available resources. These AZs have the same priority because they have no existing nodes. In this case, AZ 1 is selected by sequence to create all nodes to be added. | - | | | | - Adding nodes to a node pool that already has nodes: | - | | | | | - | | | | - Assume that the node pool has 1 node in AZ 1, 3 in AZ 2, and 2 in AZ 3, and that resources in AZ 1 have been sold out. Only AZ 2 and AZ 3 are available for scaling. In this case, AZ 3 has a higher priority than AZ 2 because AZ 3 has less nodes. Therefore, all nodes to be added will be created in AZ 3. | - | | | | - Assume that the node pool has 1 node in AZ 1, 2 in AZ 2, and 2 in AZ 3, and that resources in AZ 1 have been sold out. Only AZ 2 and AZ 3 are available for scaling. In this case, AZ 2 and AZ 3 have the same priority because they have the same number of nodes. Therefore, all nodes to be added will be created in AZ 2. | - +------------------+-----------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | initialNodeCount | Yes | Integer | Expected number of nodes in this node pool. The value cannot be greater than the maximum number of nodes allowed for the cluster. | - +------------------+-----------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | autoscaling | No | :ref:`autoscaling ` object | Auto scaling parameters. | - +------------------+-----------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nodeManagement | No | :ref:`nodeManagement ` object | Node management parameters. | - +------------------+-----------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------+-----------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +======================+=================+===============================================================+=====================================================================================================================================================================================================================================================================================================================================+ + | type | No | String | Node pool type. If this parameter is left blank, the value **vm** is used by default. | + | | | | | + | | | | - **vm**: ECS | + | | | | - **ElasticBMS**: BMS. This value is valid in CCE Turbo cluster. | + +----------------------+-----------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | nodeTemplate | Yes | :ref:`nodeTemplate ` object | Parameters of the node pool template. | + | | | | | + | | | | If **az** is set to **random**, when you create a node pool or update the number of nodes in a node pool, a scaling task is triggered. The system selects an AZ from all AZs where scaling is allowed to add nodes based on priorities. | + | | | | | + | | | | AZs with a smaller number of existing nodes have a higher priority. If AZs have the same number of nodes, the system selects the AZ based on the AZ sequence. Example: | + | | | | | + | | | | - Creating nodes in a node pool for the first time: Assume that AZ 1, AZ 2, and AZ 3 have available resources. These AZs have the same priority because they have no existing nodes. In this case, AZ 1 is selected by sequence to create all nodes to be added. | + | | | | - Adding nodes to a node pool that already has nodes: | + | | | | | + | | | | - Assume that the node pool has 1 node in AZ 1, 3 in AZ 2, and 2 in AZ 3, and that resources in AZ 1 have been sold out. Only AZ 2 and AZ 3 are available for scaling. In this case, AZ 3 has a higher priority than AZ 2 because AZ 3 has less nodes. Therefore, all nodes to be added will be created in AZ 3. | + | | | | - Assume that the node pool has 1 node in AZ 1, 2 in AZ 2, and 2 in AZ 3, and that resources in AZ 1 have been sold out. Only AZ 2 and AZ 3 are available for scaling. In this case, AZ 2 and AZ 3 have the same priority because they have the same number of nodes. Therefore, all nodes to be added will be created in AZ 2. | + +----------------------+-----------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | initialNodeCount | Yes | Integer | Expected number of nodes in this node pool. The value cannot be greater than the maximum number of nodes allowed for the cluster. | + +----------------------+-----------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | autoscaling | No | :ref:`autoscaling ` object | Auto scaling parameters. | + +----------------------+-----------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | nodeManagement | No | :ref:`nodeManagement ` object | Node management parameters. | + +----------------------+-----------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | customSecurityGroups | No | Array of strings | Custom security group settings for a node pool. New nodes scaled out in a node pool can be bound to a specified security group. | + | | | | | + | | | | - Specifying no security group ID will add the new nodes to the default security group of the worker nodes. | + | | | | - Specifying a valid security group ID will put new nodes in that security group. | + | | | | - When specifying a security group, do not modify the rules of the port on which CCE running depends. | + +----------------------+-----------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _cce_02_0354__table3150105216225: @@ -244,26 +250,26 @@ Request .. table:: **Table 8** Data structure of the **Volume** field - +-----------------+-----------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=====================================================================+============================================================================================================================================================================================+ - | volumetype | No | String | Disk type. For details, see the description of **root_volume** in `Creating an ECS `__. | - | | | | | - | | | | - **SATA**: common I/O disk type. | - | | | | - **SAS**: high I/O disk type. | - | | | | - **SSD**: ultra-high I/O disk type. | - +-----------------+-----------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | size | No | Integer | Specifies the system disk size, in GB. The value ranges from 40 to 1024. | - +-----------------+-----------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extendParam | No | Map | Disk extension parameter. For details, see the description of the extendparam parameter in `Creating an ECS `__. | - +-----------------+-----------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hw:passthrough | No | Boolean | - Pay attention to this field if your ECS is SDI-compliant. If the value of this field is **true**, the created disk is of the SCSI type. | - | | | | - If the node pool type is **ElasticBMS**, this field must be set to **true**. | - +-----------------+-----------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | No | :ref:`dataVolumeMetadata ` object | Data disk encryption information. This parameter is mandatory only when the data disk of the node to be created needs to be encrypted. | - | | | | | - | | | | If data disks are created using a data disk image, this parameter cannot be used. | - +-----------------+-----------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=====================================================================+==============================================================================================================================================================================================+ + | volumetype | No | String | Disk type. For details, see the description of **root_volume** in \ `Creating an ECS `__. | + | | | | | + | | | | - **SATA**: common I/O disk type. | + | | | | - **SAS**: high I/O disk type. | + | | | | - **SSD**: ultra-high I/O disk type. | + +-----------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | No | Integer | Specifies the system disk size, in GB. The value ranges from 40 to 1024. | + +-----------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extendParam | No | Map | Disk extension parameter. For details, see the description of the extendparam parameter in \ `Creating an ECS `__. | + +-----------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | hw:passthrough | No | Boolean | - Pay attention to this field if your ECS is SDI-compliant. If the value of this field is **true**, the created disk is of the SCSI type. | + | | | | - If the node pool type is **ElasticBMS**, this field must be set to **true**. | + +-----------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | metadata | No | :ref:`dataVolumeMetadata ` object | Data disk encryption information. This parameter is mandatory only when the data disk of the node to be created needs to be encrypted. | + | | | | | + | | | | If data disks are created using a data disk image, this parameter cannot be used. | + +-----------------+-----------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _cce_02_0354__table15849123210415: @@ -763,19 +769,25 @@ Response .. table:: **Table 28** Data structure of the spec field - +------------------+----------------------------------------------------------------+----------------------------------------------------+ - | Parameter | Type | Description | - +==================+================================================================+====================================================+ - | type | String | Node type. Currently, only VM nodes are supported. | - +------------------+----------------------------------------------------------------+----------------------------------------------------+ - | initialNodeCount | Integer | Initial number of nodes for the node pool. | - +------------------+----------------------------------------------------------------+----------------------------------------------------+ - | nodeTemplate | :ref:`nodeTemplate ` object | Detailed parameters of the node pool template. | - +------------------+----------------------------------------------------------------+----------------------------------------------------+ - | autoscaling | :ref:`autoscaling ` object | Auto scaling parameters. | - +------------------+----------------------------------------------------------------+----------------------------------------------------+ - | nodeManagement | :ref:`nodeManagement ` object | Node management parameters. | - +------------------+----------------------------------------------------------------+----------------------------------------------------+ + +-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+================================================================+=================================================================================================================================+ + | type | String | Node type. Currently, only VM nodes are supported. | + +-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | initialNodeCount | Integer | Initial number of nodes for the node pool. | + +-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | nodeTemplate | :ref:`nodeTemplate ` object | Detailed parameters of the node pool template. | + +-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | autoscaling | :ref:`autoscaling ` object | Auto scaling parameters. | + +-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | nodeManagement | :ref:`nodeManagement ` object | Node management parameters. | + +-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | customSecurityGroups | Array of strings | Custom security group settings for a node pool. New nodes scaled out in a node pool can be bound to a specified security group. | + | | | | + | | | - Specifying no security group ID will add the new nodes to the default security group of the worker nodes. | + | | | - Specifying a valid security group ID will put new nodes in that security group. | + | | | - When specifying a security group, do not modify the rules of the port on which CCE running depends. | + +-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ .. _cce_02_0354__table14356154632610: 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 be410b9..306683a 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 @@ -110,22 +110,28 @@ Response .. table:: **Table 5** NodePoolSpec - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================================================================================+=======================================================================================+ - | type | String | Node pool type. If this parameter is left blank, the value **vm** is used by default. | - | | | | - | | | - **vm**: ECS | - | | | - **ElasticBMS**: BMS. This value is valid in CCE Turbo cluster. | - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ - | nodeTemplate | :ref:`V3NodeSpec ` object | Detailed parameters of the node pool template. | - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ - | initialNodeCount | Integer | Initial number of nodes for the node pool. | - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ - | autoscaling | :ref:`NodePoolNodeAutoscaling ` object | Auto scaling parameters. | - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ - | nodeManagement | :ref:`NodeManagement ` object | Node management configuration. | - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ + +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================================================================================+=================================================================================================================================+ + | type | String | Node pool type. If this parameter is left blank, the value **vm** is used by default. | + | | | | + | | | - **vm**: ECS | + | | | - **ElasticBMS**: BMS. This value is valid in CCE Turbo cluster. | + +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | nodeTemplate | :ref:`V3NodeSpec ` object | Detailed parameters of the node pool template. | + +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | initialNodeCount | Integer | Initial number of nodes for the node pool. | + +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | autoscaling | :ref:`NodePoolNodeAutoscaling ` object | Auto scaling parameters. | + +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | nodeManagement | :ref:`NodeManagement ` object | Node management configuration. | + +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | customSecurityGroups | Array of strings | Custom security group settings for a node pool. New nodes scaled out in a node pool can be bound to a specified security group. | + | | | | + | | | - Specifying no security group ID will add the new nodes to the default security group of the worker nodes. | + | | | - Specifying a valid security group ID will put new nodes in that security group. | + | | | - When specifying a security group, do not modify the rules of the port on which CCE running depends. | + +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ .. _cce_02_0357__response_v3nodespec: 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 22f9edc..2304248 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 @@ -145,22 +145,28 @@ Response .. table:: **Table 7** NodePoolSpec - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================================================================================+=======================================================================================+ - | type | String | Node pool type. If this parameter is left blank, the value **vm** is used by default. | - | | | | - | | | - **vm**: ECS | - | | | - **ElasticBMS**: BMS. This value is valid in CCE Turbo cluster. | - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ - | nodeTemplate | :ref:`V3NodeSpec ` object | Detailed parameters of the node pool template. | - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ - | initialNodeCount | Integer | Initial number of nodes for the node pool. | - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ - | autoscaling | :ref:`NodePoolNodeAutoscaling ` object | Auto scaling parameters. | - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ - | nodeManagement | :ref:`NodeManagement ` object | Node management configuration. | - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ + +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================================================================================+=================================================================================================================================+ + | type | String | Node pool type. If this parameter is left blank, the value **vm** is used by default. | + | | | | + | | | - **vm**: ECS | + | | | - **ElasticBMS**: BMS. This value is valid in CCE Turbo cluster. | + +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | nodeTemplate | :ref:`V3NodeSpec ` object | Detailed parameters of the node pool template. | + +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | initialNodeCount | Integer | Initial number of nodes for the node pool. | + +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | autoscaling | :ref:`NodePoolNodeAutoscaling ` object | Auto scaling parameters. | + +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | nodeManagement | :ref:`NodeManagement ` object | Node management configuration. | + +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | customSecurityGroups | Array of strings | Custom security group settings for a node pool. New nodes scaled out in a node pool can be bound to a specified security group. | + | | | | + | | | - Specifying no security group ID will add the new nodes to the default security group of the worker nodes. | + | | | - Specifying a valid security group ID will put new nodes in that security group. | + | | | - When specifying a security group, do not modify the rules of the port on which CCE running depends. | + +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ .. _cce_02_0269__response_v3nodespec: diff --git a/api-ref/source/apis/cluster_management/listing_clusters_in_a_specified_project.rst b/api-ref/source/apis/cluster_management/listing_clusters_in_a_specified_project.rst index 8d069a2..9425102 100644 --- a/api-ref/source/apis/cluster_management/listing_clusters_in_a_specified_project.rst +++ b/api-ref/source/apis/cluster_management/listing_clusters_in_a_specified_project.rst @@ -150,8 +150,7 @@ Response "External": "https://10.185.69.54:5443", }, { - "external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com", - } + "external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com", } ] } } 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 c3fb471..ca28cd0 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 @@ -133,22 +133,28 @@ Response .. table:: **Table 7** Data structure of the spec field - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+================================================================+===================================================================+ - | type | String | Node type. | - | | | | - | | | - **vm**: ECS | - | | | - **ElasticBMS**: BMS. This value is valid in CCE Turbo cluster. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | initialNodeCount | Integer | Initial number of nodes for the node pool. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | nodeTemplate | :ref:`nodeTemplate ` object | Detailed parameters of the node pool template. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | autoscaling | :ref:`autoscaling ` object | Auto scaling parameters. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | nodeManagement | :ref:`nodeManagement ` object | Node management parameters. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ + +-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+================================================================+=================================================================================================================================+ + | type | String | Node type. | + | | | | + | | | - **vm**: ECS | + | | | - **ElasticBMS**: BMS. This value is valid in CCE Turbo cluster. | + +-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | initialNodeCount | Integer | Initial number of nodes for the node pool. | + +-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | nodeTemplate | :ref:`nodeTemplate ` object | Detailed parameters of the node pool template. | + +-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | autoscaling | :ref:`autoscaling ` object | Auto scaling parameters. | + +-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | nodeManagement | :ref:`nodeManagement ` object | Node management parameters. | + +-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | customSecurityGroups | Array of strings | Custom security group settings for a node pool. New nodes scaled out in a node pool can be bound to a specified security group. | + | | | | + | | | - Specifying no security group ID will add the new nodes to the default security group of the worker nodes. | + | | | - Specifying a valid security group ID will put new nodes in that security group. | + | | | - When specifying a security group, do not modify the rules of the port on which CCE running depends. | + +-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ .. _cce_02_0355__table3150105216225: diff --git a/api-ref/source/apis/cluster_management/reading_a_specified_cluster.rst b/api-ref/source/apis/cluster_management/reading_a_specified_cluster.rst index 42c097e..f68b778 100644 --- a/api-ref/source/apis/cluster_management/reading_a_specified_cluster.rst +++ b/api-ref/source/apis/cluster_management/reading_a_specified_cluster.rst @@ -363,8 +363,7 @@ Response "External": "https://10.185.69.54:5443", }, { - "external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com", - }, + "external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com", }, ] } } diff --git a/api-ref/source/apis/cluster_management/updating_a_specified_cluster.rst b/api-ref/source/apis/cluster_management/updating_a_specified_cluster.rst index 305a8a2..5d46a14 100644 --- a/api-ref/source/apis/cluster_management/updating_a_specified_cluster.rst +++ b/api-ref/source/apis/cluster_management/updating_a_specified_cluster.rst @@ -231,8 +231,7 @@ For details about the response parameters, see :ref:`Table 7 ` - :ref:`Creating a VPC and Subnet ` - :ref:`Creating a Key Pair ` +- :ref:`Node Flavor Description ` - :ref:`Attaching Disks to a Node ` .. toctree:: @@ -31,4 +32,5 @@ Appendix api_permissions creating_a_vpc_and_subnet creating_a_key_pair + node_flavor_description attaching_disks_to_a_node diff --git a/api-ref/source/appendix/node_flavor_description.rst b/api-ref/source/appendix/node_flavor_description.rst new file mode 100644 index 0000000..bb917e9 --- /dev/null +++ b/api-ref/source/appendix/node_flavor_description.rst @@ -0,0 +1,45 @@ +:original_name: cce_02_0368.html + +.. _cce_02_0368: + +Node Flavor Description +======================= + +.. note:: + + Different regions support different node flavors, and node flavors may be changed. You are advised to log in to the CCE console and check whether the required node flavors are supported on the page for creating nodes. + +- **CCE cluster** + + CCE clusters support only 2 vCPUs and 4 GiB or higher specifications. You are advised to query node specifications on the console. For details about node specifications, see ECS Specifications. + + You need to enter the specific flavor name, for example, **c4.large.2**. + + The following tables list the specifications supported by CCE. (The specifications of some ECS models vary by region. The actual specifications displayed on the console are used.) + + - ECS (VM): + + .. table:: **Table 1** x86 nodes + + ====================== ===================== + Node Type Flavor + ====================== ===================== + General computing-plus c4, c3 + General-purpose s3, s2 + Memory-optimized m4, m3 + Disk-intensive d2 + GPU-accelerated pi2, p2s, g6, and p2v + ====================== ===================== + +- **CCE Turbo clusters** + + - ECS (VM): + + .. table:: **Table 2** x86 nodes + + ====================== ====== + Node Type Flavor + ====================== ====== + General computing-plus c3n + Container-plus m3n + ====================== ====== diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index e481bc4..d71b5db 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -10,6 +10,9 @@ Change History +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Date | Revision | +===================================+============================================================================================================================================================================+ + | 2023-11-06 | - Added the customSecurityGroups field. For details, see :ref:`Table 5 `. | + | | - Added :ref:`Node Flavor Description `. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2023-02-10 | - Supported clusters of v1.25. | | | - Added the **storage** field in :ref:`Table 5 `. | | | - Added :ref:`Attaching Disks to a Node `. |