使用saectl工具管理弹性规则HPA

前提条件

已安装saectl工具，并配置AccessKey ID、AccessKey Secret、应用部署地域，详见安装与配置saectl工具。

管理弹性规则

saectl工具支持创建、查看、更新、删除弹性规则。

为应用创建弹性规则

1. 编写文件名为hpa.yaml的文件，其中包含弹性规则的配置信息。配置文件的示例如下，各配置项的详细信息请参考K8s YAML配置项说明。

   apiVersion: autoscaling/v2
   kind: HorizontalPodAutoscaler
   metadata:
     annotations:
       sae.aliyun.com/alias: test-app # 弹性策略昵称，选填
       sae.aliyun.com/enabled: "true" # 是否启用该弹性策略，选填
     name: metric-test-app # 固定格式：metric-${应用名}
     namespace: default
   spec:
     behavior: # 选填
       scaleDown: # 缩容配置
         policies:
         - periodSeconds: 15
           type: Pods
           value: 10
         stabilizationWindowSeconds: 200
       scaleUp: # 扩容配置
         policies:
         - periodSeconds: 15
           type: Pods
           value: 5
         stabilizationWindowSeconds: 100
     maxReplicas: 8
     metrics:
     - resource:
         name: cpu
         target:
           averageUtilization: 80
           type: Utilization
       type: Resource
     - resource:
         name: memory
         target:
           averageUtilization: 80
           type: Utilization
       type: Resource
     - pods:
         metric:
           name: tcpActiveConn
         target:
           averageValue: "100"
           type: AverageValue
       type: Pods
     - pods:
         metric:
           name: tcpTotalConn
         target:
           averageValue: "100"
           type: AverageValue
       type: Pods
     - external:
         metric:
           name: qps
         target:
           averageValue: "100"
           type: AverageValue
       type: External
     - external:
         metric:
           name: rt
         target:
           averageValue: 100k
           type: AverageValue
       type: External
     minReplicas: 1
     scaleTargetRef:
       apiVersion: apps/v1
       kind: Deployment
       name: test-app # 固定格式：${应用名}

2. 在hpa.yaml文件所在路径执行以下命令，实现为应用创建弹性规则。

   saectl apply -f hpa.yaml

查看弹性规则列表

saectl get hpa -l sae.aliyun.com/app-name=${deployment-name} -n ${namespace}
# ${deployment-name}为应用的名称，如果不通过-l参数指定应用名称，则默认显示范围内所有应用绑定的HPA列表
# ${namespace}为命名空间ID，如果不通过-n参数指定命名空间，则默认使用default命名空间

输出结果字段说明如下：

查看弹性规则详情

saectl工具支持使用get或describe命令查看弹性规则详情。返回结果中包含弹性规则的配置项，详情请参考K8s YAML配置项说明。

通过get命令查看弹性规则详情

saectl get hpa ${hpa-name} -o {yaml | json} -n ${namespace}
# ${hpa-name}为HPA名称
# -o参数指定返回结果的格式
# ${namespace}为命名空间ID，如果不通过-n参数指定命名空间，则默认使用default命名空间

通过describe命令查看弹性规则详情

saectl describe hpa ${hpa-name} -n ${namespace}
# ${hpa-name}为HPA名称
# ${namespace}为命名空间ID，如果不通过-n参数指定命名空间，则默认使用default命名空间

更新弹性规则

saectl工具支持使用edit或apply命令更新弹性规则。

通过edit命令在线编辑弹性规则配置信息

1. 执行以下命令，将会以YAML文件的形式打开指定弹性规则的配置信息。

   saectl edit hpa ${hpa-name} -n ${namespace}
   # ${hpa-name}为HPA名称
   # ${namespace}为命名空间ID，如果不通过-n参数指定命名空间，则默认使用default命名空间

2. 在打开的YAML文件中按需修改配置信息，保存并关闭文件，等待配置信息变更完成。

通过apply命令实现按照YAML配置文件更新弹性规则

修改已有的弹性规则的配置文件hpa.yaml。在配置文件所在路径执行以下命令，实现弹性规则配置信息的变更。

saectl apply -f hpa.yaml

删除弹性规则

执行以下命令，解绑指定的弹性规则。

saectl delete hpa ${hpa-name} -n ${namespace}
# ${hpa-name}为HPA名称
# ${namespace}为命名空间ID，如果不通过-n参数指定命名空间，则默认使用default命名空间

K8s YAML配置项说明

SAE应用的弹性规则对应于Kubernetes的HPA（HorizontalPodAutoscaler）资源类型。相关的K8s YAML配置项说明详见下表。

  labels:
    sae.aliyun.com/app-name: ${应用名}

scaleDown:
  policies:
  - periodSeconds: 15 # 固定值
    type: Pods # 固定值
    value: 4 # HPA缩容步长

scaleUp:
  policies:
  - periodSeconds: 15 # 固定值
    type: Pods # 固定值
    value: 4 # HPA扩容步长

  scaleTargetRef:
    apiVersion: apps/v1
    kind: Deployment
    name: test-app # 应用名