Annotations と AlbConfig の構成辞書 - ACK

AlbConfig カスタムリソースを使用して、ご利用の ALB インスタンスの設定をカスタマイズできます。このトピックでは、サポートされているすべての Ingress アノテーションと AlbConfig フィールドについて、その説明と使用方法を解説します。

インデックス

アノテーションフィールド

機能カテゴリ	Ingress アノテーション設定
アノテーション YAML	アノテーション YAML の例
ALB Ingress 設定	ヘルスチェック
リスナーまたはプロトコルの設定	リスナーバックエンドサービスが使用するプロトコル
トラフィック転送ルールの設定	リダイレクト段階的リリースクロスドメインカスタム転送
高度な設定	スロースタート優先度セッション維持接続ドレイン負荷分散バックエンドサーバーグループの IPv6 アタッチメント
その他	その他

AlbConfig フィールド

フィールドカテゴリ	フィールドリンク
AlbConfig YAML	完全な AlbConfig YAML
AlbConfig	AlbConfig AlbConfigSpec
ALB インスタンス	LoadBalancerSpec
リスナーの設定	ListenerSpec[]
vSwitch	ZoneMapping
Simple Log Service	AccessLogConfig
QUIC リスナー	QuicConfig
証明書の設定	証明書
アクセス制御	AclConfig
Tracing Analysis	AccessLogTracingConfig
X-Forwarded- の設定	XForwardedForConfig
ログ内のカスタムヘッダー	LogConfig
予約済みフィールド	BillingConfig ModificationProtectionConfig AlbConfigStatus LoadBalancerStatus ListenerStatus AppliedCertificate

アノテーション YAML の例

この例では、アノテーションを使用して Ingress リソース内の ALB インスタンスを設定する方法を示します。各アノテーションの詳細については、以降のセクションをご参照ください。

クリックして Ingress のアノテーション YAML の例を展開

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: cafe-ingress
  annotations:
    alb.ingress.kubernetes.io/healthcheck-enabled: "true"
    alb.ingress.kubernetes.io/healthcheck-path: "/"
    alb.ingress.kubernetes.io/healthcheck-protocol: "HTTP"
    alb.ingress.kubernetes.io/healthcheck-httpversion: "HTTP1.1"
    alb.ingress.kubernetes.io/healthcheck-method: "HEAD"
    alb.ingress.kubernetes.io/healthcheck-code: "http_2xx"
    alb.ingress.kubernetes.io/healthcheck-timeout-seconds: "5"
    alb.ingress.kubernetes.io/healthcheck-interval-seconds: "2"
    alb.ingress.kubernetes.io/healthy-threshold-count: "3"
    alb.ingress.kubernetes.io/unhealthy-threshold-count: "3"
    alb.ingress.kubernetes.io/conditions.service-a: | # ここで参照されるサービスはクラスター内に存在する必要があります。その名前は、ルールの backend フィールド内のサービス名と一致する必要があります。
     [{
       "type": "Path",
       "pathConfig": {
           "values": [
              "~*^/pathvalue1", # 正規表現の前に ~* を追加して、正規表現であることを示します。~* の後の部分が実際の正規表現です。
              "/pathvalue2" # 完全一致の場合は、前に ~* を追加しないでください。
           ]
       }
      }]
    alb.ingress.kubernetes.io/order: "1"
    alb.ingress.kubernetes.io/canary: "true"
    alb.ingress.kubernetes.io/canary-by-header: "location"
    alb.ingress.kubernetes.io/canary-by-header-value: "hz"
    ... ...
spec:
  ingressClassName: alb
  rules:
  - http:
      paths:
      # コンテキストパスの設定
      - path: /tea
        pathType: Prefix
        backend:
          service:
            name: tea-svc
            port:
              number: 80
      # コンテキストパスの設定
      - path: /coffee
        pathType: Prefix
        backend:
          service:
            name: coffee-svc
            port:
              number: 80

Ingress でサポートされるアノテーション

必要に応じて Ingress リソースにアノテーションを追加できます。

ヘルスチェック

アノテーション	説明
alb.ingress.kubernetes.io/healthcheck-enabled	バックエンドサーバーグループのヘルスチェックを有効にします。設定例については、「ヘルスチェックの設定」をご参照ください。 `true`: 有効化 `false`: 無効化デフォルト値: `false`。
alb.ingress.kubernetes.io/healthcheck-path	ヘルスチェックのパスです。デフォルト値: `/`。
alb.ingress.kubernetes.io/healthcheck-protocol	ヘルスチェックに使用されるプロトコルです。 `HTTP`: HTTP を使用します。HEAD または GET リクエストを送信してブラウザのアクセスをシミュレートし、アプリケーションの正常性を確認します。 `HTTPS`: HTTPS を使用します。HEAD または GET リクエストを送信してブラウザのアクセスをシミュレートし、アプリケーションの正常性を確認します。 `TCP`: TCP を使用します。SYN ハンドシェイクパケットを送信して、サーバーポートがアクティブかどうかを確認します。 `GRPC`: gRPC を使用します。POST または GET リクエストを送信して、アプリケーションの正常性を確認します。デフォルト値: `HTTP`。
alb.ingress.kubernetes.io/healthcheck-httpversion	HTTP バージョンです。`healthcheck-protocol` が `HTTP` または `HTTPS` の場合にのみ適用されます。 `HTTP1.0` `HTTP1.1` デフォルト値: `HTTP1.1`。
alb.ingress.kubernetes.io/healthcheck-method	ヘルスチェックのメソッドです。 `HEAD` `POST` `GET` デフォルト値: `HEAD`。重要 `healthcheck-protocol` が `GRPC` の場合は、`POST` または `GET` を選択してください。
alb.ingress.kubernetes.io/healthcheck-httpcode	ヘルスチェックのステータスコードです。プローブリクエストが成功し、これらのステータスコードのいずれかが返された場合にのみ、バックエンドサーバーは正常と見なされます。次のオプションを 1 つ以上、カンマ区切りで入力します。 `http_2xx` `http_3xx` `http_4xx` `http_5xx` デフォルト値: `http_2xx`。
alb.ingress.kubernetes.io/healthcheck-code	ヘルスチェックのステータスコードです。プローブリクエストが成功し、これらのステータスコードのいずれかが返された場合にのみ、バックエンドサーバーは正常と見なされます。 `healthcheck-httpcode` とこのフィールドの両方が設定されている場合、このフィールドが優先されます。有効な値は `healthcheck-protocol` の値によって異なります。 `HTTP または HTTPS`: 次のオプションを 1 つ以上、カンマ区切りで入力します。 `http_2xx` `http_3xx` `http_4xx` `http_5xx` デフォルト値: `http_2xx`。 `GRPC`: 有効値: [0, 99]。デフォルト値: `0`。最大 20 個の範囲をカンマで区切ってサポートします。
alb.ingress.kubernetes.io/healthcheck-timeout-seconds	ヘルスチェックのタイムアウト期間 (秒単位)。有効値: [1, 300]。デフォルト値: `5`。
alb.ingress.kubernetes.io/healthcheck-interval-seconds	ヘルスチェックの間隔 (秒単位)。有効値: [1, 50]。デフォルト値: `2`。
alb.ingress.kubernetes.io/healthy-threshold-count	バックエンドサーバーを正常とマークするために必要な、成功したヘルスチェックの回数です。有効値: [2, 10]。デフォルト値: `3`。
alb.ingress.kubernetes.io/unhealthy-threshold-count	バックエンドサーバーを異常とマークするために必要な、失敗したヘルスチェックの回数です。有効値: [2, 10]。デフォルト値: `3`。
alb.ingress.kubernetes.io/healthcheck-connect-port	ヘルスチェックに使用されるポートです。デフォルト値: `0`。説明 `0` は、ヘルスチェックがバックエンドサーバーのポートを使用することを示します。

リダイレクト

アノテーション

説明

alb.ingress.kubernetes.io/ssl-redirect

HTTP ステータスコード 308 を使用して、HTTP リクエストを HTTPS (ポート 443) にリダイレクトします。設定例については、「HTTP から HTTPS へのリダイレクトの設定」をご参照ください。

true: HTTPS にリダイレクトします。
false: HTTPS にリダイレクトしません。

デフォルト値: false。

バックエンドサービスが使用するプロトコル

アノテーション

説明

alb.ingress.kubernetes.io/backend-protocol

バックエンドサーバーグループが使用するプロトコルです。設定例については、「バックエンドサーバーでの HTTPS および gRPC プロトコルのサポート」をご参照ください。

http: HTTP を使用します。
https: HTTPS を使用します。
grpc: gRPC を使用します。

デフォルト値: http。

説明

リスナータイプごとにサポートされるバックエンドプロトコル:

HTTP リスナーは HTTP と HTTPS をサポートします。
HTTPS リスナーは HTTP、HTTPS、gRPC をサポートします。
QUIC リスナーは HTTP をサポートします。

書き換え

アノテーション	説明
alb.ingress.kubernetes.io/rewrite-target	パス書き換えのターゲットパスです。設定例については、「パスの書き換え」をご参照ください。

リスナー

アノテーション

説明

alb.ingress.kubernetes.io/listen-ports

Ingress リソースに関連付けられているリスナーのポートとプロトコルです。設定例については、「カスタムリスナーポートの設定」をご参照ください。

Ingress ルールに関連付けるリスナーのプロトコルとポートを指定します (以下の例を参照):

'[{"HTTP": 80}]' : ポート 80 の HTTP リスナーに関連付けます。
'[{"HTTPS": 443}]' : ポート 443 の HTTPS リスナーに関連付けます。
'[{"QUIC": 443}]' : ポート 443 の QUIC リスナーに関連付けます。
'[{"HTTP": 80}, {"HTTPS": 443}]' : ポート 80 の HTTP リスナーとポート 443 の HTTPS リスナーに関連付けます。
'[{"HTTPS": 443}, {"QUIC": 443}]' : ポート 443 の HTTPS リスナーとポート 443 の QUIC リスナーに関連付けます。

スロースタート

アノテーション

説明

alb.ingress.kubernetes.io/slow-start-enabled

スロースタートを有効にします。有効にすると、ALB Ingress は Service バックエンドに新しく追加された Pod にトラフィックを徐々に移行します。これにより、Pod の起動中の CPU とメモリの急増を回避できます。設定例については、「バックエンドのスロースタート」をご参照ください。

true: 有効化
false: 無効化

デフォルトでは無効です。

alb.ingress.kubernetes.io/slow-start-duration

スロースタート完了後にトラフィックがランプアップする時間 (秒単位)。期間が長いほど、ランプアップが遅くなります。

有効値: [30, 900]。

デフォルト値: 30。

優先度

アノテーション

説明

alb.ingress.kubernetes.io/order

転送ルールの相対的な優先度です。数値が小さいほど優先度が高くなります。設定例については、「転送ルールの優先度の設定」をご参照ください。

有効値: [1, 1000]。

デフォルト値: 10。

段階的リリース

アノテーション	説明
alb.ingress.kubernetes.io/canary	カナリア方式の段階的リリースを有効にします。詳細な手順については、「ALB Ingress で段階的リリースを実装する」をご参照ください。 `true`: 有効化 `false`: 無効化デフォルト値: `false`。
alb.ingress.kubernetes.io/canary-by-header	カナリアルーティングをトリガーするために使用されるリクエストヘッダーです。
alb.ingress.kubernetes.io/canary-by-header-value	カナリアルーティングをトリガーするヘッダーの値です。
alb.ingress.kubernetes.io/canary-by-cookie	カナリアルーティングをトリガーするために使用される Cookie です。
alb.ingress.kubernetes.io/canary-weight	指定されたサービスにルーティングされるリクエストの割合 (0 から 100 までの整数) です。詳細な手順については、「カナリアの重み」をご参照ください。

セッション維持

アノテーション	説明
alb.ingress.kubernetes.io/sticky-session	バックエンドサーバーグループのセッション維持を有効にします。設定例については、「アノテーションでセッション維持を有効にする」をご参照ください。 `true`: セッション維持を有効にします。 `false`: セッション維持を無効にします。デフォルト値: `false`。
alb.ingress.kubernetes.io/sticky-session-type	セッション維持のタイプです。 `Insert`: Cookie 挿入モード。ALB は、クライアントの最初の訪問時にレスポンスに Cookie を挿入します。 `Server`: Cookie 書き換えモード。ユーザーが定義した Cookie がある場合、ALB は既存の Cookie を書き換えます。デフォルト値: `Insert`。
alb.ingress.kubernetes.io/cookie-timeout	セッション維持のタイムアウト期間 (秒単位)。有効値: [1, 86400]。デフォルト値: `1000`。
alb.ingress.kubernetes.io/cookie	カスタム Cookie の値。データ型: 文字列。デフォルト値: `""`。

接続ドレイン

アノテーション

説明

alb.ingress.kubernetes.io/connection-drain-enabled

接続ドレインを有効にします。有効にすると、ALB Ingress は、バックエンド Pod が Terminating 状態になるか、ヘルスチェックに失敗した後、一定期間通常のトラフィックフローを維持します。タイムアウト期間が経過すると、接続は切断されます。これにより、バックエンドの突然の削除によるビジネスの中断を防ぎます。詳細については、「接続ドレイン」をご参照ください。

true: 接続ドレインを有効にします。
false: 接続ドレインを無効にします。

デフォルトでは無効です。

alb.ingress.kubernetes.io/connection-drain-timeout

接続ドレインのタイムアウト期間 (秒単位)。

有効値: [0, 900]。

デフォルト値: 300。

負荷分散

アノテーション

説明

alb.ingress.kubernetes.io/backend-scheduler

バックエンドサーバーグループの負荷分散アルゴリズムです。設定例については、「バックエンドサーバーグループの負荷分散アルゴリズムの指定」をご参照ください。

wrr: 重み付けラウンドロビン。重みが大きいほど、選択される確率が高くなります。
wlc: 重み付け最小接続。重みが等しい場合、現在の接続数が少ないサーバーほど選択される確率が高くなります。
sch: 送信元 IP ハッシュ。同じ送信元 IP からのリクエストは、同じバックエンドサーバーに転送されます。
uch: URL ハッシュ。同一の URL パラメーターを持つリクエストは、同じバックエンドサーバーに転送されます。

デフォルト値: wrr。

alb.ingress.kubernetes.io/backend-scheduler-uch-value

負荷分散アルゴリズムが uch の場合に使用される URL ハッシュパラメーターです。

クロスドメイン

アノテーション	説明
alb.ingress.kubernetes.io/enable-cors	オリジン間リソース共有 (CORS) の設定を有効にします。設定例については、「CORS の設定」をご参照ください。 `true`: CORS を有効にします。 `false`: CORS を無効にします。デフォルト値: `false`。
alb.ingress.kubernetes.io/cors-allow-origin	クロスドメインリクエストを行うことが許可されているオリジンです。デフォルト値: `*`。
alb.ingress.kubernetes.io/cors-expose-headers	クライアントに公開されるヘッダーのリストです。
alb.ingress.kubernetes.io/cors-allow-methods	クロスドメインリクエストで許可される HTTP メソッドです。次のオプションを 1 つ以上入力します。 `GET` `POST` `PUT` `DELETE` `HEAD` `OPTIONS` `PATCH` デフォルト値: `"GET, PUT, POST, DELETE, PATCH, OPTIONS"`。
alb.ingress.kubernetes.io/cors-allow-credentials	クロスドメインリクエストで認証情報を許可します。 `true`: 認証情報を許可します。 `false`: 運搬は許可されていません。デフォルト： `true`。
alb.ingress.kubernetes.io/cors-max-age	プリフライトレスポンスがブラウザにキャッシュされる最大時間 (秒単位)。有効値: [-1, 172800]。デフォルト値: `172800`。説明 `-1` はキャッシュ時間が無限であることを意味します。
alb.ingress.kubernetes.io/cors-allow-headers	クロスドメインリクエストで許可されるヘッダーのリストです。デフォルト値: `"DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization"`。

カスタム転送

アノテーション	説明
alb.ingress.kubernetes.io/actions.{svcName}	カスタム転送アクションです。詳細な手順については、「ALB Ingress のカスタム転送ルールを定義する」をご参照ください。
alb.ingress.kubernetes.io/conditions.{svcName}	カスタム転送条件です。
alb.ingress.kubernetes.io/rule-direction.{svcName}	カスタム転送の方向です。 `Request`: リクエスト受信時にカスタム転送を適用します。 `Response`: レスポンス送信時にカスタム転送を適用します。デフォルト値: `Request`。

バックエンドサーバーグループの IPv6 アタッチメント

アノテーション

説明

alb.ingress.kubernetes.io/enable-ipv6

バックエンドサーバーグループの IPv6 アタッチメントを有効にします。設定例については、「バックエンドサーバーグループに IPv6 アドレスをアタッチする」をご参照ください。

true: 有効化
false: 無効化

デフォルト値: false。

その他

アノテーション	説明
alb.ingress.kubernetes.io/backend-keepalive	バックエンドサーバーへの接続保持を有効にします。設定例については、「バックエンドサーバーへの接続保持」をご参照ください。デフォルト値: `false`。
alb.ingress.kubernetes.io/traffic-limit-qps	秒間リクエスト数 (QPS) のレート制限です。有効値: [1, 1000000]。
alb.ingress.kubernetes.io/use-regex	Path フィールドで正規表現を許可します。Prefix パスタイプにのみ適用されます。デフォルト値: `false`。

AlbConfig フィールド

AlbConfig カスタムリソースは、ALB インスタンスとそのリスナーを記述します。このセクションでは、完全な AlbConfig の例を示します。各フィールドの詳細については、以降のセクションをご参照ください。

クリックして完全な AlbConfig YAML を展開

apiVersion: alibabacloud.com/v1
kind: AlbConfig
metadata:
  name: alb-config-example
spec:
  # 必要に応じて ALB インスタンスのプロパティを設定します。
  config:
    id: ""   # ALB インスタンス ID。新しいインスタンスを作成する場合は空のままにします。
    name: alb-instance-name       
    addressAllocatedMode: Fixed
    addressType: Internet
    ipv6AddressType: Intranet
    addressIpVersion: IPv4
    resourceGroupId: ""
    edition: Standard
    deletionProtectionEnabled: false
    forceOverride: false
    listenerForceOverride: false
    zoneMappings:            # vSwitch。
      - vSwitchId: vsw-uf6ccg2a9g71hx8go****
        zoneId: "" 
        allocationId:   eip-asdfas****         
        eipType: ""
      - vSwitchId: vsw-uf6nun9tql5t8nh15****
        zoneId: ""      
        allocationId: "eip-xxxx"
        eipType: ""
    securityGroupids:           
      - sg-uf6blkp8************ # セキュリティグループ ID。
      - sg-djladhla************ # セキュリティグループ ID。
    accessLogConfig:        # Simple Log Service。
      logProject: ""
      logStore: "alb_******"    
    billingConfig:           
      internetBandwidth: 0
      internetChargeType: ""
      payType: ""
      bandWidthPackageId: "cbwp-xxx" 
    modificationProtectionConfig:
      reason: ""
      status: ""
    tags:
      - key: example-key
        value: example-value
  listeners:
    # 必要に応じてリスナーのプロパティを設定します。
    - port: 80
      protocol: HTTP         # HTTP: HTTP を使用します。HTTPS: HTTPS を使用します。QUIC: QUIC を使用します。
      gzipEnabled: null
      http2Enabled: null
      securityPolicyId: ""
      idleTimeout: 15
      loadBalancerId: ""
      description: "Listener description"
      caEnabled: false
      requestTimeout: 60
      quicConfig:
        quicUpgradeEnabled: false
        quicListenerId: ""
      defaultActions: []
      caCertificates: []
      certificates: []
      xForwardedForConfig:     # X-Forwarded- の設定。
        XForwardedForClientCertSubjectDNEnabled: false
        XForwardedForProtoEnabled: false
        XForwardedForClientCertIssuerDNEnabled: false
        XForwardedForSLBIdEnabled: false
        XForwardedForClientSrcPortEnabled: false
        XForwardedForClientCertFingerprintEnabled: false
        XForwardedForEnabled: true
        XForwardedForProcessingMode: append
        XForwardedForHostEnabled: false
        XForwardedForSLBPortEnabled: false
        XForwardedForClientCertClientVerifyEnabled: false
        XForwardedForClientCertSubjectDNAlias: ""
        XForwardedForClientCertClientVerifyAlias: ""
        XForwardedForClientCertIssuerDNAlias: ""
        XForwardedForClientCertFingerprintAlias: ""
        XForwardedForClientSourceIpsEnabled: false
        XForwardedForClientSourceIpsTrusted: ""
      logConfig:
        accessLogRecordCustomizedHeadersEnabled: false
        accessLogTracingConfig:
          tracingEnabled: false
          tracingSample: 100
          tracingType: Zipkin
      aclConfig:
        aclName: ""
        aclType: Black
        aclEntries: []
        aclIds: []
status:
  loadBalancer:
    dnsname: ""
    id: ""
    listeners:
      portAndProtocol: ""
      certificates:
        certificateId: ""
        isDefault: false

AlbConfig

フィールド	データ型	説明
apiVersion	固定値	APIVersion は、このオブジェクトのバージョン管理されたスキーマを定義します。固定値: `alibabacloud.com/v1`。
kind	固定値	Kind は、このオブジェクトが表す REST リソースを示します。固定値: `AlbConfig`。
metadata	ObjectMeta	オブジェクトの標準メタデータです。詳細については、「metadata」をご参照ください。
spec	AlbConfigSpec	ALB インスタンスとリスナーのプロパティを記述するパラメーターのリストです。
status	AlbConfigStatus	調整後、インスタンスのステータスは `status` に書き込まれます。この値は、現在のインスタンスのステータスを反映します。

AlbConfigSpec

フィールド	データ型	説明
config	LoadBalancerSpec	ALB インスタンスのプロパティです。
listeners	ListenerSpec[]	インスタンス配下のリスナーのプロパティです。

LoadBalancerSpec

フィールド	データ型	説明
id	string	ALB インスタンス ID。再利用モードを有効にするには入力します。コントローラーに新しい ALB インスタンスを作成させる場合は、空のままにします。詳細な手順については、「AlbConfig の作成」をご参照ください。デフォルト値: `""`。
name	string	ALB インスタンス名。デフォルト値: `k8s-{namespace}-{name}-{hashCode}` のパターンで自動生成されます。
addressAllocatedMode	enum	ALB インスタンスのアドレス割り当てモードです。 `Dynamic`: ゾーンごとに少なくとも 1 つの IP。IP はトラフィックに応じて自動的にスケールします。最大 100 万 QPS をサポートします。 `Fixed`: ゾーンごとに正確に 1 つの固定 IP。弾力性は限定的です。最大 10 万 QPS をサポートします。デフォルト値: `Fixed`。
addressType	enum	ALB インスタンスの IPv4 アドレスタイプです。 `Internet`: パブリックモード。パブリックドメイン名を自動的に取得します。 `Intranet`: プライベートモード。デフォルト値: `Internet`。
ipv6AddressType	enum	ALB インスタンスの IPv6 アドレスタイプです。IPv4 アドレスタイプと一致する必要はありません。 `Internet`: パブリックモード。パブリックドメイン名を自動的に取得します。 `Intranet`: プライベートモード。デフォルト値: `Intranet`。
addressIpVersion	enum	ALB インスタンスがデュアルスタックをサポートするかどうか。 `IPv4`: IPv4 のみ。 `DualStack`: デュアルスタック。IPv4 と IPv6 の両方をサポートします。デフォルト値: `IPv4`。
resourceGroupId	string	インスタンスを所有するリソースグループの ID。デフォルト値: `""`。
edition	enum	インスタンスの機能エディションです。再利用モードではエディションを変更できません。 `Standard`: Standard Edition。 `StandardWithWaf`: WAF 拡張版。「ALB WAF 拡張版でサービスを保護する」をご参照ください。デフォルト値: `Standard`。
deletionProtectionEnabled	bool	予約済みフィールドです。変更しないでください。
forceOverride	bool	再利用モードでインスタンスのプロパティを強制的に上書きします。 `true`: 強制的に上書きします。 `false`: 強制的に上書きしません。 `null`: 強制的に上書きしません。デフォルト値: `false`。
listenerForceOverride	bool	再利用モードでリスナーのプロパティを強制的に上書きします。 `true`: 強制的に上書きします。 `false`: 強制的に上書きしません。 `null`: 強制的に上書きしません。デフォルト値: `null`。
zoneMappings	ZoneMapping[]	ゾーンと EIP の設定です。
accessLogConfig	AccessLogConfig	ログ収集。
billingConfig	BillingConfig	課金方法。
modificationProtectionConfig	ModificationProtectionConfig	設定の読み取り専用モードです。
tags	Tag[]	インスタンスタグ。
securityGroupIds	string[]	ALB インスタンスのセキュリティグループ ID。詳細については、「AlbConfig でセキュリティグループを設定する」をご参照ください。

ZoneMapping

フィールド	データ型	説明
vSwitchId	string	(必須) vSwitch の ID。デフォルト値: `""`。
zoneId	string	vSwitch のゾーン。デフォルト値のままにしてください。デフォルト値: `""`。
allocationId	string	Elastic IP (EIP) の ID。設定例については、「AlbConfig で ALB インスタンスを設定する」をご参照ください。デフォルト値: `"eip-xxxx"`。
eipType	string	予約済みフィールドです。変更しないでください。

AccessLogConfig

フィールド

データ型

説明

logProject

string

Simple Log Service プロジェクトの名前です。

デフォルト値: ""。

logStore

string

Simple Log Service Logstore の名前です。alb_ で始まる必要があります。Logstore が存在しない場合は、自動的に作成されます。設定例については、「Simple Log Service のアクセスログを有効にする」をご参照ください。

デフォルト値: "alb_****"。

BillingConfig

フィールド	データ型	説明
internetBandwidth	int	予約済みフィールドです。変更しないでください。
internetChargeType	string	予約済みフィールドです。変更しないでください。
payType	enum	予約済みフィールドです。変更しないでください。
bandWidthPackageId	string	アタッチするインターネット共有帯域幅パッケージの ID。アタッチ後はデタッチできません。設定例については、「インターネット共有帯域幅パッケージの設定」をご参照ください。デフォルト値: `"cbwp-xxx"`。

ModificationProtectionConfig

フィールド	データ型	説明
reason	string	予約済みフィールドです。
status	string	予約済みフィールドです。

Tag

フィールド

データ型

説明

key

string

タグのキーです。

デフォルト値: ""。

value

string

タグの値です。

デフォルト値: ""。

ListenerSpec

フィールド	データ型	説明
gzipEnabled	bool	データ圧縮を有効にします。設定例については、「データ圧縮の使用」をご参照ください。 `true`: 圧縮を有効にします。 `false`: 圧縮を無効にします。 `null`: 圧縮を有効にします。デフォルト値: `null`。
http2Enabled	bool	HTTP/2 プロトコルを有効にします。 `true`: HTTP/2 を有効にします。 `false`: HTTP/2 を無効にします。 `null`: HTTP/2 を有効にします。デフォルト値: `null`。
port	int	(必須) リスナーが使用するポート。デフォルト値: `0`。
protocol	enum	(必須) リスナーが使用するプロトコル。 `HTTP`: HTTP を使用します。 `HTTPS`: HTTPS を使用します。 `QUIC`: QUIC を使用します。
securityPolicyId	string	TLS セキュリティポリシーの ID。デフォルト値: `""`。
idleTimeout	int	アイドル接続のタイムアウト期間 (秒単位)。有効値: [1, 600]。デフォルト値: `15`。説明値 0 はデフォルト値を使用します。
loadBalancerId	string	予約済みフィールドです。変更しないでください。
description	string	リスナーの名前です。デフォルト値: `ingress-auto-listener-{port}` のパターンで自動生成されます。
caEnabled	bool	相互認証を有効にします。 `true`: 相互認証を有効にします。 `false`: 相互認証を無効にします。デフォルト値: `false`。
requestTimeout	int	リクエストのタイムアウト期間 (秒単位)。有効値: [1, 600]。デフォルト値: `60`。
quicConfig	QuicConfig	QUIC リスナーの設定です。
defaultActions	Action[]	予約済みフィールドです。変更しないでください。
caCertificates	Certificate[]	リスナーのルート CA 証明書です。
certificates	Certificate[]	リスナーのサーバー証明書です。
xForwardedForConfig	XForwardedForConfig	X-Forwarded- の設定です。
logConfig	LogConfig	リスナーのロギング設定です。
aclConfig	AclConfig	アクセス制御。

QuicConfig

フィールド

データ型

説明

quicUpgradeEnabled

bool

QUIC アップグレードを有効にします。QUIC リスナーと HTTPS リスナーが連携するシナリオでは、このフィールドでそれらを関連付けたり、関連付けを解除したりします。詳細な手順については、「QUIC リスナーを使用して HTTP/3 をサポートする」をご参照ください。

true: QUIC アップグレードを有効にし、QUIC を HTTPS に関連付けます。
false: QUIC アップグレードを無効にし、QUIC を HTTPS に関連付けません。

デフォルト値: false。

quicListenerId

string

QUIC リスナーに関連付けられている HTTPS リスナーです。

デフォルト値: ""。

証明書

フィールド

データ型

説明

IsDefault

bool

この証明書をデフォルトとして設定します。詳細な手順については、「暗号化通信のための HTTPS 証明書の設定」をご参照ください。

true: デフォルトとして設定します。
false: デフォルトとして設定しません。

デフォルト値: false。

重要

デフォルトとして設定できる証明書は 1 つだけです。

CertificateId

string

証明書の CertIdentifier です。

デフォルト値: ""。

XForwardedForConfig

フィールド	データ型	説明
XForwardedForClientCertSubjectDNEnabled	bool	ALB インスタンスによって転送される HTTP メッセージに `X-Forwarded-Clientcert-subjectdn` ヘッダーを追加します。これにより、クライアント証明書の所有者情報が保持されます。 `true`: (フィールド) を追加します。 `false`: フィールドを追加しません。デフォルト値: `false`。
XForwardedForProtoEnabled	bool	ALB インスタンスによって転送される HTTP メッセージに `X-Forwarded-Proto` ヘッダーを追加します。これにより、ALB インスタンスが使用するリスナープロトコルが記録されます。 `true`: フィールドが追加されます。 `false`: フィールドを省略できます。デフォルト値: `false`。
XForwardedForClientCertIssuerDNEnabled	bool	ALB インスタンスによって転送される HTTP メッセージに `X-Forwarded-Clientcert-issuerdn` ヘッダーを追加します。これにより、クライアント証明書の発行者情報が保持されます。 `true`: フィールドを追加します。 `false`: フィールドを省略できます。デフォルト値: `false`。
XForwardedForSLBIdEnabled	bool	ALB インスタンスによって転送される HTTP メッセージに `X-Forwarded-For-SLB-ID` ヘッダーを追加します。これにより、ALB インスタンスの ID が記録されます。 `true`: フィールドを追加します。 `false`: フィールドは追加されません。デフォルト値: `false`。
XForwardedForClientSrcPortEnabled	bool	ALB インスタンスによって転送される HTTP メッセージに `X-Forwarded-Client-Port` ヘッダーを追加します。これにより、クライアントのポート情報が保持されます。 `true`: フィールドを追加します。 `false`: フィールドを追加しません。デフォルト値: `false`。
XForwardedForClientCertFingerprintEnabled	bool	ALB インスタンスによって転送される HTTP メッセージに `X-Forwarded-Clientcert-fingerprint` ヘッダーを追加します。これにより、クライアント証明書のフィンガープリントが保持されます。 `true`: フィールドを追加します。 `false`: フィールドを追加しません。デフォルト値: `false`。
XForwardedForEnabled	bool	ALB インスタンスによって転送される HTTP メッセージのリクエストヘッダーに `X-Forwarded-For` フィールドが追加され、クライアントの送信元 IP アドレスが保持されます。現在、この機能を無効にするために値を `false` に設定することはできません。この機能を無効にするか、拡張機能を使用するには、ALB Ingress Controller をバージョン 2.15.0 以降にアップグレードし、`XForwardedForProcessingMode` を使用してください。
XForwardedForProcessingMode	string	`append`: 元のリクエストに X-Forwarded-For ヘッダーが含まれていない場合、ALB はクライアント IP アドレスを持つヘッダーを作成します。それ以外の場合、ALB は既存の X-Forwarded-For ヘッダーにクライアント IP アドレスを追加してから、バックエンドサーバーに送信します。 `remove`: ALB は、リクエストをバックエンドサーバーに送信する前に、リクエストから X-Forwarded-For ヘッダーを削除します。 `preserve`: ALB は、リクエストをバックエンドサーバーに送信する前に、リクエスト内の X-Forwarded-For ヘッダーを変更しません。 `XForwardedForConfig` で `XForwardedForEnabled` と `XForwardedForProcessingMode` の両方が設定されている場合、`XForwardedForProcessingMode` が優先されます。ALB インスタンスのリスナーは、設定された値に基づいて X-Forwarded-For ヘッダーを追加、削除、または保持します。
XForwardedForHostEnabled	bool	ALB インスタンスによって転送される HTTP メッセージに `X-Forwarded-Host` ヘッダーを追加します。これにより、クライアントが SLB インスタンスにアクセスするために使用するドメイン名が取得されます。
XForwardedForSLBPortEnabled	bool	ALB インスタンスによって転送される HTTP メッセージに `X-Forwarded-Port` ヘッダーを追加します。これにより、ALB インスタンスのリスナーポートが記録されます。 `true`: (フィールド) を追加します。 `false`: フィールドを追加しません。デフォルト値: `false`。
XForwardedForClientCertClientVerifyEnabled	bool	ALB インスタンスによって転送される HTTP メッセージに `X-Forwarded-Clientcert-clientverify` ヘッダーを追加します。これにより、クライアント証明書の検証結果が保持されます。 `true`: フィールドを追加します。 `false`: フィールドは追加されません。デフォルト値: `false`。
XForwardedForClientCertSubjectDNAlias	string	カスタムフィールド名。`X-Forwarded-Clientcert-subjectdn` ヘッダー名を入力した値に置き換えます。`XForwardedForClientCertSubjectDNEnabled` フィールドがこのヘッダーを追加します。このフィールドは、`XForwardedForClientCertSubjectDNEnabled` が `true` の場合にのみ有効です。デフォルト値: `""`。
XForwardedForClientCertClientVerifyAlias	string	カスタムフィールド名。`X-Forwarded-Clientcert-clientverify` ヘッダー名を入力した値に置き換えます。`XForwardedForClientCertClientVerifyEnabled` フィールドがこのヘッダーを追加します。このフィールドは、`XForwardedForClientCertClientVerifyEnabled` が `true` の場合にのみ有効です。デフォルト値: `""`。
XForwardedForClientCertIssuerDNAlias	string	カスタムフィールド名。`X-Forwarded-ClientCert-IssuerDN` ヘッダー名を入力した値に置き換えます。`XForwardedForClientCertIssuerDNEnabled` フィールドがこのヘッダーを追加します。このフィールドは、`XForwardedForClientCertIssuerDNEnabled` が `true` の場合にのみ有効です。デフォルト値: `""`。
XForwardedForClientCertFingerprintAlias	string	カスタムフィールド名。`X-Forwarded-Client-Cert-Fingerprint` ヘッダー名を入力した値に置き換えます。`XForwardedForClientCertFingerprintEnabled` フィールドがこのヘッダーを追加します。このフィールドは、`XForwardedForClientCertFingerprintEnabled` が `true` の場合にのみ有効です。デフォルト値: `""`。
XForwardedForClientSourceIpsEnabled	bool	ALB が `X-Forwarded-For` ヘッダーからクライアントの送信元 IP を検索できるようにします。 `true`: 許可します。また、`XForwardedForClientSourceIpsTrusted` を有効な値で設定する必要があります。 `false`: 許可しません。デフォルト値: `false`。
XForwardedForClientSourceIpsTrusted	string	信頼できるプロキシ IP アドレスを指定します。有効な IP アドレスまたは CIDR ブロックを、スペースなしでセミコロン (`;`) で区切って入力します。このフィールドは、`XForwardedForClientSourceIpsEnabled` が `true` の場合にのみ有効です。信頼できる IP リストを `0.0.0.0/0` に設定: `X-Forwarded-For` ヘッダーから最も左のアドレス (クライアントの送信元 IP アドレス) を取得します。信頼できる IP リストを `proxy1 IP; proxy2 IP,..` に設定: リストに含まれていない右から最初のアドレスを取得し、それをクライアントの送信元 IP アドレスとして使用します。例: `192.168.x.x;192.168.x.x/16`

AclConfig

フィールド	データ型	説明
aclName	string	AclEntry モードで関連付けられている ACL ポリシーの名前です。詳細な手順については、「アクセス制御のための ACL の設定」をご参照ください。デフォルト値: `""`。
aclType	enum	アクセス制御モードです。 `Black`: ブラックリストモード。特定の IP アドレスからのアクセスをブロックします。 `White`: ホワイトリストモード。特定の IP アドレスからのアクセスのみを許可します。
aclEntries	string	アクセスポリシーのエントリです。デフォルト値: `""`。重要 `aclEntries` と `aclIds` を同時に使用しないでください。詳細については、「アクセス制御のための ACL の設定」をご参照ください。
aclIds	string	関連付ける既存のポリシー ID のリストです。デフォルト値: `""`。

LogConfig

フィールド

データ型

説明

accessLogRecordCustomizedHeadersEnabled

bool

ALB インスタンスのアクセスログでカスタムヘッダーを使用します。

true: カスタムヘッダーを使用します。
false: カスタムヘッダーを使用しません。

デフォルト値: false。

accessLogTracingConfig

AccessLogTracingConfig

Tracing Analysis の設定パラメーターです。詳細な手順については、「AlbConfig で Tracing Analysis の Xtrace を有効にする」をご参照ください。

AccessLogTracingConfig

フィールド	データ型	説明
tracingEnabled	bool	Tracing Analysis 機能を有効にするかどうかを指定します。 `true`: Tracing Analysis を有効にします。 `false`: Tracing Analysis を無効にします。デフォルト値: `false`。
tracingSample	int	Tracing Analysis のサンプルレート (`0.01%` 単位)。有効値: [1, 10000]。
tracingType	enum	Tracing Analysis のサンプリングアルゴリズムです。 `Zipkin`: Zipkin アルゴリズムを使用します。

AlbConfigStatus

重要

以下のフィールドは、ALB Ingress がステータスを記録するために予約されています。これらのフィールドは変更しないでください: AlbConfigStatus、LoadBalancerStatus、ListenerStatus、AppliedCertificate。

フィールド

出力

説明

loadBalancer

LoadBalancerStatus

予約済みフィールドです。変更しないでください。

ALB インスタンスのステータスです。

LoadBalancerStatus

フィールド	出力	説明
dnsname	string	予約済みフィールドです。変更しないでください。 ALB インスタンスの DNS アドレスです。
id	string	予約済みフィールドです。変更しないでください。 ALB インスタンスの ID。
listeners	ListenerStatus	予約済みフィールドです。変更しないでください。 ALB インスタンスのリスナープロパティです。

ListenerStatus

フィールド

出力

説明

portAndProtocol

string

予約済みフィールドです。変更しないでください。

リスナーが使用するポートとプロトコルです。

certificates

AppliedCertificate

予約済みフィールドです。変更しないでください。

リスナーに関連付けられている証明書です。

AppliedCertificate

フィールド

出力

説明

certificateId

string

予約済みフィールドです。変更しないでください。

証明書の CertIdentifier です。

isDefault

bool

予約済みフィールドです。変更しないでください。

証明書がデフォルトの証明書であるかどうか。

参考

AlbConfig の特定の設定に関する詳細については、「AlbConfig で ALB インスタンスを設定する」をご参照ください。
ALB Ingress アノテーションの使用に関する詳細については、「ALB Ingress の高度な使用法」をご参照ください。