A200161411/cloud-container-engine
1
0
Fork 0
forked from docs/cloud-container-engine
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2023-03-14 16:45:32 +00:00
parent d51fe3213e
commit 1bd1baa658
18 changed files with 980 additions and 180 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
api-ref/source/apis/cluster_management/accepting_a_node.rst
View File

@ -44,15 +44,19 @@ Request Parameters
.. table:: **Table 3** Request body parameters .. table:: **Table 3** Request body parameters
+------------+-----------+-----------------------------------------------------------------------------------------+--------------------------------------------+ +-----------------+-----------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+============+===========+=========================================================================================+============================================+ +=================+=================+=========================================================================================+=================================================================+
| apiVersion | Yes | String | API version. The value is fixed at **v3**. | | apiVersion | Yes | String | API version. The value is fixed at **v3**. |
+------------+-----------+-----------------------------------------------------------------------------------------+--------------------------------------------+ +-----------------+-----------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------------+
| kind | Yes | String | API type. The value is fixed at **List**. | | kind | Yes | String | API type. The value is fixed at **List**. |
+------------+-----------+-----------------------------------------------------------------------------------------+--------------------------------------------+ +-----------------+-----------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------------+
| nodeList | Yes | Array of :ref:`AddNode <addnode__en-us_topic_0000001417516392_request_addnode>` objects | List of the nodes to be accepted. | | nodeList | Yes | Array of :ref:`AddNode <addnode__en-us_topic_0000001417516392_request_addnode>` objects | List of the nodes to be accepted. |
+------------+-----------+-----------------------------------------------------------------------------------------+--------------------------------------------+ | | | | |
| | | | .. note:: |
| | | | |
| | | | Nodes must have 2-core or higher CPU, 4 GB or larger memory. |
+-----------------+-----------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------------+
.. _addnode__en-us_topic_0000001417516392_request_addnode: .. _addnode__en-us_topic_0000001417516392_request_addnode:

2
api-ref/source/apis/cluster_management/creating_a_cluster.rst
View File

@ -13,7 +13,7 @@ This API is used to create an empty cluster, which has only master nodes but do
.. note:: .. note::
- The URL for cluster management is in the format of **https://Endpoint/uri**. In the URL, **uri** indicates the resource path, that is, the path for API access. - The URL for cluster management is in the format of **https://Endpoint/uri**. In the URL, **uri** indicates the resource path, that is, the path for API access.
- Info collect agent (ICAgent) is an O&M data collection agent used by Application Performance Management (APM) service. It runs on each server to collect data from probes in real time. When this API is called to create a cluster, ICAgent is not installed by default. To automatically install ICAgent during cluster creation, add **"cluster.install.addons.external/install": "[{\\"addonTemplateName\\":\\"icagent\\"}]"** to the **annotations** field in the request body. - Info collect agent (ICAgent) is an O&M data collection agent. It runs on each server to collect data from probes in real time. When this API is called to create a cluster, ICAgent is not installed by default. To automatically install ICAgent during cluster creation, add **"cluster.install.addons.external/install": "[{\\"addonTemplateName\\":\\"icagent\\"}]"** to the **annotations** field in the request body.
- Before creating a cluster, :ref:`Creating a VPC and Subnet <cce_02_0100>`. If a VPC and subnet already exists, you do not need to create them again. - Before creating a cluster, :ref:`Creating a VPC and Subnet <cce_02_0100>`. If a VPC and subnet already exists, you do not need to create them again.
- By default, an account can create a maximum of five clusters in each region. - By default, an account can create a maximum of five clusters in each region.

23
api-ref/source/apis/cluster_management/creating_a_node.rst
View File

@ -126,7 +126,8 @@ Request
| | | | | | | | | |
| | | | .. note:: | | | | | .. note:: |
| | | | | | | | | |
| | | | When adding a BMS node, check whether the flavor of the node to be added supports local disks. If local disks are not supported, add at least one 100 GB EVS disk. | | | | | - When adding a BMS node, check whether the flavor of the node to be added supports local disks. If local disks are not supported, add at least one 100 GB EVS disk. |
| | | | - Nodes must have 2-core or higher CPU, 4 GB or larger memory. |
+-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| az | Yes | String | AZ of the node. For details, see the description of the **availability_zone** parameter in `Creating an ECS <https://docs.otc.t-systems.com/en-us/api/ecs/en-us_topic_0020212668.html>`__. | | az | Yes | String | AZ of the node. For details, see the description of the **availability_zone** parameter in `Creating an ECS <https://docs.otc.t-systems.com/en-us/api/ecs/en-us_topic_0020212668.html>`__. |
+-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -592,7 +593,7 @@ CCE cluster:
} }
}, },
"spec": { "spec": {
"flavor": "s1.medium", "flavor": "c4.large.2",
"az": "eu-de-01", "az": "eu-de-01",
"login": { "login": {
"sshKey": "Keypair-demo" "sshKey": "Keypair-demo"
@ -601,6 +602,10 @@ CCE cluster:
"size": 40, "size": 40,
"volumetype": "SAS" "volumetype": "SAS"
}, },
"dataVolumes" : [ {
"size" : 100,
"volumetype" : "SAS"
} ],
"storage": { "storage": {
"storageSelectors": [ "storageSelectors": [
{ {
@ -633,7 +638,6 @@ CCE cluster:
} }
] ]
}, },
],
"userTags": [ "userTags": [
{ {
"key": "tag1", "key": "tag1",
@ -1197,6 +1201,12 @@ Response
"volumetype": "SAS", "volumetype": "SAS",
"size": 40 "size": 40
}, },
"dataVolumes": [
{
"volumetype": "SAS",
"size": 100
}
],
"storage": { "storage": {
"storageSelectors": [ "storageSelectors": [
{ {
@ -1281,6 +1291,13 @@ CCE Turbo cluster:
"volumetype": "SAS", "volumetype": "SAS",
"hw:passthrough": true "hw:passthrough": true
}, },
"dataVolumes": [
{
"size": 100,
"volumetype": "SAS",
"hw:passthrough": true
}
],
"storage": { "storage": {
"storageSelectors": [ "storageSelectors": [
{ {

394
api-ref/source/apis/cluster_management/creating_a_node_pool.rst
View File

File diff suppressed because it is too large Load Diff

32
api-ref/source/apis/cluster_management/deleting_a_node.rst
View File

@ -160,6 +160,38 @@ Response
"size": 100 "size": 100
} }
], ],
"storage": {
"storageSelectors": [
{
"name": "cceUse",
"storageType": "evs",
"matchLabels": {
"size": "100",
"volumeType": "SAS",
"count": "1"
}
}
],
"storageGroups": [
{
"name": "vgpaas",
"selectorNames": [
"cceUse"
],
"cceManaged": true,
"virtualSpaces": [
{
"name": "runtime",
"size": "90%"
},
{
"name": "kubernetes",
"size": "10%"
}
]
}
]
},
"publicIP": { "publicIP": {
"eip": { "eip": {
"bandwidth": {} "bandwidth": {}

158
api-ref/source/apis/cluster_management/deleting_a_node_pool.rst
View File

File diff suppressed because it is too large Load Diff

152
api-ref/source/apis/cluster_management/listing_all_node_pools_in_a_specified_cluster.rst
View File

File diff suppressed because it is too large Load Diff

32
api-ref/source/apis/cluster_management/listing_all_nodes_in_a_cluster.rst
View File

@ -113,6 +113,38 @@ Response
"size": 100 "size": 100
} }
], ],
"storage": {
"storageSelectors": [
{
"name": "cceUse",
"storageType": "evs",
"matchLabels": {
"size": "100",
"volumeType": "SAS",
"count": "1"
}
}
],
"storageGroups": [
{
"name": "vgpaas",
"selectorNames": [
"cceUse"
],
"cceManaged": true,
"virtualSpaces": [
{
"name": "runtime",
"size": "90%"
},
{
"name": "kubernetes",
"size": "10%"
}
]
}
]
},
"publicIP": { "publicIP": {
"eip": { "eip": {
"bandwidth": {} "bandwidth": {}

24
api-ref/source/apis/cluster_management/migrating_a_node.rst
View File

@ -55,8 +55,6 @@ Request Parameters
+------------+-----------+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------+ +------------+-----------+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------+
| spec | Yes | :ref:`MigrateNodesSpec <migratenode__en-us_topic_0000001467833433_request_migratenodesspec>` object | Configuration data. | | spec | Yes | :ref:`MigrateNodesSpec <migratenode__en-us_topic_0000001467833433_request_migratenodesspec>` object | Configuration data. |
+------------+-----------+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------+ +------------+-----------+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------+
| status | No | :ref:`TaskStatus <migratenode__en-us_topic_0000001467833433_request_taskstatus>` object | Job status. |
+------------+-----------+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------+
.. _migratenode__en-us_topic_0000001467833433_request_migratenodesspec: .. _migratenode__en-us_topic_0000001467833433_request_migratenodesspec:
@ -143,22 +141,12 @@ Request Parameters
uid Yes String Node ID. uid Yes String Node ID.
========= ========= ====== =========== ========= ========= ====== ===========
.. _migratenode__en-us_topic_0000001467833433_request_taskstatus:
.. table:: **Table 8** TaskStatus
+-----------+-----------+--------+----------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===========+===========+========+================================================================+
| jobID | No | String | Job ID, which is used by the caller to query the job progress. |
+-----------+-----------+--------+----------------------------------------------------------------+
Response Parameters Response Parameters
------------------- -------------------
**Status code: 200** **Status code: 200**
.. table:: **Table 9** Response body parameters .. table:: **Table 8** Response body parameters
+------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ +------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
@ -174,7 +162,7 @@ Response Parameters
.. _migratenode__en-us_topic_0000001467833433_response_migratenodesspec: .. _migratenode__en-us_topic_0000001467833433_response_migratenodesspec:
.. table:: **Table 10** MigrateNodesSpec .. table:: **Table 9** MigrateNodesSpec
+-------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
@ -190,7 +178,7 @@ Response Parameters
.. _migratenode__en-us_topic_0000001467833433_response_migratenodeextendparam: .. _migratenode__en-us_topic_0000001467833433_response_migratenodeextendparam:
.. table:: **Table 11** MigrateNodeExtendParam .. table:: **Table 10** MigrateNodeExtendParam
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
@ -233,7 +221,7 @@ Response Parameters
.. _migratenode__en-us_topic_0000001467833433_response_login: .. _migratenode__en-us_topic_0000001467833433_response_login:
.. table:: **Table 12** Login .. table:: **Table 11** Login
+-----------------------+-----------------------+---------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
@ -249,7 +237,7 @@ Response Parameters
.. _migratenode__en-us_topic_0000001467833433_response_nodeitem: .. _migratenode__en-us_topic_0000001467833433_response_nodeitem:
.. table:: **Table 13** NodeItem .. table:: **Table 12** NodeItem
========= ====== =========== ========= ====== ===========
Parameter Type Description Parameter Type Description
@ -259,7 +247,7 @@ Response Parameters
.. _migratenode__en-us_topic_0000001467833433_response_taskstatus: .. _migratenode__en-us_topic_0000001467833433_response_taskstatus:
.. table:: **Table 14** TaskStatus .. table:: **Table 13** TaskStatus
+-----------+--------+----------------------------------------------------------------+ +-----------+--------+----------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |

152
api-ref/source/apis/cluster_management/querying_a_specified_node_pool.rst
View File

File diff suppressed because it is too large Load Diff

32
api-ref/source/apis/cluster_management/reading_a_specified_node.rst
View File

@ -494,6 +494,38 @@ Response
"size": 100 "size": 100
} }
], ],
"storage": {
"storageSelectors": [
{
"name": "cceUse",
"storageType": "evs",
"matchLabels": {
"size": "100",
"volumeType": "SAS",
"count": "1"
}
}
],
"storageGroups": [
{
"name": "vgpaas",
"selectorNames": [
"cceUse"
],
"cceManaged": true,
"virtualSpaces": [
{
"name": "runtime",
"size": "90%"
},
{
"name": "kubernetes",
"size": "10%"
}
]
}
]
},
"publicIP": { "publicIP": {
"eip": { "eip": {
"bandwidth": {} "bandwidth": {}

22
api-ref/source/apis/cluster_management/removing_a_node.rst
View File

@ -53,8 +53,6 @@ Request Parameters
+------------+-----------+--------------------------------------------------------------------------------------------------+------------------------------------------------------+ +------------+-----------+--------------------------------------------------------------------------------------------------+------------------------------------------------------+
| spec | Yes | :ref:`RemoveNodesSpec <removenode__en-us_topic_0000001417833320_request_removenodesspec>` object | Configuration information. | | spec | Yes | :ref:`RemoveNodesSpec <removenode__en-us_topic_0000001417833320_request_removenodesspec>` object | Configuration information. |
+------------+-----------+--------------------------------------------------------------------------------------------------+------------------------------------------------------+ +------------+-----------+--------------------------------------------------------------------------------------------------+------------------------------------------------------+
| status | No | :ref:`TaskStatus <removenode__en-us_topic_0000001417833320_request_taskstatus>` object | Job status. |
+------------+-----------+--------------------------------------------------------------------------------------------------+------------------------------------------------------+
.. _removenode__en-us_topic_0000001417833320_request_removenodesspec: .. _removenode__en-us_topic_0000001417833320_request_removenodesspec:
@ -94,22 +92,12 @@ Request Parameters
uid Yes String Node ID. uid Yes String Node ID.
========= ========= ====== =========== ========= ========= ====== ===========
.. _removenode__en-us_topic_0000001417833320_request_taskstatus:
.. table:: **Table 7** TaskStatus
+-----------+-----------+--------+----------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===========+===========+========+================================================================+
| jobID | No | String | Job ID, which is used by the caller to query the job progress. |
+-----------+-----------+--------+----------------------------------------------------------------+
Response Parameters Response Parameters
------------------- -------------------
**Status code: 200** **Status code: 200**
.. table:: **Table 8** Response body parameters .. table:: **Table 7** Response body parameters
+------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------+ +------------+---------------------------------------------------------------------------------------------------+------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
@ -125,7 +113,7 @@ Response Parameters
.. _removenode__en-us_topic_0000001417833320_response_removenodesspec: .. _removenode__en-us_topic_0000001417833320_response_removenodesspec:
.. table:: **Table 9** RemoveNodesSpec .. table:: **Table 8** RemoveNodesSpec
+-----------+-----------------------------------------------------------------------------------------------+-------------------------------+ +-----------+-----------------------------------------------------------------------------------------------+-------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
@ -137,7 +125,7 @@ Response Parameters
.. _removenode__en-us_topic_0000001417833320_response_login: .. _removenode__en-us_topic_0000001417833320_response_login:
.. table:: **Table 10** Login .. table:: **Table 9** Login
+-----------------------+-----------------------+---------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
@ -153,7 +141,7 @@ Response Parameters
.. _removenode__en-us_topic_0000001417833320_response_nodeitem: .. _removenode__en-us_topic_0000001417833320_response_nodeitem:
.. table:: **Table 11** NodeItem .. table:: **Table 10** NodeItem
========= ====== =========== ========= ====== ===========
Parameter Type Description Parameter Type Description
@ -163,7 +151,7 @@ Response Parameters
.. _removenode__en-us_topic_0000001417833320_response_taskstatus: .. _removenode__en-us_topic_0000001417833320_response_taskstatus:
.. table:: **Table 12** TaskStatus .. table:: **Table 11** TaskStatus
+-----------+--------+----------------------------------------------------------------+ +-----------+--------+----------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |

32
api-ref/source/apis/cluster_management/updating_a_specified_node.rst
View File

@ -123,6 +123,38 @@ For the description of the response parameters, see :ref:`Table 4 <cce_02_0243__
"diskSize": 100 "diskSize": 100
} }
], ],
"storage": {
"storageSelectors": [
{
"name": "cceUse",
"storageType": "evs",
"matchLabels": {
"size": "100",
"volumeType": "SAS",
"count": "1"
}
}
],
"storageGroups": [
{
"name": "vgpaas",
"selectorNames": [
"cceUse"
],
"cceManaged": true,
"virtualSpaces": [
{
"name": "runtime",
"size": "90%"
},
{
"name": "kubernetes",
"size": "10%"
}
]
}
]
},
"publicIP": { "publicIP": {
"eip": { "eip": {
"bandwidth": {} "bandwidth": {}

66
api-ref/source/apis/cluster_management/updating_a_specified_node_pool.rst
View File

@ -206,6 +206,38 @@ Request
} }
} }
], ],
"storage": {
"storageSelectors": [
{
"name": "cceUse",
"storageType": "evs",
"matchLabels": {
"size": "100",
"volumeType": "SAS",
"count": "1"
}
}
],
"storageGroups": [
{
"name": "vgpaas",
"selectorNames": [
"cceUse"
],
"cceManaged": true,
"virtualSpaces": [
{
"name": "runtime",
"size": "90%"
},
{
"name": "kubernetes",
"size": "10%"
}
]
}
]
},
"publicIP": { "publicIP": {
"eip": { "eip": {
"bandwidth": {} "bandwidth": {}
@ -262,7 +294,7 @@ Response
**Response parameters**: **Response parameters**:
:ref:`Table 18 <cce_02_0354__table835415466262>` describes the response parameters. :ref:`Table 25 <cce_02_0354__table835415466262>` describes the response parameters.
**Response example**: **Response example**:
@ -299,6 +331,38 @@ Response
} }
} }
], ],
"storage": {
"storageSelectors": [
{
"name": "cceUse",
"storageType": "evs",
"matchLabels": {
"size": "100",
"volumeType": "SAS",
"count": "1"
}
}
],
"storageGroups": [
{
"name": "vgpaas",
"selectorNames": [
"cceUse"
],
"cceManaged": true,
"virtualSpaces": [
{
"name": "runtime",
"size": "90%"
},
{
"name": "kubernetes",
"size": "10%"
}
]
}
]
},
"publicIP": { "publicIP": {
"eip": { "eip": {
"bandwidth": {} "bandwidth": {}

0
api-ref/source/examples/attaching_disks_to_a_node.rst → api-ref/source/appendix/attaching_disks_to_a_node.rst
View File

2
api-ref/source/appendix/index.rst
View File

@ -15,6 +15,7 @@ Appendix
- :ref:`API Permissions <cce_02_0272>` - :ref:`API Permissions <cce_02_0272>`
- :ref:`Creating a VPC and Subnet <cce_02_0100>` - :ref:`Creating a VPC and Subnet <cce_02_0100>`
- :ref:`Creating a Key Pair <cce_02_0101>` - :ref:`Creating a Key Pair <cce_02_0101>`
- :ref:`Attaching Disks to a Node <node_storage_example>`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -30,3 +31,4 @@ Appendix
api_permissions api_permissions
creating_a_vpc_and_subnet creating_a_vpc_and_subnet
creating_a_key_pair creating_a_key_pair
attaching_disks_to_a_node

14
api-ref/source/examples/index.rst
View File

@ -1,14 +0,0 @@
:original_name: cce_02_0237.html
.. _cce_02_0237:
Examples
========
- :ref:`Attaching Disks to a Node <node_storage_example>`
.. toctree::
:maxdepth: 1
:hidden:
attaching_disks_to_a_node

1
api-ref/source/index.rst
View File

@ -6,7 +6,6 @@ Cloud Container Engine - API Reference
:maxdepth: 1 :maxdepth: 1
api_usage_guidelines api_usage_guidelines
examples/index
apis/index apis/index
kubernetes_apis/index kubernetes_apis/index
permissions_policies_and_supported_actions permissions_policies_and_supported_actions