Kubernetes 適用於容器的應用程式閘道 API 規格 (預覽版)
套件
套件 v1 是 API 的 v1 版本。
alb.networking.azure.io/v1
本文件會定義 alb.networking.azure.io/v1
的每個資源類型。
資源類型:
AffinityType (string
別名)
(出現於:SessionAffinity)
AffinityType 定義服務的親和性類型
值 | Description |
---|---|
"application-cookie" |
AffinityTypeApplicationCookie 是應用程式 Cookie 的工作階段親和性類型 |
"managed-cookie" |
AffinityTypeManagedCookie 是受控 Cookie 的工作階段親和性類型 |
AlbConditionReason (string
別名)
AlbConditionReason 定義一組原因,說明為何在適用於容器的應用程式閘道資源上引發特定條件類型。
值 | Description |
---|---|
"Accepted" |
AlbReasonAccepted 指出控制器已接受適用於容器的應用程式閘道資源。 |
"Ready" |
AlbReasonDeploymentReady 指出適用於容器的應用程式閘道資源部署狀態。 |
"InProgress" |
AlbReasonInProgress 指出是否正在建立、更新或刪除適用於容器的應用程式閘道資源。 |
AlbConditionType (string
別名)
AlbConditionType 是與適用於容器的應用程式閘道資源相關聯的條件類型。 此類型應該與 AlbStatus.Conditions 欄位搭配使用。
值 | Description |
---|---|
"Accepted" |
AlbConditionTypeAccepted 指出控制器是否已接受適用於容器的應用程式閘道資源。 |
"Deployment" |
AlbConditionTypeDeployment 指出適用於容器的應用程式閘道資源的部署狀態。 |
AlbSpec
(出現於:ApplicationLoadBalancer)
AlbSpec 定義適用於容器的應用程式閘道資源的規格。
欄位 | 描述 |
---|---|
associations []string |
Associations 是適用於容器的應用程式閘道資源與之相關聯的子網路資源識別碼。 |
AlbStatus
(出現於:ApplicationLoadBalancer)
AlbStatus 定義適用於容器的應用程式閘道資源的觀察狀態。
欄位 | 描述 |
---|---|
conditions []Kubernetes meta/v1.Condition |
(選擇性)
已知條件類型為:
|
ApplicationLoadBalancer
ApplicationLoadBalancer 是適用於容器的應用程式閘道資源的結構描述。
欄位 | 描述 | ||
---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
(選擇性)
物件的中繼資料。 如需metadata 欄位的各欄位,請參閱 Kubernetes API 文件。
|
||
spec AlbSpec |
Spec 是適用於容器的應用程式閘道資源的規格。
|
||
status AlbStatus |
Status 定義適用於容器的應用程式閘道資源的目前狀態。 |
BackendTLSPolicy
BackendTLSPolicy 是 BackendTLSPolicys API 的結構描述
欄位 | 描述 | ||||||
---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
(選擇性)
物件的中繼資料。 如需metadata 欄位的各欄位,請參閱 Kubernetes API 文件。
|
||||||
spec BackendTLSPolicySpec |
Spec 是 BackendTLSPolicy 規格。
|
||||||
status BackendTLSPolicyStatus |
Status 定義 BackendTLSPolicy 的目前狀態。 |
BackendTLSPolicyConditionReason (string
別名)
BackendTLSPolicyConditionReason 定義一組原因,說明為何引發特定的 BackendTLSPolicy 條件類型。
值 | Description |
---|---|
"InvalidCertificateRef" |
參考無效憑證時,會使用 BackendTLSPolicyInvalidCertificateRef |
"Accepted" |
BackendTLSPolicyReasonAccepted 用來在指定的 BackendTLSPolicy 正確設定時,將 BackendTLSPolicyConditionReason 設定為 Accepted |
"InvalidBackendTLSPolicy" |
BackendTLSPolicyReasonInvalid 是未接受 BackendTLSPolicy 時的原因 |
"InvalidGroup" |
如果群組無效,則會使用 BackendTLSPolicyReasonInvalidGroup |
"InvalidKind" |
如果種類/群組無效,則會使用 BackendTLSPolicyReasonInvalidKind |
"InvalidName" |
如果名稱無效,則會使用 BackendTLSPolicyReasonInvalidName |
"InvalidSecret" |
如果祕密無效,則會使用 BackendTLSPolicyReasonInvalidSecret |
"InvalidService" |
如果服務無效,則會使用 BackendTLSPolicyReasonInvalidService |
"NoTargetReference" |
沒有目標參考時,會使用 BackendTLSPolicyReasonNoTargetReference |
"RefNotPermitted" |
不允許 ref 時,會使用 BackendTLSPolicyReasonRefNotPermitted |
BackendTLSPolicyConditionType (string
別名)
BackendTLSPolicyConditionType 是與 BackendTLSPolicy 相關聯的條件類型。 此類型應該與 BackendTLSPolicyStatus.Conditions 欄位搭配使用。
值 | Description |
---|---|
"Accepted" |
BackendTLSPolicyConditionAccepted 用來將 BackendTLSPolicyConditionType 設定為 Accepted |
"ResolvedRefs" |
BackendTLSPolicyConditionResolvedRefs 用來將 BackendTLSPolicyCondition 設定為 ResolvedRefs |
BackendTLSPolicyConfig
(出現於:BackendTLSPolicySpec)
BackendTLSPolicyConfig 定義後端 TLS 原則的原則規格。
欄位 | 描述 |
---|---|
CommonTLSPolicy CommonTLSPolicy |
( |
sni string |
(選擇性)
Sni 是用於後端 TLS 連線的伺服器名稱。 |
ports []BackendTLSPolicyPort |
Ports 指定套用原則的連接埠清單。 |
clientCertificateRef Gateway API .SecretObjectReference |
(選擇性)
ClientCertificateRef 是用戶端憑證的參考,用於後端的 TLS 連線。 |
BackendTLSPolicyPort
(出現於:BackendTLSPolicyConfig)
BackendTLSPolicyPort 定義用於後端 TLS 連線的連接埠
欄位 | 描述 |
---|---|
port int |
Port 是用於後端 TLS 連線的連接埠 |
BackendTLSPolicySpec
(出現於:BackendTLSPolicy)
BackendTLSPolicySpec 定義 BackendTLSPolicy 的預期狀態
欄位 | 描述 |
---|---|
targetRef Gateway API .PolicyTargetReference |
TargetRef 可識別要套用原則的 API 物件。 |
override BackendTLSPolicyConfig |
(選擇性)
Override 定義原則組態,該組態應該覆寫階層中目標資源下方所附加的原則組態。 |
default BackendTLSPolicyConfig |
(選擇性)
Default 定義目標資源的預設原則組態。 |
BackendTLSPolicyStatus
(出現於:BackendTLSPolicy)
BackendTLSPolicyStatus 定義 BackendTLSPolicy 的觀察狀態。
欄位 | 描述 |
---|---|
conditions []Kubernetes meta/v1.Condition |
(選擇性)
Conditions 描述 BackendTLSPolicy 的目前條件。 實作應偏好使用 已知條件類型為:
|
CommonTLSPolicy
(出現於:BackendTLSPolicyConfig)
CommonTLSPolicy 是 CommonTLSPolicy API 的結構描述
欄位 | 描述 |
---|---|
verify CommonTLSPolicyVerify |
(選擇性)
Verify 提供驗證後端憑證的選項 |
CommonTLSPolicyVerify
(出現於:CommonTLSPolicy)
CommonTLSPolicyVerify 定義 CommonTLSPolicyVerify API 的結構描述
欄位 | 描述 |
---|---|
caCertificateRef Gateway API .SecretObjectReference |
CaCertificateRef 是用來驗證後端對等憑證的 CA 憑證。 |
subjectAltName string |
SubjectAltName 是用來驗證後端對等憑證的主體別名。 |
CustomTargetRef
(出現於:FrontendTLSPolicySpec)
CustomTargetRef 是不屬於 Kubernetes 核心 API 的自訂資源參考。
欄位 | 描述 |
---|---|
name Gateway API .ObjectName |
Name 是參考項目的名稱。 |
kind Gateway API .Kind |
Kind 是參考項目的種類。 |
listeners []string |
(選擇性)
Listener 是接聽程式的名稱。 |
namespace Gateway API .Namespace |
Namespace 是參考項目的命名空間。 未指定時,則為本機 |
group Gateway API .Group |
(選擇性)
Group 是參考項目的群組。 |
FrontendTLSPolicy
FrontendTLSPolicy 是 FrontendTLSPolicy API 的結構描述
欄位 | 描述 | ||||
---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
(選擇性)
物件的中繼資料。 如需metadata 欄位的各欄位,請參閱 Kubernetes API 文件。
|
||||
spec FrontendTLSPolicySpec |
Spec 是 FrontendTLSPolicy 規格。
|
||||
status FrontendTLSPolicyStatus |
Status 定義 FrontendTLSPolicy 的目前狀態。 |
FrontendTLSPolicyConditionReason (string
別名)
FrontendTLSPolicyConditionReason 定義一組原因,說明為何引發特定的 FrontendTLSPolicy 條件類型。
值 | Description |
---|---|
"Accepted" |
FrontendTLSPolicyReasonAccepted 用來在指定的 FrontendTLSPolicy 正確設定時,將 FrontendTLSPolicyConditionReason 設定為 Accepted |
"InvalidFrontendTLSPolicy" |
FrontendTLSPolicyReasonInvalid 是未接受 FrontendTLSPolicy 時的原因 |
"InvalidGateway" |
如果閘道無效,則會使用 FrontendTLSPolicyReasonInvalidGateway |
"InvalidGroup" |
如果群組無效,則會使用 FrontendTLSPolicyReasonInvalidGroup |
"InvalidKind" |
如果種類/群組無效,則會使用 FrontendTLSPolicyReasonInvalidKind |
"InvalidName" |
如果名稱無效,則會使用 FrontendTLSPolicyReasonInvalidName |
"InvalidPolicyName" |
如果原則名稱無效,則會使用 FrontendTLSPolicyReasonInvalidPolicyName |
"InvalidPolicyType" |
如果原則類型無效,則會使用 FrontendTLSPolicyReasonInvalidPolicyType |
"NoTargetReference" |
沒有目標參考時,會使用 FrontendTLSPolicyReasonNoTargetReference |
"RefNotPermitted" |
不允許 ref 時,會使用 FrontendTLSPolicyReasonRefNotPermitted |
FrontendTLSPolicyConditionType (string
別名)
FrontendTLSPolicyConditionType 是與 FrontendTLSPolicy 相關聯的條件類型。 此類型應該與 FrontendTLSPolicyStatus.Conditions 欄位搭配使用。
值 | Description |
---|---|
"Accepted" |
FrontendTLSPolicyConditionAccepted 用來將 FrontendTLSPolicyCondition 設定為 Accepted |
"ResolvedRefs" |
FrontendTLSPolicyConditionResolvedRefs 用來將 FrontendTLSPolicyCondition 設定為 ResolvedRefs |
FrontendTLSPolicyConfig
(出現於:FrontendTLSPolicySpec)
FrontendTLSPolicyConfig 定義前端 TLS 原則的原則規格。
欄位 | 描述 |
---|---|
policyType PolicyType |
Type 是原則的類型。 |
FrontendTLSPolicySpec
(出現於:FrontendTLSPolicy)
FrontendTLSPolicySpec 定義 FrontendTLSPolicy 的預期狀態
欄位 | 描述 |
---|---|
targetRef CustomTargetRef |
TargetRef 可識別要套用原則的 API 物件。 |
default FrontendTLSPolicyConfig |
(選擇性)
Default 定義目標資源的預設原則組態。 |
FrontendTLSPolicyStatus
(出現於:FrontendTLSPolicy)
FrontendTLSPolicyStatus 定義 FrontendTLSPolicy 的觀察狀態。
欄位 | 描述 |
---|---|
conditions []Kubernetes meta/v1.Condition |
(選擇性)
Conditions 描述 FrontendTLSPolicy 的目前條件。 實作應偏好使用 已知條件類型為:
|
FrontendTLSPolicyType (string
別名)
(出現於:PolicyType)
FrontendTLSPolicyType 是前端 TLS 原則的類型。
值 | Description |
---|---|
"predefined" |
PredefinedFrontendTLSPolicyType 是預先定義的前端 TLS 原則類型。 |
HTTPHeader
(出現於:HeaderFilter)
HTTPHeader 代表 RFC 7230 所定義的 HTTP 標頭名稱和值。
欄位 | 描述 |
---|---|
name HTTPHeaderName |
Name 是要比對的 HTTP 標頭名稱。 名稱比對必須不區分大小寫。 (請參閱 https://tools.ietf.org/html/rfc7230#section-3.2)。 如果多個項目指定對等的標頭名稱,則必須將具有對等名稱的第一個項目視為相符項目。 必須忽略具有對等標頭名稱的後續項目。 由於標頭名稱不區分大小寫,因此 "foo" 和 "Foo" 視為對等項目。 |
value string |
Value 是要比對的 HTTP 標頭值。 |
HTTPHeaderName (string
別名)
(出現於:HTTPHeader)
HTTPHeaderName 是 HTTP 標頭的名稱。
有效值包括:
- "Authorization"
- "Set-Cookie"
無效值包括:
- ":method":":" 是無效的字元。 這表示此類型目前不支援 HTTP/2 虛擬標頭。
- "/invalid":"/ " 是無效的字元
HTTPMatch
(出現於:HTTPSpecifiers)
HTTPMatch 定義用於 HealthCheck 檢查的 HTTP 比對器。
欄位 | 描述 |
---|---|
body string |
(選擇性)
Body 定義用於 HealthCheck 檢查的 HTTP 本文比對器。 |
statusCodes []StatusCodes |
(選擇性)
StatusCodes 定義用於 HealthCheck 檢查的 HTTP 狀態碼比對器。 |
HTTPPathModifier
(出現於:Redirect、URLRewriteFilter)
HTTPPathModifier 定義路徑修飾元的組態。
欄位 | 描述 | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type HTTPPathModifierType |
Type 定義路徑修飾元的類型。 可能會在未來版本的 API 中新增其他類型。 請注意,您可以將值新增至此列舉,實作必須確保未知的值不會造成當機。 此處的未知值必須導致實作設定規則為 false 的接受條件 |
||||||||||||||||||||||||||||||||||||||||||||||||
replaceFullPath string |
(選擇性)
ReplaceFullPath 可指定要在重寫或重新導向期間取代要求完整路徑的值。 |
||||||||||||||||||||||||||||||||||||||||||||||||
replacePrefixMatch string |
(選擇性)
ReplacePrefixMatch 可指定要在重寫或重新導向期間取代要求前置詞相符項目的值。 例如,對於前置詞相符項目為 "/foo" 且 ReplacePrefixMatch 為 "/xyz" 的 "/foo/bar" 要求會修改為 "/xyz/bar"。 請注意,這符合 PathPrefix 比對類型的行為。 這會比對完整路徑元素。 路徑元素是指路徑中依 ReplacePrefixMatch 只與
|
HTTPPathModifierType (string
別名)
(出現於:HTTPPathModifier)
HTTPPathModifierType 定義路徑重新導向或重寫的類型。
值 | Description |
---|---|
"ReplaceFullPath" |
FullPathHTTPPathModifier 指出將完整路徑取代為指定值。 |
"ReplacePrefixMatch" |
PrefixMatchHTTPPathModifier 指出任何前置詞路徑相符項目都會取代為替代值。 例如,前置詞相符項目為 "/foo" 且 ReplacePrefixMatch 替代值為 "/bar" 的路徑會在相符要求中將 "/foo" 前置詞取代為 "/bar"。 請注意,這符合 PathPrefix 比對類型的行為。 這會比對完整路徑元素。 路徑元素是指路徑中依 |
HTTPSpecifiers
(出現於:HealthCheckPolicyConfig)
HTTPSpecifiers 定義 HTTP HealthCheck 檢查規格的結構描述
欄位 | 描述 |
---|---|
host string |
(選擇性)
Host 是用於 HealthCheck 檢查的主機標頭值。 |
path string |
(選擇性)
Path 是用於 HealthCheck 檢查的路徑。 |
match HTTPMatch |
(選擇性)
Match 定義用於 HealthCheck 檢查的 HTTP 比對器。 |
HeaderFilter
(出現於:IngressRewrites)
HeaderFilter 定義修改 HTTP 要求或回應標頭的篩選條件。 只允許對指定標頭名稱執行一個動作。 為任何一個標頭名稱指定多個相同或不同類型動作的篩選條件無效,將會遭到拒絕。 為標頭設定或新增多個值的組態必須使用 RFC 7230 標頭值格式,以逗號分隔每個值。
欄位 | 描述 |
---|---|
set []HTTPHeader |
(選擇性)
Set 可在動作之前以指定標頭 (name、value) 覆寫要求。 輸入:GET /foo HTTP/1.1 my-header: foo 設定:set: - name: "my-header" value: "bar" 輸出:GET /foo HTTP/1.1 my-header: bar |
add []HTTPHeader |
(選擇性)
Add 可在動作之前將指定標頭 (name、value) 新增至要求。 其會附加至與標頭名稱相關聯的任何現有值。 輸入:GET /foo HTTP/1.1 my-header: foo 設定:add: - name: "my-header" value: "bar,baz" 輸出:GET /foo HTTP/1.1 my-header: foo,bar,baz |
remove []string |
(選擇性)
在動作之前,從 HTTP 要求中移除指定標頭。 Remove 的值是 HTTP 標頭名稱的清單。 請注意,標頭名稱不區分大小寫 (請參閱 https://datatracker.ietf.org/doc/html/rfc2616#section-4.2)。 輸入:GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz 設定:remove: ["my-header1", "my-header3"] 輸出:GET /foo HTTP/1.1 my-header2: bar |
HeaderName (string
別名)
HeaderName 是標頭或查詢參數的名稱。
HealthCheckPolicy
HealthCheckPolicy 是 HealthCheckPolicy API 的結構描述
欄位 | 描述 | ||||||
---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
(選擇性)
物件的中繼資料。 如需metadata 欄位的各欄位,請參閱 Kubernetes API 文件。
|
||||||
spec HealthCheckPolicySpec |
Spec 是 HealthCheckPolicy 規格。
|
||||||
status HealthCheckPolicyStatus |
Status 定義 HealthCheckPolicy 的目前狀態。 |
HealthCheckPolicyConditionReason (string
別名)
HealthCheckPolicyConditionReason 定義一組原因,說明為何引發特定的 HealthCheckPolicy 條件類型。
值 | Description |
---|---|
"Accepted" |
HealthCheckPolicyReasonAccepted 用來在指定的 HealthCheckPolicy 正確設定時,將 HealthCheckPolicyConditionReason 設定為 Accepted |
"InvalidHealthCheckPolicy" |
HealthCheckPolicyReasonInvalid 是未接受 HealthCheckPolicy 時的原因 |
"InvalidGroup" |
如果群組無效,則會使用 HealthCheckPolicyReasonInvalidGroup |
"InvalidKind" |
如果種類/群組無效,則會使用 HealthCheckPolicyReasonInvalidKind |
"InvalidName" |
如果名稱無效,則會使用 HealthCheckPolicyReasonInvalidName |
"InvalidPort" |
如果連接埠無效,則會使用 HealthCheckPolicyReasonInvalidPort |
"InvalidService" |
如果服務無效,則會使用 HealthCheckPolicyReasonInvalidService |
"NoTargetReference" |
沒有目標參考時,會使用 HealthCheckPolicyReasonNoTargetReference |
"RefNotPermitted" |
不允許 ref 時,會使用 HealthCheckPolicyReasonRefNotPermitted |
HealthCheckPolicyConditionType (string
別名)
HealthCheckPolicyConditionType 是與 HealthCheckPolicy 相關聯的條件類型。 此類型應該與 HealthCheckPolicyStatus.Conditions 欄位搭配使用。
值 | Description |
---|---|
"Accepted" |
HealthCheckPolicyConditionAccepted 用來將 HealthCheckPolicyConditionType 設定為 Accepted |
"ResolvedRefs" |
HealthCheckPolicyConditionResolvedRefs 用來將 HealthCheckPolicyCondition 設定為 ResolvedRefs |
HealthCheckPolicyConfig
(出現於:HealthCheckPolicySpec)
HealthCheckPolicyConfig 定義 HealthCheck 檢查規格的結構描述
欄位 | 描述 |
---|---|
port int32 |
(選擇性)
Port 是用於 HealthCheck 檢查的連接埠。 |
protocol Protocol |
(選擇性)
Protocol 是用於 HealthCheck 檢查的通訊協定。 |
interval Kubernetes meta/v1.Duration |
(選擇性)
Interval 是 HealthCheck 檢查之間的秒數。 |
timeout Kubernetes meta/v1.Duration |
(選擇性)
Timeout 是 HealthCheck 檢查視為失敗之前的秒數。 |
unhealthyThreshold int32 |
(選擇性)
UnhealthyThreshold 是連續失敗的 HealthCheck 檢查次數 |
healthyThreshold int32 |
(選擇性)
HealthyThreshold 是連續成功的 HealthCheck 檢查次數 |
http HTTPSpecifiers |
(選擇性)
HTTP 可為目標資源的 HealthCheck 定義 HTTP 限制式規格。 |
HealthCheckPolicySpec
(出現於:HealthCheckPolicy)
HealthCheckPolicySpec 定義 HealthCheckPolicy 的預期狀態
欄位 | 描述 |
---|---|
targetRef Gateway API .PolicyTargetReference |
TargetRef 可識別要套用原則的 API 物件。 |
override HealthCheckPolicyConfig |
(選擇性)
Override 定義原則組態,該組態應該覆寫階層中目標資源下方所附加的原則組態。 |
default HealthCheckPolicyConfig |
(選擇性)
Default 定義目標資源的預設原則組態。 |
HealthCheckPolicyStatus
(出現於:HealthCheckPolicy)
HealthCheckPolicyStatus 定義 HealthCheckPolicy 的觀察狀態。
欄位 | 描述 |
---|---|
conditions []Kubernetes meta/v1.Condition |
(選擇性)
Conditions 描述 HealthCheckPolicy 的目前條件。 實作應偏好使用 已知條件類型為:
|
IngressBackendPort
(出現於:IngressBackendSettings)
IngressBackendPort 描述後端的連接埠。 應該只定義一個名稱/數字。
欄位 | 描述 |
---|---|
port int32 |
(選擇性)
Port 指出後端服務上的連接埠 |
name string |
(選擇性)
Name 必須參考後端服務連接埠上的名稱 |
protocol Protocol |
Protocol 應該是 "HTTP"、"HTTPS" 其中之一 |
IngressBackendSettingStatus
(出現於:IngressExtensionStatus)
IngressBackendSettingStatus 描述 BackendSetting 的狀態
欄位 | 描述 |
---|---|
service string |
Service 會識別此狀態描述的 BackendSetting |
validationErrors []string |
(選擇性)
Errors 是與此設定相關的錯誤清單 |
valid bool |
Valid 指出此 BackendSetting 上不存在驗證錯誤 |
IngressBackendSettings
(出現於:IngressExtensionSpec)
IngressBackendSettings 提供後端服務的擴充組態選項
欄位 | 描述 |
---|---|
service string |
Service 是套用此組態的後端服務名稱 |
ports []IngressBackendPort |
(選擇性)
Ports 用來指出後端服務是否在 HTTP 或 HTTPS 上接聽 |
trustedRootCertificate string |
(選擇性)
在指定為 HTTPS 的連接埠上與後端通訊時,可以使用 TrustedRootCertificate 為閘道提供要信任的憑證 |
sessionAffinity SessionAffinity |
(選擇性)
SessionAffinity 可讓用戶端要求一致地提供給相同的後端 |
timeouts IngressTimeouts |
(選擇性)
Timeouts 定義一組要套用至輸入的逾時參數 |
IngressCertificate
(出現於:IngressRuleTLS)
IngressCertificate 定義要與 TLS 搭配使用的憑證和私密金鑰。
欄位 | 描述 |
---|---|
type string |
Type 指出儲存憑證的位置。 可以是 KubernetesSecret 或 KeyVaultCertificate |
name string |
(選擇性)
Name 是包含 TLS 憑證和金鑰的 KubernetesSecret 名稱 |
secretId string |
(選擇性)
SecretID 是 KeyVaultCertificate 的資源識別碼 |
IngressExtension
IngressExtension 是 IngressExtension API 的結構描述
欄位 | 描述 | ||||
---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
(選擇性)
物件的中繼資料。 如需metadata 欄位的各欄位,請參閱 Kubernetes API 文件。
|
||||
spec IngressExtensionSpec |
Spec 是 IngressExtension 規格。
|
||||
status IngressExtensionStatus |
IngressExtensionConditionReason (string
別名)
IngressExtensionConditionReason 定義一組原因,說明為何引發特定的 IngressExtension 條件類型。
值 | Description |
---|---|
"Accepted" |
IngressExtensionReasonAccepted 用來將 IngressExtensionConditionAccepted 設定為 Accepted |
"HasValidationErrors" |
IngressExtensionReasonHasErrors 指出有一些驗證錯誤 |
"NoValidationErrors" |
IngressExtensionReasonNoErrors 指出沒有任何驗證錯誤 |
"PartiallyAcceptedWithErrors" |
IngressExtensionReasonPartiallyAccepted 用來將 IngressExtensionConditionAccepted 設定為 Accepted,但發生不嚴重的驗證錯誤 |
IngressExtensionConditionType (string
別名)
IngressExtensionConditionType 是與 IngressExtension 相關聯的條件類型。 此類型應該與 IngressExtensionStatus.Conditions 欄位搭配使用。
值 | Description |
---|---|
"Accepted" |
IngressExtensionConditionAccepted 指出控制器是否已接受 (協調) IngressExtension |
"Errors" |
IngressExtensionConditionErrors 指出延伸模組上是否有驗證或建置錯誤 |
IngressExtensionSpec
(出現於:IngressExtension)
IngressExtensionSpec 定義 IngressExtension 所需的組態
欄位 | 描述 |
---|---|
rules []IngressRuleSetting |
(選擇性)
Rules 定義每個主機的規則 |
backendSettings []IngressBackendSettings |
(選擇性)
BackendSettings 定義一組輸入服務後端的組態選項 |
IngressExtensionStatus
(出現於:IngressExtension)
IngressExtensionStatus 描述 IngressExtension 的目前狀態
欄位 | 描述 |
---|---|
rules []IngressRuleStatus |
(選擇性)
Rules 包含與每個規則相關的詳細狀態資訊 |
backendSettings []IngressBackendSettingStatus |
(選擇性)
BackendSettings 包含與每個 BackendSettings 相關的詳細狀態資訊 |
conditions []Kubernetes meta/v1.Condition |
(選擇性)
Conditions 描述 IngressExtension 的目前條件。 已知條件類型為:
|
IngressRewrites
(出現於:IngressRuleSetting)
IngressRewrites 提供規則支援的各種重寫
欄位 | 描述 |
---|---|
type RewriteType |
Type 可識別重寫的類型 |
requestHeaderModifier HeaderFilter |
(選擇性)
RequestHeaderModifier 定義修改要求標頭的結構描述。 |
responseHeaderModifier HeaderFilter |
(選擇性)
RequestHeaderModifier 定義修改回應標頭的結構描述。 |
urlRewrite URLRewriteFilter |
(選擇性)
URLRewrite 定義在轉送期間修改要求的結構描述。 |
IngressRuleSetting
(出現於:IngressExtensionSpec)
IngressRuleSetting 提供規則的組態選項
欄位 | 描述 |
---|---|
host string |
Host 用來與具有相同主機名稱的輸入規則比對,以便識別哪些規則會受到這些設定影響 |
tls IngressRuleTLS |
(選擇性)
TLS 定義規則的 TLS 設定 |
additionalHostnames []string |
(選擇性)
AdditionalHostnames 可指定要接聽的其他主機名稱 |
rewrites []IngressRewrites |
(選擇性)
Rewrites 定義規則的重寫 |
requestRedirect Redirect |
(選擇性)
RequestRedirect 定義規則的重新導向行為 |
IngressRuleStatus
(出現於:IngressExtensionStatus)
IngressRuleStatus 描述規則的狀態
欄位 | 描述 |
---|---|
host string |
Host 可識別此狀態描述的規則 |
validationErrors []string |
(選擇性)
Errors 是與此設定相關的錯誤清單 |
valid bool |
(選擇性)
Valid 指出此規則上不存在驗證錯誤 |
IngressRuleTLS
(出現於:IngressRuleSetting)
IngressRuleTLS 提供在規則上設定 TLS 設定的選項
欄位 | 描述 |
---|---|
certificate IngressCertificate |
(選擇性)
Certificate 可指定設定規則所使用的 TLS 憑證 |
IngressTimeouts
(出現於:IngressBackendSettings)
IngressTimeouts 可用來設定輸入的逾時屬性
欄位 | 描述 |
---|---|
requestTimeout Kubernetes meta/v1.Duration |
(選擇性)
RequestTimeout 定義負載平衡器將要求轉送至後端服務時所使用的逾時 |
PolicyType
(出現於:FrontendTLSPolicyConfig)
PolicyType 是原則的類型。
欄位 | 描述 |
---|---|
name string |
Name 是原則的名稱。 |
type FrontendTLSPolicyType |
PredefinedFrontendTLSPolicyType 是預先定義的前端 TLS 原則類型。 |
PortNumber (int32
別名)
(出現於:Redirect)
PortNumber 定義網路連接埠。
PreciseHostname (string
別名)
(出現於:Redirect、URLRewriteFilter)
PreciseHostname 是網路主機的完整網域名稱。 這符合主機名稱的 RFC 1123 定義,其中 1 個值得注意的例外狀況是不允許使用數字 IP 位址。
請注意,根據 RFC1035 和 RFC1123,標籤必須包含小寫英數字元或 ‘-’,且開頭和結尾必須是英數字元。 不允許使用其他標點符號。
Protocol (string
別名)
(出現於:HealthCheckPolicyConfig、IngressBackendPort)
Protocol 定義用於特定屬性的通訊協定。 有效的通訊協定值為:
- HTTP
- HTTPS
- TCP
值 | Description |
---|---|
"HTTP" |
HTTP 表示服務將使用 HTTP |
"HTTPS" |
HTTPS 表示服務將使用 HTTPS |
"TCP" |
TCP 表示服務將使用一般 TCP |
重新導向
(出現於:IngressRuleSetting)
Redirect 定義重新導向要求的篩選條件。 這不得用於同時具有 URLRewriteFilter 的相同規則。
欄位 | 描述 |
---|---|
scheme string |
(選擇性)
Scheme 是用於回應 |
hostname PreciseHostname |
(選擇性)
Hostname 是用於回應 |
path HTTPPathModifier |
(選擇性)
Path 定義用來修改傳入要求路徑的參數。
接著將使用修改過的路徑來建構 |
port PortNumber |
(選擇性)
Port 是用於回應 如果未指定任何連接埠,則必須使用下列規則衍生重新導向連接埠:
實作不應該在下列情況下,於 ‘Location’ 標頭中新增連接埠號碼:
|
statusCode int |
(選擇性)
StatusCode 是用於回應的 HTTP 狀態碼。 請注意,您可以將值新增至此列舉,實作必須確保未知的值不會造成當機。 |
RewriteType (string
別名)
(出現於:IngressRewrites)
RewriteType 可識別重寫類型
值 | Description |
---|---|
"RequestHeaderModifier" |
RequestHeaderModifier 可用來在將 HTTP 要求傳送至上游目標之前,先從 HTTP 要求新增或移除 HTTP 標頭。 |
"ResponseHeaderModifier" |
ResponseHeaderModifier 可用來在將 HTTP 回應傳送至用戶端之前,先從 HTTP 回應新增或移除 HTTP 標頭。 |
"URLRewrite" |
URLRewrite 可用來在轉送期間修改要求。 |
RoutePolicy
RoutePolicy 是 RoutePolicy API 的結構描述
欄位 | 描述 | ||||||
---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
(選擇性)
物件的中繼資料。 如需metadata 欄位的各欄位,請參閱 Kubernetes API 文件。
|
||||||
spec RoutePolicySpec |
Spec 是 RoutePolicy 規格。
|
||||||
status RoutePolicyStatus |
Status 定義 RoutePolicy 的目前狀態。 |
RoutePolicyConditionReason (string
別名)
RoutePolicyConditionReason 定義一組原因,說明為何引發特定的 RoutePolicy 條件類型。
值 | Description |
---|---|
"Accepted" |
RoutePolicyReasonAccepted 用來在指定的 RoutePolicy 正確設定時,將 RoutePolicyConditionReason to Accepted 設定為 Accepted |
"InvalidRoutePolicy" |
RoutePolicyReasonInvalid 是未接受 RoutePolicy 時的原因 |
"InvalidGroup" |
如果群組無效,則會使用 RoutePolicyReasonInvalidGroup |
"InvalidHTTPRoute" |
如果 HTTPRoute 無效,則會使用 RoutePolicyReasonInvalidHTTPRoute |
"InvalidKind" |
如果種類/群組無效,則會使用 RoutePolicyReasonInvalidKind |
"InvalidName" |
如果名稱無效,則會使用 RoutePolicyReasonInvalidName |
"NoTargetReference" |
沒有目標參考時,會使用 RoutePolicyReasonNoTargetReference |
"RefNotPermitted" |
不允許 ref 時,會使用 RoutePolicyReasonRefNotPermitted |
RoutePolicyConditionType (string
別名)
RoutePolicyConditionType 是與 RoutePolicy 相關聯的條件類型。 此類型應該與 RoutePolicyStatus.Conditions 欄位搭配使用。
值 | Description |
---|---|
"Accepted" |
RoutePolicyConditionAccepted 用來將 RoutePolicyConditionType 設定為 Accepted |
"ResolvedRefs" |
RoutePolicyConditionResolvedRefs 用來將 RoutePolicyCondition 設定為 ResolvedRefs |
RoutePolicyConfig
(出現於:RoutePolicySpec)
RoutePolicyConfig 定義 RoutePolicy 規格的結構描述。 這允許下列屬性的規格:* 逾時 * 工作階段親和性
欄位 | 描述 |
---|---|
timeouts RouteTimeouts |
(選擇性)
目標資源的自訂 Timeouts 逾時。 |
sessionAffinity SessionAffinity |
SessionAffinity 定義工作階段親和性規格的結構描述 |
RoutePolicySpec
(出現於:RoutePolicy)
RoutePolicySpec 定義 RoutePolicy 的預期狀態
欄位 | 描述 |
---|---|
targetRef Gateway API .PolicyTargetReference |
TargetRef 可識別要套用原則的 API 物件。 |
override RoutePolicyConfig |
(選擇性)
Override 定義原則組態,該組態應該覆寫階層中目標資源下方所附加的原則組態。 |
default RoutePolicyConfig |
(選擇性)
Default 定義目標資源的預設原則組態。 |
RoutePolicyStatus
(出現於:RoutePolicy)
RoutePolicyStatus 定義 RoutePolicy 的觀察狀態。
欄位 | 描述 |
---|---|
conditions []Kubernetes meta/v1.Condition |
(選擇性)
Conditions 描述 RoutePolicy 的目前條件。 實作應偏好使用 已知條件類型為:
|
RouteTimeouts
(出現於:RoutePolicyConfig)
RouteTimeouts 定義逾時規格的結構描述
欄位 | 描述 |
---|---|
routeTimeout Kubernetes meta/v1.Duration |
(選擇性)
RouteTimeout 是路由的逾時。 |
SessionAffinity
(出現於:IngressBackendSettings、RoutePolicyConfig)
SessionAffinity 定義工作階段親和性規格的結構描述
欄位 | 描述 |
---|---|
affinityType AffinityType |
|
cookieName string |
(選擇性) |
cookieDuration Kubernetes meta/v1.Duration |
(選擇性) |
StatusCodes
(出現於:HTTPMatch)
StatusCodes 定義用於 HealthCheck 檢查的 HTTP 狀態碼比對器。
欄位 | 描述 |
---|---|
start int32 |
(選擇性)
Start 定義用於 HealthCheck 檢查的狀態碼範圍開頭。 此值也包含在內。 |
end int32 |
(選擇性)
End 定義用於 HealthCheck 檢查的狀態碼範圍結尾。 此值也包含在內。 |
URLRewriteFilter
(出現於:IngressRewrites)
URLRewriteFilter 定義在轉送期間修改要求的篩選條件。 在規則上最多可以使用其中一個篩選條件。 這不得用於具有 sslRedirect 的相同規則上。
欄位 | 描述 |
---|---|
hostname PreciseHostname |
(選擇性)
Hostname 是用來在轉送期間取代 Host 標頭值的值。 |
path HTTPPathModifier |
(選擇性)
Path 定義路徑重寫。 |
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應