diff --git a/docs/cce/api-ref/ALL_META.TXT.json b/docs/cce/api-ref/ALL_META.TXT.json index 551f7fa9..73267ce3 100644 --- a/docs/cce/api-ref/ALL_META.TXT.json +++ b/docs/cce/api-ref/ALL_META.TXT.json @@ -14,8 +14,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"API Usage Guidelines", @@ -33,8 +32,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"APIs", @@ -52,8 +50,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"API Version Query", @@ -71,8 +68,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Querying All API Versions", @@ -90,8 +86,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Querying Information About API v3", @@ -109,8 +104,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Cluster Management", @@ -128,8 +122,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Creating a Cluster", @@ -147,8 +140,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Reading a Specified Cluster", @@ -166,8 +158,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Listing Clusters in a Specified Project", @@ -185,8 +176,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Updating a Specified Cluster", @@ -204,8 +194,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Deleting a Specified Cluster", @@ -223,8 +212,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Hibernating a Cluster", @@ -242,8 +230,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Waking Up a Cluster", @@ -261,8 +248,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Obtaining Cluster Certificates", @@ -280,8 +266,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Obtaining Cluster Certificates (Deprecated)", @@ -299,8 +284,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Creating a Node", @@ -318,8 +302,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Reading a Specified Node", @@ -337,8 +320,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Listing All Nodes in a Cluster", @@ -356,8 +338,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Updating a Specified Node", @@ -375,8 +356,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Deleting a Node", @@ -394,8 +374,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Reading Job Progress", @@ -413,8 +392,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Querying the Access Information of a Specified Cluster", @@ -432,8 +410,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Modifying the Access Information of a Specified Cluster", @@ -451,8 +428,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Accepting a Node", @@ -470,8 +446,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Resetting a Node", @@ -489,8 +464,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Removing a Node", @@ -508,8 +482,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Migrating a Node", @@ -527,8 +500,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Creating a Node Pool", @@ -546,8 +518,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Querying a Specified Node Pool", @@ -565,8 +536,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Updating a Specified Node Pool", @@ -584,8 +554,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Listing All Node Pools in a Specified Cluster", @@ -603,8 +572,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Deleting a Node Pool", @@ -622,8 +590,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Add-on Management", @@ -641,8 +608,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Installing an Add-on Instance", @@ -660,8 +626,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Reading Add-on Templates", @@ -679,8 +644,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Updating an Add-on Instance", @@ -698,8 +662,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Deleting an Add-on Instance", @@ -717,8 +680,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Reading an Add-on Instance", @@ -736,8 +698,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Listing Add-on Instances", @@ -755,8 +716,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Quota Management", @@ -774,18 +734,215 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Querying Resource Quotas", "githuburl":"" }, + { + "uri":"cce_02_0366.html", + "node_id":"cce_02_0366.xml", + "product_code":"cce", + "code":"42", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api2", + "kw":"Add-on Instance Parameters", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Add-on Instance Parameters", + "githuburl":"" + }, + { + "uri":"cce_02_0407.html", + "node_id":"cce_02_0407.xml", + "product_code":"cce", + "code":"43", + "des":"CoreDNS is a DNS server that uses chain plug-ins to provide domain name resolution services for Kubernetes clusters. It is the recommended DNS server solution by the Kube", + "doc_type":"api2", + "kw":"CoreDNS,Add-on Instance Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"CoreDNS", + "githuburl":"" + }, + { + "uri":"cce_02_0408.html", + "node_id":"cce_02_0408.xml", + "product_code":"cce", + "code":"44", + "des":"The CCE Container Storage (Everest) add-on uses the Container Storage Interface (CSI) to link Kubernetes clusters with cloud storage services.", + "doc_type":"api2", + "kw":"CCE Container Storage (Everest),Add-on Instance Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"CCE Container Storage (Everest)", + "githuburl":"" + }, + { + "uri":"cce_02_0409.html", + "node_id":"cce_02_0409.xml", + "product_code":"cce", + "code":"45", + "des":"CCE Node Problem Detector (node-problem-detector, NPD) is an add-on that monitors abnormal events of cluster nodes and connects to a third-party monitoring platform. It i", + "doc_type":"api2", + "kw":"CCE Node Problem Detector,Add-on Instance Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"CCE Node Problem Detector", + "githuburl":"" + }, + { + "uri":"cce_02_0411.html", + "node_id":"cce_02_0411.xml", + "product_code":"cce", + "code":"46", + "des":"The CCE Cluster Autoscaler (autoscaler) add-on enables node pools to be scaled in or out.", + "doc_type":"api2", + "kw":"CCE Cluster Autoscaler,Add-on Instance Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"CCE Cluster Autoscaler", + "githuburl":"" + }, + { + "uri":"cce_02_0412.html", + "node_id":"cce_02_0412.xml", + "product_code":"cce", + "code":"47", + "des":"The NGINX Ingress Controller add-on can automatically modify configurations when there are changes to pods in Services. This add-on uses Nginx's excellent stability, perf", + "doc_type":"api2", + "kw":"NGINX Ingress Controller,Add-on Instance Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"NGINX Ingress Controller", + "githuburl":"" + }, + { + "uri":"cce_02_0413.html", + "node_id":"cce_02_0413.xml", + "product_code":"cce", + "code":"48", + "des":"From version 1.8 onwards, Kubernetes provides resource usage metrics, such as the container CPU and memory usage, through the Metrics API. These metrics can be directly a", + "doc_type":"api2", + "kw":"Kubernetes Metrics Server,Add-on Instance Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Kubernetes Metrics Server", + "githuburl":"" + }, + { + "uri":"cce_02_0414.html", + "node_id":"cce_02_0414.xml", + "product_code":"cce", + "code":"49", + "des":"CCE Advanced HPA (cce-hpa-controller) is an in-house add-on, which can be used to flexibly scale in or out Deployments based on metrics such as CPU usage and memory usage", + "doc_type":"api2", + "kw":"CCE Advanced HPA,Add-on Instance Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"CCE Advanced HPA", + "githuburl":"" + }, + { + "uri":"cce_02_0415.html", + "node_id":"cce_02_0415.xml", + "product_code":"cce", + "code":"50", + "des":"CCE AI Suite (NVIDIA GPU) is a device management add-on that supports GPUs in containers. To use GPU nodes in a cluster, this add-on must be installed.", + "doc_type":"api2", + "kw":"CCE AI Suite (NVIDIA GPU),Add-on Instance Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"CCE AI Suite (NVIDIA GPU)", + "githuburl":"" + }, + { + "uri":"cce_02_0417.html", + "node_id":"cce_02_0417.xml", + "product_code":"cce", + "code":"51", + "des":"Volcano is a batch scheduling platform based on Kubernetes. It provides a series of features required by machine learning, deep learning, bioinformatics, genomics, and ot", + "doc_type":"api2", + "kw":"Volcano Scheduler,Add-on Instance Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Volcano Scheduler", + "githuburl":"" + }, + { + "uri":"cce_02_0421.html", + "node_id":"cce_02_0421.xml", + "product_code":"cce", + "code":"52", + "des":"The Cluster Native Cluster Monitoring add-on (kube-prometheus-stack) uses Prometheus-operator and Prometheus to provide easy-to-use, end-to-end Kubernetes cluster monitor", + "doc_type":"api2", + "kw":"Cloud Native Cluster Monitoring,Add-on Instance Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Cloud Native Cluster Monitoring", + "githuburl":"" + }, { "uri":"cce_02_0340.html", "node_id":"cce_02_0340.xml", "product_code":"cce", - "code":"42", + "code":"53", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api2", "kw":"Kubernetes APIs", @@ -793,8 +950,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Kubernetes APIs", @@ -804,7 +960,7 @@ "uri":"kubernetesapi.html", "node_id":"kubernetesapi.xml", "product_code":"cce", - "code":"43", + "code":"54", "des":"Kubernetes APIs are resource-based (RESTful) programming interfaces provided through HTTP. It supports query, creation, update, and deletion of various cluster resources ", "doc_type":"api2", "kw":"Overview,Kubernetes APIs,API Reference", @@ -812,8 +968,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Overview", @@ -823,7 +978,7 @@ "uri":"cce_02_0327.html", "node_id":"cce_02_0327.xml", "product_code":"cce", - "code":"44", + "code":"55", "des":"This chapter describes fine-grained permissions management for your CCE. If your cloud account does not need individual IAM users, then you may skip over this chapter.A p", "doc_type":"api2", "kw":"Permissions Policies and Supported Actions,API Reference", @@ -831,8 +986,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Permissions Policies and Supported Actions", @@ -842,7 +996,7 @@ "uri":"cce_02_0083.html", "node_id":"cce_02_0083.xml", "product_code":"cce", - "code":"45", + "code":"56", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api2", "kw":"Appendix", @@ -850,8 +1004,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Appendix", @@ -861,7 +1014,7 @@ "uri":"cce_02_0085.html", "node_id":"cce_02_0085.xml", "product_code":"cce", - "code":"46", + "code":"57", "des":"Kubernetes APIs use the HTTP header \"Content-Type\" to distinguish between patch request method operations.Currently, three types of patch request method operations are su", "doc_type":"api2", "kw":"Patch Request Method Operation Description,Appendix,API Reference", @@ -869,8 +1022,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Patch Request Method Operation Description", @@ -880,7 +1032,7 @@ "uri":"cce_02_0086.html", "node_id":"cce_02_0086.xml", "product_code":"cce", - "code":"47", + "code":"58", "des":"This section provides examples of Merge Patch and Strategic Merge Patch method operations.By way of example, Merge Patch and Strategic Merge Patch method operations are p", "doc_type":"api2", "kw":"Patch Request Method Operation Example,Appendix,API Reference", @@ -888,8 +1040,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Patch Request Method Operation Example", @@ -899,7 +1050,7 @@ "uri":"cce_02_0084.html", "node_id":"cce_02_0084.xml", "product_code":"cce", - "code":"48", + "code":"59", "des":"Table 1 describes the status codes.", "doc_type":"api2", "kw":"Status Code,Appendix,API Reference", @@ -907,8 +1058,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Status Code", @@ -918,7 +1068,7 @@ "uri":"cce_02_0250.html", "node_id":"cce_02_0250.xml", "product_code":"cce", - "code":"49", + "code":"60", "des":"If an error occurs in API calling, no result is returned. Identify the cause based on the error code of each API. If an error occurs in API calling, HTTP status code 4xx ", "doc_type":"api2", "kw":"Error Codes,Appendix,API Reference", @@ -926,8 +1076,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Error Codes", @@ -937,7 +1086,7 @@ "uri":"cce_02_0341.html", "node_id":"cce_02_0341.xml", "product_code":"cce", - "code":"50", + "code":"61", "des":"You can obtain the project ID by calling the API used to query project information based on the specified criteria.The API used to obtain a project ID is GET https://{End", "doc_type":"api2", "kw":"Obtaining a Project ID,Appendix,API Reference", @@ -945,8 +1094,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Obtaining a Project ID", @@ -956,7 +1104,7 @@ "uri":"cce_02_0342.html", "node_id":"cce_02_0342.xml", "product_code":"cce", - "code":"51", + "code":"62", "des":"An account ID is required for some URLs when an API is called. To obtain an account ID, perform the following operations:On the My Credentials page, view account IDs in t", "doc_type":"api2", "kw":"Obtaining the Account ID,Appendix,API Reference", @@ -964,8 +1112,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Obtaining the Account ID", @@ -975,7 +1122,7 @@ "uri":"cce_02_0271.html", "node_id":"cce_02_0271.xml", "product_code":"cce", - "code":"52", + "code":"63", "des":"If you are using Google Chrome, press F12. On the pane displayed on the right, click the Network tab. Enter jobs in the Filter text box to filter the job list. Select a j", "doc_type":"api2", "kw":"How to Obtain Parameters in the API URI,Appendix,API Reference", @@ -983,8 +1130,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"How to Obtain Parameters in the API URI", @@ -994,7 +1140,7 @@ "uri":"cce_02_0272.html", "node_id":"cce_02_0272.xml", "product_code":"cce", - "code":"53", + "code":"64", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api2", "kw":"API Permissions,Appendix,API Reference", @@ -1002,8 +1148,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"API Permissions", @@ -1013,7 +1158,7 @@ "uri":"cce_02_0100.html", "node_id":"cce_02_0100.xml", "product_code":"cce", - "code":"54", + "code":"65", "des":"To provide a secure and isolated network environment for CCE, create a VPC before creating a cluster.If you have already created a VPC, you do not need to create it again", "doc_type":"api2", "kw":"Creating a VPC and Subnet,Appendix,API Reference", @@ -1021,8 +1166,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Creating a VPC and Subnet", @@ -1032,7 +1176,7 @@ "uri":"cce_02_0101.html", "node_id":"cce_02_0101.xml", "product_code":"cce", - "code":"55", + "code":"66", "des":"Create a key pair before you create a container cluster. Key pairs are used for user identity authentication upon login to a node.If you have already created a key pair, ", "doc_type":"api2", "kw":"Creating a Key Pair,Appendix,API Reference", @@ -1040,8 +1184,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Creating a Key Pair", @@ -1051,7 +1194,7 @@ "uri":"cce_02_0368.html", "node_id":"cce_02_0368.xml", "product_code":"cce", - "code":"56", + "code":"67", "des":"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 flavor", "doc_type":"api2", "kw":"Node Flavor Description,Appendix,API Reference", @@ -1059,8 +1202,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Node Flavor Description", @@ -1070,7 +1212,7 @@ "uri":"node_storage_example.html", "node_id":"node_storage_example.xml", "product_code":"cce", - "code":"57", + "code":"68", "des":"In disk planning and striped logical disk creation, it is difficult for users to flexibly attach and partition disks when creating a node.During node creation, the storag", "doc_type":"api2", "kw":"Attaching Disks to a Node,Appendix,API Reference", @@ -1078,8 +1220,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Attaching Disks to a Node", @@ -1089,7 +1230,7 @@ "uri":"cce_02_0273.html", "node_id":"cce_02_0273.xml", "product_code":"cce", - "code":"58", + "code":"69", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api2", "kw":"Change History,API Reference", @@ -1097,8 +1238,7 @@ "metedata":[ { "documenttype":"api2", - "prodname":"cce", - "opensource":"true" + "prodname":"cce" } ], "title":"Change History", diff --git a/docs/cce/api-ref/AddNode.html b/docs/cce/api-ref/AddNode.html index 72a8f51b..b8e979e1 100644 --- a/docs/cce/api-ref/AddNode.html +++ b/docs/cce/api-ref/AddNode.html @@ -526,6 +526,7 @@

String

EVS disk type.

+

metadataEncrypted

diff --git a/docs/cce/api-ref/CLASS.TXT.json b/docs/cce/api-ref/CLASS.TXT.json index e79f2bb7..04a1708b 100644 --- a/docs/cce/api-ref/CLASS.TXT.json +++ b/docs/cce/api-ref/CLASS.TXT.json @@ -368,6 +368,105 @@ "p_code":"40", "code":"41" }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"cce", + "title":"Add-on Instance Parameters", + "uri":"cce_02_0366.html", + "doc_type":"api2", + "p_code":"2", + "code":"42" + }, + { + "desc":"CoreDNS is a DNS server that uses chain plug-ins to provide domain name resolution services for Kubernetes clusters. It is the recommended DNS server solution by the Kube", + "product_code":"cce", + "title":"CoreDNS", + "uri":"cce_02_0407.html", + "doc_type":"api2", + "p_code":"42", + "code":"43" + }, + { + "desc":"The CCE Container Storage (Everest) add-on uses the Container Storage Interface (CSI) to link Kubernetes clusters with cloud storage services.", + "product_code":"cce", + "title":"CCE Container Storage (Everest)", + "uri":"cce_02_0408.html", + "doc_type":"api2", + "p_code":"42", + "code":"44" + }, + { + "desc":"CCE Node Problem Detector (node-problem-detector, NPD) is an add-on that monitors abnormal events of cluster nodes and connects to a third-party monitoring platform. It i", + "product_code":"cce", + "title":"CCE Node Problem Detector", + "uri":"cce_02_0409.html", + "doc_type":"api2", + "p_code":"42", + "code":"45" + }, + { + "desc":"The CCE Cluster Autoscaler (autoscaler) add-on enables node pools to be scaled in or out.", + "product_code":"cce", + "title":"CCE Cluster Autoscaler", + "uri":"cce_02_0411.html", + "doc_type":"api2", + "p_code":"42", + "code":"46" + }, + { + "desc":"The NGINX Ingress Controller add-on can automatically modify configurations when there are changes to pods in Services. This add-on uses Nginx's excellent stability, perf", + "product_code":"cce", + "title":"NGINX Ingress Controller", + "uri":"cce_02_0412.html", + "doc_type":"api2", + "p_code":"42", + "code":"47" + }, + { + "desc":"From version 1.8 onwards, Kubernetes provides resource usage metrics, such as the container CPU and memory usage, through the Metrics API. These metrics can be directly a", + "product_code":"cce", + "title":"Kubernetes Metrics Server", + "uri":"cce_02_0413.html", + "doc_type":"api2", + "p_code":"42", + "code":"48" + }, + { + "desc":"CCE Advanced HPA (cce-hpa-controller) is an in-house add-on, which can be used to flexibly scale in or out Deployments based on metrics such as CPU usage and memory usage", + "product_code":"cce", + "title":"CCE Advanced HPA", + "uri":"cce_02_0414.html", + "doc_type":"api2", + "p_code":"42", + "code":"49" + }, + { + "desc":"CCE AI Suite (NVIDIA GPU) is a device management add-on that supports GPUs in containers. To use GPU nodes in a cluster, this add-on must be installed.", + "product_code":"cce", + "title":"CCE AI Suite (NVIDIA GPU)", + "uri":"cce_02_0415.html", + "doc_type":"api2", + "p_code":"42", + "code":"50" + }, + { + "desc":"Volcano is a batch scheduling platform based on Kubernetes. It provides a series of features required by machine learning, deep learning, bioinformatics, genomics, and ot", + "product_code":"cce", + "title":"Volcano Scheduler", + "uri":"cce_02_0417.html", + "doc_type":"api2", + "p_code":"42", + "code":"51" + }, + { + "desc":"The Cluster Native Cluster Monitoring add-on (kube-prometheus-stack) uses Prometheus-operator and Prometheus to provide easy-to-use, end-to-end Kubernetes cluster monitor", + "product_code":"cce", + "title":"Cloud Native Cluster Monitoring", + "uri":"cce_02_0421.html", + "doc_type":"api2", + "p_code":"42", + "code":"52" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"cce", @@ -375,7 +474,7 @@ "uri":"cce_02_0340.html", "doc_type":"api2", "p_code":"", - "code":"42" + "code":"53" }, { "desc":"Kubernetes APIs are resource-based (RESTful) programming interfaces provided through HTTP. It supports query, creation, update, and deletion of various cluster resources ", @@ -383,8 +482,8 @@ "title":"Overview", "uri":"kubernetesapi.html", "doc_type":"api2", - "p_code":"42", - "code":"43" + "p_code":"53", + "code":"54" }, { "desc":"This chapter describes fine-grained permissions management for your CCE. If your cloud account does not need individual IAM users, then you may skip over this chapter.A p", @@ -393,7 +492,7 @@ "uri":"cce_02_0327.html", "doc_type":"api2", "p_code":"", - "code":"44" + "code":"55" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -402,7 +501,7 @@ "uri":"cce_02_0083.html", "doc_type":"api2", "p_code":"", - "code":"45" + "code":"56" }, { "desc":"Kubernetes APIs use the HTTP header \"Content-Type\" to distinguish between patch request method operations.Currently, three types of patch request method operations are su", @@ -410,8 +509,8 @@ "title":"Patch Request Method Operation Description", "uri":"cce_02_0085.html", "doc_type":"api2", - "p_code":"45", - "code":"46" + "p_code":"56", + "code":"57" }, { "desc":"This section provides examples of Merge Patch and Strategic Merge Patch method operations.By way of example, Merge Patch and Strategic Merge Patch method operations are p", @@ -419,8 +518,8 @@ "title":"Patch Request Method Operation Example", "uri":"cce_02_0086.html", "doc_type":"api2", - "p_code":"45", - "code":"47" + "p_code":"56", + "code":"58" }, { "desc":"Table 1 describes the status codes.", @@ -428,8 +527,8 @@ "title":"Status Code", "uri":"cce_02_0084.html", "doc_type":"api2", - "p_code":"45", - "code":"48" + "p_code":"56", + "code":"59" }, { "desc":"If an error occurs in API calling, no result is returned. Identify the cause based on the error code of each API. If an error occurs in API calling, HTTP status code 4xx ", @@ -437,8 +536,8 @@ "title":"Error Codes", "uri":"cce_02_0250.html", "doc_type":"api2", - "p_code":"45", - "code":"49" + "p_code":"56", + "code":"60" }, { "desc":"You can obtain the project ID by calling the API used to query project information based on the specified criteria.The API used to obtain a project ID is GET https://{End", @@ -446,8 +545,8 @@ "title":"Obtaining a Project ID", "uri":"cce_02_0341.html", "doc_type":"api2", - "p_code":"45", - "code":"50" + "p_code":"56", + "code":"61" }, { "desc":"An account ID is required for some URLs when an API is called. To obtain an account ID, perform the following operations:On the My Credentials page, view account IDs in t", @@ -455,8 +554,8 @@ "title":"Obtaining the Account ID", "uri":"cce_02_0342.html", "doc_type":"api2", - "p_code":"45", - "code":"51" + "p_code":"56", + "code":"62" }, { "desc":"If you are using Google Chrome, press F12. On the pane displayed on the right, click the Network tab. Enter jobs in the Filter text box to filter the job list. Select a j", @@ -464,8 +563,8 @@ "title":"How to Obtain Parameters in the API URI", "uri":"cce_02_0271.html", "doc_type":"api2", - "p_code":"45", - "code":"52" + "p_code":"56", + "code":"63" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -473,8 +572,8 @@ "title":"API Permissions", "uri":"cce_02_0272.html", "doc_type":"api2", - "p_code":"45", - "code":"53" + "p_code":"56", + "code":"64" }, { "desc":"To provide a secure and isolated network environment for CCE, create a VPC before creating a cluster.If you have already created a VPC, you do not need to create it again", @@ -482,8 +581,8 @@ "title":"Creating a VPC and Subnet", "uri":"cce_02_0100.html", "doc_type":"api2", - "p_code":"45", - "code":"54" + "p_code":"56", + "code":"65" }, { "desc":"Create a key pair before you create a container cluster. Key pairs are used for user identity authentication upon login to a node.If you have already created a key pair, ", @@ -491,8 +590,8 @@ "title":"Creating a Key Pair", "uri":"cce_02_0101.html", "doc_type":"api2", - "p_code":"45", - "code":"55" + "p_code":"56", + "code":"66" }, { "desc":"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 flavor", @@ -500,8 +599,8 @@ "title":"Node Flavor Description", "uri":"cce_02_0368.html", "doc_type":"api2", - "p_code":"45", - "code":"56" + "p_code":"56", + "code":"67" }, { "desc":"In disk planning and striped logical disk creation, it is difficult for users to flexibly attach and partition disks when creating a node.During node creation, the storag", @@ -509,8 +608,8 @@ "title":"Attaching Disks to a Node", "uri":"node_storage_example.html", "doc_type":"api2", - "p_code":"45", - "code":"57" + "p_code":"56", + "code":"68" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -519,6 +618,6 @@ "uri":"cce_02_0273.html", "doc_type":"api2", "p_code":"", - "code":"58" + "code":"69" } ] \ No newline at end of file diff --git a/docs/cce/api-ref/ResetNode.html b/docs/cce/api-ref/ResetNode.html index f0e1a56f..b9a1a1e2 100644 --- a/docs/cce/api-ref/ResetNode.html +++ b/docs/cce/api-ref/ResetNode.html @@ -523,7 +523,8 @@

String

-

EVS disk type. Currently, SSD, GPSSD and SAS are supported.

+

EVS disk type.

+

metadataEncrypted

diff --git a/docs/cce/api-ref/cce_02_0103.html b/docs/cce/api-ref/cce_02_0103.html index 96f8f17d..927c51d6 100644 --- a/docs/cce/api-ref/cce_02_0103.html +++ b/docs/cce/api-ref/cce_02_0103.html @@ -12,6 +12,8 @@ + diff --git a/docs/cce/api-ref/cce_02_0242.html b/docs/cce/api-ref/cce_02_0242.html index c2b94917..e5284af1 100644 --- a/docs/cce/api-ref/cce_02_0242.html +++ b/docs/cce/api-ref/cce_02_0242.html @@ -632,7 +632,7 @@

String

Disk type. For details, see the description of root_volume in Creating an ECS.

- +

size

@@ -959,6 +959,7 @@

String

EVS disk type.

+

metadataEncrypted

@@ -1903,7 +1904,8 @@

String

-

EVS disk type. Currently, SSD, GPSSD and SAS are supported.

+

EVS disk type.

+

metadataEncrypted

diff --git a/docs/cce/api-ref/cce_02_0243.html b/docs/cce/api-ref/cce_02_0243.html index 54f6a218..48da2167 100644 --- a/docs/cce/api-ref/cce_02_0243.html +++ b/docs/cce/api-ref/cce_02_0243.html @@ -673,7 +673,8 @@

String

-

EVS disk type. Currently, SSD, GPSSD and SAS are supported.

+

EVS disk type.

+

metadataEncrypted

diff --git a/docs/cce/api-ref/cce_02_0269.html b/docs/cce/api-ref/cce_02_0269.html index c5824e8e..304e94ce 100644 --- a/docs/cce/api-ref/cce_02_0269.html +++ b/docs/cce/api-ref/cce_02_0269.html @@ -514,7 +514,7 @@

String

Disk type. For details about possible values, see the description of the root_volume parameter in the API used to create an ECS in the ECS API reference.

- +

extendParam

@@ -1004,7 +1004,8 @@

String

-

EVS disk type. Currently, SSD, GPSSD and SAS are supported.

+

EVS disk type.

+

metadataEncrypted

diff --git a/docs/cce/api-ref/cce_02_0273.html b/docs/cce/api-ref/cce_02_0273.html index d003ae64..a1701401 100644 --- a/docs/cce/api-ref/cce_02_0273.html +++ b/docs/cce/api-ref/cce_02_0273.html @@ -8,7 +8,25 @@ -

2024-08-30

+

2024-11-25

+ +

Add:

+

Added NGINX Ingress Controller.

+

Update:

+

Updated Volcano Scheduler.

+

Updated the values field in Installing an Add-on Instance and Updating an Add-on Instance. Added some hyperlink to the "Add-on Instance Parameters".

+

Updated the volumetype field in Creating a Node , Reading a Specified Node , Accepting a Node , Resetting a Node , Creating a Node Pool , Querying a Specified Node Pool , Listing All Node Pools in a Specified Cluster and Deleting a Node Pool.

+ + +

2024-10-23

+ +

Add:

+

Added Add-on Instance Parameters.

+

Update:

+

Updated Node Flavor Description.

+ + +

2024-08-30

Added the publicAccess field in Creating a Cluster and Reading a Specified Cluster.

diff --git a/docs/cce/api-ref/cce_02_0322.html b/docs/cce/api-ref/cce_02_0322.html index c869b93d..ea028562 100644 --- a/docs/cce/api-ref/cce_02_0322.html +++ b/docs/cce/api-ref/cce_02_0322.html @@ -154,7 +154,7 @@

Object

-

Add-on template installation parameters (varying depending on the add-on). During the add-on upgrade, you need to specify all the installation parameters. If the parameters are not specified, the default values in the add-on template are used. The current add-on installation parameters can be obtained through the API for querying add-on instances.

+

Add-on template installation parameters (varying depending on the add-on). During the add-on upgrade, you need to specify all the installation parameters. If the parameters are not specified, the default values in the add-on template are used. The current add-on installation parameters can be obtained through the API for querying add-on instances. For details, see Add-on Instance Parameters.

diff --git a/docs/cce/api-ref/cce_02_0323.html b/docs/cce/api-ref/cce_02_0323.html index 9695c191..9fc6c822 100644 --- a/docs/cce/api-ref/cce_02_0323.html +++ b/docs/cce/api-ref/cce_02_0323.html @@ -187,7 +187,7 @@

Object

-

Add-on template installation parameters (varying depending on the add-on). During the add-on upgrade, you need to specify all the installation parameters. If the parameters are not specified, the default values in the add-on template are used. The current add-on installation parameters can be obtained through the API for querying add-on instances.

+

Add-on template installation parameters (varying depending on the add-on). During the add-on upgrade, you need to specify all the installation parameters. If the parameters are not specified, the default values in the add-on template are used. The current add-on installation parameters can be obtained through the API for querying add-on instances. For details, see Add-on Instance Parameters.

diff --git a/docs/cce/api-ref/cce_02_0354.html b/docs/cce/api-ref/cce_02_0354.html index 67b28d71..37447242 100644 --- a/docs/cce/api-ref/cce_02_0354.html +++ b/docs/cce/api-ref/cce_02_0354.html @@ -465,7 +465,7 @@

String

Disk type. For details, see the description of root_volume in Creating an ECS.

- +

size

@@ -1054,6 +1054,7 @@

String

EVS disk type.

+

metadataEncrypted

diff --git a/docs/cce/api-ref/cce_02_0355.html b/docs/cce/api-ref/cce_02_0355.html index e2eb17b9..1faf8824 100644 --- a/docs/cce/api-ref/cce_02_0355.html +++ b/docs/cce/api-ref/cce_02_0355.html @@ -502,7 +502,7 @@

String

Disk type. For details, see the description of root_volume in Creating an ECS.

- +

size

@@ -997,7 +997,8 @@

String

-

EVS disk type. Currently, SSD, GPSSD and SAS are supported.

+

EVS disk type.

+

metadataEncrypted

diff --git a/docs/cce/api-ref/cce_02_0357.html b/docs/cce/api-ref/cce_02_0357.html index 3d9e1758..2db3d5ef 100644 --- a/docs/cce/api-ref/cce_02_0357.html +++ b/docs/cce/api-ref/cce_02_0357.html @@ -454,7 +454,7 @@

String

Disk type. For details about possible values, see the description of the root_volume parameter in the API used to create an ECS in the ECS API reference.

- +

extendParam

@@ -944,7 +944,8 @@

String

-

EVS disk type. Currently, SSD, GPSSD and SAS are supported.

+

EVS disk type.

+

metadataEncrypted

diff --git a/docs/cce/api-ref/cce_02_0366.html b/docs/cce/api-ref/cce_02_0366.html new file mode 100644 index 00000000..cf358195 --- /dev/null +++ b/docs/cce/api-ref/cce_02_0366.html @@ -0,0 +1,33 @@ + + +

Add-on Instance Parameters

+
+
+ + + +
+ diff --git a/docs/cce/api-ref/cce_02_0368.html b/docs/cce/api-ref/cce_02_0368.html index 6e074f85..a361ea31 100644 --- a/docs/cce/api-ref/cce_02_0368.html +++ b/docs/cce/api-ref/cce_02_0368.html @@ -14,17 +14,17 @@

General computing-plus

-

c4, c3

+

c4, c3, c7n

General-purpose

-

s3, s2

+

s3, s2, s7n

Memory-optimized

-

m4, m3

+

m4, m3, m7n

Disk-intensive

@@ -34,7 +34,7 @@

GPU-accelerated

-

pi2, p2s, g6, and p2v

+

pi2, p3, p2v, p2s, g6, and g7

@@ -51,7 +51,22 @@

General computing-plus

-

c3n

+

c3n, c7n, c4ne

+ + +

General computing

+ +

s7n

+ + +

Memory-optimized

+ +

m7n, m3n

+ + +

GPU-accelerated

+ +

g7

Container-plus

diff --git a/docs/cce/api-ref/cce_02_0407.html b/docs/cce/api-ref/cce_02_0407.html new file mode 100644 index 00000000..3a11c4c0 --- /dev/null +++ b/docs/cce/api-ref/cce_02_0407.html @@ -0,0 +1,457 @@ + + +

CoreDNS

+

Add-on Overview

CoreDNS is a DNS server that uses chain plug-ins to provide domain name resolution services for Kubernetes clusters. It is the recommended DNS server solution by the Kubernetes community.

+
+

Add-on Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

basic

+

No

+

object

+

Basic configuration parameters, which do not need to be specified

+

flavor

+

Yes

+

Table 2 object

+

Flavor parameters

+

custom

+

Yes

+

Table 3 object

+

Custom parameters

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Configuration of flavor

Parameter

+

Mandatory

+

Type

+

Description

+

replicas

+

Yes

+

int

+

Number of pods. The default value is 2.

+

resources

+

Yes

+

Array of resources object

+

Container resource (CPU and memory) quotas

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Configuration of custom

Parameter

+

Mandatory

+

Type

+

Description

+

servers

+

No

+

object

+

Configuration of servers

+

stub_domains

+

No

+

Map<String>[]string

+

Stub domain configuration

+

multiAZEnable

+

No

+

bool

+

Whether to enable the forcible mode of multi-AZ deployment for the deployment component. The default value is false. Deployment pods of the add-on will be forcibly scheduled to nodes in different AZs. If there are fewer AZs than pods, the extra pods will fail to run. If both multiAZEnable and multiAZBalance are set to true, the settings of multiAZBalance take effect, which means, the equivalent mode of multi-AZ deployment is used.

+

multiAZBalance

+

No

+

bool

+

Whether to enable the equivalent mode of multi-AZ deployment for the deployment component. The default value is false. Deployment pods of the add-on are evenly scheduled to the nodes in the cluster in each AZ. If a new AZ is added, it is recommended that you increase add-on pods for cross-AZ HA deployment. With the equivalent multi-AZ deployment, the difference between the number of add-on pods in different AZs will be less than or equal to 1. If resources in one of the AZs are insufficient, pods cannot be scheduled to that AZ.

+

tolerations

+

No

+

Array of Table 5

+

Toleration configuration

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Data structure of the resources field

Parameter

+

Mandatory

+

Type

+

Description

+

limitsCpu

+

Yes

+

String

+

CPU size limit (unit: m)

+

limitsMem

+

Yes

+

String

+

Memory size limit (unit: Mi)

+

name

+

Yes

+

String

+

Add-on name. The value is fixed at coredns.

+

requestsCpu

+

Yes

+

String

+

Requested CPU size (unit: m)

+

requestsMem

+

Yes

+

String

+

Requested memory size (unit: Mi)

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Taints and tolerations

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Taint key

+

effect

+

No

+

String

+

Taint policy

+

operator

+

No

+

String

+

Operator

+

tolerationSeconds

+

No

+

Int

+

Toleration time window

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 Configuration of server

Parameter

+

Mandatory

+

Type

+

Description

+

port

+

No

+

Int

+

Domain port number. The default value is 5353.

+

zones

+

No

+

Array of Table 8

+

Domain configuration

+

plugins

+

No

+

Array of Table 7

+

Configuration of plugin

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 Configuration of plugin

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Plugin name

+

configBlock

+

No

+

String

+

Configuration of plugin

+

parameters

+

No

+

String/Int

+

Extended parameters of the plugin

+
+
+ +
+ + + + + + + + + + + +
Table 8 Configuration of zone

Parameter

+

Mandatory

+

Type

+

Description

+

zone

+

Yes

+

String

+

Domain value. The default value is ".".

+
+
+
+

Example Request

{
+	"kind": "Addon",
+	"apiVersion": "v3",
+	"metadata": {
+		"annotations": {
+			"addon.install/type": "install"
+		}
+	},
+	"spec": {
+		"clusterID": "2292498e-******-0255ac1001ba",
+		"version": "1.29.2",
+		"addonTemplateName": "coredns",
+		"values": {
+                        "basic": {
+				"basickey":"val"
+			},
+			"flavor": {
+				"replicas": 2,
+				"resources": [{
+					"limitsCpu": "2000m",
+					"limitsMem": "2000Mi",
+					"name": "coredns",
+					"requestsCpu": "2000m",
+					"requestsMem": "2000Mi"
+				}]
+			},
+			"custom": {
+				"multiAZBalance": false,
+				"multiAZEnabled": false,
+				"node_match_expressions": [],
+				"servers": [{
+					"plugins": [{
+						"name": "bind",
+						"parameters": "{$POD_IP}"
+					},
+					{
+						"configBlock": "servfail 5s",
+						"name": "cache",
+						"parameters": 30
+					},
+					{
+						"name": "errors"
+					},
+					{
+						"name": "health",
+						"parameters": "{$POD_IP}:8080"
+					},
+					{
+						"name": "ready",
+						"parameters": "{$POD_IP}:8081"
+					},
+					{
+						"configBlock": "pods insecure\nfallthrough in-addr.arpa ip6.arpa",
+						"name": "kubernetes",
+						"parameters": "cluster.local in-addr.arpa ip6.arpa"
+					},
+					{
+						"name": "loadbalance",
+						"parameters": "round_robin"
+					},
+					{
+						"name": "prometheus",
+						"parameters": "{$POD_IP}:9153"
+					},
+					{
+						"configBlock": "policy random",
+						"name": "forward",
+						"parameters": ". /etc/resolv.conf"
+					},
+					{
+						"name": "reload"
+					}],
+					"port": 5353,
+					"zones": [{
+						"zone": "."
+					}]
+				}],
+				"stub_domains": {
+					
+				},
+				"tolerations": [{
+					"key": "node.kubernetes.io/not-ready",
+					"operator": "Exists",
+					"effect": "NoExecute",
+					"tolerationSeconds": 60
+				},
+				{
+					"key": "node.kubernetes.io/unreachable",
+					"operator": "Exists",
+					"effect": "NoExecute",
+					"tolerationSeconds": 60
+				}]
+			}
+		}
+	}
+}
+
+
+
+
+ +
+ diff --git a/docs/cce/api-ref/cce_02_0408.html b/docs/cce/api-ref/cce_02_0408.html new file mode 100644 index 00000000..740a1aba --- /dev/null +++ b/docs/cce/api-ref/cce_02_0408.html @@ -0,0 +1,502 @@ + + +

CCE Container Storage (Everest)

+

Add-on Overview

The CCE Container Storage (Everest) add-on uses the Container Storage Interface (CSI) to link Kubernetes clusters with cloud storage services.

+
+

Add-on Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

basic

+

No

+

object

+

Basic configuration parameters, which do not need to be specified

+

flavor

+

Yes

+

Table 2 object

+

Flavor parameters

+

custom

+

Yes

+

Table 3 object

+

Custom parameters

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Configuration of flavor

Parameter

+

Mandatory

+

Type

+

Description

+

description

+

No

+

String

+

Add-on description

+

name

+

Yes

+

String

+

Add-on specification name

+

replicas

+

Yes

+

String

+

Number of pods. The default value is 1.

+

resources

+

Yes

+

resources object

+

Container resource (CPU and memory) quotas

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Configuration of custom

Parameter

+

Mandatory

+

Type

+

Description

+

default_vpc_id

+

Yes

+

String

+

+

VPC ID

+

cluster_id

+

Yes

+

String

+

Cluster ID

+

cluster_name

+

Yes

+

String

+

Cluster name

+

project_id

+

Yes

+

String

+

Project ID

+

disable_auto_mount_secret

+

No

+

bool

+

Whether to allow the default AK/SK to be used during OBS volume mounting

+

Default value: false

+

+

over_subscription

+

No

+

String

+

Local PV overcommitment ratio

+

Default value: 80

+

csi_attacher_detach_worker_threads

+

No

+

String

+

The number of concurrent workers for detaching volumes

+

Default value: 60

+

volume_attaching_flow_ctrl

+

No

+

String

+

Attaching flow control data

+

Default value: 0.

+

number_of_reserved_disks

+

No

+

String

+

Disk attaching capability reserved for non-container scenarios

+

Default value: 6

+

flow_control

+

No

+

Map<String>string

+

Flow control parameter

+

Default value: {}

+

enable_node_attacher

+

No

+

bool

+

Whether to start agent attacher

+

Default value: false

+

multiAZEnabled

+

No

+

bool

+

Whether to enable the forcible mode of multi-AZ deployment for the deployment component. The default value is false. Deployment pods of the add-on will be forcibly scheduled to nodes in different AZs. If there are fewer AZs than pods, the extra pods will fail to run. If both multiAZEnable and multiAZBalance are set to true, the settings of multiAZBalance take effect, which means, the equivalent mode of multi-AZ deployment is used.

+

+

multiAZBalance

+

No

+

bool

+

Whether to enable the equivalent mode of multi-AZ deployment for the deployment component. The default value is false. Deployment pods of the add-on are evenly scheduled to the nodes in the cluster in each AZ. If a new AZ is added, it is recommended that you increase add-on pods for cross-AZ HA deployment. With the equivalent multi-AZ deployment, the difference between the number of add-on pods in different AZs will be less than or equal to 1. If resources in one of the AZs are insufficient, pods cannot be scheduled to that AZ.

+

+

tolerations

+

No

+

Array of Table 5

+

Toleration configuration

+

node_match_expressions

+

No

+

Array of Table 6

+

Add-on pod affinity configuration

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Data structure of the resources field

Parameter

+

Mandatory

+

Type

+

Description

+

limitsCpu

+

Yes

+

String

+

CPU size limit (unit: m)

+

limitsMem

+

Yes

+

String

+

Memory size limit (unit: Mi)

+

name

+

Yes

+

String

+

Add-on name. The value is fixed at everest-csi-controller or everest-csi-driver.

+

requestsCpu

+

Yes

+

String

+

Requested CPU size (unit: m)

+

requestsMem

+

Yes

+

String

+

Requested memory size (unit: Mi)

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Taints and tolerations

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Taint key

+

effect

+

No

+

String

+

Taint policy

+

operator

+

No

+

String

+

Operator

+

tolerationSeconds

+

No

+

Int

+

Toleration time window

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 nodeMatchExpresssion node affinity

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Taint key

+

values

+

No

+

List<String>

+

Node affinity name

+

operator

+

No

+

String

+

Operator

+
+
+
+

Example Request

{
+  "kind": "Addon",
+  "apiVersion": "v3",
+  "metadata": { "annotations": { "addon.install/type": "install" } },
+  "spec": {
+    "clusterID": "cea63ae5-df9b-11ee-9f27-0255ac1001b2",
+    "version": "2.4.4",
+    "addonTemplateName": "everest",
+    "values": {
+      "basic": {
+        "bms_url": "bms.***.com",
+        "driver_init_image_version": "2.4.4",
+        "ecsEndpoint": "https://ecs.***.com",
+        "everest_image_version": "2.4.4",
+        "evs_url": "evs.***.com",
+        "iam_url": "iam.***.com",
+        "ims_url": "ims.***.com",
+        "obs_url": "obs.***.com",
+        "platform": "linux-amd64",
+        "sfs30_url": "obs.***.com",
+        "sfs_turbo_url": "sfs-turbo.***.com",
+        "sfs_url": "sfs.***.com",
+        "supportHcs": false,
+        "swr_addr": "swr.***.com",
+        "swr_user": "hwofficial",
+        "rbac_enabled": true,
+        "cluster_version": "v1.23"
+      },
+      "flavor": {
+        "description": "High avaiable",
+        "is_default": true,
+        "name": "HA50",
+        "recommend_cluster_flavor_types": ["small"],
+        "replicas": 2,
+        "resources": [
+          {
+            "limitsCpu": "250m",
+            "limitsMem": "600Mi",
+            "name": "everest-csi-controller",
+            "requestsCpu": "250m",
+            "requestsMem": "600Mi"
+          },
+          {
+            "limitsCpu": "300m",
+            "limitsMem": "300Mi",
+            "name": "everest-csi-driver",
+            "requestsCpu": "300m",
+            "requestsMem": "300Mi"
+          }
+        ],
+        "category": ["CCE", "Turbo"]
+      },
+      "custom": {
+        "annotations": {},
+        "cluster_id": "",
+        "cluster_name": "",
+        "csi_attacher_detach_worker_threads": "60",
+        "csi_attacher_worker_threads": "60",
+        "default_vpc_id": "",
+        "disable_auto_mount_secret": false,
+        "enable_node_attacher": false,
+        "flow_control": {},
+        "multiAZBalance": false,
+        "multiAZEnabled": false,
+        "node_match_expressions": [],
+        "number_of_reserved_disks": "6",
+        "over_subscription": "80",
+        "project_id": "",
+        "tolerations": [
+          {
+            "key": "node.kubernetes.io/not-ready",
+            "operator": "Exists",
+            "effect": "NoExecute",
+            "tolerationSeconds": 60
+          },
+          {
+            "key": "node.kubernetes.io/unreachable",
+            "operator": "Exists",
+            "effect": "NoExecute",
+            "tolerationSeconds": 60
+          }
+        ],
+        "volume_attaching_flow_ctrl": "0"
+      }
+    }
+  }
+}
+
+
+
+ +
+ diff --git a/docs/cce/api-ref/cce_02_0409.html b/docs/cce/api-ref/cce_02_0409.html new file mode 100644 index 00000000..e93b5b61 --- /dev/null +++ b/docs/cce/api-ref/cce_02_0409.html @@ -0,0 +1,420 @@ + + +

CCE Node Problem Detector

+

Add-on Overview

CCE Node Problem Detector (node-problem-detector, NPD) is an add-on that monitors abnormal events of cluster nodes and connects to a third-party monitoring platform. It is a daemon running on each node. It collects node issues from different daemons and reports them to the API server. It can run as a DaemonSet or a daemon.

+
+

Add-on Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

basic

+

No

+

object

+

Basic configuration parameters, which do not need to be specified

+

flavor

+

Yes

+

Table 2 object

+

Flavor parameters

+

custom

+

Yes

+

Table 3 object

+

Custom parameters

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Configuration of flavor

Parameter

+

Mandatory

+

Type

+

Description

+

description

+

No

+

String

+

Add-on description

+

name

+

Yes

+

String

+

Add-on specification name. The value is fixed at Single-instance.

+

replicas

+

Yes

+

String

+

Number of pods. The default value is 1.

+

resources

+

Yes

+

resources object

+

Container resource (CPU and memory) quotas

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Configuration of custom

Parameter

+

Mandatory

+

Type

+

Description

+

feature_gate

+

No

+

String

+

Feature gate, which is used to enable the beta features

+

multiAZBalance

+

No

+

Bool

+

Multi AZ deployment

+

multiAZEnabled

+

No

+

Bool

+

Whether to deploy the add-on pods in multiple AZs. The default value is false. If this parameter is set to true, cross-AZ deployment is forcibly performed. If this parameter is set to false, cross-AZ deployment is preferred.

+

npc

+

Yes

+

object Table 5

+

node-problem-controller configuration

+

tolerations

+

No

+

List<Object> Table 7

+

Tolerations of the add-on

+

node_match_expressions

+

No

+

List<Object> Table 7

+

Node affinity configuration of the add-on

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Data structure of the resources field

Parameter

+

Mandatory

+

Type

+

Description

+

limitsCpu

+

Yes

+

String

+

CPU size limit (unit: m)

+

limitsMem

+

Yes

+

String

+

Memory size limit (unit: Mi)

+

name

+

Yes

+

String

+

Add-on name. The value is fixed at custom-resources.

+

requestsCpu

+

Yes

+

String

+

Requested CPU size (unit: m)

+

requestsMem

+

Yes

+

String

+

Requested memory size (unit: Mi)

+
+
+ +
+ + + + + + + + + + + +
Table 5 Data structure of the npc field

Parameter

+

Mandatory

+

Type

+

Description

+

maxTaintedNode

+

Yes

+

String or Int

+

The maximum number of nodes that NPC can add taints to when a single fault occurs on multiple nodes for minimizing impact.

+

The value can be in int or percentage format.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 Taints and tolerations

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Taint key

+

effect

+

No

+

String

+

Taint policy

+

operator

+

No

+

String

+

Operator

+

tolerationSeconds

+

No

+

Int

+

Toleration time window

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 nodeMatchExpresssion node affinity

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Taint key

+

values

+

No

+

List<String>

+

Node affinity name

+

operator

+

No

+

String

+

Operator

+
+
+
+

Example Request

{
+  "kind": "Addon",
+  "apiVersion": "v3",
+  "metadata": {
+    "annotations": {
+      "addon.install/type": "install"
+    }
+  },
+  "spec": {
+    "clusterID": "b78fb690-b82c-11ee-83cf-0255ac100b0f",
+    "version": "1.18.48",
+    "addonTemplateName": "npd",
+    "values": {
+      "basic": {
+        "image_version": "1.18.48",
+        "swr_addr": "***",
+        "swr_user": "***",
+        "rbac_enabled": true,
+        "cluster_version": "v1.23"
+      },
+      "flavor": {
+        "description": "custom resources",
+        "name": "custom-resources",
+        "replicas": 2,
+        "resources": [
+          {
+            "limitsCpu": "100m",
+            "limitsMem": "300Mi",
+            "name": "node-problem-controller",
+            "requestsCpu": "30m",
+            "requestsMem": "100Mi"
+          },
+          {
+            "limitsCpu": "100m",
+            "limitsMem": "300Mi",
+            "name": "node-problem-detector",
+            "requestsCpu": "30m",
+            "requestsMem": "100Mi"
+          }
+        ],
+        "category": [
+          "CCE",
+          "Turbo"
+        ]
+      },
+      "custom": {
+        "annotations": {},
+        "common": {},
+        "feature_gates": "",
+        "multiAZBalance": false,
+        "multiAZEnabled": false,
+        "node_match_expressions": [],
+        "npc": {
+          "maxTaintedNode": "10%"
+        },
+        "tolerations": [
+          {
+            "key": "node.kubernetes.io/not-ready",
+            "operator": "Exists",
+            "effect": "NoExecute",
+            "tolerationSeconds": 60
+          },
+          {
+            "key": "node.kubernetes.io/unreachable",
+            "operator": "Exists",
+            "effect": "NoExecute",
+            "tolerationSeconds": 60
+          }
+        ]
+      }
+    }
+  }
+}
+
+
+
+ +
+ diff --git a/docs/cce/api-ref/cce_02_0411.html b/docs/cce/api-ref/cce_02_0411.html new file mode 100644 index 00000000..94821f32 --- /dev/null +++ b/docs/cce/api-ref/cce_02_0411.html @@ -0,0 +1,505 @@ + + +

CCE Cluster Autoscaler

+

Add-on Overview

The CCE Cluster Autoscaler (autoscaler) add-on enables node pools to be scaled in or out.

+
+

Add-on Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

basic

+

No

+

object

+

Basic configuration parameters, which do not need to be specified

+

flavor

+

Yes

+

Table 2 object

+

Flavor parameters

+

custom

+

Yes

+

Table 3 object

+

Custom parameters

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 flavor

Parameter

+

Mandatory

+

Type

+

Description

+

replicas

+

Yes

+

String

+

Number of pods. The default value is 2.

+

resources

+

Yes

+

Array of resources object

+

Container resource (CPU and memory) quotas

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 custom

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_id

+

Yes

+

string

+

Cluster ID.

+

tenant_id

+

Yes

+

string

+

ID of the project where the current cluster is in.

+

scaleDownEnabled

+

No

+

bool

+

Whether to enable auto scale-in. The default value is false.

+

scaleDownDelayAfterAdd

+

No

+

int

+

Cooldown period (in minutes) for starting scale-in evaluation again after auto scale-out was triggered in a cluster. The default value is 10.

+

scaleDownDelayAfterDelete

+

No

+

int

+

Cooldown period (in minutes) for starting scale-in evaluation again after auto scale-in was triggered in a cluster. The default value is 10.

+

scaleDownDelayAfterFailure

+

No

+

int

+

Cooldown period (in minutes) for starting scale-in evaluation again after auto scale-in triggered by a cluster failed. The default value is 10.

+

maxEmptyBulkDeleteFlag

+

No

+

int

+

Number of idle nodes that can be concurrently scaled in. The default value is 10.

+

unremovableNodeRecheckTimeout

+

No

+

int

+

Interval (in minutes) for starting the checks again after a node is determined not to be scaled in. The default value is 5.

+

scaleDownUtilizationThreshold

+

No

+

double

+

CPU and memory usage thresholds for determining whether a node can be scaled in. The default value is 0.5.

+

maxNodesTotal

+

No

+

int

+

Maximum number of nodes that can be added to a cluster. The default value is 1000.

+

coresTotal

+

No

+

int

+

Maximum number of CPU cores that can be added to a cluster. The default value is 32000.

+

memoryTotal

+

No

+

int

+

Memory upper limit (in Gi) for cluster scale-out. The default value is 128000.

+

scaleUpUtilizationEnabled

+

No

+

bool

+

Whether to enable custom scaling. The default value is true.

+

scaleUpUnscheduledPodEnabled

+

No

+

bool

+

Whether to enable automatic scale-out for unscheduled pods. The default value is true.

+

ignoreDaemonSetsUtilization

+

No

+

bool

+

Whether to ignore DaemonSets' resource usage when thresholds determine if scale-in is performed. The default value is false.

+

skipNodesWithCustomControllerPods

+

No

+

bool

+

Scale-in is not performed on the node which has containers created by a third-party controller running on it. The default value is true.

+

logLevel

+

No

+

int

+

Log level. The default value is 4.

+

multiAZEnable

+

No

+

bool

+

Whether to enable the forcible mode of multi-AZ deployment for the deployment component. The default value is false. Deployment pods of the add-on will be forcibly scheduled to nodes in different AZs. If there are fewer AZs than pods, the extra pods will fail to run. If both multiAZEnable and multiAZBalance are set to true, the settings of multiAZBalance take effect, which means, the equivalent mode of multi-AZ deployment is used.

+

multiAZBalance

+

No

+

bool

+

Whether to enable the equivalent mode of multi-AZ deployment for the deployment component. The default value is false. Deployment pods of the add-on are evenly scheduled to the nodes in the cluster in each AZ. If a new AZ is added, it is recommended that you increase add-on pods for cross-AZ HA deployment. With the equivalent multi-AZ deployment, the difference between the number of add-on pods in different AZs will be less than or equal to 1. If resources in one of the AZs are insufficient, pods cannot be scheduled to that AZ.

+

tolerations

+

No

+

Array of Table 5

+

Toleration configuration

+

node_match_expressions

+

No

+

Array of Table 6

+

Add-on pod affinity configuration

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Data structure of the resources field

Parameter

+

Mandatory

+

Type

+

Description

+

limitsCpu

+

Yes

+

String

+

CPU size limit (unit: m)

+

limitsMem

+

Yes

+

String

+

Memory size limit (unit: Mi)

+

name

+

Yes

+

String

+

Add-on name. The value is fixed at autoscaler.

+

requestsCpu

+

Yes

+

String

+

Requested CPU size (unit: m)

+

requestsMem

+

Yes

+

String

+

Requested memory size (unit: Mi)

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Taints and tolerations

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Taint key

+

effect

+

No

+

String

+

Taint policy

+

operator

+

No

+

String

+

Operator

+

tolerationSeconds

+

No

+

Int

+

Toleration time window

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 nodeMatchExpresssion node affinity

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Taint key

+

values

+

No

+

List<String>

+

Node affinity name

+

operator

+

No

+

String

+

Operator

+
+
+
+

Example Request

{
+	"kind": "Addon",
+	"apiVersion": "v3",
+	"metadata": {
+		"annotations": {
+			"addon.install/type": "install"
+		}
+	},
+	"spec": {
+		"clusterID": "2292498e-*******-0255ac1001ba",
+		"version": "1.23.116",
+		"addonTemplateName": "autoscaler",
+		"values": {
+                        "basic": {
+				"basickey":"val"
+			},
+			"flavor": {
+				"replicas": 2,
+				"resources": [{
+					"limitsCpu": "1000m",
+					"limitsMem": "1000Mi",
+					"name": "autoscaler",
+					"requestsCpu": "1000m",
+					"requestsMem": "1000Mi"
+				}]
+			},
+			"custom": {
+				"cluster_id": "2292498e-*******-0255ac1001ba",
+				"coresTotal": 32000,
+				"ignoreDaemonSetsUtilization": false,
+				"logLevel": 4,
+				"maxEmptyBulkDeleteFlag": 10,
+				"maxNodeProvisionTime": 15,
+				"maxNodesTotal": 1000,
+				"memoryTotal": 128000,
+				"multiAZBalance": false,
+				"multiAZEnabled": false,
+				"node_match_expressions": [],
+				"scaleDownDelayAfterAdd": 10,
+				"scaleDownDelayAfterDelete": 10,
+				"scaleDownDelayAfterFailure": 3,
+				"scaleDownEnabled": false,
+				"scaleDownUnneededTime": 10,
+				"scaleDownUtilizationThreshold": 0.5,
+				"scaleUpUnscheduledPodEnabled": true,
+				"scaleUpUtilizationEnabled": true,
+				"skipNodesWithCustomControllerPods": true,
+				"tenant_id": "*****************",
+				"tolerations": [{
+					"key": "node.kubernetes.io/not-ready",
+					"operator": "Exists",
+					"effect": "NoExecute",
+					"tolerationSeconds": 60
+				},
+				{
+					"key": "node.kubernetes.io/unreachable",
+					"operator": "Exists",
+					"effect": "NoExecute",
+					"tolerationSeconds": 60
+				}],
+				"unremovableNodeRecheckTimeout": 5
+			}
+		}
+	}
+}
+
+
+
+ +
+ diff --git a/docs/cce/api-ref/cce_02_0412.html b/docs/cce/api-ref/cce_02_0412.html new file mode 100644 index 00000000..e2bacf81 --- /dev/null +++ b/docs/cce/api-ref/cce_02_0412.html @@ -0,0 +1,534 @@ + + +

NGINX Ingress Controller

+

Add-on Overview

The NGINX Ingress Controller add-on can automatically modify configurations when there are changes to pods in Services. This add-on uses Nginx's excellent stability, performance, and concurrent processing ability to effectively manage containerized applications at the application layer.

+
+

Add-on Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

basic

+

No

+

object

+

Basic configuration parameters, which do not need to be specified

+

flavor

+

Yes

+

Table 2 object

+

Flavor parameters

+

custom

+

Yes

+

Table 3 object

+

Custom parameters

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 flavor

Parameter

+

Mandatory

+

Type

+

Description

+

replicas

+

Yes

+

String

+

Number of pods. The default value is 1.

+

resources

+

Yes

+

resources object

+

Container resource (CPU and memory) quotas

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 custom

Parameter

+

Mandatory

+

Type

+

Description

+

ingressClass

+

Yes

+

String

+

Controller name. The default value is nginx.

+

namespace

+

Yes

+

String

+

Namespace where the add-on is in. The default value is kube-system.

+

service

+

Yes

+

Table 8

+

Configuration of a Service that provides external access

+

config

+

No

+

Map<String>String

+

Nginx configuration parameters. For details, see ConfigMaps.

+

admissionWebhooks

+

No

+

Table 7

+

Configuration of ingress admission verification.

+

metrics

+

No

+

Table 9

+

Monitoring metric configuration.

+

defaultBackendService

+

No

+

String

+

Default 404 service, which is in the format of <namespace>/<service_name>.

+

extraArgs

+

No

+

Table 10

+

Extended parameter configuration.

+

multiAZEnable

+

No

+

bool

+

Whether to enable the forcible mode of multi-AZ deployment for the deployment component. The default value is false. Deployment pods of the add-on will be forcibly scheduled to nodes in different AZs. If there are fewer AZs than pods, the extra pods will fail to run. If both multiAZEnable and multiAZBalance are set to true, the settings of multiAZBalance take effect, which means, the equivalent mode of multi-AZ deployment is used.

+

multiAZBalance

+

No

+

bool

+

Whether to enable the equivalent mode of multi-AZ deployment for the deployment component. The default value is false. Deployment pods of the add-on are evenly scheduled to the nodes in the cluster in each AZ. If a new AZ is added, it is recommended that you increase add-on pods for cross-AZ HA deployment. With the equivalent multi-AZ deployment, the difference between the number of add-on pods in different AZs will be less than or equal to 1. If resources in one of the AZs are insufficient, pods cannot be scheduled to that AZ.

+

tolerations

+

No

+

Array of Table 5

+

Toleration configuration

+

node_match_expressions

+

No

+

Array of Table 6

+

Add-on pod affinity configuration

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Data structure of the resources field

Parameter

+

Mandatory

+

Type

+

Description

+

limitsCpu

+

Yes

+

String

+

CPU size limit (unit: m)

+

limitsMem

+

Yes

+

String

+

Memory size limit (unit: Mi)

+

name

+

Yes

+

String

+

Add-on name. The value is fixed at nginx-ingress.

+

requestsCpu

+

Yes

+

String

+

Requested CPU size (unit: m)

+

requestsMem

+

Yes

+

String

+

Requested memory size (unit: Mi)

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Taints and tolerations

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Taint key

+

effect

+

No

+

String

+

Taint policy

+

operator

+

No

+

String

+

Operator

+

tolerationSeconds

+

No

+

Int

+

Toleration time window

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 nodeMatchExpresssion node affinity

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Taint key

+

values

+

No

+

List<String>

+

Node affinity name

+

operator

+

No

+

String

+

Operator

+
+
+ +
+ + + + + + + + + + + +
Table 7 admissionWebhook

Parameter

+

Mandatory

+

Type

+

Description

+

enable

+

No

+

bool

+

Whether to enable ingress resource admission verification. The default value is true.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 8 service

Parameter

+

Mandatory

+

Type

+

Description

+

annotations

+

No

+

Map<String>String

+

Annotations of a Service that provides external access. This parameter is only for configurations of ELB-related options, such as kubernetes.io/elb.class, kubernetes.io/elb.id, and kubernetes.io/elb.pass-through.

+

loadBalancerIP

+

No

+

String

+

Load balancer IP address used by the Service that is interconnected with the load balancer.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 9 metrics

Parameter

+

Mandatory

+

Type

+

Description

+

enable

+

No

+

bool

+

Whether to monitor metrics. The default value is true.

+

excludeSocketMetrics

+

No

+

String

+

Shielded monitoring metrics. The default value is "nginx_ingress_controller_success,nginx_ingress_controller_header_duration_seconds,nginx_ingress_controller_ingress_upstream_latency_seconds".

+
+
+ +
+ + + + + + + + + + + +
Table 10 extraArg extended parameter

Parameter

+

Mandatory

+

Type

+

Description

+

default-ssl-certificat

+

No

+

String

+

Default certificate configuration. For details, see Default SSL Certificate.

+
+
+
+

Example Request

{
+	"kind": "Addon",
+	"apiVersion": "v3",
+	"metadata": {
+		"annotations": {
+			"addon.install/type": "install"
+		}
+	},
+	"spec": {
+		"clusterID": "2292498e-**************ac1001ba",
+		"version": "2.2.52",
+		"addonTemplateName": "nginx-ingress",
+		"values": {
+                        "basic": {
+				"basickey":"val"
+			},
+			"flavor": {
+				"replicas": 2,
+				"resources": [{
+					"limitsCpu": "8000m",
+					"limitsMem": "4000Mi",
+					"name": "nginx-ingress",
+					"requestsCpu": "8000m",
+					"requestsMem": "4000Mi"
+				}]
+			},
+			"custom": {
+				"config": {
+					"keep-alive-requests": "100"
+				},
+				"defaultBackend": {
+					"enabled": true
+				},
+				"defaultBackendService": "",
+				"extraArgs": {
+					"default-ssl-certificate": ""
+				},
+				"ingressClass": "nginx",
+				"multiAZBalance": false,
+				"multiAZEnabled": false,
+				"namespace": "kube-system",
+				"node_match_expressions": [],
+				"service": {
+					"annotations": {
+						"kubernetes.io/elb.class": "performance",
+						"kubernetes.io/elb.id": "8d6bd485-d8ac-4693-815d-9d54d79b0666"
+					},
+					"loadBalancerIP": ""
+				},
+				"tolerations": [{
+					"key": "node.kubernetes.io/not-ready",
+					"operator": "Exists",
+					"effect": "NoExecute",
+					"tolerationSeconds": 60
+				},
+				{
+					"key": "node.kubernetes.io/unreachable",
+					"operator": "Exists",
+					"effect": "NoExecute",
+					"tolerationSeconds": 60
+				}]
+			}
+		}
+	}
+}
+
+
+
+ +
+ diff --git a/docs/cce/api-ref/cce_02_0413.html b/docs/cce/api-ref/cce_02_0413.html new file mode 100644 index 00000000..225a4648 --- /dev/null +++ b/docs/cce/api-ref/cce_02_0413.html @@ -0,0 +1,369 @@ + + +

Kubernetes Metrics Server

+

Add-on Overview

From version 1.8 onwards, Kubernetes provides resource usage metrics, such as the container CPU and memory usage, through the Metrics API. These metrics can be directly accessed by users (for example, by using the kubectl top command) or used by controllers (for example, Horizontal Pod Autoscaler) in a cluster for decision-making. The specific component is metrics-server, which is used to substitute for Heapster for providing the similar functions. Heapster has been gradually abandoned since v1.11.

+
+

Add-on Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

basic

+

No

+

object

+

Basic configuration parameters, which do not need to be specified

+

flavor

+

Yes

+

Table 2 object

+

Flavor parameters

+

custom

+

Yes

+

Table 3 object

+

Custom parameters

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 flavor

Parameter

+

Mandatory

+

Type

+

Description

+

description

+

No

+

String

+

Add-on description

+

name

+

Yes

+

String

+

Add-on specification name. The value is fixed at Single-instance.

+

replicas

+

Yes

+

String

+

Number of pods. The default value is 1.

+

resources

+

Yes

+

resources object

+

Container resource (CPU and memory) quotas

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 custom

Parameter

+

Mandatory

+

Type

+

Description

+

multiAZBalance

+

No

+

Bool

+

Whether the equivalent mode of multi-AZ deployment is enabled. If this function is enabled, the equivalent mode is used.

+

multiAZEnabled

+

No

+

Bool

+

Whether to deploy the add-on pods in multiple AZs. The default value is false. If this parameter is set to true, cross-AZ deployment is forcibly performed. If this parameter is set to false, cross-AZ deployment is preferred.

+

tolerations

+

No

+

+

List<Object> Table 6

+

Tolerations of the add-on

+

node_match_expressions

+

No

+

List<Object> Table 6

+

Node affinity configuration of the add-on

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Data structure of the resources field

Parameter

+

Mandatory

+

Type

+

Description

+

limitsCpu

+

Yes

+

String

+

CPU size limit (unit: m)

+

limitsMem

+

Yes

+

String

+

Memory size limit (unit: Mi)

+

+

name

+

Yes

+

String

+

Add-on name. The value is fixed at metrics-server.

+

requestsCpu

+

Yes

+

String

+

Requested CPU size (unit: m)

+

requestsMem

+

Yes

+

String

+

Requested memory size (unit: Mi)

+

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Taints and tolerations

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Taint key

+

effect

+

No

+

String

+

Taint policy

+

operator

+

No

+

String

+

Operator

+

tolerationSeconds

+

No

+

Int

+

Toleration time window

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 nodeMatchExpresssion node affinity

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Taint key

+

values

+

No

+

List<String>

+

Node affinity name

+

operator

+

No

+

String

+

Operator

+
+
+
+

Example Request

{
+  "kind": "Addon",
+  "apiVersion": "v3",
+  "metadata": {
+    "annotations": {
+      "addon.install/type": "install"
+    }
+  },
+  "spec": {
+    "clusterID": "b78fb690-b82c-11ee-83cf-0255ac100b0f",
+    "version": "1.3.39",
+    "addonTemplateName": "metrics-server",
+    "values": {
+      "basic": {
+        "image_version": "v0.6.2",
+        "swr_addr": "***",
+        "swr_user": "***",
+        "rbac_enabled": true,
+        "cluster_version": "v1.23"
+      },
+      "flavor": {
+        "description": "Has only one instance",
+        "name": "Single",
+        "replicas": 1,
+        "resources": [
+          {
+            "limitsCpu": "1000m",
+            "limitsMem": "1000Mi",
+            "name": "metrics-server",
+            "requestsCpu": "100m",
+            "requestsMem": "300Mi"
+          }
+        ],
+        "category": [
+          "CCE",
+          "Turbo"
+        ]
+      },
+      "custom": {
+        "annotations": {},
+        "multiAZBalance": false,
+        "multiAZEnabled": false,
+        "node_match_expressions": [],
+        "tolerations": [
+          {
+            "key": "node.kubernetes.io/not-ready",
+            "operator": "Exists",
+            "effect": "NoExecute",
+            "tolerationSeconds": 60
+          },
+          {
+            "key": "node.kubernetes.io/unreachable",
+            "operator": "Exists",
+            "effect": "NoExecute",
+            "tolerationSeconds": 60
+          }
+        ]
+      }
+    }
+  }
+}
+
+
+
+ +
+ diff --git a/docs/cce/api-ref/cce_02_0414.html b/docs/cce/api-ref/cce_02_0414.html new file mode 100644 index 00000000..4496ff49 --- /dev/null +++ b/docs/cce/api-ref/cce_02_0414.html @@ -0,0 +1,333 @@ + + +

CCE Advanced HPA

+

Add-on Overview

CCE Advanced HPA (cce-hpa-controller) is an in-house add-on, which can be used to flexibly scale in or out Deployments based on metrics such as CPU usage and memory usage.

+
+

Add-on Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

basic

+

No

+

object

+

Basic configuration parameters, which do not need to be specified

+

flavor

+

Yes

+

Table 2 object

+

Flavor parameters

+

custom

+

Yes

+

Table 3 object

+

Custom parameters

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 flavor

Parameter

+

Mandatory

+

Type

+

Description

+

replicas

+

Yes

+

String

+

Number of pods. The default value is 2.

+

resources

+

Yes

+

resources object

+

Container resource (CPU and memory) quotas.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 custom

Parameter

+

Mandatory

+

Type

+

Description

+

multiAZEnable

+

No

+

bool

+

Whether to enable the forcible mode of multi-AZ deployment for the deployment component. The default value is false. Deployment pods of the add-on will be forcibly scheduled to nodes in different AZs. If there are fewer AZs than pods, the extra pods will fail to run. If both multiAZEnable and multiAZBalance are set to true, the settings of multiAZBalance take effect, which means, the equivalent mode of multi-AZ deployment is used.

+

multiAZBalance

+

No

+

bool

+

Whether to enable the equivalent mode of multi-AZ deployment for the deployment component. The default value is false. Deployment pods of the add-on are evenly scheduled to the nodes in the cluster in each AZ. If a new AZ is added, it is recommended that you increase add-on pods for cross-AZ HA deployment. With the equivalent multi-AZ deployment, the difference between the number of add-on pods in different AZs will be less than or equal to 1. If resources in one of the AZs are insufficient, pods cannot be scheduled to that AZ.

+

tolerations

+

No

+

Array of Table 5

+

Toleration configuration

+

node_match_expressions

+

No

+

Array of Table 6

+

Add-on pod affinity configuration

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Data structure of the resources field

Parameter

+

Mandatory

+

Type

+

Description

+

limitsCpu

+

Yes

+

String

+

CPU size limit (unit: m)

+

limitsMem

+

Yes

+

String

+

Memory size limit (unit: Mi)

+

name

+

Yes

+

String

+

Add-on name. The value is fixed at customedhpa-controller.

+

requestsCpu

+

Yes

+

String

+

Requested CPU size (unit: m)

+

requestsMem

+

Yes

+

String

+

Requested memory size (unit: Mi)

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Taints and tolerations

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Taint key

+

effect

+

No

+

String

+

Taint policy

+

operator

+

No

+

String

+

Operator

+

tolerationSeconds

+

No

+

Int

+

Toleration time window

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 nodeMatchExpresssion node affinity

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Taint key

+

values

+

No

+

List<String>

+

Node affinity name

+

operator

+

No

+

String

+

Operator

+
+
+
+

Example Request

{
+	"kind": "Addon",
+	"apiVersion": "v3",
+	"metadata": {
+		"annotations": {
+			"addon.install/type": "install"
+		}
+	},
+	"spec": {
+		"clusterID": "2292498e-******-0255ac1001ba",
+		"version": "1.4.2",
+		"addonTemplateName": "cce-hpa-controller",
+		"values": {
+                        "basic": {
+				"basickey":"val"
+			},
+			"flavor": {
+				"replicas": 1,
+				"resources": [{
+					"limitsCpu": "100m",
+					"limitsMem": "300Mi",
+					"name": "customedhpa-controller",
+					"requestsCpu": "100m",
+					"requestsMem": "300Mi"
+				}]
+			},
+			"custom": {
+				"multiAZBalance": false,
+				"multiAZEnabled": false,
+				"node_match_expressions": [],
+				"tolerations": [{
+					"key": "node.kubernetes.io/not-ready",
+					"operator": "Exists",
+					"effect": "NoExecute",
+					"tolerationSeconds": 60
+				},
+				{
+					"key": "node.kubernetes.io/unreachable",
+					"operator": "Exists",
+					"effect": "NoExecute",
+					"tolerationSeconds": 60
+				}]
+			}
+		}
+	}
+}
+
+
+
+ +
+ diff --git a/docs/cce/api-ref/cce_02_0415.html b/docs/cce/api-ref/cce_02_0415.html new file mode 100644 index 00000000..93d82206 --- /dev/null +++ b/docs/cce/api-ref/cce_02_0415.html @@ -0,0 +1,341 @@ + + +

CCE AI Suite (NVIDIA GPU)

+

Add-on Overview

CCE AI Suite (NVIDIA GPU) is a device management add-on that supports GPUs in containers. To use GPU nodes in a cluster, this add-on must be installed.

+
+

Add-on Parameters

+
+ + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

basic

+

Yes

+

object

+

Basic add-on configuration parameters

+

custom

+

Yes

+

Table 3 object

+

Custom parameters

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Configuration of basic

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_version

+

No

+

String

+

CCE cluster version

+

device_version

+

Yes

+

String

+

Add-on version

+

driver_version

+

Yes

+

String

+

Image tag of an add-on pod where a driver is installed. Generally, the value is the same as that of device_version.

+

obs_url

+

Yes

+

String

+

When a GPU driver is downloaded from the default driver address, the value is the GPU driver address.

+

swr_addr

+

Yes

+

String

+

Image repository address

+

swr_user

+

Yes

+

String

+

Tenant path of an image repository

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Configuration of custom

Parameter

+

Mandatory

+

Type

+

Description

+

compatible_with_legacy_api

+

No

+

Bool

+

API compatibility switch

+

Default value: false

+

true: The add-on supports the GPU native mode and xGPU virtualization.

+

component_schedulername

+

Yes

+

String

+

Name of the scheduler used by the add-on.

+

Default value: default-scheduler

+

disable_mount_path_v1

+

No

+

Bool

+

Default value: false

+

true: /opt/cloud/cce/nvidia is not mounted to the /usr/lib/nvidia directory of a GPU container.

+

disable_nvidia_gsp

+

No

+

Bool

+

Default value: true

+

true: The GPU GSP firmware is disabled.

+

driver_mount_paths

+

No

+

String

+

Driver file directory that needs to be automatically mounted to a GPU container

+

Default value: "bin,lib64"

+

enable_fault_isolation

+

No

+

Bool

+

Default value: true

+

true: The add-on detects hardware faults or driver issues of a GPU and then sets the GPU to be unavailable.

+

enable_health_monitoring

+

No

+

Bool

+

Default value: true

+

true: The add-on detects hardware faults or driver issues of a GPU.

+

enable_metrics_monitoring

+

No

+

Bool

+

Default value: true

+

true: The add-on collects GPU metrics and reports these metrics to Prometheus.

+

enable_simple_lib64_mount

+

No

+

Bool

+

Default value: true

+

true: Only the libxxx.so.x file is mounted to a container.

+

enable_xgpu

+

No

+

Bool

+

Default value: false

+

Whether to enable xGPU virtualization.

+

gpu_driver_config

+

No

+

Map

+

Configurations of the GPU driver for a single node pool

+

Default value: {}

+

health_check_xids_v2

+

No

+

String

+

GPU error range for the add-on health checks

+

Default value: "74,79"

+

inject_ld_Library_path

+

No

+

String

+

Value of the LD_LIBRARY_PATH environment variable automatically injected by the add-on to a GPU container

+

Default value: ""

+

lib64_container_paths

+

No

+

String

+

Mount path of NVIDIA lib64 in a GPU container

+

Default value: "/usr/lib64,/usr/lib/x86_64-linux-gnu"

+

metrics_delete_interval

+

No

+

int

+

Timeout threshold for deleting a metric when the metric cannot be obtained. The unit is millisecond.

+

Default value: 30000

+

metrics_monitor_interval

+

No

+

int

+

Interval for obtaining metrics, in milliseconds.

+

Default value: 15000

+

nvidia_driver_download_url

+

Yes

+

String

+

Path for downloading the NVIDIA driver

+

Default value: ""

+
+
+
+

Example Request

{
+  "kind": "Addon",
+  "apiVersion": "v3",
+  "metadata": {
+    "name": "gpu-beta",
+  },
+  "spec": {
+    "clusterID": "80c9e306-***-***-***-0255ac100043",
+    "version": "2.0.69",
+    "addonTemplateName": "gpu-beta",
+    "values": {
+      "basic": {
+        "cluster_version": "v1.27",
+        "device_version": "2.0.69",
+        "driver_version": "2.0.69",
+        "obs_url": "***",
+        "region": "***",
+        "swr_addr": "***",
+        "swr_user": "***"
+      },
+      "custom": {
+        "compatible_with_legacy_api": true,
+        "component_schedulername": "kube-scheduler",
+        "disable_mount_path_v1": false,
+        "disable_nvidia_gsp": true,
+        "driver_mount_paths": "bin,lib64",
+        "enable_fault_isolation": true,
+        "enable_health_monitoring": true,
+        "enable_metrics_monitoring": true,
+        "enable_simple_lib64_mount": true,
+        "enable_xgpu": true,
+        "gpu_driver_config": {},
+        "health_check_xids_v2": "74,79",
+        "inject_ld_Library_path": "",
+        "lib64_container_paths": "/usr/lib64,/usr/lib/x86_64-linux-gnu",
+        "metrics_delete_interval": 30000,
+        "metrics_monitor_interval": 15000,
+        "nvidia_driver_download_url": ""
+      },
+    }
+  }
+}
+
+
+
+ +
+ diff --git a/docs/cce/api-ref/cce_02_0417.html b/docs/cce/api-ref/cce_02_0417.html new file mode 100644 index 00000000..588022f5 --- /dev/null +++ b/docs/cce/api-ref/cce_02_0417.html @@ -0,0 +1,536 @@ + + +

Volcano Scheduler

+

Add-on Overview

Volcano is a batch scheduling platform based on Kubernetes. It provides a series of features required by machine learning, deep learning, bioinformatics, genomics, and other big data applications, as a powerful supplement to Kubernetes capabilities.

+
+

Add-on Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

basic

+

No

+

Table 2 object

+

Basic configuration parameters, which do not need to be specified

+

flavor

+

Yes

+

Table 3 object

+

Flavor parameters

+

custom

+

Yes

+

Table 4 object

+

Custom parameters

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Configuration of basic

Parameter

+

Mandatory

+

Type

+

Description

+

swr_addr

+

Yes

+

String

+

Add-on download address, which does not need to be specified

+

swr_user

+

Yes

+

String

+

User who can download the add-on. This parameter does not need to be specified.

+

platform

+

Yes

+

String

+

Add-on platform, which does not need to be specified

+

escEndpoint

+

Yes

+

String

+

ECS address, which does not need to be specified

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Configuration of flavor

Parameter

+

Mandatory

+

Type

+

Description

+

description

+

No

+

String

+

Add-on description

+

name

+

Yes

+

String

+

Add-on specification name. The value is fixed at Single-instance.

+

replicas

+

Yes

+

String

+

Number of pods. The default value is 1.

+

resources

+

Yes

+

resources object

+

Container resource (CPU and memory) quotas

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Configuration of custom

Parameter

+

Mandatory

+

Type

+

Description

+

multiAZEnabled

+

No

+

Bool

+

Whether multi-AZ deployment is enabled

+

true: The Volcano Scheduler pods are deployed based on anti-affinity.

+

node_match_expressions

+

No

+

Array of Table 7

+

Expression for matching the Volcano Scheduler pods to nodes

+

tolerations

+

No

+

Array of Table 6

+

The format is the same as that of Kubernetes tolerations. It is used to add taints to Volcano Scheduler pod pods.

+

oversubscription_ratio

+

No

+

int

+

Node resource overcommitment ratio in the Volcano scheduling environment

+

descheduler_enable

+

No

+

Bool

+

Whether to support rescheduling

+

enable_workload_balancer

+

No

+

Bool

+

Whether load balancers are supported

+

default_scheduler_conf

+

Yes

+

yaml

+

The format is the same as that of Volcano configuration YAML.

+

deschedulerPolicy

+

No

+

yaml

+

The format is the same as that of the volcano descheduling configuration YAML.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Data structure of the resources field

Parameter

+

Mandatory

+

Type

+

Description

+

limitsCpu

+

Yes

+

String

+

CPU size limit (unit: m)

+

Default value: 250m

+

limitsMem

+

Yes

+

String

+

Memory size limit (unit: Mi)

+

Default value: 512Mi

+

name

+

Yes

+

String

+

Add-on name. The value is fixed at virtual-kubelet.

+

requestsCpu

+

Yes

+

String

+

Requested CPU size (unit: m)

+

Default value: 250m

+

requestsMem

+

Yes

+

String

+

Requested memory size (unit: Mi)

+

Default value: 512Mi

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 Taints and tolerations

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Taint key

+

effect

+

No

+

String

+

Taint policy

+

operator

+

No

+

String

+

Operator

+

tolerationSeconds

+

No

+

Int

+

Toleration time window

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 nodeMatchExpresssion node affinity

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Taint key

+

values

+

No

+

List<String>

+

Node affinity name

+

operator

+

No

+

String

+

Operator

+
+
+
+

Example Request

{
+	"kind": "Addon",
+	"apiVersion": "v3",
+	"metadata": {
+		"annotations": {
+			"addon.install/type": "install"
+		}
+	},
+	"spec": {
+		"clusterID": "2292498e-d169-******-0255ac1001ba",
+		"version": "1.12.14",
+		"addonTemplateName": "volcano",
+		"values": {
+                        "basic": {
+				"swr_addr":"x.x.x.x:20202",
+                                "swr_user":"hwofficial",
+                                "platform":"linux-amd64",
+                                "ecsEndpoint":"x.x.x.x"
+			},
+			"flavor": {
+				"resources": [{
+					"limitsCpu": "500m",
+					"limitsMem": "500Mi",
+					"name": "volcano-scheduler",
+					"requestsCpu": "2000m",
+					"requestsMem": "2000Mi"
+				},
+				{
+					"limitsCpu": "500m",
+					"limitsMem": "500Mi",
+					"name": "volcano-controller",
+					"requestsCpu": "2000m",
+					"requestsMem": "2000Mi"
+				},
+				{
+					"limitsCpu": "200m",
+					"limitsMem": "500Mi",
+					"name": "volcano-admission",
+					"requestsCpu": "500m",
+					"requestsMem": "500Mi"
+				},
+				{
+					"limitsCpu": "100m",
+					"limitsMem": "150Mi",
+					"name": "volcano-agent",
+					"requestsCpu": "200m",
+					"requestsMem": "200Mi"
+				},
+				{
+					"limitsCpu": "50m",
+					"limitsMem": "50Mi",
+					"name": "volcano-exporter",
+					"requestsCpu": "100m",
+					"requestsMem": "100Mi"
+				},
+				{
+					"limitsCpu": "500m",
+					"limitsMem": "256Mi",
+					"name": "volcano-descheduler",
+					"requestsCpu": "1000m",
+					"requestsMem": "512Mi"
+				},
+				{
+					"limitsCpu": "300m",
+					"limitsMem": "300Mi",
+					"name": "volcano-recommender",
+					"requestsCpu": "500m",
+					"requestsMem": "500Mi"
+				},
+				{
+					"limitsCpu": "200m",
+					"limitsMem": "200Mi",
+					"name": "volcano-recommender-prometheus-adapter",
+					"requestsCpu": "300m",
+					"requestsMem": "300Mi"
+				}]
+			},
+			"custom": {
+				"default_scheduler_conf": {
+                                        "actions":"allocate,backfill,preempt",
+                                        "tiers": [{
+                                                "plugins": [{
+                                                        "name":"priority"
+                                                },
+                                                {
+                                                        "name":"conformance"
+                                                },
+                                                {
+                                                        "name":"gang",
+                                                        "enablePreemptable":"false",
+                                                        "enableJobStarving":"false",
+                                                }]
+                                        },
+                                        {
+                                                "plugins": [{
+                                                        "name":"predicates"
+                                                },
+                                                {
+                                                        "name":"nodeorder"
+                                                },
+                                                {
+                                                        "name":"drf",
+                                                        "enablePreemptable":"false",
+                                                }]
+                                        },
+                                        {
+                                                "plugins": [{
+                                                        "name":"cce-gpu-topology-predicate"
+                                                },
+                                                {
+                                                        "name":"cce-gpu-topology-priority"
+                                                },
+                                                {
+                                                        "name":"xgpu"
+                                                }]
+                                        },
+                                        {
+                                                "plugins": [{
+                                                        "name":"nodelocalvolume"
+                                                },
+                                                {
+                                                        "name":"nodeemptydirvolume"
+                                                },
+                                                {
+                                                        "name":"nodeCSIscheduling"
+                                                },
+                                                {
+                                                        "name":"networkresource"
+                                                }]
+                                        }],
+                                        "metrics":{
+                                                "type":"",
+                                                "interval":30s,
+                                        } 
+
+                                }
+			}
+		}
+	}
+}
+
+
+
+ +
+ diff --git a/docs/cce/api-ref/cce_02_0421.html b/docs/cce/api-ref/cce_02_0421.html new file mode 100644 index 00000000..785645de --- /dev/null +++ b/docs/cce/api-ref/cce_02_0421.html @@ -0,0 +1,418 @@ + + +

Cloud Native Cluster Monitoring

+

Add-on Overview

The Cluster Native Cluster Monitoring add-on (kube-prometheus-stack) uses Prometheus-operator and Prometheus to provide easy-to-use, end-to-end Kubernetes cluster monitoring.

+

This add-on enables monitoring data to connect to the monitoring center, so that you can view monitoring data and configure alarms on the console.

+
+

Add-on Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

basic

+

No

+

object

+

Basic configuration parameters, which do not need to be specified

+

flavor

+

Yes

+

Table 2 object

+

Flavor parameters

+

custom

+

Yes

+

Table 3 object

+

Custom parameters

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Configuration of flavor

Parameter

+

Mandatory

+

Type

+

Description

+

description

+

No

+

String

+

Add-on description

+

name

+

Yes

+

String

+

Add-on specification name

+

resources

+

Yes

+

resources object

+

Container resource (CPU and memory) quotas

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Configuration of custom

Parameter

+

Mandatory

+

Type

+

Description

+

aom_enable

+

No

+

Boolean

+

Whether to interconnect with AOM

+

aom_instance_id

+

No

+

String

+

AOM instance ID. This parameter is mandatory when AOM is interconnected with the cluster.

+

aom_project_id

+

No

+

String

+

ID of the project to which the AOM instance belongs. This parameter is mandatory when AOM is interconnected with the cluster.

+

aom_auth_type

+

No

+

String

+

Authentication type for interconnecting with AOM. This parameter is mandatory when AOM is interconnected with the cluster. The value is fixed at Bearer.

+

aom_app_key

+

No

+

String

+

app_key for interconnecting with AOM. This parameter is mandatory when AOM is interconnected with the cluster.

+

aom_app_secret

+

No

+

String

+

app_secret for interconnecting with AOM. This parameter is mandatory when AOM is interconnected with the cluster.

+

deploy_mode

+

Yes

+

String

+

Prometheus add-on model. The value can be agent or server. agent is recommended.

+

enablethird

+

No

+

Boolean

+

Whether to report metrics to the third-party monitoring system.

+

url_third

+

No

+

String

+

URL for the third-party monitoring system to report metrics.

+

basic_auth_username_third

+

No

+

String

+

Account for interconnecting with a third-party monitoring system (in the BasicAuth authentication mode)

+

basic_auth_password_third

+

No

+

String

+

Password for interconnecting with a third-party monitoring system (in the BasicAuth authentication mode)

+

bearer_token

+

No

+

String

+

Token for interconnecting with a third-party monitoring system (in the BearerToken authentication mode)

+

cluster

+

Yes

+

String

+

Cluster name

+

clusterId

+

Yes

+

String

+

Cluster ID

+

enable_custom_metrics

+

No

+

Boolean

+

Whether to enable custom metric collection. The default value is false.

+

highAvailability

+

No

+

Boolean

+

Whether HA is enabled. The default value is false.

+

scrapeInterval

+

Yes

+

String

+

Default metric collection period. The default value is 15s.

+

shards

+

No

+

Integer

+

Number of collected fragments. This parameter is valid only in the agent mode. The default value is 1.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Data structure of the resources field

Parameter

+

Mandatory

+

Type

+

Description

+

limitsCpu

+

Yes

+

String

+

CPU size limit (unit: m)

+

limitsMem

+

Yes

+

String

+

Memory size limit (unit: Mi)

+

name

+

Yes

+

String

+

Workload name

+

requestsCpu

+

Yes

+

String

+

Requested CPU size (unit: m)

+

requestsMem

+

Yes

+

String

+

Requested memory size (unit: Mi)

+
+
+
+

Example Request

{
+    "kind":"Addon",
+    "apiVersion":"v3",
+    "metadata":{
+        "annotations":{
+            "addon.install/type":"install"
+        }
+    },
+    "spec":{
+        "clusterID":"b889764e-c100-11ee-80cf-0255ac100b0f",
+        "version":"3.9.5",
+        "addonTemplateName":"cie-collector",
+        "values":{
+            "basic":{
+                "aom_endpoint":"https://***",
+                "aom_url":"https://***",
+                "region_id":"***",
+                "swr_addr":"***",
+                "swr_user":"***",
+                "rbac_enabled":true,
+                "cluster_version":"v1.27"
+            },
+            "flavor":{
+                "deploy_mode":"agent",
+                "description":"Default flavor for agent mode.",
+                "name":"Agent-Default",
+                "resources":[
+                    {
+                        "limitsCpu":"500m",
+                        "limitsMem":"500Mi",
+                        "name":"prometheusOperator",
+                        "requestsCpu":"100m",
+                        "requestsMem":"100Mi"
+                    },
+                    {
+                        "limitsCpu":"4",
+                        "limitsMem":"8Gi",
+                        "name":"prometheus",
+                        "requestsCpu":"500m",
+                        "requestsMem":"500Mi"
+                    },
+                    {
+                        "limitsCpu":"500m",
+                        "limitsMem":"500Mi",
+                        "name":"kubeStateMetrics",
+                        "requestsCpu":"200m",
+                        "requestsMem":"200Mi"
+                    },
+                    {
+                        "limitsCpu":"500m",
+                        "limitsMem":"1Gi",
+                        "name":"nodeExporter",
+                        "requestsCpu":"200m",
+                        "requestsMem":"100Mi"
+                    }
+                ],
+                "category":[
+                    "CCE",
+                    "Turbo"
+                ]
+            },
+            "custom":{
+                "aom_app_key":"******",
+                "aom_app_secret":"******",
+                "aom_auth_type":"Bearer",
+                "aom_enable":true,
+                "aom_instance_id":"a2bf5a6f-2c64-4a7f-a369-78dccd9cb6fd",
+                "aom_project_id":"b6315dd3d0ff4be5b31a963256794989",
+                "basic_auth_password_third":"",
+                "basic_auth_username_third":"",
+                "bearer_token":"",
+                "cluster":"test-cluster",
+                "clusterId":"b889764e-c100-11ee-80cf-0255ac100b0f",
+                "deploy_mode":"agent",
+                "enable_custom_metrics":true,
+                "enablethird":false,
+                "highAvailability":false,
+                "projectId":"b6315dd3d0ff4be5b31a963256794989",
+                "region":"***",
+                "scrapeInterval":"15s",
+                "shards":1,
+                "url_third":"",
+            }
+        }
+    }
+}
+
+
+
+ +
+