：ALB Ingress配置詞典

Annotation

說明

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。

alb.ingress.kubernetes.io/healthcheck-httpcode

健全狀態檢查狀態代碼。僅當探測請求成功且返回指定狀態代碼時，才認為該後端伺服器狀態正常。

可以填入以下選項中的任意一個或多個組合，多個狀態代碼用英文半形逗號（,）分隔：

• http_2xx

• http_3xx

• http_4xx

• http_5xx

預設值：http_2xx。

alb.ingress.kubernetes.io/healthcheck-code

健全狀態檢查狀態代碼，僅當探測請求成功且返回指定狀態代碼時，才認為該後端伺服器狀態正常。

與healthcheck-httpcode同時使用時，以此欄位為準。

選擇性參數依賴於healthcheck-protocol中填入的值：

• HTTP或HTTPS：

  可以填入以下選項中的任意一個或多個組合，多個狀態代碼用英文半形逗號（,）分隔：

  • http_2xx

  • http_3xx

  • http_4xx

  • http_5xx

  預設值：http_2xx。

• GRPC：

  取值範圍：[0, 99]。

  預設值：0。

  支援範圍輸入，最多填入20個範圍值，多個範圍值使用英文半形逗號（,）分隔。

alb.ingress.kubernetes.io/healthcheck-timeout-seconds

健全狀態檢查逾時時間，單位秒（s）。

取值範圍：[1, 300]。

預設值：5。

alb.ingress.kubernetes.io/healthcheck-interval-seconds

健全狀態檢查間隔周期，單位秒（s）。

取值範圍：[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。

Annotation

說明

alb.ingress.kubernetes.io/ssl-redirect

是否對HTTP請求返回308狀態代碼，重新導向到HTTPS監聽（443連接埠）。重新導向的配置樣本，請參見配置HTTP重新導向至HTTPS。

• true：重新導向到HTTPS。

• false：不重新導向到HTTPS。

預設值：false。

Annotation

說明

alb.ingress.kubernetes.io/backend-protocol

後端伺服器組所使用的協議。配置樣本請參見支援後端HTTPS和gRPC協議。

• http：使用HTTP協議。

• https：使用HTTPS協議。

• grpc：使用gRPC協議。

預設值：http。

Annotation

說明

alb.ingress.kubernetes.io/rewrite-target

路徑重寫的地址。使用重寫的配置樣本，請參見Rewrite重寫。

Annotation

說明

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監聽與QUIC監聽。

Annotation

說明

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

是否啟用慢啟動功能。啟用慢啟動後，ALB Ingress在新增Pod被添加到Service後端時，會逐步將流量分配到新增Pod中，以避免造成Pod啟動後瞬時CPU與記憶體高壓造成的異常。慢啟動的配置樣本請參見後端慢啟動。

• true：啟用慢啟動功能。

• false：不啟用慢啟動功能。

預設不開啟。

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

慢啟動完成流量逐步增加所花費的時間，時間越長，流量增加的速度越慢，單位秒（s）。

取值範圍：[30, 900]。

預設值：30。

Annotation

說明

alb.ingress.kubernetes.io/order

轉寄規則的相對優先順序，數字越小優先順序越高。優先順序的配置樣本，請參見配置轉寄規則優先順序。

取值範圍：[1, 1000]。

預設值：10。

Annotation

說明

alb.ingress.kubernetes.io/canary

是否啟用Canary灰階。使用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標記。

Annotation

說明

alb.ingress.kubernetes.io/sticky-session

是否開啟後端伺服器組會話保持。會話保持的配置樣本，請參見通過註解實現會話保持。

• true：開啟會話保持。

• false：不開啟會話保持。

預設值：false。

alb.ingress.kubernetes.io/sticky-session-type

開啟會話保持的類型。

• Insert：植入Cookie模式。用戶端第一次訪問時，ALB執行個體會在返回請求中植入Cookie。

• Server：重寫Cookie模式。當ALB執行個體發現使用者自訂了Cookie，將會對原來的Cookie進行重寫。

預設值：Insert。

alb.ingress.kubernetes.io/cookie-timeout

會話保持逾時時間，單位秒（s）。

取值範圍：[1, 86400]。

預設值：1000。

Annotation

說明

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

是否開啟串連優雅中斷。開啟優雅中斷後，ALB Ingress在後端Pod進入Terminating狀態或健全狀態檢查報告異常時保持一定時間的正常傳輸，在到達逾時時間後再中斷串連，可以防止後端突然移除對業務的影響。優雅中斷的具體工作原理請參見串連優雅中斷。

• true：開啟優雅中斷。

• false：不開啟優雅中斷。

預設不開啟。

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

優雅中斷逾時時間，單位秒（s）。

取值範圍：[0, 900]。

預設值：300。

Annotation

說明

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雜湊參數。

Annotation

說明

alb.ingress.kubernetes.io/enable-cors

是否啟用跨網域設定。配置樣本，請參見跨網域設定。

• true：啟用跨網域設定。

• false：不啟用跨網域設定。

預設值：false。

alb.ingress.kubernetes.io/cors-allow-origin

允許跨域的源。

預設值：*。

alb.ingress.kubernetes.io/cors-expose-headers

允許暴露的Header列表。

alb.ingress.kubernetes.io/cors-allow-methods

允許跨域的要求方法。

可以填入以下選項中的任意一個或多個組合：

• 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

預檢請求在瀏覽器中的最大的緩衝時間，單位秒（s）。

取值範圍：[-1, 172800]。

預設值：172800。

alb.ingress.kubernetes.io/cors-allow-headers

允許跨域的Header列表。

預設值："DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization"。

Annotation

說明

alb.ingress.kubernetes.io/actions.{svcName}

自訂轉寄動作。自訂轉寄的具體操作，請參見自訂ALB Ingress的轉寄規則。

alb.ingress.kubernetes.io/conditions.{svcName}

自訂轉寄條件。

alb.ingress.kubernetes.io/rule-direction.{svcName}

自訂轉寄方向。

• Request：接收請求時的自訂轉寄。

• Response：響應時的自訂轉寄。

預設值：Request。

Annotation

說明

alb.ingress.kubernetes.io/backend-keepalive

是否啟用後端長連結。配置樣本請參見後端長串連。

預設值：false。

alb.ingress.kubernetes.io/traffic-limit-qps

QPS限速配置。

取值範圍：[1, 100000]。

alb.ingress.kubernetes.io/use-regex

允許Path欄位使用正則，僅在Prefix類型下生效。

預設值：false。

欄位

取實值型別

說明

apiVersion

固定取值

APIVersion定義了該對象的版本化模式。

固定取值：alibabacloud.com/v1。

kind

固定取值

Kind表示該對象所代表的REST資源。

固定取值：AlbConfig。

metadata

ObjectMeta

標準對象的metadata。

關於metadata的更多資訊，請參見metadata。

spec

AlbConfigSpec

用來描述ALB執行個體屬性和監聽屬性的參數列表。

status

AlbConfigStatus

在調和成功後，會將執行個體狀態寫入status中，寫入的值表示執行個體的目前狀態。

欄位

取實值型別

說明

config

LoadBalancerSpec

ALB執行個體的屬性。

listeners

ListenerSpec[]

執行個體下的監聽屬性。

欄位

取實值型別

說明

id

string

ALB執行個體ID，填寫代表啟用複用模式。置空表示不指定，會由controller建立一個ALB執行個體。建立新ALB執行個體或複用已有執行個體的具體操作，請參見建立AlbConfig。

預設值：""。

name

string

ALB執行個體名。

預設值：使用以下規則自動產生：k8s-{namespace}-{name}-{hashCode}。

addressAllocatedMode

enum

ALB執行個體的地址模式。

• Dynamic：ALB執行個體在每個可用性區域至少有一個IP，隨著業務請求的增加，會自動擴充IP數量。此模式下最大支援100萬QPS。

• Fixed：每個可用性區域有且只有一個IP，並且IP地址保持固定不變。此模式下執行個體彈效能力有限，最大支援10萬QPS。

預設值：Dynamic。

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：標準版。

• 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[]

執行個體標籤。

欄位

取實值型別

說明

vSwitchId

string

（必填）虛擬交換器的ID。

預設值：""。

zoneId

string

虛擬交換器的可用性區域。

預設值：""。

allocationId

string

彈性公網EIP的ID。

預設值：""。

eipType

string

保留欄位，請勿修改。

欄位

取實值型別

說明

logProject

string

SLS記錄項目的名稱。

預設值：""。

logStore

string

SLS日誌庫的名稱，必須以alb_開頭。如果不存在此日誌庫，則會自動建立。SLS日誌庫的配置樣本，請參見開啟Log Service訪問日誌。

預設值：""。

欄位

取實值型別

說明

internetBandwidth

int

保留欄位，請勿修改。

internetChargeType

string

保留欄位，請勿修改。

payType

enum

保留欄位，請勿修改。

bandWidthPackageId

string[]

綁定共用頻寬包ID。綁定後不支援解除綁定。

預設值：""。

欄位

取實值型別

說明

reason

string

保留欄位。

status

string

保留欄位。

欄位

取實值型別

說明

key

string

標籤的Key值。

預設值：""。

value

string

標籤的Value值。

預設值：""。

欄位

取實值型別

說明

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

空閑連結逾時時間，單位秒（s）。

預設值：15。

loadBalancerId

string

保留欄位，請勿修改。

description

string

監聽的名稱。

預設值：使用以下規則自動產生：ingress-auto-listener-{port}。

caEnabled

bool

是否開啟雙向認證功能。

• true：開啟雙向認證。

• false：不開啟雙向認證。

預設值：false。

requestTimeout

int

請求逾時時間，單位秒（s）。

預設值：60。

quicConfig

QuicConfig

Quic監聽配置。

defaultActions

Action[]

保留欄位，請勿修改。

caCertificates

Certificate[]

監聽的根CA認證。

certificates

Certificate[]

監聽的伺服器憑證。

xForwardedForConfig

XForwardedForConfig

XForward欄位配置資訊。

logConfig

LogConfig

監聽日誌相關配置。

aclConfig

AclConfig

存取控制。

欄位

取實值型別

說明

quicUpgradeEnabled

bool

是否開啟QUIC升級。在聯合使用QUIC與HTTPS監聽的情境中，quicUpgradeEnabled用於關聯或解關聯QUIC與HTTPS監聽。詳細操作，請參見使用QUIC監聽相容HTTP/3協議。

• true：開啟QUIC升級，關聯QUIC與HTTPS監聽。

• false：不開啟QUIC升級，不關聯QUIC與HTTPS監聽。

預設值：false。

quicListenerId

string

QUIC監聽關聯的HTTPS監聽。

預設值：""。

欄位

取實值型別

說明

IsDefault

bool

指定認證是否為預設認證。配置認證的具體操作，請參見配置HTTPS認證以實現加密通訊。

• true：指定為預設認證。

• false：不指定為預設認證。

預設值：false。

CertificateId

string

認證的CertIdentifier。

預設值：""。

欄位

取實值型別

說明

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資訊。該功能暫不支援關閉。

XForwardedForSLBPortEnabled

bool

是否在經過ALB執行個體轉寄的HTTP報文的要求標頭中添加X-Forwarded-Port欄位，以記錄ALB執行個體的監聽連接埠。

• true：添加欄位。

• false：不添加欄位。

預設值：false。

XForwardedForClientCertClientVerifyEnabled

bool

是否在經過ALB執行個體轉寄的HTTP報文的要求標頭中添加X-Forwarded-Clientcert-clientverify欄位，以保留用戶端認證的校正結果。

• true：添加欄位。

• false：不添加欄位。

預設值：false。

XForwardedForClientCertSubjectDNAlias

string

自訂欄位名稱。填入值後，會將XForwardedForClientCertSubjectDNEnabled添加的X-Forwarded-Clientcert-subjectdn欄位名稱替換為填入的值。

僅當XForwardedForClientCertSubjectDNEnabled的值為true時，該欄位才會生效。

預設值：""。

XForwardedForClientCertClientVerifyAlias

string

自訂欄位名稱。填入值後，會將XForwardedForClientCertClientVerifyEnabled添加的X-Forwarded-Clientcert-clientverify欄位名稱替換為填入的值。

僅當XForwardedForClientCertClientVerifyEnabled的值為true的時候，該欄位才會生效。

預設值：""。

XForwardedForClientCertIssuerDNAlias

string

自訂欄位名稱。填入值後，會將XForwardedForClientCertIssuerDNEnabled添加的X-Forwarded-Clientcert-issuerdn欄位名稱替換為填入的值。

僅當XForwardedForClientCertIssuerDNEnabled的值為true的時候，此欄位才會生效。

預設值：""。

XForwardedForClientCertFingerprintAlias

string

自訂欄位名稱。填入值後，會將XForwardedForClientCertFingerprintEnabled添加的X-Forwarded-Clientcert-fingerprint欄位名稱替換為填入的值。

僅當XForwardedForClientCertFingerprintEnabled的值為true時，該欄位才會生效。

預設值：""。

XForwardedForClientSourceIpsEnabled

bool

是否允許ALB從X-Forwarded-For頭欄位中尋找真實用戶端 IP。

• true：允許。此時必須配置XForwardedForClientSourceIpsTrusted並寫入格式正確的內容。

• false：不允許。

預設值：false。

XForwardedForClientSourceIpsTrusted

string

指定可信的代理IP。

請輸入正確格式的IP或網段，並以英文半形分號;分隔，IP或網段之間無需添加空格。僅在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

欄位

取實值型別

說明

aclName

string

AclEntry模式下關聯的ACL策略名稱。配置ACL的具體操作，請參見配置ACL實現存取控制。

預設值：""。

aclType

enum

存取控制的模式。

• Black：黑名單模式，阻止特定IP訪問服務。

• White：白名單模式，只允許特定IP訪問服務。

aclEntries

string[]

存取原則條目。

預設值：""。

aclIds

string[]

關聯已經存在的策略ID列表。

預設值：""。

欄位

取實值型別

說明

accessLogRecordCustomizedHeadersEnabled

bool

是否在ALB執行個體的訪問日誌中使用自訂Header。

• true：使用自訂Header。

• false：不使用自訂Header。

預設值：false。

accessLogTracingConfig

AccessLogTracingConfig

鏈路追蹤相關配置參數。鏈路追蹤的具體操作，請參見通過Albconfig開啟Xtrace實現鏈路追蹤。

欄位

取實值型別

說明

tracingEnabled

bool

是否啟用鏈路追蹤功能。

• true：開啟鏈路追蹤。

• false：不開啟鏈路追蹤。

預設值：false。

tracingSample

int

鏈路追蹤採樣率，單位為0.01%。

取值範圍：[1, 10000]。

tracingType

enum

鏈路追蹤的採樣演算法。

• Zipkin：使用Zipkin演算法。

欄位

輸出內容

說明

loadBalancer

LoadBalancerStatus

保留欄位，請勿修改。

ALB執行個體的狀態。

欄位

輸出內容

說明

dnsname

string

保留欄位，請勿修改。

ALB執行個體的DNS地址。

id

string

保留欄位，請勿修改。

ALB執行個體的ID。

listeners

ListenerStatus

保留欄位，請勿修改。

ALB執行個體的監聽屬性。

欄位

輸出內容

說明

portAndProtocol

string

保留欄位，請勿修改。

監聽使用的連接埠與協議。

certificates

AppliedCertificate

保留欄位，請勿修改。

監聽關聯的認證。

欄位

輸出內容

說明

certificateId

string

保留欄位，請勿修改。

認證的CertIdentifier。

isDefault

bool

保留欄位，請勿修改。

認證是否為預設認證。