第4章 HorizontalPodAutoscaler [autoscaling/v2]

behavior

object

HorizontalPodAutoscalerBehavior は、上方向と下方向の両方のターゲットのスケーリング動作を設定します (それぞれ、scaleUp フィールドと scaleDown フィールド)。

maxReplicas

integer

maxReplicas は、Autoscaler がスケールアップできるレプリカの数の上限です。minReplicas の数より少なくすることはできません。

metrics

array

metrics には、必要なレプリカ数を計算するために使用する仕様が含まれています (すべてのメトリックでの最大レプリカ数が使用されます)。必要なレプリカ数は、ターゲット値と現在の値の比率に現在の Pod 数を乗算して計算されます。したがって、Pod 数が増加すると、使用されるメトリックを減らす必要があります。またその逆も同様です。各タイプのメトリックがどのように応答する必要があるかについては、個々のメトリックソースタイプを参照してください。設定されていない場合、デフォルトのメトリックは平均 CPU 使用率 80% に設定されます。

metrics[]

object

MetricSpec は、単一のメトリックに基づいてスケーリングする方法を指定します (一度に設定できるのは、type と他の 1 つの一致フィールドのみです)。

minReplicas

integer

minReplicas は、オートスケーラーがスケールダウンできるレプリカの数の下限です。デフォルトは 1Pod です。アルファ機能ゲート HPAScaleToZero が有効で、少なくとも 1 つのオブジェクトまたは外部メトリックが設定されている場合、minReplicas は 0 になります。スケーリングは、少なくとも 1 つのメトリック値が使用可能である限りアクティブです。

scaleTargetRef

object

CrossVersionObjectReference には、参照されたリソースを識別できるようにするための十分な情報が含まれています。

scaleDown

object

HPAScalingRules は、一方向のスケーリング動作を設定します。これらのルールは、HPA のメトリクスから DesiredReplicas を計算した後に適用されます。スケーリングポリシーを指定することで、スケーリング速度を制限できます。安定化ウィンドウを指定してフラッピングを防ぐことができ、レプリカの数が即座に設定されるのではなく、固定化ウィンドウから最も安全な値が選択されます。

scaleUp

object

HPAScalingRules は、一方向のスケーリング動作を設定します。これらのルールは、HPA のメトリクスから DesiredReplicas を計算した後に適用されます。スケーリングポリシーを指定することで、スケーリング速度を制限できます。安定化ウィンドウを指定してフラッピングを防ぐことができ、レプリカの数が即座に設定されるのではなく、固定化ウィンドウから最も安全な値が選択されます。

policies

array

ポリシーは、スケーリング中に使用できる潜在的なスケーリングポリシーのリストです。少なくとも 1 つのポリシーを指定する必要があります。指定しない場合、HPAScalingRules は無効として破棄されます。

policies[]

object

HPAScalingPolicy は、指定された過去の期間にわたって合致する必要がある単一のポリシーです。

selectPolicy

string

selectPolicy は、どのポリシーを使用するかを指定するために使用されます。設定されていない場合は、デフォルト値の Max が使用されます。

stabilizationWindowSeconds

integer

stabilizationWindowSeconds は、スケールアップまたはスケールダウン中に過去の推奨事項を考慮する必要がある時間 (秒) です。StabilizationWindowSeconds は、0 以上 3600 (1 時間) 以下である必要があります。設定されていない場合は、デフォルト値を使用します。- スケールアップの場合: 0 (固定化なし)。- スケールダウンの場合: 300 (固定化ウィンドウの長さは 300 秒です)。

periodSeconds

integer

periodSeconds は、ポリシーが適用される時間枠を指定します。PeriodSeconds は、0 より大きく、1800 (30 分) 以下である必要があります。

type

string

type はスケーリングポリシーを指定するために使用されます。

value

integer

value には、ポリシーによって許可されている変更量が含まれます。ゼロより大きくなければなりません

policies

array

ポリシーは、スケーリング中に使用できる潜在的なスケーリングポリシーのリストです。少なくとも 1 つのポリシーを指定する必要があります。指定しない場合、HPAScalingRules は無効として破棄されます。

policies[]

object

HPAScalingPolicy は、指定された過去の期間にわたって合致する必要がある単一のポリシーです。

selectPolicy

string

selectPolicy は、どのポリシーを使用するかを指定するために使用されます。設定されていない場合は、デフォルト値の Max が使用されます。

stabilizationWindowSeconds

integer

stabilizationWindowSeconds は、スケールアップまたはスケールダウン中に過去の推奨事項を考慮する必要がある時間 (秒) です。StabilizationWindowSeconds は、0 以上 3600 (1 時間) 以下である必要があります。設定されていない場合は、デフォルト値を使用します。- スケールアップの場合: 0 (固定化なし)。- スケールダウンの場合: 300 (固定化ウィンドウの長さは 300 秒です)。

periodSeconds

integer

periodSeconds は、ポリシーが適用される時間枠を指定します。PeriodSeconds は、0 より大きく、1800 (30 分) 以下である必要があります。

type

string

type はスケーリングポリシーを指定するために使用されます。

value

integer

value には、ポリシーによって許可されている変更量が含まれます。ゼロより大きくなければなりません

containerResource

object

ContainerResourceMetricSource は、リクエストと制限で指定されているように、Kubernetes で認識されているリソースメトリックに基づいてスケーリングする方法を示します。各 Pod は、現在のスケールターゲット (CPU やメモリーなど) で記述します。値はターゲットと比較される前に平均化されます。このようなメトリックは Kubernetes に組み込まれており、"Pod" ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。1 つの "target" タイプのみを設定する必要があります。

external

object

ExternalMetricSource は、Kubernetes オブジェクトに関連付けられていないメトリック (クラウドメッセージングサービスのキューの長さ、クラスターの外部で実行されているロードバランサーからの QPS など) に基づいてスケールする方法を示します。

object

object

ObjectMetricSource は、kubernetes オブジェクトを記述するメトリック (例: Ingress オブジェクトの 1 秒あたりのヒット数) をスケールする方法を示します。

pods

object

PodsMetricSource は、現在のスケールターゲットで各 Pod を記述するメトリック (例:1 秒あたりのトランザクション処理数) に基づいてスケールする方法を示します。値はターゲット値と比較される前に平均化されます。

resource

object

ResourceMetricSource は、リクエストと制限で指定されているように、Kubernetes で認識されているリソースメトリックに基づいてスケーリングする方法を示します。各 Pod は、現在のスケールターゲット (CPU やメモリーなど) で記述します。値はターゲットと比較される前に平均化されます。このようなメトリックは Kubernetes に組み込まれており、"Pod" ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。1 つの "target" タイプのみを設定する必要があります。

type

string

type はメトリックソースのタイプです。これは、"ContainerResource"、"External"、"Object"、"Pod"、または "Resource" のいずれかである必要があり、それぞれがオブジェクト内の一致するフィールドにマッピングされます。注: "ContainerResource" タイプは、フィーチャーゲート HPAContainerMetrics が有効になっている場合に使用できます。

container

string

container は、スケーリングターゲットの Pod にあるコンテナーの名前です。

name

string

name は、対象のリソースの名前です。

target

object

MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。

averageUtilization

integer

averageUtilization は、関連する全 Pod のリソースメトリクスの平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。現在、Resource metric source type に対してのみ有効です

averageValue

Quantity

averageValue は、関連するすべての Pod にわたるメトリックの平均ターゲット値 (数量) です。

type

string

type は、メトリックタイプが Utilization、Value、または AverageValue のいずれであるかを表します。

value

Quantity

value は、メトリックの目標値 (数量として) です。

メトリクス

object

MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。

target

object

MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。

name

string

name は、指定されたメトリクスの名前です。

selector

LabelSelector

selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricName のみがメトリクスの収集に使用されます。

averageUtilization

integer

averageUtilization は、関連する全 Pod のリソースメトリクスの平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。現在、Resource metric source type に対してのみ有効です

averageValue

Quantity

averageValue は、関連するすべての Pod にわたるメトリックの平均ターゲット値 (数量) です。

type

string

type は、メトリックタイプが Utilization、Value、または AverageValue のいずれであるかを表します。

value

Quantity

value は、メトリックの目標値 (数量として) です。

describedObject

object

CrossVersionObjectReference には、参照されたリソースを識別できるようにするための十分な情報が含まれています。

メトリクス

object

MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。

target

object

MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。

apiVersion

string

apiVersion は参照先の API バージョンです。

kind

string

kind は指示対象の種類です。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

name は指示対象の名前です。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

name

string

name は、指定されたメトリクスの名前です。

selector

LabelSelector

selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricName のみがメトリクスの収集に使用されます。

averageUtilization

integer

averageUtilization は、関連する全 Pod のリソースメトリクスの平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。現在、Resource metric source type に対してのみ有効です

averageValue

Quantity

averageValue は、関連するすべての Pod にわたるメトリックの平均ターゲット値 (数量) です。

type

string

type は、メトリックタイプが Utilization、Value、または AverageValue のいずれであるかを表します。

value

Quantity

value は、メトリックの目標値 (数量として) です。

メトリクス

object

MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。

target

object

MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。

name

string

name は、指定されたメトリクスの名前です。

selector

LabelSelector

selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricName のみがメトリクスの収集に使用されます。

averageUtilization

integer

averageUtilization は、関連する全 Pod のリソースメトリクスの平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。現在、Resource metric source type に対してのみ有効です

averageValue

Quantity

averageValue は、関連するすべての Pod にわたるメトリックの平均ターゲット値 (数量) です。

type

string

type は、メトリックタイプが Utilization、Value、または AverageValue のいずれであるかを表します。

value

Quantity

value は、メトリックの目標値 (数量として) です。

name

string

name は、対象のリソースの名前です。

target

object

MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。

averageUtilization

integer

averageUtilization は、関連する全 Pod のリソースメトリクスの平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。現在、Resource metric source type に対してのみ有効です

averageValue

Quantity

averageValue は、関連するすべての Pod にわたるメトリックの平均ターゲット値 (数量) です。

type

string

type は、メトリックタイプが Utilization、Value、または AverageValue のいずれであるかを表します。

value

Quantity

value は、メトリックの目標値 (数量として) です。

apiVersion

string

apiVersion は参照先の API バージョンです。

kind

string

kind は指示対象の種類です。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

name は指示対象の名前です。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

conditions

array

conditions は、このオートスケーラーがターゲットをスケーリングするために必要な一連の条件であり、それらの条件が満たされているかどうかを示します。

conditions[]

object

HorizontalPodAutoscalerCondition は、特定の時点での HorizontalPodAutoscaler の状態を記述します。

currentMetrics

array

currentMetrics は、このオートスケーラーによって使用されるメトリクスの最後の読み取り状態です。

currentMetrics[]

object

MetricStatus は、単一メトリックの最後に読み取られた状態を表します。

currentReplicas

integer

currentReplicas は、オートスケーラーが管理する Pod のレプリカ数で、オートスケーラーが最後に確認した数値です。

desiredReplicas

integer

desiredReplicas は、オートスケーラーが管理する Pod の任意のレプリカ数で、オートスケーラーが最後に計算した数値です。

lastScaleTime

Time

lastScaleTime は、HorizontalPodAutoscaler が Pod の数を最後にスケーリングした時間であり、オートスケーラーが Pod の数を変更する頻度を制御するために使用されます。

observedGeneration

integer

observedGeneration は、このオートスケーラーによって確認された最新の世代です。

lastTransitionTime

Time

lastTransitionTime は、別の状態に最後に遷移した時間です。

message

string

message は、遷移の詳細を含む、人間が判読できる説明です。

reason

string

reason は、条件の最後の遷移の理由です。

status

string

status は条件のステータス (True、False、Unknown) です。

type

string

type は現在の状態を表します

containerResource

object

ContainerResourceMetricStatus は、リクエストと制限で指定されているように、Kubernetes で認識されているリソースメトリックの現在値を示し、現在のスケールターゲット (CPU やメモリーなど) で、各 Pod に含まれる単一のコンテナーを記述します。このようなメトリックは Kubernetes に組み込まれており、"Pod" ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。

external

object

ExternalMetricStatus は、Kubernetes オブジェクトに関連付けられていないグローバルメトリクスの現在の値を示します。

object

object

ObjectMetricStatus は、kubernetes オブジェクトを説明するメトリックの現在の値 (例: Ingress オブジェクトの 1 秒あたりのヒット数) を示します。

pods

object

PodsMetricStatus は、現在のスケールターゲット内の各 Pod を説明するメトリックの現在の値 (例: 1 秒あたりのトランザクション処理数) を示します。

resource

object

ResourceMetricStatus は、リクエストと制限で指定されているように、Kubernetes に認識されているリソースメトリックの現在の値を示し、現在のスケールターゲット (CPU やメモリーなど) で各 Pod を記述します。このようなメトリックは Kubernetes に組み込まれており、"Pod" ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。

type

string

type はメトリックソースのタイプです。これは ContainerResource、外部、オブジェクト、Pod、またはリソースのいずれかであり、それぞれがオブジェクト内の一致するフィールドに対応します。注: "ContainerResource" タイプは、フィーチャーゲート HPAContainerMetrics が有効になっている場合に使用できます。

container

string

container は、スケーリングターゲットの Pod にあるコンテナーの名前です。

current

object

MetricValueStatus は、メトリクスの現在の値を保持します

name

string

name は、対象のリソースの名前です。

averageUtilization

integer

curentAverageUtilization は、関連する全 Pod のリソースメトリクスの現在における平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。

averageValue

Quantity

AverageValue は、関連するすべての Pod にわたるメトリックの現在における平均値です (数量)。

value

Quantity

value は、メトリックの現在における平均値 (数量) です。

current

object

MetricValueStatus は、メトリクスの現在の値を保持します

メトリクス

object

MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。

averageUtilization

integer

curentAverageUtilization は、関連する全 Pod のリソースメトリクスの現在における平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。

averageValue

Quantity

AverageValue は、関連するすべての Pod にわたるメトリックの現在における平均値です (数量)。

value

Quantity

value は、メトリックの現在における平均値 (数量) です。

name

string

name は、指定されたメトリクスの名前です。

selector

LabelSelector

selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricName のみがメトリクスの収集に使用されます。

current

object

MetricValueStatus は、メトリクスの現在の値を保持します

describedObject

object

CrossVersionObjectReference には、参照されたリソースを識別できるようにするための十分な情報が含まれています。

メトリクス

object

MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。

averageUtilization

integer

curentAverageUtilization は、関連する全 Pod のリソースメトリクスの現在における平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。

averageValue

Quantity

AverageValue は、関連するすべての Pod にわたるメトリックの現在における平均値です (数量)。

value

Quantity

value は、メトリックの現在における平均値 (数量) です。

apiVersion

string

apiVersion は参照先の API バージョンです。

kind

string

kind は指示対象の種類です。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

name は指示対象の名前です。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

name

string

name は、指定されたメトリクスの名前です。

selector

LabelSelector

selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricName のみがメトリクスの収集に使用されます。

current

object

MetricValueStatus は、メトリクスの現在の値を保持します

メトリクス

object

MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。

averageUtilization

integer

curentAverageUtilization は、関連する全 Pod のリソースメトリクスの現在における平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。

averageValue

Quantity

AverageValue は、関連するすべての Pod にわたるメトリックの現在における平均値です (数量)。

value

Quantity

value は、メトリックの現在における平均値 (数量) です。

name

string

name は、指定されたメトリクスの名前です。

selector

LabelSelector

selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricName のみがメトリクスの収集に使用されます。

current

object

MetricValueStatus は、メトリクスの現在の値を保持します

name

string

name は、対象のリソースの名前です。

averageUtilization

integer

curentAverageUtilization は、関連する全 Pod のリソースメトリクスの現在における平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。

averageValue

Quantity

AverageValue は、関連するすべての Pod にわたるメトリックの現在における平均値です (数量)。

value

Quantity

value は、メトリックの現在における平均値 (数量) です。