Container Service for Kubernetes:コンソールまたはアノテーションを使用して ALB Ingress の転送ルールをカスタマイズする

転送条件

説明

ドメイン名

リクエストドメイン名に一致します。一致するドメイン名を持つリクエストのみがサービスにアクセスできます。次のコードに例を示します。

alb.ingress.kubernetes.io/conditions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送条件は、対応するバックエンドサービスに適用されます。
  [{
      "type": "Host",
      "hostConfig": {
        "values": [
          "anno.example.com"
        ]
      }
  }]

• type: 一致タイプ。ドメイン名に一致させるには、これを Host に設定します。

• HostConfig: 一致させる特定のドメイン名。複数のドメイン名を指定した場合、それらは OR 関係になります。

パス

リクエストパスに一致します。一致するパスを持つリクエストのみがサービスにアクセスできます。次のコードに例を示します。

alb.ingress.kubernetes.io/conditions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送条件は、対応するバックエンドサービスに適用されます。
  [{
    "type": "Path",
    "pathConfig": {
      "values": [
        "/pathvalue1",
        "/pathvalue2"
      ]
    }
  }]

• type: 一致タイプ。リクエストパスに一致させるには、これを Path に設定します。

• pathConfig: 一致させる特定のパス。複数のパスを指定した場合、それらは OR 関係になります。

ヘッダー

リクエストヘッダーに一致します。一致するヘッダーを持つリクエストのみがサービスにアクセスできます。次のコードに例を示します。

alb.ingress.kubernetes.io/conditions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送条件は、対応するバックエンドサービスに適用されます。
  [{
    "type": "Header",
    "headerConfig": {
      "key": "headername",
      "values": [
        "headervalue1",
        "headervalue2"
      ]
     }
  }]

• type: 一致タイプ。リクエスト内のヘッダーに一致させるには、これを Header に設定します。

• headerConfig: ヘッダーのキーと値のペア。複数のヘッダー値を指定した場合、それらは OR 関係になります。

クエリ文字列

クエリ文字列に一致します。一致するクエリ文字列を含むリクエストのみがサービスにアクセスできます。次のコードに例を示します。

alb.ingress.kubernetes.io/conditions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送条件は、対応するバックエンドサービスに適用されます。
  [{
    "type": "QueryString",
    "queryStringConfig": {
      "values": [
        {
           "key":"querystringkey1",
           "value":"querystringvalue2"
        }
      ]
    }
  }]

• type: 一致タイプ。リクエストのクエリ文字列に一致させるには、これを QueryString に設定します。

• queryStringConfig: クエリ文字列のキーと値のペア。キーの長さは 1 ～ 100 文字です。値の長さは 1 ～ 100 文字です。キーと値には、小文字、表示可能な文字、ワイルドカード文字のアスタリスク (*) と疑問符 (?) を含めることができます。スペースや次の文字を含めることはできません: #[]{}\|<>&。複数のクエリ文字列を指定した場合、それらは OR 関係になります。

リクエストメソッド

リクエストメソッドに一致します。一致するメソッドを持つリクエストのみがサービスにアクセスできます。次のコードに例を示します。

alb.ingress.kubernetes.io/conditions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送条件は、対応するバックエンドサービスに適用されます。
  [{
    "type": "Method",
    "methodConfig": {
      "values": [
        "GET",
        "HEAD"
      ]
    }
  }]

• type: 一致タイプ。リクエストメソッドに一致させるには、これを Method に設定します。

• methodConfig: 特定のリクエストメソッド。有効な値は GET、POST、PUT、DELETE、HEAD、OPTIONS、および PATCH です。複数のリクエストメソッドを指定した場合、それらは OR 関係になります。

Cookie

Cookie に一致します。一致する Cookie を含むリクエストのみがサービスにアクセスできます。次のコードに例を示します。

alb.ingress.kubernetes.io/conditions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送条件は、対応するバックエンドサービスに適用されます。
  [{
    "type": "Cookie",
    "cookieConfig": {
      "values": [
        {
           "key":"cookiekey1",
           "value":"cookievalue2"
        }
      ]
     }
  }]

• type: 一致タイプ。Cookie に一致させるには、これを Cookie に設定します。

• cookieConfig: Cookie のキーと値のペア。キーの長さは 1 ～ 100 文字です。値の長さは 1 ～ 100 文字です。キーと値には、小文字、表示可能な文字、ワイルドカード文字のアスタリスク (*) と疑問符 (?) を含めることができます。スペースや次の文字を含めることはできません: #[]{}\|<>&。複数の Cookie を指定した場合、それらは OR 関係になります。

ソース IP

リクエストのソース IP アドレスに一致します。一致するソース IP アドレスからのリクエストのみがサービスにアクセスできます。次のコードに例を示します。

alb.ingress.kubernetes.io/conditions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送条件は、対応するバックエンドサービスに適用されます。
  [{
    "type": "SourceIp",
    "sourceIpConfig": {
      "values": [
        "192.168.0.0/16",
        "172.16.0.0/16"
      ]
    }
  }]

• type: 一致タイプ。リクエストのソース IP アドレスに一致させるには、これを SourceIP に設定します。

• sourceIpConfig: リクエストの IP アドレス。複数の IP アドレスを指定した場合、それらは OR 関係になります。

ResponseHeader

レスポンスヘッダーに一致します。転送アクションは、一致するヘッダーを持つレスポンスに対してのみ実行されます。これは、レスポンス転送アクションおよび alb.ingress.kubernetes.io/rule-direction.<service-name>: Response アノテーションと共に使用する必要があることに注意してください。次のコードに例を示します。

alb.ingress.kubernetes.io/conditions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送条件は、対応するバックエンドサービスに適用されます。
  [{
    "type": "ResponseHeader",
    "headerConfig": {
      "key": "headername",
      "values": [
        "headervalue1",
        "headervalue2"
      ]
     }
  }]

• type: 一致タイプ。レスポンス内のヘッダーに一致させるには、これを ResponseHeader に設定します。

• headerConfig: ヘッダーのキーと値のペア。複数のヘッダー値を指定した場合、それらは OR 関係になります。

ResponseStatusCode

レスポンスステータスコードに一致します。一致するステータスコードを返すレスポンスのみがサービスにアクセスできます。これは、レスポンス転送アクションおよび alb.ingress.kubernetes.io/rule-direction.<service-name>: Response アノテーションと共に使用する必要があることに注意してください。次のコードに例を示します。

alb.ingress.kubernetes.io/conditions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送条件は、対応するバックエンドサービスに適用されます。
  [{
    "type": "ResponseStatusCode",
    "responseStatusCodeConfig": {
      "values": [
        "statuscode1",
        "statuscode2"
      ]
    }
  }]

• type: 一致タイプ。レスポンスステータスコードに一致させるには、これを ResponseStatusCode に設定します。

• responseStatusCodeConfig: 特定のレスポンスステータスコード。複数のレスポンスステータスコードを指定した場合、それらは OR 関係になります。

転送アクション

説明

固定レスポンス

ALB を介してクライアントに固定レスポンスを返します。レスポンスのステータスコード、コンテンツ、およびコンテンツタイプを設定できます。次のコードに例を示します。

alb.ingress.kubernetes.io/actions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送アクションは、対応するバックエンドサービスに適用されます。
  [{
      "type": "FixedResponse",
      "FixedResponseConfig": {
          "contentType": "text/plain",
          "httpCode": "503",
          "content": "503 error text"
      }
  }]

• type: 転送アクションのタイプ。固定レスポンスを設定するには、これを FixedResponse に設定します。

• contentType: レスポンス本文のコンテンツタイプ。

• httpCode: レスポンスステータスコード。

• content: レスポンス本文。

リダイレクト

alb.ingress.kubernetes.io/actions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送アクションは、対応するバックエンドサービスに適用されます。
  [{
      "type": "Redirect",
      "RedirectConfig": {
          "host": "${host}",
          "path": "${path}",
          "port": "443",
          "protocol": "${protocol}",
          "query": "${query}",
          "httpCode": "301"
      }
  }]

• type: 転送アクションのタイプ。リダイレクトを設定するには、これを Redirect に設定します。

• host: リクエストがリダイレクトされるドメイン名。

• path: リクエストがリダイレクトされるパス。

• port: リクエストがリダイレクトされるポート。

• protocol: リクエストがリダイレクトされるプロトコル。

• query: リクエストがリダイレクトされるクエリ文字列。

• httpCode: ステータスコード。

トラフィックミラーリング

トラフィックミラーリング用のサーバーグループの ID を設定します。これにより、リクエストがコピーされ、トラフィックミラーリングサーバーグループに転送されます。次のコードに例を示します。

alb.ingress.kubernetes.io/actions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送アクションは、対応するバックエンドサービスに適用されます。
      [{
          "type": "TrafficMirror",
          "TrafficMirrorConfig": {
              "TargetType" : "ForwardGroupMirror",
              "MirrorGroupConfig": {
                  "ServerGroupTuples" : [{
                      "ServerGroupID": "sgp-2auud2fxj1r46*****"
                  }]
              }
           }
      }]

• type: 転送アクションのタイプ。トラフィックミラーリングを設定するには、これを TrafficMirror に設定します。

• TargetType: ミラーリングのターゲットタイプ。現在、サーバーグループにリクエストをミラーリングする ForwardGroupMirror のみがサポートされています。

• ServerGroupID: トラフィックミラーリングサーバーグループの ID。

複数のバックエンドサーバーグループへの転送

ALB リクエストを複数のバックエンドサーバーグループに転送します。ServerGroupID を使用してバックエンドサーバーグループを指定するか、ServiceName+ServicePort を使用してサーバーグループを作成またはアタッチできます。各バックエンドサーバーグループへのリクエスト転送の重みを設定し、サーバーグループ間のセッション維持を有効にすることができます。

alb.ingress.kubernetes.io/actions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送アクションは、対応するバックエンドサービスに適用されます。
       [{
           "type": "ForwardGroup",
           "ForwardConfig": {
             "ServerGroups" : [{
               "ServiceName": "tea-svc",
               "Weight": 30,
               "ServicePort": 80
             },
             {
               "ServiceName": "coffee-svc",
               "Weight": 20,
               "ServicePort": 80
             },
             {
               "ServerGroupID": "sgp-71aexb9y93ypo*****",
               "Weight": 20
             },
             {
               "ServerGroupID": "sgp-slygpbvm2cydo*****",
               "Weight": 30
             }],
             "ServerGroupStickySession": {
              "Enabled": true,
              "Timeout": 80
             }
           }
       }]

• type: 転送アクションのタイプ。複数のバックエンドサーバーグループへの転送を設定するには、これを ForwardGroup に設定します。

• ForwardConfig: バックエンド転送サーバーグループの特定のパラメーター。複数のサーバーグループを設定した場合、リクエストはそれぞれの重みに基づいて各サーバーグループに転送されます。

• ServerGroupID: サーバーグループの ID。

• ServiceName: サービスの名前。

• ServicePort: サービスのポート。

• Weight: 各サーバーグループにリクエストを転送するための重み。

• Enabled: サーバーグループ間のセッション維持を有効にするかどうかを指定します。

• Timeout: サーバーグループ間のセッション維持のタイムアウト期間。

書き換え

ALB の書き換え機能を有効にします。これにより、リクエストのドメイン名、パス、およびクエリ文字列が上書きされます。次のコードに例を示します。

alb.ingress.kubernetes.io/actions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送アクションは、対応するバックエンドサービスに適用されます。
       [{
           "type": "Rewrite",
           "RewriteConfig": {
               "Host": "demo.domain.ingress.top",
               "Path": "/test",
               "Query": "querystring"
           }
       }]

• type: 転送アクションのタイプ。Rewrite に設定すると、現在の ALB が書き換え機能をサポートしていることを示します。

• RewriteConfig: 書き換えの特定のパラメーター。

• Host: 書き換えに一致させる特定のドメイン名。

• Path: 書き換えに一致させる特定のパス。

• Query: 書き換えに一致させる特定のクエリ文字列。

書き換えルールの詳細については、「書き換えのサポート」をご参照ください。

リクエストヘッダーの挿入

ヘッダーフィールド名とコンテンツを設定します。これにより、リクエスト内の既存のヘッダー変数が上書きされます。次のコードに例を示します。

alb.ingress.kubernetes.io/actions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送アクションは、対応するバックエンドサービスに適用されます。
  [{
      "type": "InsertHeader",
      "InsertHeaderConfig": {
          "key": "key",
          "value": "value",
          "valueType": "UserDefined"
      }
  }]

• type: 転送アクションのタイプ。リクエストヘッダーの挿入を設定するには、これを InsertHeader に設定します。

• key: リクエストヘッダーのフィールド名。

• value: リクエストヘッダーのフィールドコンテンツ。

• valueType: 値のタイプ。

リクエストヘッダーの削除

ヘッダーフィールド名とコンテンツを削除します。次のコードに例を示します。

alb.ingress.kubernetes.io/actions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送アクションは、対応するバックエンドサービスに適用されます。
     [{
         "type": "RemoveHeader",
         "RemoveHeaderConfig": {
             "key": "key"
         }
     }]

type: 転送アクションのタイプ。リクエストヘッダーの削除を設定するには、これを RemoveHeader に設定します。

key: リクエストヘッダーのフィールド名。

QPS スロットリング

ALB の転送ルールを設定する際に、全体的なリクエストレート制限と、クライアントのソース IP に基づくリクエストレート制限の両方を設定できます。

次のコードに設定例を示します。

 annotations:
    alb.ingress.kubernetes.io/actions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送アクションは、対応するバックエンドサービスに適用されます。
      [{
          "type": "TrafficLimit",
          "TrafficLimitConfig": {
              "QPS": "1000",
              "QPSPerIp": "100"
          }
      }]

• type: 転送アクションのタイプを指定します。ここでは、スロットリング設定を示す TrafficLimit に設定されています。

• QPS: 全体的なリクエストレート制限で、1 秒あたりに処理できるリクエストの数です。値は [1, 1000000] の範囲内である必要があります。リクエストレートが指定された制限を超えると、制限を超える新しい接続リクエストは拒否され、クライアントは HTTP 503 ステータスコードを受け取ります。

• QPSPerIp: 各クライアントソース IP に基づくリクエストレート制限。値は [1, 1000000] の範囲内である必要があります。QPS (全体的な制限) と QPSPerIp (クライアントソース IP に基づく制限) の両方が設定されている場合、後者の値は前者よりも小さくなければなりません。リクエストレートが指定された制限を超えると、制限を超えるリクエストは拒否され、クライアントは HTTP 503 ステータスコードを受け取ります。

転送アクション

説明

リクエストヘッダーの挿入

ヘッダーフィールド名とコンテンツを設定します。これにより、リクエスト内の既存のヘッダー変数が上書きされます。次のコードに例を示します。

alb.ingress.kubernetes.io/actions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送アクションは、対応するバックエンドサービスに適用されます。
  [{
      "type": "InsertHeader",
      "InsertHeaderConfig": {
          "key": "key",
          "value": "value",
          "valueType": "UserDefined"
      }
  }]

• type: 転送アクションのタイプ。リクエストヘッダーの挿入を設定するには、これを InsertHeader に設定します。

• key: リクエストヘッダーのフィールド名。

• value: リクエストヘッダーのフィールドコンテンツ。

• valueType: 値のタイプ。

リクエストヘッダーの削除

ヘッダーフィールド名とコンテンツを削除します。次のコードに例を示します。

alb.ingress.kubernetes.io/actions.service-name: | # 注: このアノテーションの "service-name" は、spec.rules で設定されたバックエンドサービス名と一致する必要があります。アノテーションで設定された転送アクションは、対応するバックエンドサービスに適用されます。
     [{
         "type": "RemoveHeader",
         "RemoveHeaderConfig": {
             "key": "key"
         }
     }]

type: 転送アクションのタイプ。リクエストヘッダーの削除を設定するには、これを RemoveHeader に設定します。

key: リクエストヘッダーのフィールド名。