Compare commits
15 Commits
propose-cc
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| fa4e76d124 | |||
| b96cce29e3 | |||
| b93a06d9ba | |||
| ec0bd5d533 | |||
| 5a159a630b | |||
| 53849d0717 | |||
| 64bf481152 | |||
| d0e56d084a | |||
| b4a298affc | |||
| 85e1a6ed92 | |||
| 85126a07b8 | |||
| 26bd70975e | |||
| 42ae15f292 | |||
| a78a05377d | |||
| bcb637d073 |
@ -17,11 +17,11 @@ Cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transm
|
||||
|
||||
Before using X-Remote-User as a header, obtain the required certificate in advance. Two types of certificates are supported:
|
||||
|
||||
- Self-owned certificate uploaded during cluster creation. For details, see `Creating a Cluster <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0028.html>`__.
|
||||
- Self-owned certificate uploaded during cluster creation. For details, see `Creating a Cluster <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_10_0028.html>`__.
|
||||
|
||||
|image1|
|
||||
|
||||
- Cluster certificate generated and downloaded after cluster creation. For details, see `Obtaining a Cluster Certificate <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0175.html>`__.
|
||||
- Cluster certificate generated and downloaded after cluster creation. For details, see `Obtaining a Cluster Certificate <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_10_0175.html>`__.
|
||||
|
||||
|image2|
|
||||
|
||||
@ -35,7 +35,7 @@ CCE provides two methods to authenticate requests for calling an API: token and
|
||||
|
||||
.. note::
|
||||
|
||||
Method 3 requires that the CA root certificate must has been uploaded before you create a cluster on the CCE console. For details, see `Cluster Management Permission Control <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0085.html>`__.
|
||||
Method 3 requires that the CA root certificate must has been uploaded before you create a cluster on the CCE console.
|
||||
|
||||
.. |image1| image:: /_static/images/en-us_image_0000001121602072.png
|
||||
.. |image2| image:: /_static/images/en-us_image_0227096557.png
|
||||
|
||||
@ -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:
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -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 <cce_02_0357__response_v3nodespec>` object | Detailed parameters of the node pool template. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| initialNodeCount | Integer | Initial number of nodes for the node pool. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| autoscaling | :ref:`NodePoolNodeAutoscaling <cce_02_0357__response_nodepoolnodeautoscaling>` object | Auto scaling parameters. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| nodeManagement | :ref:`NodeManagement <cce_02_0357__response_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 <cce_02_0357__response_v3nodespec>` object | Detailed parameters of the node pool template. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| initialNodeCount | Integer | Initial number of nodes for the node pool. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| autoscaling | :ref:`NodePoolNodeAutoscaling <cce_02_0357__response_nodepoolnodeautoscaling>` object | Auto scaling parameters. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| nodeManagement | :ref:`NodeManagement <cce_02_0357__response_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:
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ Cluster Management
|
||||
- :ref:`Hibernating a Cluster <cce_02_0374>`
|
||||
- :ref:`Waking Up a Cluster <cce_02_0375>`
|
||||
- :ref:`Obtaining Cluster Certificates <cce_02_0248>`
|
||||
- :ref:`Obtaining Cluster Certificates (Deprecated) <cce_02_0359_0>`
|
||||
- :ref:`Obtaining Cluster Certificates (Deprecated) <cce_02_0359>`
|
||||
- :ref:`Creating a Node <cce_02_0242>`
|
||||
- :ref:`Reading a Specified Node <cce_02_0243>`
|
||||
- :ref:`Listing All Nodes in a Cluster <cce_02_0244>`
|
||||
|
||||
@ -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 <cce_02_0269__response_v3nodespec>` object | Detailed parameters of the node pool template. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| initialNodeCount | Integer | Initial number of nodes for the node pool. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| autoscaling | :ref:`NodePoolNodeAutoscaling <cce_02_0269__response_nodepoolnodeautoscaling>` object | Auto scaling parameters. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+
|
||||
| nodeManagement | :ref:`NodeManagement <cce_02_0269__response_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 <cce_02_0269__response_v3nodespec>` object | Detailed parameters of the node pool template. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| initialNodeCount | Integer | Initial number of nodes for the node pool. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| autoscaling | :ref:`NodePoolNodeAutoscaling <cce_02_0269__response_nodepoolnodeautoscaling>` object | Auto scaling parameters. |
|
||||
+-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| nodeManagement | :ref:`NodeManagement <cce_02_0269__response_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:
|
||||
|
||||
|
||||
@ -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", }
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
@ -69,6 +69,8 @@ Request Parameters
|
||||
+-------------+-----------+-----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| login | Yes | :ref:`Login <migratenode__en-us_topic_0000001467833433_request_login>` object | Node login mode. |
|
||||
+-------------+-----------+-----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| runtime | No | :ref:`Runtime <migratenode__request_runtime>` object | Container runtime configuration. |
|
||||
+-------------+-----------+-----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| nodes | Yes | Array of :ref:`NodeItem <migratenode__en-us_topic_0000001467833433_request_nodeitem>` objects | List of nodes to be operated. |
|
||||
+-------------+-----------+-----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
@ -131,9 +133,27 @@ Request Parameters
|
||||
| | | | This field is not supported for the current version. |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------+
|
||||
|
||||
.. _migratenode__request_runtime:
|
||||
|
||||
.. table:: **Table 7** Runtime
|
||||
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+=================+=================+=================+================================================================================================================================================================================================================================+
|
||||
| name | No | String | Container runtime: |
|
||||
| | | | |
|
||||
| | | | - Clusters of v1.25 or earlier: **docker**. |
|
||||
| | | | - Clusters of v1.25 or later: Container runtime varies with the OS. For nodes running EulerOS 2.5, the default container runtime is **docker**. For nodes running other OSs, the default container runtime is **containerd**. |
|
||||
| | | | |
|
||||
| | | | Enumeration values: |
|
||||
| | | | |
|
||||
| | | | - docker |
|
||||
| | | | - containerd |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _migratenode__en-us_topic_0000001467833433_request_nodeitem:
|
||||
|
||||
.. table:: **Table 7** NodeItem
|
||||
.. table:: **Table 8** NodeItem
|
||||
|
||||
========= ========= ====== ===========
|
||||
Parameter Mandatory Type Description
|
||||
@ -146,7 +166,7 @@ Response Parameters
|
||||
|
||||
**Status code: 200**
|
||||
|
||||
.. table:: **Table 8** Response body parameters
|
||||
.. table:: **Table 9** Response body parameters
|
||||
|
||||
+------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
@ -162,7 +182,7 @@ Response Parameters
|
||||
|
||||
.. _migratenode__en-us_topic_0000001467833433_response_migratenodesspec:
|
||||
|
||||
.. table:: **Table 9** MigrateNodesSpec
|
||||
.. table:: **Table 10** MigrateNodesSpec
|
||||
|
||||
+-------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
@ -178,7 +198,7 @@ Response Parameters
|
||||
|
||||
.. _migratenode__en-us_topic_0000001467833433_response_migratenodeextendparam:
|
||||
|
||||
.. table:: **Table 10** MigrateNodeExtendParam
|
||||
.. table:: **Table 11** MigrateNodeExtendParam
|
||||
|
||||
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
@ -221,7 +241,7 @@ Response Parameters
|
||||
|
||||
.. _migratenode__en-us_topic_0000001467833433_response_login:
|
||||
|
||||
.. table:: **Table 11** Login
|
||||
.. table:: **Table 12** Login
|
||||
|
||||
+-----------------------+-----------------------+---------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
@ -237,7 +257,7 @@ Response Parameters
|
||||
|
||||
.. _migratenode__en-us_topic_0000001467833433_response_nodeitem:
|
||||
|
||||
.. table:: **Table 12** NodeItem
|
||||
.. table:: **Table 13** NodeItem
|
||||
|
||||
========= ====== ===========
|
||||
Parameter Type Description
|
||||
@ -247,7 +267,7 @@ Response Parameters
|
||||
|
||||
.. _migratenode__en-us_topic_0000001467833433_response_taskstatus:
|
||||
|
||||
.. table:: **Table 13** TaskStatus
|
||||
.. table:: **Table 14** TaskStatus
|
||||
|
||||
+-----------+--------+----------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -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 <cce_02_0355__table3150105216225>` object | Detailed parameters of the node pool template. |
|
||||
+-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+
|
||||
| autoscaling | :ref:`autoscaling <cce_02_0355__table14356154632610>` object | Auto scaling parameters. |
|
||||
+-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+
|
||||
| nodeManagement | :ref:`nodeManagement <cce_02_0355__table1778609171919>` 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 <cce_02_0355__table3150105216225>` object | Detailed parameters of the node pool template. |
|
||||
+-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| autoscaling | :ref:`autoscaling <cce_02_0355__table14356154632610>` object | Auto scaling parameters. |
|
||||
+-----------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| nodeManagement | :ref:`nodeManagement <cce_02_0355__table1778609171919>` 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:
|
||||
|
||||
|
||||
@ -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", },
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
@ -231,8 +231,7 @@ For details about the response parameters, see :ref:`Table 7 <cce_02_0240__table
|
||||
"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", },
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
@ -43,10 +43,10 @@ The basic logic for field matching is as follows:
|
||||
|
||||
|image2|
|
||||
|
||||
a. In step 1, the first disk in **dataVolumes** is matched by the EVS disk whose size is 100 GB and storage class is SAS. In step 2, the second disk in **dataVolumes** is matched by the EVS disk whose size is 100 GB because the first disk has been selected.
|
||||
a. In step 1, the first disk in **dataVolumes** is matched by the EVS disk whose size is 100 GiB and storage class is SAS. In step 2, the second disk in **dataVolumes** is matched by the EVS disk whose size is 100 GiB because the first disk has been selected.
|
||||
b. In step 3, two disks in **dataVolumes** can be matched because **volumeType** or **count** is not specified in **matchLabels**. In this case, no disk is available for matching in step 4.
|
||||
|
||||
#. **storageGroups** associates with **storageSelectors** based on **selectorName**. Finally, two 100 GB disks are selected. The CCE backend groups the two PVs into a volume group (VG) and divides the VG into two logical volumes (LVs) in the ratio of 9:1. 10% of Kubernetes LVs are partitioned in striped mode. 90% runtime LVs are partitioned in linear mode by default because runtimeConfig is not configured.
|
||||
#. **storageGroups** associates with **storageSelectors** based on **selectorName**. Finally, two 100 GiB disks are selected. The CCE backend groups the two PVs into a volume group (VG) and divides the VG into two logical volumes (LVs) in the ratio of 9:1. 10% of Kubernetes LVs are partitioned in striped mode. 90% runtime LVs are partitioned in linear mode by default because runtimeConfig is not configured.
|
||||
|
||||
Creating a Raw Disk
|
||||
-------------------
|
||||
@ -57,11 +57,11 @@ The following figure shows the API calling logic.
|
||||
|
||||
|image3|
|
||||
|
||||
#. The **cceUse** selector matches a 100 GB data disk.
|
||||
#. The **cceUse** selector matches a 100 GiB data disk.
|
||||
#. The selected disk is managed by CCE and used as a data disk.
|
||||
#. The other 100 GB data disk created in **dataVolumes** is not selected by any selector and is managed by storageGroups. Therefore, this EVS disk will be attached to the node as a raw disk and will not be initialized.
|
||||
#. The other 100 GiB data disk created in **dataVolumes** is not selected by any selector and is managed by storageGroups. Therefore, this EVS disk will be attached to the node as a raw disk and will not be initialized.
|
||||
|
||||
After the node is created, log in to the node and check whether a 100 GB disk has been attached but not initialized.
|
||||
After the node is created, log in to the node and check whether a 100 GiB disk has been attached but not initialized.
|
||||
|
||||
|image4|
|
||||
|
||||
@ -108,7 +108,7 @@ The following is an API example:
|
||||
"login": {
|
||||
"userPassword": {
|
||||
"username": "root",
|
||||
"password": "JDYkbzhEbE90ckIkY1c0SWJzRy9WeVIzcDFVbC41NFVqa1pxenE0bW9naERlS2RCWEIyWlhqSlpWSjJrL2NmcmdWeE12NGh4T25DeDhlMTdrREVSM2dicHdZNmYzZXh5dy4="
|
||||
"password": "******"
|
||||
}
|
||||
},
|
||||
"storage": {
|
||||
@ -156,11 +156,11 @@ The following figure shows the API calling logic.
|
||||
|
||||
|image5|
|
||||
|
||||
#. The **user1** selector selects a 100 GB data disk.
|
||||
#. The **user1** selector selects a 100 GiB data disk.
|
||||
#. Create a VG named **vguser1** using LVM.
|
||||
#. Strip all the space of **vguser1** into an LV named **user** and format the disk in ext4 format. Finally, attach the disk to the **/tmp2** directory.
|
||||
|
||||
After the node is created, log in to the node and check whether a 100 GB disk has been attached and managed by LVM.
|
||||
After the node is created, log in to the node and check whether a 100 GiB disk has been attached and managed by LVM.
|
||||
|
||||
|image6|
|
||||
|
||||
@ -207,7 +207,7 @@ The following is an API example. There are two data disks. One is used by CCE, a
|
||||
"login": {
|
||||
"userPassword": {
|
||||
"username": "root",
|
||||
"password": "JDYkRmJPckIwRkMkR3RXTkFsNmYvNlAxSDdOTUhYSHZmWjQ0b0ttODRzTDk0L1NzMzRIaHBsQVJkRTZiOGI0WTVJbUtSLlF5aTAuTUpwbGZqdHBTdkYxOU9peGZPV2FUYi4="
|
||||
"password": "******"
|
||||
}
|
||||
},
|
||||
"storage": {
|
||||
@ -278,7 +278,7 @@ Currently, the striped LV function is supported only by calling an API. The foll
|
||||
|
||||
|image7|
|
||||
|
||||
#. **storageSelectors** matches all EVS disks in **dataVolumes** because **matchLables** is not contained in **storageSelectors**.
|
||||
#. **storageSelectors** matches all EVS disks in **dataVolumes** because **matchLabels** is not contained in **storageSelectors**.
|
||||
#. Create a VG named **vgpaas** using LVM.
|
||||
#. Strip 90% of the **vgpaas** space into runtime LVs.
|
||||
#. Strip 10% of the **vgpaas** space into Kubernetes LVs.
|
||||
@ -286,7 +286,8 @@ Currently, the striped LV function is supported only by calling an API. The foll
|
||||
.. note::
|
||||
|
||||
- Two or more data disks are required for striping.
|
||||
- When creating a striped LV, ensure that the types and sizes of the PVs added to the VG are the same. Otherwise, the striping fails.
|
||||
- When creating a striped LV, ensure that the types and sizes of the PVs added to the VG are the same. Otherwise, the creation will fail.
|
||||
- When creating a striped LV, use the striping configuration for both the runtime LV and Kubernetes LV. Otherwise, the creation will fail.
|
||||
|
||||
Log in to the node and run the following command to view the striping result:
|
||||
|
||||
@ -335,7 +336,7 @@ The following is an API example:
|
||||
"login": {
|
||||
"userPassword": {
|
||||
"username": "root",
|
||||
"password": "JDYkbzhEbE90ckIkY1c0SWJzRy9WeVIzcDFVbC41NFVqa1pxenE0bW9naERlS2RCWEIyWlhqSlpWSjJrL2NmcmdWeE12NGh4T25DeDhlMTdrREVSM2dicHdZNmYzZXh5dy4="
|
||||
"password": "******"
|
||||
}
|
||||
},
|
||||
"storage": {
|
||||
|
||||
@ -15,6 +15,7 @@ Appendix
|
||||
- :ref:`API Permissions <cce_02_0272>`
|
||||
- :ref:`Creating a VPC and Subnet <cce_02_0100>`
|
||||
- :ref:`Creating a Key Pair <cce_02_0101>`
|
||||
- :ref:`Node Flavor Description <cce_02_0368>`
|
||||
- :ref:`Attaching Disks to a Node <node_storage_example>`
|
||||
|
||||
.. 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
|
||||
|
||||
45
api-ref/source/appendix/node_flavor_description.rst
Normal file
45
api-ref/source/appendix/node_flavor_description.rst
Normal file
@ -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
|
||||
====================== ======
|
||||
@ -10,6 +10,9 @@ Change History
|
||||
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Date | Revision |
|
||||
+===================================+============================================================================================================================================================================+
|
||||
| 2023-11-06 | - Added the customSecurityGroups field. For details, see :ref:`Table 5 <cce_02_0354__table620623542313>`. |
|
||||
| | - Added :ref:`Node Flavor Description <cce_02_0368>`. |
|
||||
+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2023-02-10 | - Supported clusters of v1.25. |
|
||||
| | - Added the **storage** field in :ref:`Table 5 <cce_02_0242__table3150105216225>`. |
|
||||
| | - Added :ref:`Attaching Disks to a Node <node_storage_example>`. |
|
||||
|
||||
@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/cloud-container-engine'
|
||||
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
|
||||
otcdocs_git_type = 'gitea'
|
||||
|
||||
# Those variables are needed for indexing into OpenSearch
|
||||
otcdocs_doc_environment = 'internal'
|
||||
otcdocs_doc_link = '/cloud-container-engine/api-ref/'
|
||||
otcdocs_doc_title = 'API Reference'
|
||||
otcdocs_doc_type = 'api-ref'
|
||||
otcdocs_service_category = 'container'
|
||||
otcdocs_service_title = 'Cloud Container Engine'
|
||||
otcdocs_service_type = 'cce'
|
||||
otcdocs_search_environment = 'hc_de'
|
||||
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
|
||||
@ -8,26 +8,14 @@ Overview
|
||||
Description
|
||||
-----------
|
||||
|
||||
You can use Kubernetes native APIs to manage your Kubernetes clusters. For details, see `Kubernetes API Concepts <https://kubernetes.io/docs/reference/using-api/api-concepts/>`__.
|
||||
Kubernetes APIs are resource-based (RESTful) programming interfaces provided through HTTP. It supports query, creation, update, and deletion of various cluster resources using standard HTTP request methods (POST, PUT, PATCH, DELETE, and GET).
|
||||
|
||||
To find detailed API definitions for different Kubernetes versions, visit the following links:
|
||||
CCE allows you to use native `Kubernetes APIs <https://kubernetes.io/docs/reference/kubernetes-api/>`__ in the following ways:
|
||||
|
||||
- 1.19: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/
|
||||
- 1.21: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/
|
||||
- 1.23: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/
|
||||
- 1.25: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/
|
||||
- :ref:`Calling Kubernetes APIs Through API Gateway <kubernetesapi__section41207155509>`
|
||||
- :ref:`Calling Kubernetes APIs Through the API Server <kubernetesapi__section14674391312>`
|
||||
|
||||
Based on the open source Kubernetes APIs, CCE enhances and adapts following functions.
|
||||
|
||||
- Ingress: For details, see `Using kubectl to Create an ELB Ingress <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0252.html>`__.
|
||||
- PV and PVC: For details, see `PV <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0379.html>`__ and `PVC <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0378.html>`__.
|
||||
|
||||
- EVS: For details, see `Creating a Pod Mounted with an EVS Volume <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0257.html>`__.
|
||||
- SFS Turbo: For details, see `Creating a Deployment Mounted with an SFS Turbo Volume <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0274.html>`__ and `Creating a StatefulSet Mounted with an SFS Turbo Volume <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0273.html>`__.
|
||||
- OBS: For details, see `Creating a Deployment Mounted with an OBS Volume <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0269.html>`__ and `Creating a StatefulSet Mounted with an OBS Volume <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0268.html>`__.
|
||||
- SFS: For details, see `Creating a Deployment Mounted with an SFS Volume <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0263.html>`__ and `Creating a StatefulSet Mounted with an SFS Volume <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0262.html>`__.
|
||||
|
||||
- Network Policies: For details, see `Network Policies <https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0059.html>`__.
|
||||
.. _kubernetesapi__section41207155509:
|
||||
|
||||
Calling Kubernetes APIs Through API Gateway
|
||||
-------------------------------------------
|
||||
@ -46,6 +34,8 @@ You can call Kubernetes native APIs through API Gateway using the URL in the for
|
||||
| uri | Path in which the resource requested by the API is located. You can obtain the path from the URI of the API. |
|
||||
+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _kubernetesapi__section14674391312:
|
||||
|
||||
Calling Kubernetes APIs Through the API Server
|
||||
----------------------------------------------
|
||||
|
||||
|
||||
0
doc/best-practice/source/_static/.placeholder
Normal file
0
doc/best-practice/source/_static/.placeholder
Normal file
117
doc/best-practice/source/conf.py
Normal file
117
doc/best-practice/source/conf.py
Normal file
File diff suppressed because it is too large
Load Diff
2
doc/best-practice/source/docutils.conf
Normal file
2
doc/best-practice/source/docutils.conf
Normal file
@ -0,0 +1,2 @@
|
||||
[html writers]
|
||||
table-style: table, caption-top
|
||||
4
doc/best-practice/source/index.rst
Normal file
4
doc/best-practice/source/index.rst
Normal file
@ -0,0 +1,4 @@
|
||||
======================================
|
||||
Cloud Container Engine - Best Practice
|
||||
======================================
|
||||
|
||||
@ -1,7 +1,10 @@
|
||||
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||
|
||||
otcdocstheme # Apache-2.0
|
||||
|
||||
# releasenotes
|
||||
reno>=3.1.0 # Apache-2.0
|
||||
|
||||
otc-sphinx-directives>=0.1.0
|
||||
sphinx-minify>=0.0.1 # Apache-2.0
|
||||
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
|
||||
@ -31,6 +31,17 @@ otcdocs_repo_name = 'docs/cloud-container-engine'
|
||||
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
|
||||
otcdocs_git_type = 'gitea'
|
||||
|
||||
# Those variables are needed for indexing into OpenSearch
|
||||
otcdocs_doc_environment = ''
|
||||
otcdocs_doc_link = ''
|
||||
otcdocs_doc_title = ''
|
||||
otcdocs_doc_type = ''
|
||||
otcdocs_service_category = 'container'
|
||||
otcdocs_service_title = 'Cloud Container Engine'
|
||||
otcdocs_service_type = 'cce'
|
||||
otcdocs_search_environment = 'hc_de'
|
||||
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
|
||||
@ -8,5 +8,7 @@ CCE provides highly scalable, high-performance, enterprise-class Kubernetes clus
|
||||
|
||||
.. service_card::
|
||||
:service_type: cce
|
||||
:environment: internal
|
||||
:umn: Describes the basic concepts, functions, key terms, best practices, FAQs and steps for quickly creating clusters and containerized applications.
|
||||
:api-ref: Describes the APIs provided by CCE including the functions, parameters, and examples of each API.
|
||||
:best-practice: To use Cloud Container Engine more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.
|
||||
|
||||
BIN
umn/source/_static/images/en-us_image_0000001168997466.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001168997466.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
BIN
umn/source/_static/images/en-us_image_0000001169315996.gif
Normal file
BIN
umn/source/_static/images/en-us_image_0000001169315996.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 294 KiB |
BIN
umn/source/_static/images/en-us_image_0000001169475948.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001169475948.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.7 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB |
BIN
umn/source/_static/images/en-us_image_0000001214475863.gif
Normal file
BIN
umn/source/_static/images/en-us_image_0000001214475863.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 202 KiB |
BIN
umn/source/_static/images/en-us_image_0000001214635805.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001214635805.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 27 KiB |
BIN
umn/source/_static/images/en-us_image_0000001214717329.gif
Normal file
BIN
umn/source/_static/images/en-us_image_0000001214717329.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 216 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 439 B |
BIN
umn/source/_static/images/en-us_image_0000001244128658.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001244128658.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 170 B |
Binary file not shown.
|
Before Width: | Height: | Size: 62 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 257 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 33 KiB |
BIN
umn/source/_static/images/en-us_image_0000001352090724.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001352090724.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 59 KiB |
BIN
umn/source/_static/images/en-us_image_0000001352253356.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001352253356.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 107 KiB |
BIN
umn/source/_static/images/en-us_image_0000001352413288.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001352413288.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 144 KiB |
BIN
umn/source/_static/images/en-us_image_0000001352573116.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001352573116.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
BIN
umn/source/_static/images/en-us_image_0000001402893085.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001402893085.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 229 KiB |
BIN
umn/source/_static/images/en-us_image_0000001403252957.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001403252957.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
BIN
umn/source/_static/images/en-us_image_0000001499246158.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001499246158.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
BIN
umn/source/_static/images/en-us_image_0000001499406022.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001499406022.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
BIN
umn/source/_static/images/en-us_image_0000001499406030.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001499406030.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
BIN
umn/source/_static/images/en-us_image_0000001499565914.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001499565914.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
BIN
umn/source/_static/images/en-us_image_0000001499565934.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001499565934.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
BIN
umn/source/_static/images/en-us_image_0000001499598344.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001499598344.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 346 B |
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user