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

Changes to cce_api-ref from docs/doc-exports#771 (Fix some link problems

Browse Source 
Fix so

Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
This commit is contained in:
proposalbot 2023-06-13 06:10:56 +00:00 committed by zuul
parent 26bd70975e
commit 85126a07b8
7 changed files with 102 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api-ref/source/api_usage_guidelines.rst
View File

@ -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: 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| |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| |image2|
@ -35,7 +35,7 @@ CCE provides two methods to authenticate requests for calling an API: token and
.. note:: .. 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 .. |image1| image:: /_static/images/en-us_image_0000001121602072.png
.. |image2| image:: /_static/images/en-us_image_0227096557.png .. |image2| image:: /_static/images/en-us_image_0227096557.png

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

@ -13,7 +13,7 @@ Cluster Management
- :ref:`Hibernating a Cluster <cce_02_0374>` - :ref:`Hibernating a Cluster <cce_02_0374>`
- :ref:`Waking Up a Cluster <cce_02_0375>` - :ref:`Waking Up a Cluster <cce_02_0375>`
- :ref:`Obtaining Cluster Certificates <cce_02_0248>` - :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:`Creating a Node <cce_02_0242>`
- :ref:`Reading a Specified Node <cce_02_0243>` - :ref:`Reading a Specified Node <cce_02_0243>`
- :ref:`Listing All Nodes in a Cluster <cce_02_0244>` - :ref:`Listing All Nodes in a Cluster <cce_02_0244>`

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

@ -69,6 +69,8 @@ Request Parameters
+-------------+-----------+-----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------+-----------+-----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| login | Yes | :ref:`Login <migratenode__en-us_topic_0000001467833433_request_login>` object | Node login mode. | | 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. | | 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. | | | | | 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: .. _migratenode__en-us_topic_0000001467833433_request_nodeitem:
.. table:: **Table 7** NodeItem .. table:: **Table 8** NodeItem
========= ========= ====== =========== ========= ========= ====== ===========
Parameter Mandatory Type Description Parameter Mandatory Type Description
@ -146,7 +166,7 @@ Response Parameters
**Status code: 200** **Status code: 200**
.. table:: **Table 8** Response body parameters .. table:: **Table 9** Response body parameters
+------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ +------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
@ -162,7 +182,7 @@ Response Parameters
.. _migratenode__en-us_topic_0000001467833433_response_migratenodesspec: .. _migratenode__en-us_topic_0000001467833433_response_migratenodesspec:
.. table:: **Table 9** MigrateNodesSpec .. table:: **Table 10** MigrateNodesSpec
+-------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
@ -178,7 +198,7 @@ Response Parameters
.. _migratenode__en-us_topic_0000001467833433_response_migratenodeextendparam: .. _migratenode__en-us_topic_0000001467833433_response_migratenodeextendparam:
.. table:: **Table 10** MigrateNodeExtendParam .. table:: **Table 11** MigrateNodeExtendParam
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
@ -221,7 +241,7 @@ Response Parameters
.. _migratenode__en-us_topic_0000001467833433_response_login: .. _migratenode__en-us_topic_0000001467833433_response_login:
.. table:: **Table 11** Login .. table:: **Table 12** Login
+-----------------------+-----------------------+---------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
@ -237,7 +257,7 @@ Response Parameters
.. _migratenode__en-us_topic_0000001467833433_response_nodeitem: .. _migratenode__en-us_topic_0000001467833433_response_nodeitem:
.. table:: **Table 12** NodeItem .. table:: **Table 13** NodeItem
========= ====== =========== ========= ====== ===========
Parameter Type Description Parameter Type Description
@ -247,7 +267,7 @@ Response Parameters
.. _migratenode__en-us_topic_0000001467833433_response_taskstatus: .. _migratenode__en-us_topic_0000001467833433_response_taskstatus:
.. table:: **Table 13** TaskStatus .. table:: **Table 14** TaskStatus
+-----------+--------+----------------------------------------------------------------+ +-----------+--------+----------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |

120
api-ref/source/apis/cluster_management/obtaining_cluster_certificates_deprecated.rst
View File

File diff suppressed because it is too large Load Diff

6
api-ref/source/appendix/attaching_disks_to_a_node.rst
View File

@ -108,7 +108,7 @@ The following is an API example:
"login": { "login": {
"userPassword": { "userPassword": {
"username": "root", "username": "root",
"password": "JDYkbzhEbE90ckIkY1c0SWJzRy9WeVIzcDFVbC41NFVqa1pxenE0bW9naERlS2RCWEIyWlhqSlpWSjJrL2NmcmdWeE12NGh4T25DeDhlMTdrREVSM2dicHdZNmYzZXh5dy4=" "password": "******"
} }
}, },
"storage": { "storage": {
@ -207,7 +207,7 @@ The following is an API example. There are two data disks. One is used by CCE, a
"login": { "login": {
"userPassword": { "userPassword": {
"username": "root", "username": "root",
"password": "JDYkRmJPckIwRkMkR3RXTkFsNmYvNlAxSDdOTUhYSHZmWjQ0b0ttODRzTDk0L1NzMzRIaHBsQVJkRTZiOGI0WTVJbUtSLlF5aTAuTUpwbGZqdHBTdkYxOU9peGZPV2FUYi4=" "password": "******"
} }
}, },
"storage": { "storage": {
@ -335,7 +335,7 @@ The following is an API example:
"login": { "login": {
"userPassword": { "userPassword": {
"username": "root", "username": "root",
"password": "JDYkbzhEbE90ckIkY1c0SWJzRy9WeVIzcDFVbC41NFVqa1pxenE0bW9naERlS2RCWEIyWlhqSlpWSjJrL2NmcmdWeE12NGh4T25DeDhlMTdrREVSM2dicHdZNmYzZXh5dy4=" "password": "******"
} }
}, },
"storage": { "storage": {

2
api-ref/source/conf.py
View File

@ -18,7 +18,7 @@ import os
import sys import sys
extensions = [ extensions = [
'otcdocstheme', 'otcdocstheme'
] ]
otcdocs_auto_name = False otcdocs_auto_name = False

24
api-ref/source/kubernetes_apis/overview.rst
View File

@ -8,26 +8,14 @@ Overview
Description 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/ - :ref:`Calling Kubernetes APIs Through API Gateway <kubernetesapi__section41207155509>`
- 1.21: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/ - :ref:`Calling Kubernetes APIs Through the API Server <kubernetesapi__section14674391312>`
- 1.23: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/
- 1.25: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/
Based on the open source Kubernetes APIs, CCE enhances and adapts following functions. .. _kubernetesapi__section41207155509:
- 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>`__.
Calling Kubernetes APIs Through API Gateway 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. | | 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 Calling Kubernetes APIs Through the API Server
---------------------------------------------- ----------------------------------------------