This API is used to create a release.
+POST /cce/cam/v3/clusters/{cluster_id}/releases
+ +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. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +Request body type or format. +Constraints: +The GET method is not verified. +Options: +
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. + |
+
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 + |
+
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. + |
+
Status code: 201
+ +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 +
|
+
status_description + |
+String + |
+Release status description + |
+
update_at + |
+String + |
+Updated at + |
+
values + |
+String + |
+Release value + |
+
version + |
+Integer + |
+Release version + |
+
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" : ""
+ }
+}
+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 Code + |
+Description + |
+
|---|---|
201 + |
+Created + |
+
See Error Codes.
+This API is used to delete a chart.
+DELETE /v2/charts/{chart_id}
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
chart_id + |
+Yes + |
+String + |
+Chart ID + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +Request body type or format. +Constraints: +The GET method is not verified. +Options: +
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. + |
+
Status code: 200
+ +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 + |
+
None
+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 Code + |
+Description + |
+
|---|---|
200 + |
+OK + |
+
See Error Codes.
+This API is used to delete a release.
+DELETE /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}
+ +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. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +Request body type or format. +Constraints: +The GET method is not verified. +Options: +
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. + |
+
Status code: 200
+ +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. +
|
+
status_description + |
+String + |
+Release status description + |
+
update_at + |
+String + |
+Updated at + |
+
values + |
+String + |
+Release value + |
+
version + |
+Integer + |
+Release version + |
+
None
+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 Code + |
+Description + |
+
|---|---|
200 + |
+OK + |
+
See Error Codes.
+This API is used to download a chart.
+GET /v2/charts/{chart_id}/archive
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
chart_id + |
+Yes + |
+String + |
+Chart ID + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +Request body type or format. +Constraints: +The GET method is not verified. +Options: +
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. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
- + |
+File + |
+File name of the downloaded chart. + |
+
None
+Status code: 200
+OK
+"chart-file.tgz"+
Status Code + |
+Description + |
+
|---|---|
200 + |
+OK + |
+
See Error Codes.
+This API is used to obtain the chart list.
+GET /v2/charts
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +Request body type or format. +Constraints: +The GET method is not verified. +Options: +
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. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
[items] + |
+Array of ChartResp objects + |
+Chart list + |
+
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 + |
+
None
+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 Code + |
+Description + |
+
|---|---|
200 + |
+OK + |
+
See Error Codes.
+This API is used to obtain a release list.
+GET /cce/cam/v3/clusters/{cluster_id}/releases
+ +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. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
chart_id + |
+No + |
+String + |
+Chart ID + |
+
namespace + |
+No + |
+String + |
+Namespace of the chart + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +Request body type or format. +Constraints: +The GET method is not verified. +Options: +
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. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
[items] + |
+Array of ReleaseResp objects + |
+- + |
+
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 +
|
+
status_description + |
+String + |
+Release status description + |
+
update_at + |
+String + |
+Updated at + |
+
values + |
+String + |
+Release value + |
+
version + |
+Integer + |
+Release version + |
+
None
+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 Code + |
+Description + |
+
|---|---|
200 + |
+OK + |
+
See Error Codes.
+This API is used to obtain a chart.
+GET /v2/charts/{chart_id}
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
chart_id + |
+Yes + |
+String + |
+Chart ID + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +Request body type or format. +Constraints: +The GET method is not verified. +Options: +
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. + |
+
Status code: 200
+ +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 + |
+
None
+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 Code + |
+Description + |
+
|---|---|
200 + |
+OK + |
+
See Error Codes.
+This API is used to obtain chart values.
+GET /v2/charts/{chart_id}/values
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
chart_id + |
+Yes + |
+String + |
+Chart ID + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +Request body type or format. +Constraints: +The GET method is not verified. +Options: +
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. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
values + |
+Map<String,Object> + |
+Data in values.yaml. The data structure depends on the chart. + |
+
None
+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 Code + |
+Description + |
+
|---|---|
200 + |
+OK + |
+
See Error Codes.
+This API is used to obtain a release.
+GET /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}
+ +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. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +Request body type or format. +Constraints: +The GET method is not verified. +Options: +
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. + |
+
Status code: 200
+ +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 +
|
+
status_description + |
+String + |
+Release status description + |
+
update_at + |
+String + |
+Updated at + |
+
values + |
+String + |
+Release value + |
+
version + |
+Integer + |
+Release version + |
+
None
+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 Code + |
+Description + |
+
|---|---|
200 + |
+OK + |
+
See Error Codes.
+This API is used to obtain historical records of a release.
+GET /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}/history
+ +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. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +Request body type or format. +Constraints: +The GET method is not verified. +Options: +
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. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
[items] + |
+Array of ReleaseResp objects + |
+- + |
+
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 +
|
+
status_description + |
+String + |
+Release status description + |
+
update_at + |
+String + |
+Updated at + |
+
values + |
+String + |
+Release value + |
+
version + |
+Integer + |
+Release version + |
+
None
+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 Code + |
+Description + |
+
|---|---|
200 + |
+OK + |
+
See Error Codes.
+This API is used to obtain the quota of a user chart.
+GET /v2/charts/{project_id}/quotas
+ +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. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +Request body type or format. +Constraints: +The GET method is not verified. +Options: +
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. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
quotas + |
+quotas object + |
+Chart quota + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
resources + |
+Array of resources objects + |
+Resources + |
+
None
+Status code: 200
+OK
+{
+ "quotas" : {
+ "resources" : [ {
+ "type" : "Charts",
+ "quota" : 200,
+ "used" : 2
+ } ]
+ }
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+OK + |
+
See Error Codes.
+This API is used to update a chart.
+PUT /v2/charts/{chart_id}
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
chart_id + |
+Yes + |
+String + |
+Chart ID + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +Request body type or format. +Constraints: +The GET method is not verified. +Options: +
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. + |
+
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"}" +
|
+
content + |
+Yes + |
+File + |
+Chart package file + |
+
Status code: 200
+ +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 + |
+
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
+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 Code + |
+Description + |
+
|---|---|
200 + |
+OK + |
+
See Error Codes.
+This API is used to update a release.
+PUT /cce/cam/v3/clusters/{cluster_id}/namespace/{namespace}/releases/{name}
+ +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. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +Request body type or format. +Constraints: +The GET method is not verified. +Options: +
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. + |
+
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 + |
+
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. + |
+
Status code: 200
+ +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 +
|
+
status_description + |
+String + |
+Release status description + |
+
update_at + |
+String + |
+Updated at + |
+
values + |
+String + |
+Release value + |
+
version + |
+Integer + |
+Release version + |
+
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"
+ }
+}
+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 Code + |
+Description + |
+
|---|---|
200 + |
+OK + |
+
See Error Codes.
+This API is used to upload a chart.
+POST /v2/charts
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
Content-Type + |
+Yes + |
+String + |
+Details: +Request body type or format. +Constraints: +The GET method is not verified. +Options: +
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. + |
+
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"}" +
|
+
content + |
+Yes + |
+File + |
+Chart package file + |
+
Status code: 201
+ +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 + |
+
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
+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 Code + |
+Description + |
+
|---|---|
201 + |
+Created + |
+
See Error Codes.
+timezone
+No
+String
+Details:
+Cluster time zone
+Constraints:
+None
+Options:
+N/A
+Default value:
+N/A
+timezone
+String
+Details:
+Cluster time zone
+Constraints:
+None
+Options:
+N/A
+Default value:
+N/A
+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 @@ + + ++