容量バッファを構成する

Standard Autopilot

容量バッファは、Kubernetes CapacityBuffer カスタムリソース定義を使用して予備のクラスタ容量を事前に管理することで、重要なワークロードの応答性と信頼性を向上させます。容量バッファを使用すると、クラスタ内の未使用のノード容量の特定の量を明示的に定義できます。この予約容量により、GKE がノードを事前にプロビジョニングできます。

優先度の高いワークロードをすばやくスケールアップする必要がある場合、新しいワークロードはノードのプロビジョニングを待たずに空き容量をすぐに使用できます。これにより、レイテンシを最小限に抑え、需要の急増時のリソース競合を回避できます。

このページでは、容量バッファを構成する 3 つの方法（固定レプリカバッファ、割合ベースのバッファ、リソース上限バッファ）について説明します。

始める前に

作業を始める前に、次のタスクが完了していることを確認してください。

Google Kubernetes Engine API を有効にする。

Google Kubernetes Engine API を有効化

このタスクに Google Cloud CLI を使用する場合は、gcloud CLI をインストールして初期化する。gcloud CLI をインストール済みの場合は、gcloud components update コマンドを実行して最新のバージョンを取得します。以前のバージョンの gcloud CLI では、このドキュメントのコマンドを実行できない場合があります。
注: gcloud CLI がすでにインストールされている場合には、必ず compute/region プロパティを設定してください。主にゾーンクラスタを使用する場合は、代わりに compute/zone を設定します。デフォルトのロケーションを設定することで、gcloud CLI のエラー（One of [--zone, --region] must be supplied: Please specify location など）を防止できます。クラスタのロケーションが設定したデフォルトと異なる場合は、特定のコマンドでロケーションの指定が必要になることがあります。

バージョン 1.35.2-gke.1842000 以降の GKE クラスタを作成するか、アクセスできるようにします。
（省略可、推奨）クラスタでノード自動プロビジョニングを有効にします。

前提条件となる Kubernetes オブジェクトを作成する

CapacityBuffer を構成するには、必要なすべてのオブジェクト（CapacityBuffer 自体、PodTemplate やワークロードなどの追加リソース）を保持する Namespace が必要です。PodTemplate と CapacityBuffer は同じ Namespace に存在している必要があります。Namespace を作成することも、default Namespace などの既存の Namespace を使用することもできます。

構成する CapacityBuffer のタイプに応じて、次のいずれかも必要になります。

PodTemplate: バッファ容量の単一ユニットのリソース要件を定義します。CapacityBuffer オブジェクトで指定された構成は、Pod テンプレートを参照します。
ワークロード: CapacityBuffer オブジェクトで参照する既存のワークロード。このガイドでは、Deployment オブジェクトをワークロードの例として使用しますが、容量バッファは次のリソースタイプをサポートしています。
- デプロイ
- ReplicaSet
- StatefulSet
- ReplicationController
- ジョブ
- scale サブリソースを実装する CustomResourceDefinitions（CRD）。
  
  注: カスタム CRD を使用している場合は、クラスタオートスケーラーにスケールサブリソースを読み取る権限を手動で付与する必要がある場合があります。カスタムスケーラブルリソースの権限エラーをご覧ください。

このセクションでは、これらのオブジェクトの例を示します。容量バッファで構成するワークロードがすでに存在する場合は、容量バッファを適用するに進みます。

Kubernetes ワークロードの例を作成する手順は次のとおりです。

次のマニフェストを namespace.yaml として保存します。
```
apiVersion: v1
kind: Namespace
metadata:
  name: capacity-buffer-example
  labels:
    name: capacity-buffer-example
```
このマニフェストは、capacity-buffer-example という名前空間を作成します。
次のマニフェストを buffer-pod-template.yaml として保存します。
```
apiVersion: v1
kind: PodTemplate
metadata:
  name: buffer-unit-template
  namespace: capacity-buffer-example # the namespace must be the same namespace as the CapacityBuffer
template:
  spec:
    terminationGracePeriodSeconds: 0
    containers:
    - name: buffer-container
      image: registry.k8s.io/pause:3.9
      resources:
        requests:
          cpu: "1"
          memory: "1Gi"
        limits:
          cpu: "1"
          memory: "1Gi"
```
このマニフェストは、バッファ容量の 1 単位（1 CPU と 1Gi メモリ）のリソース要件を定義する PodTemplate を作成します。この構成は、GKE がバッファ用にプロビジョニングする容量単位のサイズを指定します。たとえば、この PodTemplate を使用すると、クラスタがスケールアップした場合、GKE は 1 CPU 未満で 1 Gi の使用可能なリソースを持つノードをバッファの一部とみなしません。

次のマニフェストを sample-workload-deployment.yaml として保存します。

apiVersion: apps/v1
kind: Deployment
metadata:
  name: critical-workload-ref
  namespace: capacity-buffer-example # the namespace must be the same namespace as the CapacityBuffer
spec:
  replicas: 10
  selector:
    matchLabels:
      app: critical-workload
  template:
    metadata:
      labels:
        app: critical-workload
    spec:
      containers:
      - name: busybox
        image: busybox
        command: ["sleep", "3600"]
        resources:
          requests:
            cpu: 100m

このマニフェストは、10 個のレプリカを含む Deployment のサンプルを作成します。これは、次のセクションの割合ベースのバッファの例の参照オブジェクトです。

マニフェストをクラスタに適用します。

kubectl apply -f namespace.yaml -f buffer-pod-template.yaml -f sample-workload-deployment.yaml

GKE がオブジェクトを作成したことを確認します。

kubectl get podtemplate -n capacity-buffer-example
kubectl get deployment critical-workload-ref -n capacity-buffer-example

出力は次のようになります。

NAME                   AGE
buffer-unit-template   1m

NAME                    READY   UP-TO-DATE   AVAILABLE   AGE
critical-workload-ref   10/10   10           10          1m

容量バッファを適用する

このセクションでは、ワークロードに適用できるさまざまな種類の容量バッファの例を示します。

固定レプリカバッファを構成する

固定レプリカで CapacityBuffer を構成すると、PodTemplate に基づいて必要なバッファ単位の正確な数を指定できます。

固定レプリカ数でバッファを作成するには、次の操作を行います。

次のマニフェストを cb-fixed-replicas.yaml として保存します。
```
apiVersion: autoscaling.x-k8s.io/v1beta1
kind: CapacityBuffer
metadata:
  name: fixed-replica-buffer
  namespace: NAMESPACE
spec:
  podTemplateRef:
    name: POD_TEMPLATE
  replicas: 3
```
次のように置き換えます。
- NAMESPACE: Namespace の名前（例: capacity-buffer-example）。
- POD_TEMPLATE: リソース要件を定義する PodTemplate（buffer-unit-template など）。
このマニフェストは、PodTemplate を参照して特定の数のバッファ単位をリクエストする CapacityBuffer リソースを作成します。
次のようにマニフェストを適用します。
```
kubectl apply -f cb-fixed-replicas.yaml
```
GKE が容量バッファを適用したことを確認します。
```
kubectl get capacitybuffer fixed-replica-buffer -n NAMESPACE
```
ステータスの replicas フィールドには、マニフェストで定義したレプリカの数を反映する 3 が表示されます。STATUS フィールドには ReadyForProvisioning が表示されます。

割合ベースのバッファを構成する

割合ベースのバッファを構成すると、既存のスケーラブルワークロードの割合に基づいてバッファのサイズが動的に設定されます。

割合ベースのバッファを作成する手順は次のとおりです。

次のマニフェストを cb-percentage-based.yaml として保存します。
```
apiVersion: autoscaling.x-k8s.io/v1beta1
kind: CapacityBuffer
metadata:
  name: percentage-buffer
  namespace: NAMESPACE
spec:
  scalableRef:
    apiGroup: apps
    kind: Deployment
    name: SCALABLE_RESOURCE_NAME
  percentage: 20
```
次のように置き換えます。
- NAMESPACE: 名前空間の名前。
- SCALABLE_RESOURCE_NAME: スケーラブルリソースの名前（critical-workload-ref など）。
このマニフェストは、参照されるリソースのレプリカの 20% に相当するバッファサイズをリクエストする CapacityBuffer リソースを作成します。前のセクションの Deployment の例を使用している場合、レプリカの値は 10 に設定されます。

注: 参照されるワークロードの現在のサイズよりも大きいバッファが必要な場合は、percentage フィールドの値を 100 より大きい値に設定できます。
次のようにマニフェストを適用します。
```
kubectl apply -f cb-percentage-based.yaml
```
GKE が容量バッファを適用したことを確認します。
```
kubectl get capacitybuffer percentage-buffer -n NAMESPACE
```
CapacityBuffer のステータスを確認します。replicas フィールドには、割合の計算結果の値が表示されます。前のセクションの Deployment の例を使用している場合は、2 バッファユニットが表示されます。これは、Deployment で定義された 10 個のレプリカの 20% です。
Deployment を最大 20 個のレプリカに手動でスケーリングして、動的スケーリングをテストします。
```
kubectl scale deployment critical-workload-ref -n NAMESPACE --replicas=20
```
CapacityBuffer コントローラが反応し、バッファを 4 つのレプリカに自動的にスケーリングします。

リソース上限バッファを構成する

limits フィールドを使用して、バッファが消費するリソースの最大数を定義できます。この数は PodTemplate のサイズに基づいて計算されます。

リソース上限バッファを作成する手順は次のとおりです。

次のマニフェストを cb-resource-limits.yaml として保存します。
```
apiVersion: autoscaling.x-k8s.io/v1beta1
kind: CapacityBuffer
metadata:
  name: resource-limit-buffer
  namespace: NAMESPACE
spec:
  podTemplateRef:
    name: POD_TEMPLATE
  limits:
    cpu: "5"
    memory: "5Gi"
```
次のように置き換えます。
- NAMESPACE: Namespace の名前（例: capacity-buffer-example）。
- POD_TEMPLATE: リソース要件を定義する PodTemplate（buffer-unit-template など）。
このマニフェストは、合計上限が 5 個の CPU と 5 GiB のメモリの CapacityBuffer リソースを作成します。前の手順の PodTemplate の例を使用している場合は、各ユニットを 1 CPU と 1Gi メモリとして定義します。これにより、5 個のバッファユニットが生成されます。
次のようにマニフェストを適用します。
```
kubectl apply -f cb-resource-limits.yaml
```
GKE が容量バッファを適用したことを確認します。
```
kubectl get capacitybuffer resource-limit-buffer -n NAMESPACE
```
CapacityBuffer のステータスを確認します。replicas フィールドには、定義した上限から導出された値が表示されます。前のセクションの PodTemplate の例を使用している場合は、5 バッファ単位が表示されます。これは、定義された制限内に収まる最大単位数です。

容量バッファを削除する

ワークロードに容量バッファが不要になった場合は、CapacityBuffer オブジェクトを削除します。これにより、プレースホルダ Pod が削除され、クラスタオートスケーラーがノードをスケールダウンできるようになります。

kubectl delete capacitybuffer CAPACITY_BUFFER_NAME -n NAMESPACE

CAPACITY_BUFFER_NAME は、削除する CapacityBuffer の名前に置き換えます。

トラブルシューティング

次のセクションでは、容量バッファに関する一般的な問題を解決する方法について説明します。

課金モデルが原因で容量バッファの準備ができていない

Pod ベースの課金モデル（Pod ごとの課金）を使用するワークロードの CapacityBuffer を作成した場合、容量バッファはプロビジョニングの準備が整いません。

この問題を特定するには、CapacityBuffer のステータスを確認します。

kubectl describe capacitybuffer BUFFER_NAME -n NAMESPACE

ステータスが False のタイプ ReadyForProvisioning の条件を探します。

この問題を解決するには、CapacityBuffer がノードベースの課金と互換性のあるワークロードまたは PodTemplate を参照していることを確認します。

カスタムスケーラブルリソースの権限エラー

カスタムスケーラブルオブジェクト（scalableRef フィールドを使用）で動作するように CapacityBuffer を構成すると、必要な権限がない場合、クラスタオートスケーラーがバッファをスケーリングできないことがあります。

この問題を解決するには、次の例のように ClusterRole と ClusterRoleBinding を作成して、必要な権限を手動で付与します。

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: custom-scale-getter
rules:
- apiGroups: ["api.example.com"]
  resources: ["customreplicatedresources/scale"]
  verbs: ["get"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: ca-custom-scale-getter
subjects:
- kind: User
  name: "system:cluster-autoscaler"
  namespace: kube-system
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: custom-scale-getter

RBAC の構成の詳細については、Kubernetes RBAC のドキュメントをご覧ください。

次のステップ

詳しくは、容量バッファをご覧ください。
CapacityBuffer CRD のドキュメントを参照してください。