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

   オプション: 「ワークロードのカスタムメトリクスオートスケーラーの一時停止」セクションで説明されているように、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

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

   13

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

   14

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

   15

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

   16

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

   17

   オプション: カスタムメトリックオートスケーラートリガー認証の作成のセクションで説明されているように、トリガー認証を指定します。

   18

   オプション: カスタムメトリックオートスケーラートリガー認証の作成のセクションで説明されているように、クラスタートリガー認証を指定します。

   注記

   namespace トリガー認証とクラスタートリガー認証の両方を指定する必要はありません。

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 になります。
   • 固定の完了数を持つ並列ジョブの場合、完了の数を指定します。
   • ワークキューのある並列ジョブでは、未設定のままにします。設定されていない場合、デフォルトは parallelism パラメーターの値になります。

   5

   コントローラーが作成する Pod のテンプレートを指定します。

   6

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

   7

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

   8

   オプション: 保持する必要がある正常に終了したジョブの数を指定します。デフォルトは 100 です。

   9

   オプション: 保持する必要がある失敗したジョブの数を指定します。デフォルトは 100 です。

   10

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

   11

   オプション: スケーリングされたジョブが更新されるたびに、既存のジョブを終了するかどうかを指定します。

   • default : 関連するスケーリングされたジョブが更新されると、オートスケーラーは既存のジョブを終了します。オートスケーラーは、最新の仕様でジョブを再作成します。
   • gradual : 関連するスケーリングされたジョブが更新された場合、オートスケーラーは既存のジョブを終了しません。オートスケーラーは、最新の仕様で新しいジョブを作成します。

   12

   オプション: スケーリングストラテジーを指定します: default、custom、または accurate。デフォルトは default です。詳細については、以下の関連情報セクションのリンクを参照してください。

   13

   カスタムメトリックオートスケーラートリガーについてのセクションで説明されているように、スケーリングの基礎として使用するトリガーを指定します。

   14

   オプション: カスタムメトリックオートスケーラートリガー認証の作成のセクションで説明されているように、トリガー認証を指定します。

   15

   オプション: カスタムメトリックオートスケーラートリガー認証の作成のセクションで説明されているように、クラスタートリガー認証を指定します。

   注記

   namespace トリガー認証とクラスタートリガー認証の両方を指定する必要はありません。

2. カスタムメトリックオートスケーラーを作成します。

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