ALB インスタンスとリスナーの設定でサポートされているすべての Ingress アノテーションと AlbConfig フィールドを参照してください。
インデックス
アノテーションフィールド
|
機能カテゴリ |
Ingress アノテーション設定 |
|
アノテーション YAML |
|
|
ALB Ingress の設定 |
|
|
リスナーまたはプロトコルの設定 |
|
|
トラフィック転送ルールの設定 |
|
|
高度な設定 |
|
|
その他 |
AlbConfig フィールド
|
フィールドカテゴリ |
フィールドへのリンク |
|
AlbConfig YAML |
|
|
AlbConfig |
|
|
ALB インスタンス |
|
|
リスナーの設定 |
|
|
仮想スイッチ |
|
|
Simple Log Service |
|
|
QUIC リスナー |
|
|
証明書の設定 |
|
|
アクセス制御 |
|
|
トレーシング分析 |
|
|
X-Forwarded-For の設定 |
|
|
ログ内のカスタムヘッダー |
|
|
予約済みフィールド |
アノテーション YAML の例
Ingress アノテーションを使用して ALB インスタンスを設定する例です。
Ingress の対応アノテーション
必要に応じて、Ingress リソースにアノテーションを追加します。
ヘルスチェック
|
アノテーション |
説明 |
|
alb.ingress.kubernetes.io/healthcheck-enabled |
バックエンドサーバーグループのヘルスチェックを有効にします。詳細については、「ヘルスチェックの設定」をご参照ください。
デフォルト値: |
|
alb.ingress.kubernetes.io/healthcheck-path |
ヘルスチェックパス。 デフォルト値: |
|
alb.ingress.kubernetes.io/healthcheck-protocol |
ヘルスチェックに使用するプロトコル。
デフォルト値: |
|
alb.ingress.kubernetes.io/healthcheck-httpversion |
HTTP バージョン。
デフォルト値: |
|
alb.ingress.kubernetes.io/healthcheck-method |
ヘルスチェックメソッド。
デフォルト値: 重要
|
|
alb.ingress.kubernetes.io/healthcheck-httpcode |
ヘルスチェックステータスコード。プローブがこれらのコードのいずれかを返した場合にのみ、バックエンドサーバーは正常とみなされます。 カンマで区切って、1 つ以上の値を指定します。
デフォルト値: |
|
alb.ingress.kubernetes.io/healthcheck-code |
ヘルスチェックステータスコード。プローブがこれらのコードのいずれかを返した場合にのみ、バックエンドサーバーは正常とみなされます。
有効な値は
|
|
alb.ingress.kubernetes.io/healthcheck-timeout-seconds |
ヘルスチェックのタイムアウト期間 (秒)。 範囲: [1, 300]。 デフォルト値: |
|
alb.ingress.kubernetes.io/healthcheck-interval-seconds |
ヘルスチェックの間隔 (秒)。 範囲: [1, 50]。 デフォルト値: |
|
alb.ingress.kubernetes.io/healthy-threshold-count |
サーバーを正常とみなすために必要な、ヘルスチェックの連続成功回数。 範囲: [2, 10]。 デフォルト値: |
|
alb.ingress.kubernetes.io/unhealthy-threshold-count |
サーバーを異常とみなすために必要な、ヘルスチェックの連続失敗回数。 範囲: [2, 10]。 デフォルト値: |
|
alb.ingress.kubernetes.io/healthcheck-connect-port |
ヘルスチェックに使用するポート。 デフォルト値: 説明
|
リダイレクト
|
アノテーション |
説明 |
|
alb.ingress.kubernetes.io/ssl-redirect |
ステータスコード 308 で HTTP リクエストを HTTPS (ポート 443) にリダイレクトします。詳細については、HTTP から HTTPS へのリダイレクトの設定をご参照ください。
デフォルト: |
バックエンドサービスで使用するプロトコル
|
アノテーション |
説明 |
|
alb.ingress.kubernetes.io/backend-protocol |
バックエンドサーバーグループで使用するプロトコルです。詳細については、「バックエンドサーバーでの HTTPS および gRPC プロトコルのサポート」をご参照ください。
デフォルト: 説明
リスナータイプごとにサポートされているバックエンドプロトコル:
|
書き換え
|
アノテーション |
説明 |
|
alb.ingress.kubernetes.io/rewrite-target |
パスの書き換えのターゲットパスです。パスの書き換え をご参照ください。 |
リスナー
|
アノテーション |
説明 |
|
alb.ingress.kubernetes.io/listen-ports |
Ingress リソースに関連付けるリスナーのポートとプロトコルです。詳細については、カスタムリスナーポートの設定をご参照ください。 Ingress ルールに関連付けるリスナーのプロトコルとポートを指定します:
|
スロースタート
|
アノテーション |
説明 |
|
alb.ingress.kubernetes.io/slow-start-enabled |
スロースタートを有効にします。ALB イングレスは、起動時の CPU とメモリのスパイクを防ぐため、新しく追加された Pod にトラフィックを段階的に移行します。「バックエンドスロースタート」をご参照ください。
デフォルト:無効。 |
|
alb.ingress.kubernetes.io/slow-start-duration |
スロースタートの開始後にトラフィックがランプアップするまでの期間を秒 (s) で指定します。期間が長いほど、ランプアップが遅くなります。 範囲:[30, 900]。 デフォルト: |
優先度
|
Annotation |
説明 |
|
alb.ingress.kubernetes.io/order |
転送ルールの相対的な優先度です。 数値が小さいほど優先度が高くなります。 詳細については、転送ルールの優先度の設定をご参照ください。 範囲: [1, 1000] デフォルト: |
段階的リリース
|
Annotation |
説明 |
|
alb.ingress.kubernetes.io/canary |
カナリアリリースを有効にします。詳細については、「ALB Ingress で段階的リリースを実装する」をご参照ください。
デフォルト: |
|
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 |
指定された Service にルーティングされるリクエストの割合 (0~100) です。詳細については、「カナリアの重み」をご参照ください。 |
セッション維持
|
アノテーション |
説明 |
|
alb.ingress.kubernetes.io/sticky-session |
バックエンドサーバーグループのセッション維持を有効にします。アノテーションを使用したセッション維持の有効化をご参照ください。
デフォルト: |
|
alb.ingress.kubernetes.io/sticky-session-type |
セッション維持のタイプ。
デフォルト: |
|
alb.ingress.kubernetes.io/cookie-timeout |
セッション維持のタイムアウト期間。単位は秒 (s) です。 範囲: [1, 86400]。 デフォルト: |
|
alb.ingress.kubernetes.io/cookie |
カスタムクッキーの名前。タイプ:文字列。デフォルト: |
コネクションドレイニング
|
アノテーション |
説明 |
|
alb.ingress.kubernetes.io/connection-drain-enabled |
コネクションドレイニングを有効にします。ALB Ingress は、Pod が Terminating 状態になるか、ヘルスチェックに失敗した後も、一定期間その Pod へのトラフィックを維持します。タイムアウト後、コネクションがクローズされます。コネクションドレイニングをご参照ください。
デフォルト: 無効。 |
|
alb.ingress.kubernetes.io/connection-drain-timeout |
コネクションドレイニングのタイムアウト期間で、単位は秒 (s) です。 範囲: [0, 900]。 デフォルト: |
負荷分散
|
アノテーション |
説明 |
|
alb.ingress.kubernetes.io/backend-scheduler |
バックエンドサーバーグループの負荷分散アルゴリズムです。詳細については、「バックエンドサーバーグループの負荷分散アルゴリズムの指定」をご参照ください。
デフォルト: |
|
alb.ingress.kubernetes.io/backend-scheduler-uch-value |
負荷分散アルゴリズムが uch の場合に使用する URL ハッシュパラメーターです。 |
クロスドメイン
|
アノテーション |
説明 |
|
alb.ingress.kubernetes.io/enable-cors |
オリジン間リソース共有 (CORS) を有効にするかどうかを指定します。詳細については、「CORS 設定」をご参照ください。
デフォルト: |
|
alb.ingress.kubernetes.io/cors-allow-origin |
クロスドメインリクエストを許可するオリジンです。 デフォルト: |
|
alb.ingress.kubernetes.io/cors-expose-headers |
クライアントに公開されるヘッダーのリストです。 |
|
alb.ingress.kubernetes.io/cors-allow-methods |
クロスドメインリクエストで許可される HTTP メソッドです。 1 つ以上の値を指定します:
デフォルト: |
|
alb.ingress.kubernetes.io/cors-allow-credentials |
クロスドメインリクエストで認証情報を許可するかどうかを指定します。
デフォルト: |
|
alb.ingress.kubernetes.io/cors-max-age |
プリフライトレスポンスをブラウザーにキャッシュする最大時間 (秒) です。 範囲: [-1, 172800] デフォルト: 説明
|
|
alb.ingress.kubernetes.io/cors-allow-headers |
クロスドメインリクエストで許可されるヘッダーのリストです。 デフォルト: |
カスタム転送
|
アノテーション |
説明 |
|
alb.ingress.kubernetes.io/actions.{svcName} |
カスタム転送アクションです。ALB Ingress のカスタム転送ルールの定義をご参照ください。 |
|
alb.ingress.kubernetes.io/conditions.{svcName} |
カスタム転送条件です。 |
|
alb.ingress.kubernetes.io/rule-direction.{svcName} |
カスタム転送方向です。
デフォルト: |
バックエンドサーバーグループの IPv6 アタッチメント
|
Annotation |
説明 |
|
alb.ingress.kubernetes.io/enable-ipv6 |
バックエンドサーバーグループの IPv6 アタッチメントを有効にします。詳細については、「バックエンドサーバーグループに IPv6 アドレスをアタッチする」をご参照ください。
デフォルト: |
その他
|
アノテーション |
説明 |
|
alb.ingress.kubernetes.io/backend-keepalive |
バックエンドサーバーへの永続的な接続を有効にします。詳細については、「バックエンドサーバーへの永続的な接続」をご参照ください。 デフォルト: |
|
alb.ingress.kubernetes.io/traffic-limit-qps |
1 秒あたりのリクエスト数 (QPS) のレート制限。 範囲: [1, 1000000] |
|
alb.ingress.kubernetes.io/use-regex |
パスフィールドで正規表現を許可します。プレフィックスパスタイプにのみ適用されます。 デフォルト: |
AlbConfig のフィールド
AlbConfig カスタムリソースで、ALB インスタンスとそのリスナーを定義します。フィールドの詳細については、以下をご参照ください。
AlbConfig
|
フィールド |
データ型 |
説明 |
|
apiVersion |
固定値 |
このリソースの API バージョン。 固定値: |
|
kind |
固定値 |
リソースタイプ。 固定値: |
|
metadata |
標準オブジェクトの metadata。 |
|
|
spec |
ALB インスタンスとリスナーのプロパティを記述するパラメータ。 |
|
|
status |
調整後、インスタンスのステータスが |
AlbConfigSpec
|
フィールド |
データ型 |
説明 |
|
config |
ALB インスタンスのプロパティ。 |
|
|
listeners |
インスタンス配下のリスナーのプロパティ。 |
LoadBalancerSpec
|
フィールド |
データ型 |
説明 |
|
id |
文字列 |
ALB インスタンス ID。再利用モードを有効にする場合は入力します。空のままにすると、新しいインスタンスが作成されます。詳細については、「AlbConfig の作成」をご参照ください。 デフォルト: |
|
name |
文字列 |
ALB インスタンス名。 デフォルトでは、 |
|
addressAllocatedMode |
enum |
アドレス割り当てモード。
デフォルト: |
|
addressType |
enum |
IPv4 アドレスタイプ。
デフォルト: |
|
ipv6AddressType |
enum |
IPv6 アドレスタイプ。IPv4 アドレスタイプと一致する必要はありません。
デフォルト: |
|
addressIpVersion |
enum |
インスタンスがデュアルスタックをサポートするかどうか。
デフォルト: |
|
resourceGroupId |
文字列 |
リソースグループ ID。 デフォルト: |
|
edition |
enum |
機能エディション。再利用モードでは変更できません。
デフォルト: |
|
deletionProtectionEnabled |
bool |
予約済みフィールド。変更しないでください。 |
|
forceOverride |
bool |
再利用モードでインスタンスのプロパティを強制的にオーバーライドするかどうか。
デフォルト: |
|
listenerForceOverride |
bool |
再利用モードでリスナーのプロパティを強制的にオーバーライドするかどうか。
デフォルト: |
|
zoneMappings |
ゾーンと EIP の設定。 |
|
|
accessLogConfig |
ログ収集。 |
|
|
billingConfig |
課金方法。 |
|
|
modificationProtectionConfig |
設定読み取り専用モード。 |
|
|
tags |
インスタンスタグ。 |
|
|
securityGroupIds |
string[] |
ALB インスタンスのセキュリティグループ ID。詳細については、「AlbConfig を使用したセキュリティグループの設定」をご参照ください。 |
ZoneMapping
|
フィールド |
データ型 |
説明 |
|
vSwitchId |
文字列 |
(必須) 仮想スイッチの ID。 デフォルト: |
|
zoneId |
文字列 |
仮想スイッチのゾーン。デフォルト値のままにしてください。 デフォルト: |
|
allocationId |
文字列 |
Elastic IP (EIP) の ID。AlbConfig を使用した ALB インスタンスの設定をご参照ください。 デフォルト: |
|
eipType |
文字列 |
予約済みフィールドです。変更しないでください。 |
AccessLogConfig
|
フィールド |
データ型 |
説明 |
|
logProject |
文字列 |
Simple Log Service プロジェクトの名前です。 デフォルト: |
|
logStore |
文字列 |
Simple Log Service (SLS) の Logstore 名です。 デフォルト: |
BillingConfig
|
フィールド |
データ型 |
説明 |
|
internetBandwidth |
int |
予約済みフィールドです。変更しないでください。 |
|
internetChargeType |
文字列 |
予約済みフィールドです。変更しないでください。 |
|
payType |
enum |
予約済みフィールドです。変更しないでください。 |
|
bandWidthPackageId |
文字列 |
アタッチする Internet Shared Bandwidth パッケージの ID です。アタッチ後はデタッチできません。詳細は、Internet Shared Bandwidth パッケージ設定をご参照ください。 デフォルト: |
ModificationProtectionConfig
|
フィールド |
データ型 |
説明 |
|
reason |
文字列 |
予約済みフィールド。 |
|
status |
文字列 |
予約済みフィールド。 |
タグ
|
フィールド |
データ型 |
説明 |
|
キー |
文字列 |
タグのキー デフォルト: |
|
値 |
文字列 |
タグの値 デフォルト: |
ListenerSpec
|
フィールド |
データ型 |
説明 |
|
gzipEnabled |
bool |
データ圧縮を有効にするかどうか。詳細については、「データ圧縮の使用」をご参照ください。
デフォルト: |
|
http2Enabled |
bool |
HTTP/2 プロトコルを有効にするかどうか。
デフォルト: |
|
port |
int |
必須。リスナーが使用するポートです。 デフォルト: |
|
protocol |
enum |
必須。リスナーが使用するプロトコルです。
|
|
securityPolicyId |
文字列 |
TLS セキュリティポリシーの ID です。 デフォルト: |
|
idleTimeout |
int |
アイドルタイムアウト期間 (秒) です。 範囲: [1, 600]。 デフォルト: 説明
値が 0 の場合は、デフォルト値が使用されます。 |
|
loadBalancerId |
文字列 |
予約済みフィールドです。変更しないでください。 |
|
description |
文字列 |
リスナーの名前です。 デフォルト: |
|
caEnabled |
bool |
相互認証を有効にするかどうか。
デフォルト: |
|
requestTimeout |
int |
リクエストタイムアウト期間 (秒) です。 範囲: [1, 600]。 デフォルト: |
|
quicConfig |
QUIC リスナーの設定です。 |
|
|
defaultActions |
Action[] |
予約済みフィールドです。変更しないでください。 |
|
caCertificates |
リスナーのルート CA 証明書です。 |
|
|
certificates |
リスナーのサーバー証明書です。 |
|
|
xForwardedForConfig |
X-Forwarded-For の設定です。 |
|
|
logConfig |
リスナーのログ設定です。 |
|
|
aclConfig |
アクセス制御です。 |
QuicConfig
|
フィールド |
データ型 |
説明 |
|
quicUpgradeEnabled |
bool |
QUIC アップグレードを有効にするかどうかを指定します。QUIC リスナーと HTTPS リスナーを関連付けるか、関連付けを解除します。詳細については、「HTTP/3 をサポートするための QUIC リスナーの使用」をご参照ください。
デフォルト: |
|
quicListenerId |
文字列 |
HTTPS リスナーに関連付ける QUIC リスナーの ID。 デフォルト: |
証明書
|
フィールド |
データ型 |
説明 |
|
IsDefault |
bool |
この証明書をデフォルトとして設定するかどうかを指定します。「暗号化通信に使用する HTTPS 証明書の設定」をご参照ください。
デフォルト: 重要
デフォルトとして設定できる証明書は 1 つだけです。 |
|
CertificateId |
文字列 |
証明書の CertIdentifier。 デフォルト: |
XForwardedForConfig
|
フィールド |
データ型 |
説明 |
|
XForwardedForClientCertSubjectDNEnabled |
bool |
転送 HTTP メッセージに
デフォルト: |
|
XForwardedForProtoEnabled |
bool |
転送 HTTP メッセージに
デフォルト: |
|
XForwardedForClientCertIssuerDNEnabled |
bool |
転送 HTTP メッセージに
デフォルト: |
|
XForwardedForSLBIdEnabled |
bool |
転送 HTTP メッセージに
デフォルト: |
|
XForwardedForClientSrcPortEnabled |
bool |
転送 HTTP メッセージに
デフォルト: |
|
XForwardedForClientCertFingerprintEnabled |
bool |
転送 HTTP メッセージに
デフォルト: |
|
XForwardedForEnabled |
bool |
ALB インスタンスは、クライアントの送信元 IP アドレスを保持するために、転送する HTTP メッセージのリクエストヘッダーに この機能を無効にするか、拡張機能を使用するには、ALB Ingress コントローラーをバージョン 2.15.0 以降にアップグレードし、
|
|
XForwardedForProcessingMode |
文字列 |
|
|
XForwardedForHostEnabled |
bool |
転送 HTTP メッセージに |
|
XForwardedForSLBPortEnabled |
bool |
転送 HTTP メッセージに
デフォルト: |
|
XForwardedForClientCertClientVerifyEnabled |
bool |
転送 HTTP メッセージに
デフォルト: |
|
XForwardedForClientCertSubjectDNAlias |
文字列 |
デフォルト: |
|
XForwardedForClientCertClientVerifyAlias |
文字列 |
デフォルト: |
|
XForwardedForClientCertIssuerDNAlias |
文字列 |
デフォルト: |
|
XForwardedForClientCertFingerprintAlias |
文字列 |
デフォルト: |
|
XForwardedForClientSourceIpsEnabled |
bool |
ALB が
デフォルト: |
|
XForwardedForClientSourceIpsTrusted |
文字列 |
信頼できるプロキシの IP アドレスを指定します。 有効な IP アドレスまたは CIDR ブロックを、スペースを入れずにセミコロン (
例: |
AclConfig
|
フィールド |
データ型 |
説明 |
|
aclName |
文字列 |
デフォルト: |
|
aclType |
enum |
アクセス制御モードです。
|
|
aclEntries |
文字列 |
アクセスポリシーエントリです。 デフォルト: 重要
|
|
aclIds |
文字列 |
関連付ける既存のポリシー ID のリストです。 デフォルト: |
LogConfig
|
フィールド |
データ型 |
説明 |
|
accessLogRecordCustomizedHeadersEnabled |
bool |
ALB インスタンスのアクセスログでカスタムヘッダーを使用するかどうか。
デフォルト: |
|
accessLogTracingConfig |
トレーシング分析の設定です。 詳細については、「AlbConfig によるトレーシング分析のための Xtrace の有効化」をご参照ください。 |
AccessLogTracingConfig
|
フィールド |
データ型 |
説明 |
|
tracingEnabled |
bool |
トレーシング分析を有効にするかどうか。
デフォルト: |
|
tracingSample |
int |
トレース分析のサンプリングレート、単位は 範囲: [1, 10000]。 |
|
tracingType |
enum |
トレーシング分析のサンプリングアルゴリズムです。
|
AlbConfigStatus
次のフィールドは、ALB イングレスがステータスを記録するために予約されています。これらのフィールドは変更しないでください:AlbConfigStatus、LoadBalancerStatus、ListenerStatus、AppliedCertificate。
|
フィールド |
出力 |
説明 |
|
loadBalancer |
予約済みフィールドです。変更しないでください。 ALB インスタンスのステータスです。 |
LoadBalancerStatus
|
フィールド |
出力 |
説明 |
|
dnsname |
文字列 |
予約済みフィールドです。変更しないでください。 ALB インスタンスの DNS アドレスです。 |
|
id |
文字列 |
予約済みフィールドです。変更しないでください。 ALB インスタンスの ID です。 |
|
listeners |
予約済みフィールドです。変更しないでください。 ALB インスタンスのリスナープロパティです。 |
ListenerStatus
|
フィールド |
出力 |
説明 |
|
portAndProtocol |
文字列 |
予約済みのフィールド。変更しないでください。 リスナーが使用するポートとプロトコルです。 |
|
certificates |
予約済みのフィールド。変更しないでください。 リスナーに関連付けられた証明書です。 |
AppliedCertificate
|
フィールド |
出力 |
説明 |
|
certificateId |
文字列 |
予約済みフィールドです。変更しないでください。 証明書の CertIdentifier です。 |
|
isDefault |
Boolean |
予約済みフィールドです。変更しないでください。 デフォルト証明書であるかどうかを示します。 |
参考資料
-
AlbConfig による ALB インスタンスの設定をご参照ください。
-
ALB Ingress の高度な使用方法をご参照ください。