From 7c4d829d6410e194a628ad0fd851775e8b7916ff Mon Sep 17 00:00:00 2001 From: OpenTelekomCloud Proposal Bot Date: Mon, 13 Feb 2023 13:30:12 +0000 Subject: [PATCH] Update content --- .../appendix/how_to_use_elb_in_a_cluster.rst | 140 ------------------ api-ref/source/appendix/index.rst | 2 - api-ref/source/change_history.rst | 7 +- api-ref/source/kubernetes_apis/overview.rst | 1 + 4 files changed, 5 insertions(+), 145 deletions(-) delete mode 100644 api-ref/source/appendix/how_to_use_elb_in_a_cluster.rst diff --git a/api-ref/source/appendix/how_to_use_elb_in_a_cluster.rst b/api-ref/source/appendix/how_to_use_elb_in_a_cluster.rst deleted file mode 100644 index 65871b9..0000000 --- a/api-ref/source/appendix/how_to_use_elb_in_a_cluster.rst +++ /dev/null @@ -1,140 +0,0 @@ -:original_name: cce_02_0087.html - -.. _cce_02_0087: - -How to Use ELB in a Cluster -=========================== - -This section describes how to use the Elastic Load Balancer (ELB) in a cluster created by CCE. - -Procedure ---------- - -Create a Service. - -.. note:: - - Before enabling sticky session, ensure that the following conditions are met: - - - The workload protocol is TCP. - - Anti-affinity has been configured between pods of the workload. That is, all pods of the workload are deployed on different nodes. - -Automatically creating an ELB: - -.. code-block:: - - apiVersion: v1 - kind: Service - metadata: - annotations: - kubernetes.io/elb.class: union - kubernetes.io/session-affinity-mode: SOURCE_IP - kubernetes.io/elb.subnet-id: 5083f225-9bf8-48fa-9c8b-67bd9693c4c0 - kubernetes.io/elb.autocreate: "{\"type\":\"public\",\"bandwidth_name\":\"cce-bandwidth-1551163379627\",\"bandwidth_chargemode\":\"traffic\",\"bandwidth_size\":5,\"bandwidth_sharetype\":\"PER\",\"eip_type\":\"5_bgp\",\"name\":\"james\"}" - labels: - app: nginx - name: nginx - spec: - externalTrafficPolicy: Local - ports: - - name: service0 - port: 80 - protocol: TCP - targetPort: 80 - selector: - app: nginx - type: LoadBalancer - -Using an existing ELB: - -.. code-block:: - - apiVersion: v1 - kind: Service - metadata: - annotations: - kubernetes.io/elb.class: union - kubernetes.io/session-affinity-mode: SOURCE_IP - kubernetes.io/elb.id: 3c7caa5a-a641-4bff-801a-feace27424b6 - kubernetes.io/elb.subnet-id: 5083f225-9bf8-48fa-9c8b-67bd9693c4c0 - labels: - app: nginx - name: nginx - spec: - loadBalancerIP: 10.78.42.242 - externalTrafficPolicy: Local - ports: - - name: service0 - port: 80 - protocol: TCP - targetPort: 80 - selector: - app: nginx - type: LoadBalancer - -.. table:: **Table 1** Key parameters - - +-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=====================================+=================================================================+==========================================================================================================================================================================================================================================================================================================================+ - | kubernetes.io/elb.class | String | Mandatory and must be set to **union** if an enhanced load balancer is in use. | - +-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | kubernetes.io/session-affinity-mode | String | Optional. If sticky session is enabled, add this parameter. | - | | | | - | | | The value **SOURCE_IP** indicates that listeners ensure sticky session based on source IP addresses. | - +-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | kubernetes.io/elb.id | String | Optional. This parameter is mandatory if an existing ELB is used. | - | | | | - | | | It indicates the ID of an enhanced load balancer. | - +-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | kubernetes.io/elb.subnet-id | String | Optional. This parameter is mandatory only if a load balancer will be automatically created. For clusters of v1.11.7-r0 or later, this parameter can be left unspecified. | - +-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | kubernetes.io/elb.autocreate | :ref:`elb.autocreate ` object | Optional. This parameter is mandatory if a public network load balancer will be automatically created. The system will create an enhanced load balancer and an EIP. This parameter is also mandatory if a private network load balancer will be automatically created. The system will create an enhanced load balancer. | - | | | | - | | | **Example:** | - | | | | - | | | - Value for a public network load balancer that is automatically created: "{\\"type\\":\\"public\\",\\"bandwidth_name\\":\\"cce-bandwidth-1551163379627\\",\\"bandwidth_chargemode\\":\\"traffic\\",\\"bandwidth_size\\":5,\\"bandwidth_sharetype\\":\\"PER\\",\\"eip_type\\":\\"5_bgp\\",\\"name\\":\\"james\\"}" | - | | | - Value for a private network load balancer that is automatically created: "{\\"type\\":\\"inner\\"}" | - +-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | loadBalancerIP | String | Private IP address of a private network load balancer or public IP address of a public network load balancer. | - +-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | externalTrafficPolicy | String | Optional. If sticky session is enabled, add this parameter so requests are transferred to a fixed node. If a LoadBalancer Service with this parameter set to **Local** is created for a workload, the workload can be accessed only when the client is installed on the same node as the server. | - +-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port | Integer | Access port that is registered on the load balancer and mapped to the cluster-internal IP address. | - +-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | targetPort | String | Container port on the CCE console. | - +-------------------------------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _cce_02_0087__table19417184671919: - -.. table:: **Table 2** Data structure of the **elb.autocreate** field - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=============================================================================================================================+ - | name | String | Name of the load balancer that is automatically created. | - | | | | - | | | The value is a string of 1 to 64 characters that consist of letters, digits, underscores (_), and hyphens (-). | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | type | String | Network type of the load balancer. | - | | | | - | | | - **public**: public network load balancer. | - | | | - **inner**: private network load balancer. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | bandwidth_name | String | Bandwidth name. The default value is **cce-bandwidth-*****\***. | - | | | | - | | | The value is a string of 1 to 64 characters that consist of letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | bandwidth_chargemode | String | Bandwidth billing mode. | - | | | | - | | | The value is **traffic**, indicating that the billing is based on traffic. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | bandwidth_size | Integer | Bandwidth size. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | bandwidth_sharetype | String | Bandwidth sharing mode. | - | | | | - | | | - **PER**: dedicated bandwidth. | - | | | - **WHOLE**: shared bandwidth. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | eip_type | String | EIP type. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/appendix/index.rst b/api-ref/source/appendix/index.rst index e0b08ff..68d51f4 100644 --- a/api-ref/source/appendix/index.rst +++ b/api-ref/source/appendix/index.rst @@ -11,7 +11,6 @@ Appendix - :ref:`Error Codes ` - :ref:`Obtaining a Project ID ` - :ref:`Obtaining the Account ID ` -- :ref:`How to Use ELB in a Cluster ` - :ref:`How to Obtain Parameters in the API URI ` - :ref:`API Permissions ` - :ref:`Creating a VPC and Subnet ` @@ -27,7 +26,6 @@ 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 diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index d18bab5..6c57005 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -10,14 +10,15 @@ Change History +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Date | Revision | +===================================+============================================================================================================================================================================+ + | 2023-02-10 | Supported clusters of v1.25. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2022-05-24 | - Supported clusters of v1.23. | | | - Add a note about how to automatically install ICAgent. For details, see :ref:`Creating a Cluster `. | | | - The native APIs of Kubernetes will no longer be maintained. For details, see :ref:`Overview `. | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 `. | - | | - Added the **cidrs** field in :ref:`Table 5 `. | + | | - Added the **cidrs** field in :ref:`Table 9 `. | | | - Added :ref:`Quota Management `. | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2022-02-17 | - Supported the creation of CCE Turbo Cluster. | diff --git a/api-ref/source/kubernetes_apis/overview.rst b/api-ref/source/kubernetes_apis/overview.rst index 5cb43c8..bb55b6d 100644 --- a/api-ref/source/kubernetes_apis/overview.rst +++ b/api-ref/source/kubernetes_apis/overview.rst @@ -15,6 +15,7 @@ To find detailed API definitions for different Kubernetes versions, visit the fo - 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/ Based on the open source Kubernetes APIs, CCE enhances and adapts following functions.