From 85126a07b807f2804bd8517d0aff06ae7a701259 Mon Sep 17 00:00:00 2001 From: proposalbot Date: Tue, 13 Jun 2023 06:10:56 +0000 Subject: [PATCH] Changes to cce_api-ref from docs/doc-exports#771 (Fix some link problems Fix so Reviewed-by: Eotvos, Oliver Co-authored-by: proposalbot Co-committed-by: proposalbot --- api-ref/source/api_usage_guidelines.rst | 6 +- .../source/apis/cluster_management/index.rst | 2 +- .../cluster_management/migrating_a_node.rst | 34 ++++- ...aining_cluster_certificates_deprecated.rst | 120 +++++++++--------- .../appendix/attaching_disks_to_a_node.rst | 6 +- api-ref/source/conf.py | 2 +- api-ref/source/kubernetes_apis/overview.rst | 24 +--- 7 files changed, 102 insertions(+), 92 deletions(-) diff --git a/api-ref/source/api_usage_guidelines.rst b/api-ref/source/api_usage_guidelines.rst index 2edc400..caa9120 100644 --- a/api-ref/source/api_usage_guidelines.rst +++ b/api-ref/source/api_usage_guidelines.rst @@ -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 `__. + - Self-owned certificate uploaded during cluster creation. For details, see `Creating a Cluster `__. |image1| - - Cluster certificate generated and downloaded after cluster creation. For details, see `Obtaining a Cluster Certificate `__. + - Cluster certificate generated and downloaded after cluster creation. For details, see `Obtaining a Cluster Certificate `__. |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 `__. + 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 diff --git a/api-ref/source/apis/cluster_management/index.rst b/api-ref/source/apis/cluster_management/index.rst index 03db36e..a4b87ed 100644 --- a/api-ref/source/apis/cluster_management/index.rst +++ b/api-ref/source/apis/cluster_management/index.rst @@ -13,7 +13,7 @@ Cluster Management - :ref:`Hibernating a Cluster ` - :ref:`Waking Up a Cluster ` - :ref:`Obtaining Cluster Certificates ` -- :ref:`Obtaining Cluster Certificates (Deprecated) ` +- :ref:`Obtaining Cluster Certificates (Deprecated) ` - :ref:`Creating a Node ` - :ref:`Reading a Specified Node ` - :ref:`Listing All Nodes in a Cluster ` diff --git a/api-ref/source/apis/cluster_management/migrating_a_node.rst b/api-ref/source/apis/cluster_management/migrating_a_node.rst index 0c73a30..e68a308 100644 --- a/api-ref/source/apis/cluster_management/migrating_a_node.rst +++ b/api-ref/source/apis/cluster_management/migrating_a_node.rst @@ -69,6 +69,8 @@ Request Parameters +-------------+-----------+-----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | login | Yes | :ref:`Login ` object | Node login mode. | +-------------+-----------+-----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | runtime | No | :ref:`Runtime ` object | Container runtime configuration. | + +-------------+-----------+-----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | nodes | Yes | Array of :ref:`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 | diff --git a/api-ref/source/apis/cluster_management/obtaining_cluster_certificates_deprecated.rst b/api-ref/source/apis/cluster_management/obtaining_cluster_certificates_deprecated.rst index 3fdb1f5..b37219d 100644 --- a/api-ref/source/apis/cluster_management/obtaining_cluster_certificates_deprecated.rst +++ b/api-ref/source/apis/cluster_management/obtaining_cluster_certificates_deprecated.rst @@ -1,6 +1,6 @@ -:original_name: cce_02_0359_0.html +:original_name: cce_02_0359.html -.. _cce_02_0359_0: +.. _cce_02_0359: Obtaining Cluster Certificates (Deprecated) =========================================== @@ -15,9 +15,9 @@ URI GET /api/v3/projects/{project_id}/clusters/{cluster_id}/clustercert -:ref:`Table 1 ` describes the parameters of this API. +:ref:`Table 1 ` describes the parameters of this API. -.. _cce_02_0359_0__table2027961241820: +.. _cce_02_0359__table2027961241820: .. table:: **Table 1** Description @@ -34,9 +34,9 @@ Request **Request parameters**: -:ref:`Table 2 ` describes the request parameters. +:ref:`Table 2 ` describes the request parameters. -.. _cce_02_0359_0__table538113720514: +.. _cce_02_0359__table538113720514: .. table:: **Table 2** Parameters in the request header @@ -60,46 +60,46 @@ Response **Response parameters**: -:ref:`Table 3 ` describes the response parameters. +:ref:`Table 3 ` describes the response parameters. -.. _cce_02_0359_0__table10794441185312: +.. _cce_02_0359__table10794441185312: .. table:: **Table 3** Response parameters - +-----------------+---------------------------------------------------------+----------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================+=========================================================+======================================================================+ - | kind | String | API type. The value is fixed at **Config** and cannot be changed. | - +-----------------+---------------------------------------------------------+----------------------------------------------------------------------+ - | apiVersion | String | API version. The value is fixed at **v1** and cannot be changed. | - +-----------------+---------------------------------------------------------+----------------------------------------------------------------------+ - | preferences | ``-`` | This field is not used currently and is left unspecified by default. | - +-----------------+---------------------------------------------------------+----------------------------------------------------------------------+ - | clusters | :ref:`clusters ` object | Cluster list. | - +-----------------+---------------------------------------------------------+----------------------------------------------------------------------+ - | users | :ref:`users ` object | ``-`` | - +-----------------+---------------------------------------------------------+----------------------------------------------------------------------+ - | contexts | :ref:`contexts ` object | Context list. | - +-----------------+---------------------------------------------------------+----------------------------------------------------------------------+ - | current-context | String | Current context. | - +-----------------+---------------------------------------------------------+----------------------------------------------------------------------+ + +-----------------+-------------------------------------------------------+----------------------------------------------------------------------+ + | Parameter | Type | Description | + +=================+=======================================================+======================================================================+ + | kind | String | API type. The value is fixed at **Config** and cannot be changed. | + +-----------------+-------------------------------------------------------+----------------------------------------------------------------------+ + | apiVersion | String | API version. The value is fixed at **v1** and cannot be changed. | + +-----------------+-------------------------------------------------------+----------------------------------------------------------------------+ + | preferences | ``-`` | This field is not used currently and is left unspecified by default. | + +-----------------+-------------------------------------------------------+----------------------------------------------------------------------+ + | clusters | :ref:`clusters ` object | Cluster list. | + +-----------------+-------------------------------------------------------+----------------------------------------------------------------------+ + | users | :ref:`users ` object | ``-`` | + +-----------------+-------------------------------------------------------+----------------------------------------------------------------------+ + | contexts | :ref:`contexts ` object | Context list. | + +-----------------+-------------------------------------------------------+----------------------------------------------------------------------+ + | current-context | String | Current context. | + +-----------------+-------------------------------------------------------+----------------------------------------------------------------------+ -.. _cce_02_0359_0__table2157957598: +.. _cce_02_0359__table2157957598: .. table:: **Table 4** Data structure of the **clusters** field - +-----------------------+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==========================================================+==================================================================================================================================================================================+ - | name | String | Cluster name. | - | | | | - | | | - If the **publicIp** parameter does not exist (that is, no EIP exists), there is only one cluster in the cluster list, and the value of this parameter is **internalCluster**. | - | | | - If the **publicIp** parameter exists (that is, the EIP exists), there is more than one cluster in the cluster list, and the value of this parameter is **externalCluster**. | - +-----------------------+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cluster | :ref:`cluster ` object | Cluster information. | - +-----------------------+----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========================================================+==================================================================================================================================================================================+ + | name | String | Cluster name. | + | | | | + | | | - If the **publicIp** parameter does not exist (that is, no EIP exists), there is only one cluster in the cluster list, and the value of this parameter is **internalCluster**. | + | | | - If the **publicIp** parameter exists (that is, the EIP exists), there is more than one cluster in the cluster list, and the value of this parameter is **externalCluster**. | + +-----------------------+--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cluster | :ref:`cluster ` object | Cluster information. | + +-----------------------+--------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _cce_02_0359_0__table519211353218: +.. _cce_02_0359__table519211353218: .. table:: **Table 5** Data structure of the **cluster** field @@ -110,19 +110,19 @@ Response certificate-authority-data String Certificate authorization data. ========================== ====== =============================== -.. _cce_02_0359_0__table7846125310316: +.. _cce_02_0359__table7846125310316: .. table:: **Table 6** Data structure of the **users** field - +-----------+-------------------------------------------------------+-----------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=======================================================+===================================================================================+ - | name | String | The value is fixed to **user**. | - +-----------+-------------------------------------------------------+-----------------------------------------------------------------------------------+ - | user | :ref:`user ` object | Stores the certificate information and ClientKey information of a specified user. | - +-----------+-------------------------------------------------------+-----------------------------------------------------------------------------------+ + +-----------+-----------------------------------------------------+-----------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+=====================================================+===================================================================================+ + | name | String | The value is fixed to **user**. | + +-----------+-----------------------------------------------------+-----------------------------------------------------------------------------------+ + | user | :ref:`user ` object | Stores the certificate information and ClientKey information of a specified user. | + +-----------+-----------------------------------------------------+-----------------------------------------------------------------------------------+ -.. _cce_02_0359_0__table205311581434: +.. _cce_02_0359__table205311581434: .. table:: **Table 7** Data structure of the **user** field @@ -134,22 +134,22 @@ Response | client-key-data | String | Contains PEM encoding data from the TLS client key file. | +-------------------------+--------+----------------------------------------------------------+ -.. _cce_02_0359_0__table1653965354: +.. _cce_02_0359__table1653965354: .. table:: **Table 8** Data structure of the **contexts** field - +-----------------------+---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=========================================================+===========================================================================================================================================================================+ - | name | String | Context name. | - | | | | - | | | - If the **publicIp** parameter does not exist (that is, no EIP exists), there is only one cluster in the cluster list, and the value of this parameter is **internal**. | - | | | - If the **publicIp** parameter exists (that is, the EIP exists), there is more than one cluster in the cluster list, and the value of this parameter is **external**. | - +-----------------------+---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | context | :ref:`context ` object | Context information. | - +-----------------------+---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================================================+===========================================================================================================================================================================+ + | name | String | Context name. | + | | | | + | | | - If the **publicIp** parameter does not exist (that is, no EIP exists), there is only one cluster in the cluster list, and the value of this parameter is **internal**. | + | | | - If the **publicIp** parameter exists (that is, the EIP exists), there is more than one cluster in the cluster list, and the value of this parameter is **external**. | + +-----------------------+-------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | context | :ref:`context ` object | Context information. | + +-----------------------+-------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _cce_02_0359_0__table47913919518: +.. _cce_02_0359__table47913919518: .. table:: **Table 9** Data structure of the **context** field @@ -201,9 +201,9 @@ Response Status Code ----------- -:ref:`Table 10 ` describes the status code of this API. +:ref:`Table 10 ` describes the status code of this API. -.. _cce_02_0359_0__en-us_topic_0079614900_table46761928: +.. _cce_02_0359__en-us_topic_0079614900_table46761928: .. table:: **Table 10** Status code diff --git a/api-ref/source/appendix/attaching_disks_to_a_node.rst b/api-ref/source/appendix/attaching_disks_to_a_node.rst index 51cb028..8c9d318 100644 --- a/api-ref/source/appendix/attaching_disks_to_a_node.rst +++ b/api-ref/source/appendix/attaching_disks_to_a_node.rst @@ -108,7 +108,7 @@ The following is an API example: "login": { "userPassword": { "username": "root", - "password": "JDYkbzhEbE90ckIkY1c0SWJzRy9WeVIzcDFVbC41NFVqa1pxenE0bW9naERlS2RCWEIyWlhqSlpWSjJrL2NmcmdWeE12NGh4T25DeDhlMTdrREVSM2dicHdZNmYzZXh5dy4=" + "password": "******" } }, "storage": { @@ -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": { @@ -335,7 +335,7 @@ The following is an API example: "login": { "userPassword": { "username": "root", - "password": "JDYkbzhEbE90ckIkY1c0SWJzRy9WeVIzcDFVbC41NFVqa1pxenE0bW9naERlS2RCWEIyWlhqSlpWSjJrL2NmcmdWeE12NGh4T25DeDhlMTdrREVSM2dicHdZNmYzZXh5dy4=" + "password": "******" } }, "storage": { diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index c5cba60..ebf4cee 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -18,7 +18,7 @@ import os import sys extensions = [ - 'otcdocstheme', + 'otcdocstheme' ] otcdocs_auto_name = False diff --git a/api-ref/source/kubernetes_apis/overview.rst b/api-ref/source/kubernetes_apis/overview.rst index bb55b6d..63c2e6e 100644 --- a/api-ref/source/kubernetes_apis/overview.rst +++ b/api-ref/source/kubernetes_apis/overview.rst @@ -8,26 +8,14 @@ Overview Description ----------- -You can use Kubernetes native APIs to manage your Kubernetes clusters. For details, see `Kubernetes 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 `__ 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 ` +- :ref:`Calling Kubernetes APIs Through the API Server ` -Based on the open source Kubernetes APIs, CCE enhances and adapts following functions. - -- Ingress: For details, see `Using kubectl to Create an ELB Ingress `__. -- PV and PVC: For details, see `PV `__ and `PVC `__. - - - EVS: For details, see `Creating a Pod Mounted with an EVS Volume `__. - - SFS Turbo: For details, see `Creating a Deployment Mounted with an SFS Turbo Volume `__ and `Creating a StatefulSet Mounted with an SFS Turbo Volume `__. - - OBS: For details, see `Creating a Deployment Mounted with an OBS Volume `__ and `Creating a StatefulSet Mounted with an OBS Volume `__. - - SFS: For details, see `Creating a Deployment Mounted with an SFS Volume `__ and `Creating a StatefulSet Mounted with an SFS Volume `__. - -- Network Policies: For details, see `Network Policies `__. +.. _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 ----------------------------------------------