
# CCE容器弹性引擎
#### 插件介绍
CCE容器弹性引擎（cce-hpa-controller）插件是一款CCE自研的插件，能够基于CPU利用率、内存利用率等指标，对无状态工作负载进行弹性扩缩容。
#### 字段说明
表1参数描述 
| 参数     | 是否必选 | 参数类型                                            | 描述             |
|:---|:---|:---|:---|
| basic  | 否    | object                                          | 插件基础配置参数，无需指定。 |
| flavor | 是    | [表2] object      | 插件规格参数         |
| custom | 是    | [表3] object | 插件自定义参数        |
   
 表2flavor 
| 参数        | 是否必选 | 参数类型                                                | 描述              |
|:---|:---|:---|:---|
| replicas  | 是    | String                                              | 实例数，默认为：2       |
| resources | 是    | [resources] object | 容器资源（CPU、内存）配额。 |
   
 表3custom 
| 参数                     | 是否必选 | 参数类型                                             | 描述                                                                                                                                                                       |
|:---|:---|:---|:---|
| multiAZEnable          | 否    | bool                                             | 插件中deployment组件多可用部署是否采用强制模式，默认：false。强制模式下插件Deployment实例强制调度到不同可用区的节点上，如集群下节点不满足多可用区，插件实例将无法全部运行。若multiAZEnable与multiAZBalance配置也同时为true，则以multiAZBalance为准使用多可用部署均分模式。 |
| multiAZBalance         | 否    | bool                                             | 插件中deployment组件多可用部署是否采用均分模式，默认：false。插件Deployment实例均匀调度到当前集群下各可用区，增加新的可用区后建议扩容插件实例以实现跨可用区高可用部署；均分模式限制不同可用区间插件实例数相差不超过1，单个可用区资源不足会导致后续其他实例无法调度。                          |
| tolerations            | 否    | Array of [表5]  | 污点容忍配置                                                                                                                                                                   |
| node_match_expressions | 否    | Array of [表6] | 插件实例亲和性配置                                                                                                                                                                |
   
 表4resources字段数据结构说明 
| 参数          | 是否必选 | 参数类型   | 描述                              |
|:---|:---|:---|:---|
| limitsCpu   | 是    | String | CPU大小限制，单位：m                    |
| limitsMem   | 是    | String | 内存大小限制，单位：Mi                    |
| name        | 是    | String | 插件名称，固定为：customedhpa-controller |
| requestsCpu | 是    | String | 申请的CPU大小，单位：m                   |
| requestsMem | 是    | String | 申请的内存大小，单位：Mi                   |
   
 表5tolerations污点 
| 参数                | 是否必选 | 参数类型   | 描述    |
|:---|:---|:---|:---|
| key               | 否    | String | 污点键   |
| effect            | 否    | String | 污点策略  |
| operator          | 否    | String | 操作符   |
| tolerationSeconds | 否    | Int    | 容忍时间窗 |
   
 表6nodeMatchExpression节点亲和配置 
| 参数       | 是否必选 | 参数类型           | 描述      |
|:---|:---|:---|:---|
| key      | 否    | String         | 污点键     |
| values   | 否    | List\<String\> | 节点亲和的名称 |
| operator | 否    | String         | 操作符     |
   
#### 请求示例
```
{
"kind": "Addon",
"apiVersion": "v3",
"metadata": {
"annotations": {
"addon.install/type": "install"
}
},
"spec": {
"clusterID": "2292498e-******-0255ac1001ba",
"version": "1.4.2",
"addonTemplateName": "cce-hpa-controller",
"values": {
                        "basic": {
"basickey":"val"
},
"flavor": {
"replicas": 1,
"resources": [{
"limitsCpu": "100m",
"limitsMem": "300Mi",
"name": "customedhpa-controller",
"requestsCpu": "100m",
"requestsMem": "300Mi"
}]
},
"custom": {
"multiAZBalance": false,
"multiAZEnabled": false,
"node_match_expressions": [],
"tolerations": [{
"key": "node.kubernetes.io/not-ready",
"operator": "Exists",
"effect": "NoExecute",
"tolerationSeconds": 60
},
{
"key": "node.kubernetes.io/unreachable",
"operator": "Exists",
"effect": "NoExecute",
"tolerationSeconds": 60
}]
}
}
}
}
```
