3.10. 了解如何添加自定义指标自动扩展

流程

1. 创建一个类似如下的 YAML 文件：只有名称 <2>, 对象名称 <4>, 和对象类型 <5> 是必需的。

   缩放对象示例

   apiVersion: keda.sh/v1alpha1
   kind: ScaledObject
   metadata:
     annotations:
       autoscaling.keda.sh/paused-replicas: "0" 1
     name: scaledobject 2
     namespace: my-namespace
   spec:
     scaleTargetRef:
       apiVersion: apps/v1 3
       name: example-deployment 4
       kind: Deployment 5
       envSourceContainerName: .spec.template.spec.containers[0] 6
     cooldownPeriod:  200 7
     maxReplicaCount: 100 8
     minReplicaCount: 0 9
     metricsServer: 10
       auditConfig:
         logFormat: "json"
         logOutputVolumeClaim: "persistentVolumeClaimName"
         policy:
           rules:
           - level: Metadata
           omitStages: "RequestReceived"
           omitManagedFields: false
         lifetime:
           maxAge: "2"
           maxBackup: "1"
           maxSize: "50"
     fallback: 11
       failureThreshold: 3
       replicas: 6
     pollingInterval: 30 12
     advanced:
       restoreToOriginalReplicaCount: false 13
       horizontalPodAutoscalerConfig:
         name: keda-hpa-scale-down 14
         behavior: 15
           scaleDown:
             stabilizationWindowSeconds: 300
             policies:
             - type: Percent
               value: 100
               periodSeconds: 15
     triggers:
     - type: prometheus 16
       metadata:
         serverAddress: https://thanos-querier.openshift-monitoring.svc.cluster.local:9092
         namespace: kedatest
         metricName: http_requests_total
         threshold: '5'
         query: sum(rate(http_requests_total{job="test-app"}[1m]))
         authModes: basic
     - authenticationRef: 17
         name: prom-triggerauthentication
       metadata:
         name: prom-triggerauthentication
       type: object
     - authenticationRef: 18
         name: prom-cluster-triggerauthentication
       metadata:
         name: prom-cluster-triggerauthentication
       type: object

   1

   可选：指定自定义 Metrics Autoscaler Operator 将副本扩展到指定的值和停止自动扩展，如 "Pausing the custom metrics autoscaler for a workload" 部分所述。

   2

   指定此自定义指标自动扩展的名称。

   3

   可选：指定目标资源的 API 版本。默认为 apps/v1。

   4

   指定要缩放的对象名称。

   5

   指定 kind 为 Deployment, StatefulSet 或 CustomResource。

   6

   可选：指定目标资源中的容器的名称，其中的自定义自动扩展器获取包含 secret 的环境变量等。默认为 .spec.template.spec.containers[0]。

   7

   可选的。指定一个在最后的触发器报告后等待的时间（以秒为单位），在经过这个时间后才会将部署缩减为 0（如果 minReplicaCount 设置为 0）。默认值为 300。

   8

   可选：指定扩展时的最大副本数量。默认值为 100。

   9

   可选：指定缩减时的最小副本数量。

   10

   可选：指定审计日志的参数。如"配置审计日志记录"部分中所述。

   11

   可选：指定在扩展程序无法从源中获取由 failureThreshold 参数定义的次数时回退到的副本数。有关回退行为的更多信息，请参阅 KEDA 文档。

   12

   可选：指定检查每个触发器的时间间隔（以秒为单位）。默认值为 30。

   13

   可选：指定是否在删除扩展对象后将目标资源扩展为原始副本数。默认为 false，这会在删除扩展对象时保留副本数。

   14

   可选：指定 pod 横向自动扩展的名称。默认为 keda-hpa-{scaled-object-name}。

   15

   可选：指定一个扩展策略来控制用来扩展或缩减 pod 的速度，如"扩展策略"部分中所述。

   16

   指定用作扩展基础的触发器，如"识别自定义指标自动扩展触发器"部分中所述。本例使用 OpenShift Container Platform 监控。

   17

   可选：指定触发器身份验证，如 "Creating a custom metrics autoscaler trigger authentication" 部分所述。

   18

   可选：指定集群触发器身份验证，如 "Creating a custom metrics autoscaler trigger authentication" 部分所述。

   注意

   不需要同时指定命名空间触发器身份验证和集群触发器身份验证。

2. 创建自定义指标自动扩展：

   $ oc create -f <file-name>.yaml

流程

1. 创建一个类似以下示例的 YAML 文件：

   kind: ScaledJob
   apiVersion: keda.sh/v1alpha1
   metadata:
     name: scaledjob
     namespace: my-namespace
   spec:
     failedJobsHistoryLimit: 5
     jobTargetRef:
       activeDeadlineSeconds: 600 1
       backoffLimit: 6 2
       parallelism: 1 3
       completions: 1 4
       template:  5
         metadata:
           name: pi
         spec:
           containers:
           - name: pi
             image: perl
             command: ["perl",  "-Mbignum=bpi", "-wle", "print bpi(2000)"]
     maxReplicaCount: 100 6
     pollingInterval: 30 7
     successfulJobsHistoryLimit: 5 8
     failedJobsHistoryLimit: 5 9
     envSourceContainerName: 10
     rolloutStrategy: gradual 11
     scalingStrategy: 12
       strategy: "custom"
       customScalingQueueLengthDeduction: 1
       customScalingRunningJobPercentage: "0.5"
       pendingPodConditions:
         - "Ready"
         - "PodScheduled"
         - "AnyOtherCustomPodCondition"
       multipleScalersCalculation : "max"
     triggers:
     - type: prometheus 13
       metadata:
         serverAddress: https://thanos-querier.openshift-monitoring.svc.cluster.local:9092
         namespace: kedatest
         metricName: http_requests_total
         threshold: '5'
         query: sum(rate(http_requests_total{job="test-app"}[1m]))
         authModes: "bearer"
     - authenticationRef: 14
         name: prom-triggerauthentication
       metadata:
         name: prom-triggerauthentication
        type: object
     - authenticationRef: 15
         name: prom-cluster-triggerauthentication
       metadata:
         name: prom-cluster-triggerauthentication
       type: object

   1

   指定作业可以运行的最长持续时间。

   2

   指定作业的重试次数。默认值为 6。

   3

   可选：指定作业应并行运行多少个 pod 副本；默认为 1。

   • 对于非并行作业，请保留未设置。如果未设置，则默认值为 1。

   4

   可选：指定标记作业完成需要成功完成多少个 pod。

   • 对于非并行作业，请保留未设置。如果未设置，则默认值为 1。
   • 对于具有固定完成计数的并行作业，请指定完成数。
   • 对于带有工作队列的并行作业，请保留 unset。当取消设置默认值时，默认值为 parallelism 参数的值。

   5

   指定控制器创建的 pod 模板。

   6

   可选：指定扩展时的最大副本数量。默认值为 100。

   7

   可选：指定检查每个触发器的时间间隔（以秒为单位）。默认值为 30。

   8

   可选：指定成功完成作业的数量。默认值为 100。

   9

   可选：指定应保留多少个失败作业。默认值为 100。

   10

   可选：指定目标资源中的容器的名称，其中的自定义自动扩展器获取包含 secret 的环境变量等。默认为 .spec.template.spec.containers[0]。

   11

   可选：指定在更新扩展作业时是否被终止现有作业：

   • default ：如果关联的扩展作业被更新，则自动扩展器会终止一个现有作业。自动扩展会使用最新的 specs 重新创建作业。
   • gradual ：如果关联的扩展作业被更新，则自动扩展不会终止现有的作业。自动缩放器使用最新的 specs 创建新作业。

   12

   可选：指定一个扩展策略： default、custom 或 accurate。默认为 default。如需更多信息，请参阅下面的"添加资源"部分中的链接。

   13

   指定用作扩展基础的触发器，如"识别自定义指标自动扩展触发器"部分中所述。

   14

   可选：指定触发器身份验证，如 "Creating a custom metrics autoscaler trigger authentication" 部分所述。

   15

   可选：指定集群触发器身份验证，如 "Creating a custom metrics autoscaler trigger authentication" 部分所述。

   注意

   不需要同时指定命名空间触发器身份验证和集群触发器身份验证。

2. 创建自定义指标自动扩展：

   $ oc create -f <file-name>.yaml