Update tox.ini && conf.py file

Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>

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 <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

api-ref/source/apis/cluster_management/creating_a_cluster.rst

@@ -13,7 +13,7 @@ This API is used to create an empty cluster, which has only master nodes but do
 .. 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.
-   -  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.
    -  By default, an account can create a maximum of five clusters in each region.
 

api-ref/source/apis/cluster_management/deleting_a_node.rst

@@ -160,6 +160,38 @@ Response
                    "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": {
                "eip": {
                    "bandwidth": {}

api-ref/source/apis/cluster_management/index.rst

@@ -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>`
@@ -22,6 +22,10 @@ Cluster Management
 -  :ref:`Reading Job Progress <cce_02_0247>`
 -  :ref:`Querying the Access Information of a Specified Cluster <cce_02_0347>`
 -  :ref:`Modifying the Access Information of a Specified Cluster <cce_02_0346>`
+-  :ref:`Accepting a Node <addnode>`
+-  :ref:`Resetting a Node <resetnode>`
+-  :ref:`Removing a Node <removenode>`
+-  :ref:`Migrating a Node <migratenode>`
 -  :ref:`Creating a Node Pool <cce_02_0354>`
 -  :ref:`Querying a Specified Node Pool <cce_02_0355>`
 -  :ref:`Updating a Specified Node Pool <cce_02_0356>`
@@ -49,6 +53,10 @@ Cluster Management
    reading_job_progress
    querying_the_access_information_of_a_specified_cluster
    modifying_the_access_information_of_a_specified_cluster
+   accepting_a_node
+   resetting_a_node
+   removing_a_node
+   migrating_a_node
    creating_a_node_pool
    querying_a_specified_node_pool
    updating_a_specified_node_pool

api-ref/source/apis/cluster_management/listing_all_nodes_in_a_cluster.rst

@@ -113,6 +113,38 @@ Response
                "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": {
              "eip": {
                "bandwidth": {}

api-ref/source/apis/cluster_management/listing_clusters_in_a_specified_project.rst

@@ -150,8 +150,7 @@ Response
                    "External": "https://10.185.69.54:5443",
                },
               {
-                   "external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com",
-               }
+                   "external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com",            }
            ]
        }
    }

api-ref/source/apis/cluster_management/reading_a_specified_cluster.rst

@@ -363,8 +363,7 @@ Response
                    "External": "https://10.185.69.54:5443",
                },
               {
-                   "external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com",
-               },
+                   "external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com",            },
            ]
        }
    }

api-ref/source/apis/cluster_management/updating_a_specified_cluster.rst

@@ -231,8 +231,7 @@ For details about the response parameters, see :ref:`Table 7 <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",            },
            ]
        }
    }

api-ref/source/apis/cluster_management/updating_a_specified_node.rst

@@ -123,6 +123,38 @@ For the description of the response parameters, see :ref:`Table 4 <cce_02_0243__
            "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": {
            "eip": {
                "bandwidth": {}

api-ref/source/appendix/index.rst

@@ -11,11 +11,12 @@ Appendix
 -  :ref:`Error Codes <cce_02_0250>`
 -  :ref:`Obtaining a Project ID <cce_02_0341>`
 -  :ref:`Obtaining the Account ID <cce_02_0342>`
--  :ref:`How to Use ELB in a Cluster <cce_02_0087>`
 -  :ref:`How to Obtain Parameters in the API URI <cce_02_0271>`
 -  :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::
    :maxdepth: 1
@@ -27,8 +28,9 @@ Appendix
    error_codes
    obtaining_a_project_id
    obtaining_the_account_id
-   how_to_use_elb_in_a_cluster
    how_to_obtain_parameters_in_the_api_uri
    api_permissions
    creating_a_vpc_and_subnet
    creating_a_key_pair
+   node_flavor_description
+   attaching_disks_to_a_node

api-ref/source/appendix/node_flavor_description.rst

@@ -0,0 +1,45 @@
+:original_name: cce_02_0368.html
+
+.. _cce_02_0368:
+
+Node Flavor Description
+=======================
+
+.. note::
+
+   Different regions support different node flavors, and node flavors may be changed. You are advised to log in to the CCE console and check whether the required node flavors are supported on the page for creating nodes.
+
+-  **CCE cluster**
+
+   CCE clusters support only 2 vCPUs and 4 GiB or higher specifications. You are advised to query node specifications on the console. For details about node specifications, see ECS Specifications.
+
+   You need to enter the specific flavor name, for example, **c4.large.2**.
+
+   The following tables list the specifications supported by CCE. (The specifications of some ECS models vary by region. The actual specifications displayed on the console are used.)
+
+   -  ECS (VM):
+
+      .. table:: **Table 1** x86 nodes
+
+         ====================== =====================
+         Node Type              Flavor
+         ====================== =====================
+         General computing-plus c4, c3
+         General-purpose        s3, s2
+         Memory-optimized       m4, m3
+         Disk-intensive         d2
+         GPU-accelerated        pi2, p2s, g6, and p2v
+         ====================== =====================
+
+-  **CCE Turbo clusters**
+
+   -  ECS (VM):
+
+      .. table:: **Table 2** x86 nodes
+
+         ====================== ======
+         Node Type              Flavor
+         ====================== ======
+         General computing-plus c3n
+         Container-plus         m3n
+         ====================== ======

api-ref/source/change_history.rst

@@ -10,14 +10,24 @@ 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>`.                                                                                                          |
+   |                                   | -  Added :ref:`Accepting a Node <addnode>`.                                                                                                                                |
+   |                                   | -  Added :ref:`Resetting a Node <resetnode>`.                                                                                                                              |
+   |                                   | -  Added :ref:`Removing a Node <removenode>`.                                                                                                                              |
+   |                                   | -  Added :ref:`Migrating a Node <migratenode>`.                                                                                                                            |
+   +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | 2022-05-24                        | -  Supported clusters of v1.23.                                                                                                                                            |
    |                                   | -  Add a note about how to automatically install ICAgent. For details, see :ref:`Creating a Cluster <cce_02_0236>`.                                                        |
    |                                   | -  The native APIs of Kubernetes will no longer be maintained. For details, see :ref:`Overview <kubernetesapi>`.                                                           |
    +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-   | 2022-03-24                        | Supported clusters of v1.21.                                                                                                                                               |
-   |                                   |                                                                                                                                                                            |
+   | 2022-03-24                        | -  Supported clusters of v1.21.                                                                                                                                            |
    |                                   | -  The cluster certificate SAN can be customized. For details, see **customSan** field in :ref:`Table 5 <cce_02_0236__table1034041612134>`.                                |
-   |                                   | -  Added the **cidrs** field in :ref:`Table 5 <cce_02_0236__table1034041612134>`.                                                                                          |
+   |                                   | -  Added the **cidrs** field in :ref:`Table 9 <cce_02_0236__table882310145412>`.                                                                                           |
    |                                   | -  Added :ref:`Quota Management <quota_lifecycle_management>`.                                                                                                             |
    +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | 2022-02-17                        | -  Supported the creation of CCE Turbo Cluster.                                                                                                                            |
@@ -68,7 +78,7 @@ Change History
    |                                   | -  Updated **spec** in :ref:`Table 3 <cce_02_0238__table34052983203655>`.                                                                                                  |
    |                                   | -  Added **description** in :ref:`Table 4 <cce_02_0238__table1034041612134>`.                                                                                              |
    |                                   | -  Deleted **patchVersion** in :ref:`Table 10 <cce_02_0238__table17575013586>`.                                                                                            |
-   |                                   | -  Added **publicKey** in :ref:`Table 21 <cce_02_0242__table2039318361484>`.                                                                                               |
+   |                                   | -  Added **publicKey** in :ref:`Table 28 <cce_02_0242__table2039318361484>`.                                                                                               |
    |                                   | -  Added **initialNodeCount** in Table 6.                                                                                                                                  |
    |                                   | -  Added **minNodeCount** in Table 17.                                                                                                                                     |
    |                                   | -  Updated Table 19.                                                                                                                                                       |

api-ref/source/conf.py

@@ -18,18 +18,29 @@ import os
 import sys
 
 extensions = [
-    'otcdocstheme'
+    'otcdocstheme',
 ]
 
 otcdocs_auto_name = False
 otcdocs_auto_version = False
 
-project = 'Cloud Container Service'
+project = 'Cloud Container Engine'
 otcdocs_repo_name = 'docs/cloud-container-engine'
 # Those variables are required for edit/bug links
 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.
@@ -86,7 +97,7 @@ html_theme_options = {
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 
-html_title = "Cloud Container Service - API Reference"
+html_title = "Cloud Container Engine - API Reference"
 
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -101,6 +112,6 @@ html_copy_source = False
 latex_documents = [
     ('index',
      'cce-api-ref.tex',
-     u'Cloud Container Service - API Reference',
+     u'Cloud Container Engine - API Reference',
      u'OpenTelekomCloud', 'manual'),
 ]

api-ref/source/index.rst

@@ -1,6 +1,6 @@
-=======================================
-Cloud Container Service - API Reference
-=======================================
+======================================
+Cloud Container Engine - API Reference
+======================================
 
 .. toctree::
    :maxdepth: 1

api-ref/source/kubernetes_apis/overview.rst

@@ -8,25 +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/
+-  :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
 -------------------------------------------
@@ -45,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
 ----------------------------------------------
 

doc/best-practice/source/docutils.conf

@@ -0,0 +1,2 @@
+[html writers]
+table-style: table, caption-top

doc/best-practice/source/index.rst

@@ -0,0 +1,4 @@
+======================================
+Cloud Container Engine - Best Practice
+======================================
+

doc/requirements.txt

@@ -1,4 +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

doc/source/index.rst

@@ -0,0 +1,14 @@
+Cloud Container Engine
+======================
+
+CCE provides highly scalable, high-performance, enterprise-class Kubernetes clusters. It supports native Kubernetes applications, tools and easy setup of container runtime environment.
+
+.. directive_wrapper::
+   :class: container-sbv
+
+   .. 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.