3.6. カスタムメトリクスオートスケーラーの追加方法について

手順

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
       behavior: static 

   12

   
     pollingInterval: 30 

   13

   
     advanced:
       restoreToOriginalReplicaCount: false 

   14

   
       horizontalPodAutoscalerConfig:
         name: keda-hpa-scale-down 

   15

   
         behavior: 

   16

   
           scaleDown:
             stabilizationWindowSeconds: 300
             policies:
             - type: Percent
               value: 100
               periodSeconds: 15
     triggers:
     - type: prometheus 

   17

   
       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: 

   18

   
         name: prom-triggerauthentication
         kind: TriggerAuthentication

   1

   オプション: 「ワークロードのカスタムメトリクスオートスケーラーの一時停止」セクションで説明されているように、Custom Metrics Autoscaler Operator がレプリカを指定された値にスケーリングし、自動スケーリングを停止するよう指定します。

   2

   このカスタムメトリクスオートスケーラーの名前を指定します。

   3

   オプション: ターゲットリソースの API バージョンを指定します。デフォルトは apps/v1 です。

   4

   スケーリングするオブジェクトの名前を指定します。

   5

   kind を Deployment、StatefulSet または CustomResource として指定します。

   6

   オプション: カスタムメトリクスオートスケーラーがシークレットなどを保持する環境変数を取得する、ターゲットリソース内のコンテナーの名前を指定します。デフォルトは .spec.template.spec.containers[0] です。

   7

   オプション: minReplicaCount が 0 に設定されている場合、最後のトリガーが報告されてからデプロイメントを 0 にスケールバックするまでの待機時間を秒単位で指定します。デフォルトは 300 です。

   8

   オプション: スケールアップ時のレプリカの最大数を指定します。デフォルトは 100 です。

   9

   オプション: スケールダウン時のレプリカの最小数を指定します。

   10

   オプション: 「監査ログの設定」セクションで説明されているように、監査ログのパラメーターを指定します。

   11

   オプション: failureThreshold パラメーターで定義された回数だけスケーラーがソースからメトリクスを取得できなかった場合に、フォールバックするレプリカの数を指定します。フォールバック動作の詳細は、KEDA のドキュメント を参照してください。

   12

   オプション: フォールバックが発生した場合に使用するレプリカ数を指定します。次のいずれかのオプションを入力するか、パラメーターを省略します。

   • fallback.replicas パラメーターで指定されたレプリカの数を使用するには、static と入力します。これがデフォルトです。
   • 現在のレプリカ数を維持するには、currentReplicas と入力します。
   • 現在のレプリカ数が fallback.replicas パラメーターより大きい場合は、currentReplicasIfHigher と入力して、現在のレプリカ数を維持します。現在のレプリカ数が fallback.replicas パラメーターより少ない場合は、fallback.replicas 値を使用します。
   • 現在のレプリカ数が fallback.replicas パラメーターより少ない場合は、currentReplicasIfLower と入力して、現在のレプリカ数を維持します。現在のレプリカ数が fallback.replicas パラメーターより大きい場合は、fallback.replicas 値を使用します。

   13

   オプション: 各トリガーをチェックする間隔を秒単位で指定します。デフォルトは 30 です。

   14

   オプション: スケーリングされたオブジェクトが削除された後に、ターゲットリソースを元のレプリカ数にスケールバックするかどうかを指定します。デフォルトは false で、スケーリングされたオブジェクトが削除されたときのレプリカ数をそのまま保持します。

   15

   オプション: Horizontal Pod Autoscaler の名前を指定します。デフォルトは keda-hpa-{scaled-object-name} です。

   16

   オプション: 「スケーリングポリシー」セクションで説明されているように、Pod をスケールアップまたはスケールダウンするレートを制御するために使用するスケーリングポリシーを指定します。

   17

   「カスタムメトリクスオートスケーラートリガーについて」セクションで説明されているように、スケーリングの基準として使用するトリガーを指定します。この例では、OpenShift Dedicated モニタリングを使用します。

   18

   オプション: トリガー認証またはクラスタートリガー認証を指定します。詳細は、関連情報 セクションの カスタムメトリクスオートスケーラー認証について を参照してください。

   • トリガー認証を使用するには、TriggerAuthentication と入力します。これがデフォルトです。
   • クラスタートリガー認証を使用するには、ClusterTriggerAuthentication と入力します。

2. 次のコマンドを実行して、カスタムメトリクスオートスケーラーを作成します。

   $ oc create -f <filename>.yaml