From ebc8247e230d5513ad35baf45b41449c6dc9afe7 Mon Sep 17 00:00:00 2001 From: qiujiandong1 Date: Wed, 5 Mar 2025 16:51:16 +0000 Subject: [PATCH] CCE API update 20250114 version Reviewed-by: Eotvos, Oliver Co-authored-by: qiujiandong1 Co-committed-by: qiujiandong1 --- docs/cce/api-ref/ALL_META.TXT.json | 326 +++++++++++-- docs/cce/api-ref/CLASS.TXT.json | 237 +++++++-- docs/cce/api-ref/CreateRelease.html | 457 ++++++++++++++++++ docs/cce/api-ref/DeleteChart.html | 220 +++++++++ docs/cce/api-ref/DeleteRelease.html | 261 ++++++++++ docs/cce/api-ref/DownloadChart.html | 122 +++++ docs/cce/api-ref/ListCharts.html | 216 +++++++++ docs/cce/api-ref/ListReleases.html | 296 ++++++++++++ docs/cce/api-ref/ShowChart.html | 220 +++++++++ docs/cce/api-ref/ShowChartValues.html | 138 ++++++ docs/cce/api-ref/ShowRelease.html | 263 ++++++++++ docs/cce/api-ref/ShowReleaseHistory.html | 282 +++++++++++ docs/cce/api-ref/ShowUserChartsQuotas.html | 182 +++++++ docs/cce/api-ref/UpdateChart.html | 254 ++++++++++ docs/cce/api-ref/UpdateRelease.html | 450 +++++++++++++++++ docs/cce/api-ref/UploadChart.html | 231 +++++++++ docs/cce/api-ref/cce_02_0103.html | 2 + docs/cce/api-ref/cce_02_0236.html | 31 ++ docs/cce/api-ref/cce_02_0273.html | 14 +- .../api-ref/chart_lifecycle_management.html | 42 ++ 20 files changed, 4164 insertions(+), 80 deletions(-) create mode 100644 docs/cce/api-ref/CreateRelease.html create mode 100644 docs/cce/api-ref/DeleteChart.html create mode 100644 docs/cce/api-ref/DeleteRelease.html create mode 100644 docs/cce/api-ref/DownloadChart.html create mode 100644 docs/cce/api-ref/ListCharts.html create mode 100644 docs/cce/api-ref/ListReleases.html create mode 100644 docs/cce/api-ref/ShowChart.html create mode 100644 docs/cce/api-ref/ShowChartValues.html create mode 100644 docs/cce/api-ref/ShowRelease.html create mode 100644 docs/cce/api-ref/ShowReleaseHistory.html create mode 100644 docs/cce/api-ref/ShowUserChartsQuotas.html create mode 100644 docs/cce/api-ref/UpdateChart.html create mode 100644 docs/cce/api-ref/UpdateRelease.html create mode 100644 docs/cce/api-ref/UploadChart.html create mode 100644 docs/cce/api-ref/chart_lifecycle_management.html diff --git a/docs/cce/api-ref/ALL_META.TXT.json b/docs/cce/api-ref/ALL_META.TXT.json index 73267ce37..69faad5c7 100644 --- a/docs/cce/api-ref/ALL_META.TXT.json +++ b/docs/cce/api-ref/ALL_META.TXT.json @@ -740,11 +740,281 @@ "title":"Querying Resource Quotas", "githuburl":"" }, + { + "uri":"chart_lifecycle_management.html", + "node_id":"chart_lifecycle_management.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":"Chart Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Chart Management", + "githuburl":"" + }, + { + "uri":"UploadChart.html", + "node_id":"uploadchart.xml", + "product_code":"cce", + "code":"43", + "des":"This API is used to upload a chart.POST /v2/chartsStatus code: 201If the FormDataparameter exists, the value of Content-Typemust be multipart/form-data, and the file path", + "doc_type":"api2", + "kw":"Uploading a Chart,Chart Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Uploading a Chart", + "githuburl":"" + }, + { + "uri":"ListCharts.html", + "node_id":"listcharts.xml", + "product_code":"cce", + "code":"44", + "des":"This API is used to obtain the chart list.GET /v2/chartsStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "doc_type":"api2", + "kw":"Obtaining a Chart List,Chart Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Obtaining a Chart List", + "githuburl":"" + }, + { + "uri":"ListReleases.html", + "node_id":"listreleases.xml", + "product_code":"cce", + "code":"45", + "des":"This API is used to obtain a release list.GET /cce/cam/v3/clusters/{cluster_id}/releasesStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "doc_type":"api2", + "kw":"Obtaining a Release List,Chart Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Obtaining a Release List", + "githuburl":"" + }, + { + "uri":"UpdateChart.html", + "node_id":"updatechart.xml", + "product_code":"cce", + "code":"46", + "des":"This API is used to update a chart.PUT /v2/charts/{chart_id}Status code: 200If the FormDataparameter exists, the value of Content-Typemust be multipart/form-data, and the", + "doc_type":"api2", + "kw":"Updating a Chart,Chart Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Updating a Chart", + "githuburl":"" + }, + { + "uri":"CreateRelease.html", + "node_id":"createrelease.xml", + "product_code":"cce", + "code":"47", + "des":"This API is used to create a release.POST /cce/cam/v3/clusters/{cluster_id}/releasesStatus code: 201Status code: 201CreatedSee Error Codes.", + "doc_type":"api2", + "kw":"Creating a Release,Chart Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Creating a Release", + "githuburl":"" + }, + { + "uri":"DeleteChart.html", + "node_id":"deletechart.xml", + "product_code":"cce", + "code":"48", + "des":"This API is used to delete a chart.DELETE /v2/charts/{chart_id}Status code: 200NoneStatus code: 200OKSee Error Codes.", + "doc_type":"api2", + "kw":"Deleting a Chart,Chart Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Deleting a Chart", + "githuburl":"" + }, + { + "uri":"UpdateRelease.html", + "node_id":"updaterelease.xml", + "product_code":"cce", + "code":"49", + "des":"This API is used to update a release.PUT /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}Status code: 200Status code: 200OKSee Error Codes.", + "doc_type":"api2", + "kw":"Updating a Release,Chart Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Updating a Release", + "githuburl":"" + }, + { + "uri":"ShowChart.html", + "node_id":"showchart.xml", + "product_code":"cce", + "code":"50", + "des":"This API is used to obtain a chart.GET /v2/charts/{chart_id}Status code: 200NoneStatus code: 200OKSee Error Codes.", + "doc_type":"api2", + "kw":"Obtaining a Chart,Chart Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Obtaining a Chart", + "githuburl":"" + }, + { + "uri":"DeleteRelease.html", + "node_id":"deleterelease.xml", + "product_code":"cce", + "code":"51", + "des":"This API is used to delete a release.DELETE /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}Status code: 200NoneStatus code: 200OKSee Error Codes.", + "doc_type":"api2", + "kw":"Deleting a Release,Chart Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Deleting a Release", + "githuburl":"" + }, + { + "uri":"DownloadChart.html", + "node_id":"downloadchart.xml", + "product_code":"cce", + "code":"52", + "des":"This API is used to download a chart.GET /v2/charts/{chart_id}/archiveStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "doc_type":"api2", + "kw":"Downloading a Chart,Chart Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Downloading a Chart", + "githuburl":"" + }, + { + "uri":"ShowRelease.html", + "node_id":"showrelease.xml", + "product_code":"cce", + "code":"53", + "des":"This API is used to obtain a release.GET /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}Status code: 200NoneStatus code: 200OKSee Error Codes.", + "doc_type":"api2", + "kw":"Obtaining a Release,Chart Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Obtaining a Release", + "githuburl":"" + }, + { + "uri":"ShowChartValues.html", + "node_id":"showchartvalues.xml", + "product_code":"cce", + "code":"54", + "des":"This API is used to obtain chart values.GET /v2/charts/{chart_id}/valuesStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "doc_type":"api2", + "kw":"Obtaining Chart Values,Chart Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Obtaining Chart Values", + "githuburl":"" + }, + { + "uri":"ShowReleaseHistory.html", + "node_id":"showreleasehistory.xml", + "product_code":"cce", + "code":"55", + "des":"This API is used to obtain historical records of a release.GET /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}/historyStatus code: 200NoneStatus c", + "doc_type":"api2", + "kw":"Obtaining Historical Records of a Release,Chart Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Obtaining Historical Records of a Release", + "githuburl":"" + }, + { + "uri":"ShowUserChartsQuotas.html", + "node_id":"showuserchartsquotas.xml", + "product_code":"cce", + "code":"56", + "des":"This API is used to obtain the quota of a user chart.GET /v2/charts/{project_id}/quotasStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "doc_type":"api2", + "kw":"Obtaining the Quota of a User Chart,Chart Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api2", + "prodname":"cce" + } + ], + "title":"Obtaining the Quota of a User Chart", + "githuburl":"" + }, { "uri":"cce_02_0366.html", "node_id":"cce_02_0366.xml", "product_code":"cce", - "code":"42", + "code":"57", "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", @@ -762,7 +1032,7 @@ "uri":"cce_02_0407.html", "node_id":"cce_02_0407.xml", "product_code":"cce", - "code":"43", + "code":"58", "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", @@ -780,7 +1050,7 @@ "uri":"cce_02_0408.html", "node_id":"cce_02_0408.xml", "product_code":"cce", - "code":"44", + "code":"59", "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", @@ -798,7 +1068,7 @@ "uri":"cce_02_0409.html", "node_id":"cce_02_0409.xml", "product_code":"cce", - "code":"45", + "code":"60", "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", @@ -816,7 +1086,7 @@ "uri":"cce_02_0411.html", "node_id":"cce_02_0411.xml", "product_code":"cce", - "code":"46", + "code":"61", "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", @@ -834,7 +1104,7 @@ "uri":"cce_02_0412.html", "node_id":"cce_02_0412.xml", "product_code":"cce", - "code":"47", + "code":"62", "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", @@ -852,7 +1122,7 @@ "uri":"cce_02_0413.html", "node_id":"cce_02_0413.xml", "product_code":"cce", - "code":"48", + "code":"63", "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", @@ -870,7 +1140,7 @@ "uri":"cce_02_0414.html", "node_id":"cce_02_0414.xml", "product_code":"cce", - "code":"49", + "code":"64", "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", @@ -888,7 +1158,7 @@ "uri":"cce_02_0415.html", "node_id":"cce_02_0415.xml", "product_code":"cce", - "code":"50", + "code":"65", "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", @@ -906,7 +1176,7 @@ "uri":"cce_02_0417.html", "node_id":"cce_02_0417.xml", "product_code":"cce", - "code":"51", + "code":"66", "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", @@ -924,7 +1194,7 @@ "uri":"cce_02_0421.html", "node_id":"cce_02_0421.xml", "product_code":"cce", - "code":"52", + "code":"67", "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", @@ -942,7 +1212,7 @@ "uri":"cce_02_0340.html", "node_id":"cce_02_0340.xml", "product_code":"cce", - "code":"53", + "code":"68", "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", @@ -960,7 +1230,7 @@ "uri":"kubernetesapi.html", "node_id":"kubernetesapi.xml", "product_code":"cce", - "code":"54", + "code":"69", "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", @@ -978,7 +1248,7 @@ "uri":"cce_02_0327.html", "node_id":"cce_02_0327.xml", "product_code":"cce", - "code":"55", + "code":"70", "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", @@ -996,7 +1266,7 @@ "uri":"cce_02_0083.html", "node_id":"cce_02_0083.xml", "product_code":"cce", - "code":"56", + "code":"71", "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", @@ -1014,7 +1284,7 @@ "uri":"cce_02_0085.html", "node_id":"cce_02_0085.xml", "product_code":"cce", - "code":"57", + "code":"72", "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", @@ -1032,7 +1302,7 @@ "uri":"cce_02_0086.html", "node_id":"cce_02_0086.xml", "product_code":"cce", - "code":"58", + "code":"73", "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", @@ -1050,7 +1320,7 @@ "uri":"cce_02_0084.html", "node_id":"cce_02_0084.xml", "product_code":"cce", - "code":"59", + "code":"74", "des":"Table 1 describes the status codes.", "doc_type":"api2", "kw":"Status Code,Appendix,API Reference", @@ -1068,7 +1338,7 @@ "uri":"cce_02_0250.html", "node_id":"cce_02_0250.xml", "product_code":"cce", - "code":"60", + "code":"75", "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", @@ -1086,7 +1356,7 @@ "uri":"cce_02_0341.html", "node_id":"cce_02_0341.xml", "product_code":"cce", - "code":"61", + "code":"76", "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", @@ -1104,7 +1374,7 @@ "uri":"cce_02_0342.html", "node_id":"cce_02_0342.xml", "product_code":"cce", - "code":"62", + "code":"77", "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", @@ -1122,7 +1392,7 @@ "uri":"cce_02_0271.html", "node_id":"cce_02_0271.xml", "product_code":"cce", - "code":"63", + "code":"78", "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", @@ -1140,7 +1410,7 @@ "uri":"cce_02_0272.html", "node_id":"cce_02_0272.xml", "product_code":"cce", - "code":"64", + "code":"79", "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", @@ -1158,7 +1428,7 @@ "uri":"cce_02_0100.html", "node_id":"cce_02_0100.xml", "product_code":"cce", - "code":"65", + "code":"80", "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", @@ -1176,7 +1446,7 @@ "uri":"cce_02_0101.html", "node_id":"cce_02_0101.xml", "product_code":"cce", - "code":"66", + "code":"81", "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", @@ -1194,7 +1464,7 @@ "uri":"cce_02_0368.html", "node_id":"cce_02_0368.xml", "product_code":"cce", - "code":"67", + "code":"82", "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", @@ -1212,7 +1482,7 @@ "uri":"node_storage_example.html", "node_id":"node_storage_example.xml", "product_code":"cce", - "code":"68", + "code":"83", "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", @@ -1230,7 +1500,7 @@ "uri":"cce_02_0273.html", "node_id":"cce_02_0273.xml", "product_code":"cce", - "code":"69", + "code":"84", "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", diff --git a/docs/cce/api-ref/CLASS.TXT.json b/docs/cce/api-ref/CLASS.TXT.json index 04a1708b3..5f2fc7f4b 100644 --- a/docs/cce/api-ref/CLASS.TXT.json +++ b/docs/cce/api-ref/CLASS.TXT.json @@ -368,6 +368,141 @@ "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":"Chart Management", + "uri":"chart_lifecycle_management.html", + "doc_type":"api2", + "p_code":"2", + "code":"42" + }, + { + "desc":"This API is used to upload a chart.POST /v2/chartsStatus code: 201If the FormDataparameter exists, the value of Content-Typemust be multipart/form-data, and the file path", + "product_code":"cce", + "title":"Uploading a Chart", + "uri":"UploadChart.html", + "doc_type":"api2", + "p_code":"42", + "code":"43" + }, + { + "desc":"This API is used to obtain the chart list.GET /v2/chartsStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "product_code":"cce", + "title":"Obtaining a Chart List", + "uri":"ListCharts.html", + "doc_type":"api2", + "p_code":"42", + "code":"44" + }, + { + "desc":"This API is used to obtain a release list.GET /cce/cam/v3/clusters/{cluster_id}/releasesStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "product_code":"cce", + "title":"Obtaining a Release List", + "uri":"ListReleases.html", + "doc_type":"api2", + "p_code":"42", + "code":"45" + }, + { + "desc":"This API is used to update a chart.PUT /v2/charts/{chart_id}Status code: 200If the FormDataparameter exists, the value of Content-Typemust be multipart/form-data, and the", + "product_code":"cce", + "title":"Updating a Chart", + "uri":"UpdateChart.html", + "doc_type":"api2", + "p_code":"42", + "code":"46" + }, + { + "desc":"This API is used to create a release.POST /cce/cam/v3/clusters/{cluster_id}/releasesStatus code: 201Status code: 201CreatedSee Error Codes.", + "product_code":"cce", + "title":"Creating a Release", + "uri":"CreateRelease.html", + "doc_type":"api2", + "p_code":"42", + "code":"47" + }, + { + "desc":"This API is used to delete a chart.DELETE /v2/charts/{chart_id}Status code: 200NoneStatus code: 200OKSee Error Codes.", + "product_code":"cce", + "title":"Deleting a Chart", + "uri":"DeleteChart.html", + "doc_type":"api2", + "p_code":"42", + "code":"48" + }, + { + "desc":"This API is used to update a release.PUT /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}Status code: 200Status code: 200OKSee Error Codes.", + "product_code":"cce", + "title":"Updating a Release", + "uri":"UpdateRelease.html", + "doc_type":"api2", + "p_code":"42", + "code":"49" + }, + { + "desc":"This API is used to obtain a chart.GET /v2/charts/{chart_id}Status code: 200NoneStatus code: 200OKSee Error Codes.", + "product_code":"cce", + "title":"Obtaining a Chart", + "uri":"ShowChart.html", + "doc_type":"api2", + "p_code":"42", + "code":"50" + }, + { + "desc":"This API is used to delete a release.DELETE /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}Status code: 200NoneStatus code: 200OKSee Error Codes.", + "product_code":"cce", + "title":"Deleting a Release", + "uri":"DeleteRelease.html", + "doc_type":"api2", + "p_code":"42", + "code":"51" + }, + { + "desc":"This API is used to download a chart.GET /v2/charts/{chart_id}/archiveStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "product_code":"cce", + "title":"Downloading a Chart", + "uri":"DownloadChart.html", + "doc_type":"api2", + "p_code":"42", + "code":"52" + }, + { + "desc":"This API is used to obtain a release.GET /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}Status code: 200NoneStatus code: 200OKSee Error Codes.", + "product_code":"cce", + "title":"Obtaining a Release", + "uri":"ShowRelease.html", + "doc_type":"api2", + "p_code":"42", + "code":"53" + }, + { + "desc":"This API is used to obtain chart values.GET /v2/charts/{chart_id}/valuesStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "product_code":"cce", + "title":"Obtaining Chart Values", + "uri":"ShowChartValues.html", + "doc_type":"api2", + "p_code":"42", + "code":"54" + }, + { + "desc":"This API is used to obtain historical records of a release.GET /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}/historyStatus code: 200NoneStatus c", + "product_code":"cce", + "title":"Obtaining Historical Records of a Release", + "uri":"ShowReleaseHistory.html", + "doc_type":"api2", + "p_code":"42", + "code":"55" + }, + { + "desc":"This API is used to obtain the quota of a user chart.GET /v2/charts/{project_id}/quotasStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "product_code":"cce", + "title":"Obtaining the Quota of a User Chart", + "uri":"ShowUserChartsQuotas.html", + "doc_type":"api2", + "p_code":"42", + "code":"56" + }, { "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 +510,7 @@ "uri":"cce_02_0366.html", "doc_type":"api2", "p_code":"2", - "code":"42" + "code":"57" }, { "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", @@ -383,8 +518,8 @@ "title":"CoreDNS", "uri":"cce_02_0407.html", "doc_type":"api2", - "p_code":"42", - "code":"43" + "p_code":"57", + "code":"58" }, { "desc":"The CCE Container Storage (Everest) add-on uses the Container Storage Interface (CSI) to link Kubernetes clusters with cloud storage services.", @@ -392,8 +527,8 @@ "title":"CCE Container Storage (Everest)", "uri":"cce_02_0408.html", "doc_type":"api2", - "p_code":"42", - "code":"44" + "p_code":"57", + "code":"59" }, { "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", @@ -401,8 +536,8 @@ "title":"CCE Node Problem Detector", "uri":"cce_02_0409.html", "doc_type":"api2", - "p_code":"42", - "code":"45" + "p_code":"57", + "code":"60" }, { "desc":"The CCE Cluster Autoscaler (autoscaler) add-on enables node pools to be scaled in or out.", @@ -410,8 +545,8 @@ "title":"CCE Cluster Autoscaler", "uri":"cce_02_0411.html", "doc_type":"api2", - "p_code":"42", - "code":"46" + "p_code":"57", + "code":"61" }, { "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", @@ -419,8 +554,8 @@ "title":"NGINX Ingress Controller", "uri":"cce_02_0412.html", "doc_type":"api2", - "p_code":"42", - "code":"47" + "p_code":"57", + "code":"62" }, { "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", @@ -428,8 +563,8 @@ "title":"Kubernetes Metrics Server", "uri":"cce_02_0413.html", "doc_type":"api2", - "p_code":"42", - "code":"48" + "p_code":"57", + "code":"63" }, { "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", @@ -437,8 +572,8 @@ "title":"CCE Advanced HPA", "uri":"cce_02_0414.html", "doc_type":"api2", - "p_code":"42", - "code":"49" + "p_code":"57", + "code":"64" }, { "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.", @@ -446,8 +581,8 @@ "title":"CCE AI Suite (NVIDIA GPU)", "uri":"cce_02_0415.html", "doc_type":"api2", - "p_code":"42", - "code":"50" + "p_code":"57", + "code":"65" }, { "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", @@ -455,8 +590,8 @@ "title":"Volcano Scheduler", "uri":"cce_02_0417.html", "doc_type":"api2", - "p_code":"42", - "code":"51" + "p_code":"57", + "code":"66" }, { "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", @@ -464,8 +599,8 @@ "title":"Cloud Native Cluster Monitoring", "uri":"cce_02_0421.html", "doc_type":"api2", - "p_code":"42", - "code":"52" + "p_code":"57", + "code":"67" }, { "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.", @@ -474,7 +609,7 @@ "uri":"cce_02_0340.html", "doc_type":"api2", "p_code":"", - "code":"53" + "code":"68" }, { "desc":"Kubernetes APIs are resource-based (RESTful) programming interfaces provided through HTTP. It supports query, creation, update, and deletion of various cluster resources ", @@ -482,8 +617,8 @@ "title":"Overview", "uri":"kubernetesapi.html", "doc_type":"api2", - "p_code":"53", - "code":"54" + "p_code":"68", + "code":"69" }, { "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", @@ -492,7 +627,7 @@ "uri":"cce_02_0327.html", "doc_type":"api2", "p_code":"", - "code":"55" + "code":"70" }, { "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.", @@ -501,7 +636,7 @@ "uri":"cce_02_0083.html", "doc_type":"api2", "p_code":"", - "code":"56" + "code":"71" }, { "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", @@ -509,8 +644,8 @@ "title":"Patch Request Method Operation Description", "uri":"cce_02_0085.html", "doc_type":"api2", - "p_code":"56", - "code":"57" + "p_code":"71", + "code":"72" }, { "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", @@ -518,8 +653,8 @@ "title":"Patch Request Method Operation Example", "uri":"cce_02_0086.html", "doc_type":"api2", - "p_code":"56", - "code":"58" + "p_code":"71", + "code":"73" }, { "desc":"Table 1 describes the status codes.", @@ -527,8 +662,8 @@ "title":"Status Code", "uri":"cce_02_0084.html", "doc_type":"api2", - "p_code":"56", - "code":"59" + "p_code":"71", + "code":"74" }, { "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 ", @@ -536,8 +671,8 @@ "title":"Error Codes", "uri":"cce_02_0250.html", "doc_type":"api2", - "p_code":"56", - "code":"60" + "p_code":"71", + "code":"75" }, { "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", @@ -545,8 +680,8 @@ "title":"Obtaining a Project ID", "uri":"cce_02_0341.html", "doc_type":"api2", - "p_code":"56", - "code":"61" + "p_code":"71", + "code":"76" }, { "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", @@ -554,8 +689,8 @@ "title":"Obtaining the Account ID", "uri":"cce_02_0342.html", "doc_type":"api2", - "p_code":"56", - "code":"62" + "p_code":"71", + "code":"77" }, { "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", @@ -563,8 +698,8 @@ "title":"How to Obtain Parameters in the API URI", "uri":"cce_02_0271.html", "doc_type":"api2", - "p_code":"56", - "code":"63" + "p_code":"71", + "code":"78" }, { "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.", @@ -572,8 +707,8 @@ "title":"API Permissions", "uri":"cce_02_0272.html", "doc_type":"api2", - "p_code":"56", - "code":"64" + "p_code":"71", + "code":"79" }, { "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", @@ -581,8 +716,8 @@ "title":"Creating a VPC and Subnet", "uri":"cce_02_0100.html", "doc_type":"api2", - "p_code":"56", - "code":"65" + "p_code":"71", + "code":"80" }, { "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, ", @@ -590,8 +725,8 @@ "title":"Creating a Key Pair", "uri":"cce_02_0101.html", "doc_type":"api2", - "p_code":"56", - "code":"66" + "p_code":"71", + "code":"81" }, { "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", @@ -599,8 +734,8 @@ "title":"Node Flavor Description", "uri":"cce_02_0368.html", "doc_type":"api2", - "p_code":"56", - "code":"67" + "p_code":"71", + "code":"82" }, { "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", @@ -608,8 +743,8 @@ "title":"Attaching Disks to a Node", "uri":"node_storage_example.html", "doc_type":"api2", - "p_code":"56", - "code":"68" + "p_code":"71", + "code":"83" }, { "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.", @@ -618,6 +753,6 @@ "uri":"cce_02_0273.html", "doc_type":"api2", "p_code":"", - "code":"69" + "code":"84" } ] \ No newline at end of file diff --git a/docs/cce/api-ref/CreateRelease.html b/docs/cce/api-ref/CreateRelease.html new file mode 100644 index 000000000..99c3a2f39 --- /dev/null +++ b/docs/cce/api-ref/CreateRelease.html @@ -0,0 +1,457 @@ + + +

Creating a Release

+

Function

This API is used to create a release.

+
+

URI

POST /cce/cam/v3/clusters/{cluster_id}/releases

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

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_id

+

Yes

+

String

+

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

Request body type or format.

+

Constraints:

+

The GET method is not verified.

+

Options:

+
  • application/json
  • application/json;charset=utf-8
  • application/x-pem-file
  • multipart/form-data (It can be used when the FormData parameter exists.)
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see API Usage Guidelines.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

chart_id

+

Yes

+

String

+

Chart ID

+

description

+

No

+

String

+

Release description

+

name

+

Yes

+

String

+

Release name

+

namespace

+

Yes

+

String

+

Namespace to which a chart release belongs

+

version

+

Yes

+

String

+

Release version

+

parameters

+

No

+

ReleaseReqBodyParams object

+

Release parameters

+

values

+

Yes

+

values object

+

Release value

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ReleaseReqBodyParams

Parameter

+

Mandatory

+

Type

+

Description

+

dry_run

+

No

+

Boolean

+

After this function is enabled, only chart parameters are verified, and installation is not performed.

+

name_template

+

No

+

String

+

Release name template

+

no_hooks

+

No

+

Boolean

+

Whether to disable hooks during installation

+

replace

+

No

+

Boolean

+

Whether to replace the release with the same name

+

recreate

+

No

+

Boolean

+

Whether to rebuild the release

+

reset_values

+

No

+

Boolean

+

Whether to reset values during an update

+

release_version

+

No

+

Integer

+

Version of the rollback release

+

include_hooks

+

No

+

Boolean

+

Enable hooks during an update or deletion.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 values

Parameter

+

Mandatory

+

Type

+

Description

+

imagePullPolicy

+

No

+

String

+

Image pull policy

+

imageTag

+

No

+

String

+

Image tag

+
+
+
+

Response Parameters

Status code: 201

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

chart_name

+

String

+

Chart name

+

chart_public

+

Boolean

+

Whether the chart is public

+

chart_version

+

String

+

Chart version

+

cluster_id

+

String

+

Cluster ID

+

cluster_name

+

String

+

Current name

+

create_at

+

String

+

Created at

+

description

+

String

+

Release description

+

name

+

String

+

Release name

+

namespace

+

String

+

Namespace to which a chart release belongs

+

parameters

+

String

+

Release parameters

+

resources

+

String

+

Resources required by the release

+

status

+

String

+

Release status

+
  • DEPLOYED: The release is normal.
  • DELETED: The release has been deleted.
  • FAILED: The release fails to be deployed.
  • DELETING: The release is being deleted.
  • PENDING_INSTALL: The release is waiting to be installed.
  • PENDING_UPGRADE: The release is waiting to be upgraded.
  • PENDING_ROLLBACK: The release is waiting for rollback.
  • UNKNOWN: The release status is unknown, indicating that the release is abnormal. You can manually delete the release and reinstall it.
+

status_description

+

String

+

Release status description

+

update_at

+

String

+

Updated at

+

values

+

String

+

Release value

+

version

+

Integer

+

Release version

+
+
+
+

Example Requests

POST /cce/cam/v3/clusters/{cluster_id}/releases
+
+{
+  "name" : "nino21",
+  "namespace" : "project01",
+  "version" : "1.0.0",
+  "chart_id" : "3c138b72-7ce4-6d76-7c55-604cdb2ce423",
+  "values" : {
+    "imageTag" : "v2",
+    "imagePullPolicy" : "IfNotPresent"
+  },
+  "parameters" : {
+    "dry_run" : false,
+    "no_hooks" : false,
+    "replace" : false,
+    "name_template" : ""
+  }
+}
+
+

Example Responses

Status code: 201

+

Created

+
{
+  "chart_name" : "magento-mysql",
+  "chart_public" : false,
+  "chart_version" : "1.0.0",
+  "cluster_id" : "a870253f-5dc7-11ee-bf71-0255ac100b03",
+  "cluster_name" : "sfs-turbo-test",
+  "create_at" : "2023-11-14T20:30:57+08:00",
+  "description" : "Initial install underway",
+  "name" : "testwww",
+  "namespace" : "monitoring",
+  "parameters" : "",
+  "resources" : "",
+  "status" : "PENDING_INSTALL",
+  "status_description" : "Initial install underway",
+  "update_at" : "2023-11-14T20:30:57+08:00",
+  "values" : "{\"basic\":{\"admin_password\":\"******\",\"admin_username\":\"username\",\"app_name\":\"magento\",\"mysql_database\":\"magento\",\"mysql_name\":\"mysql\",\"mysql_password\":\"******\",\"mysql_port\":3306,\"mysql_root_password\":\"******\",\"mysql_user\":\"magento\",\"storage_class\":\"csi-nas\",\"storage_mode\":\"ReadWriteMany\",\"storage_size\":\"10G\"},\"global\":{\"magento_EIP\":\"100.100.100.100\",\"magento_EPORT\":32080,\"namespace\":\"default\"},\"image\":{\"magento_image\":\"example.com/everest/magento:latest\",\"mysql_image\":\"example.com/everest/mysql:5.7.14\"}}",
+  "version" : 1
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

201

+

Created

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Chart Management
+
+
+ diff --git a/docs/cce/api-ref/DeleteChart.html b/docs/cce/api-ref/DeleteChart.html new file mode 100644 index 000000000..78814c720 --- /dev/null +++ b/docs/cce/api-ref/DeleteChart.html @@ -0,0 +1,220 @@ + + +

Deleting a Chart

+

Function

This API is used to delete a chart.

+
+

URI

DELETE /v2/charts/{chart_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

chart_id

+

Yes

+

String

+

Chart ID

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

Request body type or format.

+

Constraints:

+

The GET method is not verified.

+

Options:

+
  • application/json
  • application/json;charset=utf-8
  • application/x-pem-file
  • multipart/form-data (It can be used when the FormData parameter exists.)
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see API Usage Guidelines.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Chart ID

+

name

+

String

+

Chart name

+

values

+

String

+

Chart value

+

translate

+

String

+

Chart translation resources

+

instruction

+

String

+

Chart description

+

version

+

String

+

Chart version

+

description

+

String

+

Chart description

+

source

+

String

+

Chart source

+

icon_url

+

String

+

URL to chart icons

+

public

+

Boolean

+

Whether the chart is public

+

chart_url

+

String

+

URL to the chart

+

create_at

+

String

+

Created at

+

update_at

+

String

+

Updated at

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "id" : "e99a7e86-afdd-11eb-aca3-0255ac100b0e",
+  "name" : "neo4j",
+  "values" : "{\"acceptLicenseAgreement\":\"no\",\"affinity\":{},\"authEnabled\":true,\"clusterDomain\":\"cluster.local\",\"core\":{\"initContainers\":[],\"numberOfServers\":3,\"persistentVolume\":{\"enabled\":true,\"mountPath\":\"/data\",\"size\":\"10Gi\"},\"sidecarContainers\":[]},\"defaultDatabase\":\"neo4j\",\"image\":\"neo4j\",\"imagePullPolicy\":\"IfNotPresent\",\"imageTag\":\"4.0.3-enterprise\",\"name\":\"neo4j\",\"nodeSelector\":{},\"podDisruptionBudget\":{},\"readReplica\":{\"autoscaling\":{\"enabled\":false,\"maxReplicas\":3,\"minReplicas\":1,\"targetAverageUtilization\":70},\"initContainers\":[],\"numberOfServers\":0,\"resources\":{},\"sidecarContainers\":[]},\"resources\":{},\"testImage\":\"markhneedham/k8s-kubectl\",\"testImageTag\":\"master\",\"tolerations\":[],\"useAPOC\":\"true\"}",
+  "translate" : "",
+  "instruction" : "README.md",
+  "version" : "3.0.1",
+  "description" : "DEPRECATED Neo4j is the world's leading graph database",
+  "source" : "",
+  "icon_url" : "https://example.com/images/neo4j_logo.png",
+  "public" : false,
+  "chart_url" : "neo4j-3.0.1.tgz",
+  "create_at" : "2021-05-08T08:53:12Z",
+  "update_at" : "2021-05-08T08:53:12Z"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Chart Management
+
+
+ diff --git a/docs/cce/api-ref/DeleteRelease.html b/docs/cce/api-ref/DeleteRelease.html new file mode 100644 index 000000000..e4711cec3 --- /dev/null +++ b/docs/cce/api-ref/DeleteRelease.html @@ -0,0 +1,261 @@ + + +

Deleting a Release

+

Function

This API is used to delete a release.

+
+

URI

DELETE /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}

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

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Release name

+

namespace

+

Yes

+

String

+

Namespace of the chart

+

cluster_id

+

Yes

+

String

+

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

Request body type or format.

+

Constraints:

+

The GET method is not verified.

+

Options:

+
  • application/json
  • application/json;charset=utf-8
  • application/x-pem-file
  • multipart/form-data (It can be used when the FormData parameter exists.)
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see API Usage Guidelines.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

chart_name

+

String

+

Chart name

+

chart_public

+

Boolean

+

Whether the chart is public

+

chart_version

+

String

+

Chart version

+

cluster_id

+

String

+

Cluster ID

+

cluster_name

+

String

+

Current name

+

create_at

+

String

+

Created at

+

description

+

String

+

Release description

+

name

+

String

+

Release name

+

namespace

+

String

+

Namespace to which a chart release belongs

+

parameters

+

String

+

Release parameters

+

resources

+

String

+

Resources required by the release

+

status

+

String

+

Release status.

+
  • DEPLOYED: The release is normal.
  • DELETED: The release has been deleted.
  • FAILED: The release fails to be deployed.
  • DELETING: The release is being deleted.
  • PENDING_INSTALL: The release is waiting to be installed.
  • PENDING_UPGRADE: The release is waiting to be upgraded.
  • PENDING_ROLLBACK: The release is waiting for rollback.
  • UNKNOWN: The release status is unknown, indicating that the release is abnormal. You can manually delete the release and reinstall it.
+

status_description

+

String

+

Release status description

+

update_at

+

String

+

Updated at

+

values

+

String

+

Release value

+

version

+

Integer

+

Release version

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "chart_name" : "magento-mysql",
+  "chart_public" : false,
+  "chart_version" : "1.0.0",
+  "cluster_id" : "a870253f-5dc7-11ee-bf71-0255ac100b03",
+  "cluster_name" : "sfs-turbo-test",
+  "create_at" : "2023-11-14T20:30:57+08:00",
+  "name" : "testwww",
+  "namespace" : "monitoring",
+  "parameters" : "",
+  "resources" : "",
+  "status" : "DELETING",
+  "update_at" : "2023-11-14T20:30:57+08:00",
+  "values" : "{\"basic\":{\"admin_password\":\"******\",\"admin_username\":\"username\",\"app_name\":\"magento\",\"mysql_database\":\"magento\",\"mysql_name\":\"mysql\",\"mysql_password\":\"******\",\"mysql_port\":3306,\"mysql_root_password\":\"******\",\"mysql_user\":\"magento\",\"storage_class\":\"csi-nas\",\"storage_mode\":\"ReadWriteMany\",\"storage_size\":\"10G\"},\"global\":{\"magento_EIP\":\"100.100.100.100\",\"magento_EPORT\":32080,\"namespace\":\"default\"},\"image\":{\"magento_image\":\"example.com/everest/magento:latest\",\"mysql_image\":\"example.com/everest/mysql:5.7.14\"}}",
+  "version" : 1
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Chart Management
+
+
+ diff --git a/docs/cce/api-ref/DownloadChart.html b/docs/cce/api-ref/DownloadChart.html new file mode 100644 index 000000000..0e268251d --- /dev/null +++ b/docs/cce/api-ref/DownloadChart.html @@ -0,0 +1,122 @@ + + +

Downloading a Chart

+

Function

This API is used to download a chart.

+
+

URI

GET /v2/charts/{chart_id}/archive

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

Parameter

+

Mandatory

+

Type

+

Description

+

chart_id

+

Yes

+

String

+

Chart ID

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

Request body type or format.

+

Constraints:

+

The GET method is not verified.

+

Options:

+
  • application/json
  • application/json;charset=utf-8
  • application/x-pem-file
  • multipart/form-data (It can be used when the FormData parameter exists.)
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see API Usage Guidelines.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

-

+

File

+

File name of the downloaded chart.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
"chart-file.tgz"
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Chart Management
+
+
+ diff --git a/docs/cce/api-ref/ListCharts.html b/docs/cce/api-ref/ListCharts.html new file mode 100644 index 000000000..a30105e12 --- /dev/null +++ b/docs/cce/api-ref/ListCharts.html @@ -0,0 +1,216 @@ + + +

Obtaining a Chart List

+

Function

This API is used to obtain the chart list.

+
+

URI

GET /v2/charts

+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 1 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

Request body type or format.

+

Constraints:

+

The GET method is not verified.

+

Options:

+
  • application/json
  • application/json;charset=utf-8
  • application/x-pem-file
  • multipart/form-data (It can be used when the FormData parameter exists.)
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see API Usage Guidelines.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

[items]

+

Array of ChartResp objects

+

Chart list

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 ChartResp

Parameter

+

Type

+

Description

+

id

+

String

+

Chart ID

+

name

+

String

+

Chart name

+

values

+

String

+

Chart value

+

translate

+

String

+

Chart translation resources

+

instruction

+

String

+

Chart description

+

version

+

String

+

Chart version

+

description

+

String

+

Chart description

+

source

+

String

+

Chart source

+

icon_url

+

String

+

URL to chart icons

+

public

+

Boolean

+

Whether the chart is public

+

chart_url

+

String

+

URL to the chart

+

create_at

+

String

+

Created at

+

update_at

+

String

+

Updated at

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
[ {
+  "id" : "1abd3bd6-0258-11ec-b8b0-0255ac100b05",
+  "name" : "magento-mysql",
+  "values" : "{\"basic\":{\"admin_password\":\"******\",\"admin_username\":\"username\",\"app_name\":\"magento\",\"mysql_database\":\"magento\",\"mysql_name\":\"mysql\",\"mysql_password\":\"******\",\"mysql_port\":3306,\"mysql_root_password\":\"******\",\"mysql_user\":\"magento\",\"storage_class\":\"csi-nas\",\"storage_mode\":\"ReadWriteMany\",\"storage_size\":\"10G\"},\"global\":{\"magento_EIP\":\"100.100.100.100\",\"magento_EPORT\":32080,\"namespace\":\"default\"},\"image\":{\"magento_image\":\"example.com/everest/magento:latest\",\"mysql_image\":\"example.com/everest/mysql:5.7.14\"}}",
+  "translate" : "",
+  "instruction" : "",
+  "version" : "1.0.0",
+  "description" : "chart description",
+  "source" : "",
+  "icon_url" : "https://example.com/magento-stack-110x117.png",
+  "public" : false,
+  "chart_url" : "magento-mysql-1.0.0.tgz",
+  "create_at" : "2021-08-20T08:00:29Z",
+  "update_at" : "2021-08-20T08:00:29Z"
+} ]
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Chart Management
+
+
+ diff --git a/docs/cce/api-ref/ListReleases.html b/docs/cce/api-ref/ListReleases.html new file mode 100644 index 000000000..a73449747 --- /dev/null +++ b/docs/cce/api-ref/ListReleases.html @@ -0,0 +1,296 @@ + + +

Obtaining a Release List

+

Function

This API is used to obtain a release list.

+
+

URI

GET /cce/cam/v3/clusters/{cluster_id}/releases

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

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_id

+

Yes

+

String

+

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

chart_id

+

No

+

String

+

Chart ID

+

namespace

+

No

+

String

+

Namespace of the chart

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

Request body type or format.

+

Constraints:

+

The GET method is not verified.

+

Options:

+
  • application/json
  • application/json;charset=utf-8
  • application/x-pem-file
  • multipart/form-data (It can be used when the FormData parameter exists.)
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see API Usage Guidelines.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

[items]

+

Array of ReleaseResp objects

+

-

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 ReleaseResp

Parameter

+

Type

+

Description

+

chart_name

+

String

+

Chart name

+

chart_public

+

Boolean

+

Whether the chart is public

+

chart_version

+

String

+

Chart version

+

cluster_id

+

String

+

Cluster ID

+

cluster_name

+

String

+

Current name

+

create_at

+

String

+

Created at

+

description

+

String

+

Release description

+

name

+

String

+

Release name

+

namespace

+

String

+

Namespace to which a chart release belongs

+

parameters

+

String

+

Release parameters

+

resources

+

String

+

Resources required by the release

+

status

+

String

+

Release status

+
  • DEPLOYED: The release is normal.
  • DELETED: The release has been deleted.
  • FAILED: The release fails to be deployed.
  • DELETING: The release is being deleted.
  • PENDING_INSTALL: The release is waiting to be installed.
  • PENDING_UPGRADE: The release is waiting to be upgraded.
  • PENDING_ROLLBACK: The release is waiting for rollback.
  • UNKNOWN: The release status is unknown, indicating that the release is abnormal. You can manually delete the release and reinstall it.
+

status_description

+

String

+

Release status description

+

update_at

+

String

+

Updated at

+

values

+

String

+

Release value

+

version

+

Integer

+

Release version

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
[ {
+  "chart_name" : "magento-mysql",
+  "chart_public" : false,
+  "chart_version" : "1.0.0",
+  "cluster_id" : "a870253f-5dc7-11ee-bf71-0255ac100b03",
+  "cluster_name" : "sfs-turbo-test",
+  "create_at" : "2023-11-14T20:30:57+08:00",
+  "description" : "Initial install underway",
+  "name" : "testwww",
+  "namespace" : "monitoring",
+  "parameters" : "",
+  "resources" : "",
+  "status" : "PENDING_INSTALL",
+  "status_description" : "Initial install underway",
+  "update_at" : "2023-11-14T20:30:57+08:00",
+  "values" : "{\"basic\":{\"admin_password\":\"******\",\"admin_username\":\"username\",\"app_name\":\"magento\",\"mysql_database\":\"magento\",\"mysql_name\":\"mysql\",\"mysql_password\":\"******\",\"mysql_port\":3306,\"mysql_root_password\":\"******\",\"mysql_user\":\"magento\",\"storage_class\":\"csi-nas\",\"storage_mode\":\"ReadWriteMany\",\"storage_size\":\"10G\"},\"global\":{\"magento_EIP\":\"100.100.100.100\",\"magento_EPORT\":32080,\"namespace\":\"default\"},\"image\":{\"magento_image\":\"example.com/everest/magento:latest\",\"mysql_image\":\"example.com/everest/mysql:5.7.14\"}}",
+  "version" : 1
+} ]
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Chart Management
+
+
+ diff --git a/docs/cce/api-ref/ShowChart.html b/docs/cce/api-ref/ShowChart.html new file mode 100644 index 000000000..56956f002 --- /dev/null +++ b/docs/cce/api-ref/ShowChart.html @@ -0,0 +1,220 @@ + + +

Obtaining a Chart

+

Function

This API is used to obtain a chart.

+
+

URI

GET /v2/charts/{chart_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

chart_id

+

Yes

+

String

+

Chart ID

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

Request body type or format.

+

Constraints:

+

The GET method is not verified.

+

Options:

+
  • application/json
  • application/json;charset=utf-8
  • application/x-pem-file
  • multipart/form-data (It can be used when the FormData parameter exists.)
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see API Usage Guidelines.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Chart ID

+

name

+

String

+

Chart name

+

values

+

String

+

Chart value

+

translate

+

String

+

Chart translation resources

+

instruction

+

String

+

Chart description

+

version

+

String

+

Chart version

+

description

+

String

+

Chart description

+

source

+

String

+

Chart source

+

icon_url

+

String

+

URL to chart icons

+

public

+

Boolean

+

Whether the chart is public

+

chart_url

+

String

+

URL to the chart

+

create_at

+

String

+

Created at

+

update_at

+

String

+

Updated at

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "id" : "e99a7e86-afdd-11eb-aca3-0255ac100b0e",
+  "name" : "neo4j",
+  "values" : "{\"acceptLicenseAgreement\":\"no\",\"affinity\":{},\"authEnabled\":true,\"clusterDomain\":\"cluster.local\",\"core\":{\"initContainers\":[],\"numberOfServers\":3,\"persistentVolume\":{\"enabled\":true,\"mountPath\":\"/data\",\"size\":\"10Gi\"},\"sidecarContainers\":[]},\"defaultDatabase\":\"neo4j\",\"image\":\"neo4j\",\"imagePullPolicy\":\"IfNotPresent\",\"imageTag\":\"4.0.3-enterprise\",\"name\":\"neo4j\",\"nodeSelector\":{},\"podDisruptionBudget\":{},\"readReplica\":{\"autoscaling\":{\"enabled\":false,\"maxReplicas\":3,\"minReplicas\":1,\"targetAverageUtilization\":70},\"initContainers\":[],\"numberOfServers\":0,\"resources\":{},\"sidecarContainers\":[]},\"resources\":{},\"testImage\":\"markhneedham/k8s-kubectl\",\"testImageTag\":\"master\",\"tolerations\":[],\"useAPOC\":\"true\"}",
+  "translate" : "",
+  "instruction" : "README.md",
+  "version" : "3.0.1",
+  "description" : "DEPRECATED Neo4j is the world's leading graph database",
+  "source" : "",
+  "icon_url" : "https://info.neo4j.com/rs/773-GON-065/images/neo4j_logo.png",
+  "public" : false,
+  "chart_url" : "neo4j-3.0.1.tgz",
+  "create_at" : "2021-05-08T08:53:13Z",
+  "update_at" : "2021-05-08T08:53:13Z"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Chart Management
+
+
+ diff --git a/docs/cce/api-ref/ShowChartValues.html b/docs/cce/api-ref/ShowChartValues.html new file mode 100644 index 000000000..46cb16f8f --- /dev/null +++ b/docs/cce/api-ref/ShowChartValues.html @@ -0,0 +1,138 @@ + + +

Obtaining Chart Values

+

Function

This API is used to obtain chart values.

+
+

URI

GET /v2/charts/{chart_id}/values

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

Parameter

+

Mandatory

+

Type

+

Description

+

chart_id

+

Yes

+

String

+

Chart ID

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

Request body type or format.

+

Constraints:

+

The GET method is not verified.

+

Options:

+
  • application/json
  • application/json;charset=utf-8
  • application/x-pem-file
  • multipart/form-data (It can be used when the FormData parameter exists.)
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see API Usage Guidelines.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

values

+

Map<String,Object>

+

Data in values.yaml. The data structure depends on the chart.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "values" : {
+    "basic" : {
+      "admin_password" : "******",
+      "admin_username" : "username"
+    },
+    "global" : {
+      "magento_EIP" : "127.0.0.1",
+      "magento_EPORT" : 32080,
+      "namespace" : "demo"
+    },
+    "image" : {
+      "magento_image" : "example.com/demo/magento:latest",
+      "mysql_image" : "example.com/demo/mysql:5.7.14"
+    }
+  }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Chart Management
+
+
+ diff --git a/docs/cce/api-ref/ShowRelease.html b/docs/cce/api-ref/ShowRelease.html new file mode 100644 index 000000000..bb6fb2657 --- /dev/null +++ b/docs/cce/api-ref/ShowRelease.html @@ -0,0 +1,263 @@ + + +

Obtaining a Release

+

Function

This API is used to obtain a release.

+
+

URI

GET /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}

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

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Release name

+

namespace

+

Yes

+

String

+

Namespace of the chart

+

cluster_id

+

Yes

+

String

+

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

Request body type or format.

+

Constraints:

+

The GET method is not verified.

+

Options:

+
  • application/json
  • application/json;charset=utf-8
  • application/x-pem-file
  • multipart/form-data (It can be used when the FormData parameter exists.)
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see API Usage Guidelines.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

chart_name

+

String

+

Chart name

+

chart_public

+

Boolean

+

Whether the chart is public

+

chart_version

+

String

+

Chart version

+

cluster_id

+

String

+

Cluster ID

+

cluster_name

+

String

+

Current name

+

create_at

+

String

+

Created at

+

description

+

String

+

Release description

+

name

+

String

+

Release name

+

namespace

+

String

+

Namespace to which a chart release belongs

+

parameters

+

String

+

Release parameters

+

resources

+

String

+

Resources required by the release

+

status

+

String

+

Release status

+
  • DEPLOYED: The release is normal.
  • DELETED: The release has been deleted.
  • FAILED: The release fails to be deployed.
  • DELETING: The release is being deleted.
  • PENDING_INSTALL: The release is waiting to be installed.
  • PENDING_UPGRADE: The release is waiting to be upgraded.
  • PENDING_ROLLBACK: The release is waiting for rollback.
  • UNKNOWN: The release status is unknown, indicating that the release is abnormal. You can manually delete the release and reinstall it.
+

status_description

+

String

+

Release status description

+

update_at

+

String

+

Updated at

+

values

+

String

+

Release value

+

version

+

Integer

+

Release version

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "chart_name" : "magento-mysql",
+  "chart_public" : false,
+  "chart_version" : "1.0.0",
+  "cluster_id" : "a870253f-5dc7-11ee-bf71-0255ac100b03",
+  "cluster_name" : "sfs-turbo-test",
+  "create_at" : "2023-11-14T20:30:57+08:00",
+  "description" : "Initial install underway",
+  "name" : "testwww",
+  "namespace" : "monitoring",
+  "parameters" : "",
+  "resources" : "",
+  "status" : "PENDING_INSTALL",
+  "status_description" : "Initial install underway",
+  "update_at" : "2023-11-14T20:30:57+08:00",
+  "values" : "{\"basic\":{\"admin_password\":\"******\",\"admin_username\":\"username\",\"app_name\":\"magento\",\"mysql_database\":\"magento\",\"mysql_name\":\"mysql\",\"mysql_password\":\"******\",\"mysql_port\":3306,\"mysql_root_password\":\"******\",\"mysql_user\":\"magento\",\"storage_class\":\"csi-nas\",\"storage_mode\":\"ReadWriteMany\",\"storage_size\":\"10G\"},\"global\":{\"magento_EIP\":\"100.100.100.100\",\"magento_EPORT\":32080,\"namespace\":\"default\"},\"image\":{\"magento_image\":\"example.com/everest/magento:latest\",\"mysql_image\":\"example.com/everest/mysql:5.7.14\"}}",
+  "version" : 1
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Chart Management
+
+
+ diff --git a/docs/cce/api-ref/ShowReleaseHistory.html b/docs/cce/api-ref/ShowReleaseHistory.html new file mode 100644 index 000000000..4eb47b8d3 --- /dev/null +++ b/docs/cce/api-ref/ShowReleaseHistory.html @@ -0,0 +1,282 @@ + + +

Obtaining Historical Records of a Release

+

Function

This API is used to obtain historical records of a release.

+
+

URI

GET /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}/history

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

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Release name

+

namespace

+

Yes

+

String

+

Namespace of the chart

+

cluster_id

+

Yes

+

String

+

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

Request body type or format.

+

Constraints:

+

The GET method is not verified.

+

Options:

+
  • application/json
  • application/json;charset=utf-8
  • application/x-pem-file
  • multipart/form-data (It can be used when the FormData parameter exists.)
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see API Usage Guidelines.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

[items]

+

Array of ReleaseResp objects

+

-

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ReleaseResp

Parameter

+

Type

+

Description

+

chart_name

+

String

+

Chart name

+

chart_public

+

Boolean

+

Whether the chart is public

+

chart_version

+

String

+

Chart version

+

cluster_id

+

String

+

Cluster ID

+

cluster_name

+

String

+

Current name

+

create_at

+

String

+

Created at

+

description

+

String

+

Release description

+

name

+

String

+

Release name

+

namespace

+

String

+

Namespace to which a chart release belongs

+

parameters

+

String

+

Release parameters

+

resources

+

String

+

Resources required by the release

+

status

+

String

+

Release status

+
  • DEPLOYED: The release is normal.
  • DELETED: The release has been deleted.
  • FAILED: The release fails to be deployed.
  • DELETING: The release is being deleted.
  • PENDING_INSTALL: The release is waiting to be installed.
  • PENDING_UPGRADE: The release is waiting to be upgraded.
  • PENDING_ROLLBACK: The release is waiting for rollback.
  • UNKNOWN: The release status is unknown, indicating that the release is abnormal. You can manually delete the release and reinstall it.
+

status_description

+

String

+

Release status description

+

update_at

+

String

+

Updated at

+

values

+

String

+

Release value

+

version

+

Integer

+

Release version

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
[ {
+  "chart_name" : "magento-mysql",
+  "chart_public" : false,
+  "chart_version" : "1.0.0",
+  "cluster_id" : "a870253f-5dc7-11ee-bf71-0255ac100b03",
+  "cluster_name" : "sfs-turbo-test",
+  "create_at" : "2023-11-14T20:30:57+08:00",
+  "description" : "Initial install underway",
+  "name" : "testwww",
+  "namespace" : "monitoring",
+  "parameters" : "",
+  "resources" : "",
+  "status" : "PENDING_INSTALL",
+  "status_description" : "Initial install underway",
+  "update_at" : "2023-11-14T20:30:57+08:00",
+  "values" : "{\"basic\":{\"admin_password\":\"******\",\"admin_username\":\"username\",\"app_name\":\"magento\",\"mysql_database\":\"magento\",\"mysql_name\":\"mysql\",\"mysql_password\":\"******\",\"mysql_port\":3306,\"mysql_root_password\":\"******\",\"mysql_user\":\"magento\",\"storage_class\":\"csi-nas\",\"storage_mode\":\"ReadWriteMany\",\"storage_size\":\"10G\"},\"global\":{\"magento_EIP\":\"100.100.100.100\",\"magento_EPORT\":32080,\"namespace\":\"default\"},\"image\":{\"magento_image\":\"example.com/everest/magento:latest\",\"mysql_image\":\"example.com/everest/mysql:5.7.14\"}}",
+  "version" : 1
+} ]
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Chart Management
+
+
+ diff --git a/docs/cce/api-ref/ShowUserChartsQuotas.html b/docs/cce/api-ref/ShowUserChartsQuotas.html new file mode 100644 index 000000000..b60641d4e --- /dev/null +++ b/docs/cce/api-ref/ShowUserChartsQuotas.html @@ -0,0 +1,182 @@ + + +

Obtaining the Quota of a User Chart

+

Function

This API is used to obtain the quota of a user chart.

+
+

URI

GET /v2/charts/{project_id}/quotas

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

Request body type or format.

+

Constraints:

+

The GET method is not verified.

+

Options:

+
  • application/json
  • application/json;charset=utf-8
  • application/x-pem-file
  • multipart/form-data (It can be used when the FormData parameter exists.)
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see API Usage Guidelines.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

quotas

+

quotas object

+

Chart quota

+
+
+ +
+ + + + + + + + + +
Table 4 quotas

Parameter

+

Type

+

Description

+

resources

+

Array of resources objects

+

Resources

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 resources

Parameter

+

Type

+

Description

+

type

+

String

+

Resource type

+

quota

+

Integer

+

Resource quota

+

used

+

Integer

+

Used resources

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "quotas" : {
+    "resources" : [ {
+      "type" : "Charts",
+      "quota" : 200,
+      "used" : 2
+    } ]
+  }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Chart Management
+
+
+ diff --git a/docs/cce/api-ref/UpdateChart.html b/docs/cce/api-ref/UpdateChart.html new file mode 100644 index 000000000..163faacc7 --- /dev/null +++ b/docs/cce/api-ref/UpdateChart.html @@ -0,0 +1,254 @@ + + +

Updating a Chart

+

Function

This API is used to update a chart.

+
+

URI

PUT /v2/charts/{chart_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

chart_id

+

Yes

+

String

+

Chart ID

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

Request body type or format.

+

Constraints:

+

The GET method is not verified.

+

Options:

+
  • application/json
  • application/json;charset=utf-8
  • application/x-pem-file
  • multipart/form-data (It can be used when the FormData parameter exists.)
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see API Usage Guidelines.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 FormData parameters

Parameter

+

Mandatory

+

Type

+

Description

+

parameters

+

No

+

String

+

Parameter configurations for uploading a chart. The following is an example: "{"override":true,"skip_lint":true,"source":"package"}"

+
  • skip_lint: whether lint uploaded chart
  • override: whether override existed chart
  • visible: update chart visible
+

content

+

Yes

+

File

+

Chart package file

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Chart ID

+

name

+

String

+

Chart name

+

values

+

String

+

Chart value

+

translate

+

String

+

Chart translation resources

+

instruction

+

String

+

Chart description

+

version

+

String

+

Chart version

+

description

+

String

+

Chart description

+

source

+

String

+

Chart source

+

icon_url

+

String

+

URL to chart icons

+

public

+

Boolean

+

Whether the chart is public

+

chart_url

+

String

+

URL to the chart

+

create_at

+

String

+

Created at

+

update_at

+

String

+

Updated at

+
+
+
+

Example Requests

If the FormData parameter exists, the value of Content-Type must be multipart/form-data, and the file path must be specified.

+
POST /v2/charts -H "X-Auth-Token:$token" -H "Content-Type:multipart/form-data" -F parameters='{"skip_lint":true,"override":true,"source":"package"}' -F content=@/root/neo4j-3.0.1.tgz
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "id" : "e99a7e86-afdd-11eb-aca3-0255ac100b0e",
+  "name" : "neo4j",
+  "values" : "{\"acceptLicenseAgreement\":\"no\",\"affinity\":{},\"authEnabled\":true,\"clusterDomain\":\"cluster.local\",\"core\":{\"initContainers\":[],\"numberOfServers\":3,\"persistentVolume\":{\"enabled\":true,\"mountPath\":\"/data\",\"size\":\"10Gi\"},\"sidecarContainers\":[]},\"defaultDatabase\":\"neo4j\",\"image\":\"neo4j\",\"imagePullPolicy\":\"IfNotPresent\",\"imageTag\":\"4.0.3-enterprise\",\"name\":\"neo4j\",\"nodeSelector\":{},\"podDisruptionBudget\":{},\"readReplica\":{\"autoscaling\":{\"enabled\":false,\"maxReplicas\":3,\"minReplicas\":1,\"targetAverageUtilization\":70},\"initContainers\":[],\"numberOfServers\":0,\"resources\":{},\"sidecarContainers\":[]},\"resources\":{},\"testImage\":\"markhneedham/k8s-kubectl\",\"testImageTag\":\"master\",\"tolerations\":[],\"useAPOC\":\"true\"}",
+  "translate" : "",
+  "instruction" : "README.md",
+  "version" : "3.0.1",
+  "description" : "DEPRECATED Neo4j is the world's leading graph database",
+  "source" : "",
+  "icon_url" : "https://example.com/images/neo4j_logo.png",
+  "public" : false,
+  "chart_url" : "neo4j-3.0.1.tgz",
+  "create_at" : "2021-05-08T08:53:13Z",
+  "update_at" : "2021-05-08T08:53:13Z"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Chart Management
+
+
+ diff --git a/docs/cce/api-ref/UpdateRelease.html b/docs/cce/api-ref/UpdateRelease.html new file mode 100644 index 000000000..20b507236 --- /dev/null +++ b/docs/cce/api-ref/UpdateRelease.html @@ -0,0 +1,450 @@ + + +

Updating a Release

+

Function

This API is used to update a release.

+
+

URI

PUT /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}

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

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Release name

+

namespace

+

Yes

+

String

+

Namespace of the chart

+

cluster_id

+

Yes

+

String

+

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

Request body type or format.

+

Constraints:

+

The GET method is not verified.

+

Options:

+
  • application/json
  • application/json;charset=utf-8
  • application/x-pem-file
  • multipart/form-data (It can be used when the FormData parameter exists.)
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see API Usage Guidelines.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

chart_id

+

Yes

+

String

+

Chart ID

+

action

+

Yes

+

String

+

upgrade for an upgrade and rollback for a rollback

+

parameters

+

Yes

+

ReleaseReqBodyParams object

+

Release parameters

+

values

+

Yes

+

values object

+

Release value

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ReleaseReqBodyParams

Parameter

+

Mandatory

+

Type

+

Description

+

dry_run

+

No

+

Boolean

+

After this function is enabled, only chart parameters are verified, and installation is not performed.

+

name_template

+

No

+

String

+

Release name template

+

no_hooks

+

No

+

Boolean

+

Whether to disable hooks during installation

+

replace

+

No

+

Boolean

+

Whether to replace the release with the same name

+

recreate

+

No

+

Boolean

+

Whether to rebuild the release

+

reset_values

+

No

+

Boolean

+

Whether to reset values during an update

+

release_version

+

No

+

Integer

+

Version of the rollback release

+

include_hooks

+

No

+

Boolean

+

Enable hooks during an update or deletion.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 values

Parameter

+

Mandatory

+

Type

+

Description

+

imagePullPolicy

+

No

+

String

+

Image pull policy

+

imageTag

+

No

+

String

+

Image tag

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

chart_name

+

String

+

Chart name

+

chart_public

+

Boolean

+

Whether the chart is public

+

chart_version

+

String

+

Chart version

+

cluster_id

+

String

+

Cluster ID

+

cluster_name

+

String

+

Current name

+

create_at

+

String

+

Created at

+

description

+

String

+

Release description

+

name

+

String

+

Release name

+

namespace

+

String

+

Namespace to which a chart release belongs

+

parameters

+

String

+

Release parameters

+

resources

+

String

+

Resources required by the release

+

status

+

String

+

Release status

+
  • DEPLOYED: The release is normal.
  • DELETED: The release has been deleted.
  • FAILED: The release fails to be deployed.
  • DELETING: The release is being deleted.
  • PENDING_INSTALL: The release is waiting to be installed.
  • PENDING_UPGRADE: The release is waiting to be upgraded.
  • PENDING_ROLLBACK: The release is waiting for rollback.
  • UNKNOWN: The release status is unknown, indicating that the release is abnormal. You can manually delete the release and reinstall it.
+

status_description

+

String

+

Release status description

+

update_at

+

String

+

Updated at

+

values

+

String

+

Release value

+

version

+

Integer

+

Release version

+
+
+
+

Example Requests

PUT /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}
+
+{
+  "chart_id" : "af4b699e-018c-11ec-b8b0-0255ac100b05",
+  "action" : "upgrade",
+  "parameters" : {
+    "dry_run" : false,
+    "name_template" : "string",
+    "no_hooks" : false,
+    "replace" : false,
+    "recreate" : false,
+    "reset_values" : false,
+    "release_version" : 1,
+    "include_hooks" : false
+  },
+  "values" : {
+    "imagePullPolicy" : "IfNotPresent",
+    "imageTag" : "v2"
+  }
+}
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "chart_name" : "magento-mysql",
+  "chart_public" : false,
+  "chart_version" : "1.0.0",
+  "cluster_id" : "a870253f-5dc7-11ee-bf71-0255ac100b03",
+  "cluster_name" : "sfs-turbo-test",
+  "create_at" : "2023-11-14T20:30:57+08:00",
+  "description" : "Initial install underway",
+  "name" : "testwww",
+  "namespace" : "monitoring",
+  "parameters" : "",
+  "resources" : "",
+  "status" : "PENDING_INSTALL",
+  "status_description" : "Initial install underway",
+  "update_at" : "2023-11-14T20:30:57+08:00",
+  "values" : "{\"basic\":{\"admin_password\":\"******\",\"admin_username\":\"username\",\"app_name\":\"magento\",\"mysql_database\":\"magento\",\"mysql_name\":\"mysql\",\"mysql_password\":\"******\",\"mysql_port\":3306,\"mysql_root_password\":\"******\",\"mysql_user\":\"magento\",\"storage_class\":\"csi-nas\",\"storage_mode\":\"ReadWriteMany\",\"storage_size\":\"10G\"},\"global\":{\"magento_EIP\":\"100.100.100.100\",\"magento_EPORT\":32080,\"namespace\":\"default\"},\"image\":{\"magento_image\":\"example.com/everest/magento:latest\",\"mysql_image\":\"example.com/everest/mysql:5.7.14\"}}",
+  "version" : 1
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Chart Management
+
+
+ diff --git a/docs/cce/api-ref/UploadChart.html b/docs/cce/api-ref/UploadChart.html new file mode 100644 index 000000000..c599a685d --- /dev/null +++ b/docs/cce/api-ref/UploadChart.html @@ -0,0 +1,231 @@ + + +

Uploading a Chart

+

Function

This API is used to upload a chart.

+
+

URI

POST /v2/charts

+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 1 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

Request body type or format.

+

Constraints:

+

The GET method is not verified.

+

Options:

+
  • application/json
  • application/json;charset=utf-8
  • application/x-pem-file
  • multipart/form-data (It can be used when the FormData parameter exists.)
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see API Usage Guidelines.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 FormData parameters

Parameter

+

Mandatory

+

Type

+

Description

+

parameters

+

No

+

String

+

Parameter configurations for uploading a chart. The following is an example: "{"override":true,"skip_lint":true,"source":"package"}"

+
  • skip_lint: whether lint uploaded chart
  • override: whether override existed chart
  • visible: update chart visible
+

content

+

Yes

+

File

+

Chart package file

+
+
+
+

Response Parameters

Status code: 201

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Chart ID

+

name

+

String

+

Chart name

+

values

+

String

+

Chart value

+

translate

+

String

+

Chart translation resources

+

instruction

+

String

+

Chart description

+

version

+

String

+

Chart version

+

description

+

String

+

Chart description

+

source

+

String

+

Chart source

+

icon_url

+

String

+

URL to chart icons

+

public

+

Boolean

+

Whether the chart is public

+

chart_url

+

String

+

URL to the chart

+

create_at

+

String

+

Created at

+

update_at

+

String

+

Updated at

+
+
+
+

Example Requests

If the FormData parameter exists, the value of Content-Type must be multipart/form-data, and the file path must be specified.

+
POST /v2/charts -H "X-Auth-Token:$token" -H "Content-Type:multipart/form-data" -F parameters='{"skip_lint":true,"override":true,"source":"package"}' -F content=@/root/neo4j-3.0.1.tgz
+
+

Example Responses

Status code: 201

+

Created

+
{
+  "id" : "e99a7e86-afdd-11eb-aca3-0255ac100b0e",
+  "name" : "neo4j",
+  "values" : "{\"acceptLicenseAgreement\":\"no\",\"affinity\":{},\"authEnabled\":true,\"clusterDomain\":\"cluster.local\",\"core\":{\"initContainers\":[],\"numberOfServers\":3,\"persistentVolume\":{\"enabled\":true,\"mountPath\":\"/data\",\"size\":\"10Gi\"},\"sidecarContainers\":[]},\"defaultDatabase\":\"neo4j\",\"image\":\"neo4j\",\"imagePullPolicy\":\"IfNotPresent\",\"imageTag\":\"4.0.3-enterprise\",\"name\":\"neo4j\",\"nodeSelector\":{},\"podDisruptionBudget\":{},\"readReplica\":{\"autoscaling\":{\"enabled\":false,\"maxReplicas\":3,\"minReplicas\":1,\"targetAverageUtilization\":70},\"initContainers\":[],\"numberOfServers\":0,\"resources\":{},\"sidecarContainers\":[]},\"resources\":{},\"testImage\":\"markhneedham/k8s-kubectl\",\"testImageTag\":\"master\",\"tolerations\":[],\"useAPOC\":\"true\"}",
+  "translate" : "",
+  "instruction" : "README.md",
+  "version" : "3.0.1",
+  "description" : "DEPRECATED Neo4j is the world's leading graph database",
+  "source" : "",
+  "icon_url" : "https://info.neo4j.com/rs/773-GON-065/images/neo4j_logo.png",
+  "public" : false,
+  "chart_url" : "neo4j-3.0.1.tgz",
+  "create_at" : "2021-05-08T08:53:13Z",
+  "update_at" : "2021-05-08T08:53:13Z"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

201

+

Created

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Chart Management
+
+
+ diff --git a/docs/cce/api-ref/cce_02_0103.html b/docs/cce/api-ref/cce_02_0103.html index 927c51d6f..92d7d2d56 100644 --- a/docs/cce/api-ref/cce_02_0103.html +++ b/docs/cce/api-ref/cce_02_0103.html @@ -12,6 +12,8 @@
  • Quota Management
    • +
  • Chart Management
    +
  • Add-on Instance Parameters
    • diff --git a/docs/cce/api-ref/cce_02_0236.html b/docs/cce/api-ref/cce_02_0236.html index a7091f099..e0fcda895 100644 --- a/docs/cce/api-ref/cce_02_0236.html +++ b/docs/cce/api-ref/cce_02_0236.html @@ -168,6 +168,22 @@ +

    timezone

    + +

    No

    + +

    String

    + +

    Details:

    +

    Cluster time zone

    +

    Constraints:

    +

    None

    +

    Options:

    +

    N/A

    +

    Default value:

    +

    N/A

    + + @@ -909,6 +925,20 @@ +

    timezone

    + +

    String

    + +

    Details:

    +

    Cluster time zone

    +

    Constraints:

    +

    None

    +

    Options:

    +

    N/A

    +

    Default value:

    +

    N/A

    + + @@ -1339,6 +1369,7 @@ "annotations": { "foo2": "bar2" } + "timezone" : "******" }, "spec": { "type": "VirtualMachine", diff --git a/docs/cce/api-ref/cce_02_0273.html b/docs/cce/api-ref/cce_02_0273.html index a17014019..01faffce0 100644 --- a/docs/cce/api-ref/cce_02_0273.html +++ b/docs/cce/api-ref/cce_02_0273.html @@ -8,7 +8,19 @@ -

    2024-11-25

    +

    2025-02-26

    + +

    Add:

    +

    Added the timezone field in Creating a Cluster.

    + + +

    2025-01-13

    + +

    Add:

    +

    Added Chart Management.

    + + +

    2024-11-25

    Add:

    Added NGINX Ingress Controller.

    diff --git a/docs/cce/api-ref/chart_lifecycle_management.html b/docs/cce/api-ref/chart_lifecycle_management.html new file mode 100644 index 000000000..9b9f2d9c1 --- /dev/null +++ b/docs/cce/api-ref/chart_lifecycle_management.html @@ -0,0 +1,42 @@ + + +

    Chart Management

    +

    +
    +
    + + +
    +
    Parent topic: APIs
    +
    +
    +