Sdílet prostřednictvím

Specifikace rozhraní API služby Application Gateway pro kontejnery pro Kubernetes

  • Článek

Balíčky

Package v1 je verze v1 rozhraní API.

alb.networking.azure.io/v1

Tento dokument definuje jednotlivé typy prostředků pro alb.networking.azure.io/v1.

Typy prostředků:

AffinityType (string alias)

(Zobrazí se na:SessionAffinity)

AffinityType definuje typ spřažení pro službu.

Hodnota Popis

"application-cookie"

AffinityTypeApplicationCookie je typ spřažení relace pro soubor cookie aplikace.

"managed-cookie"

AffinityTypeManagedCookie je typ spřažení relace pro spravovaný soubor cookie.

AlbConditionReason (string alias)

AlbConditionReason definuje sadu důvodů, které vysvětlují, proč je určitý typ podmínky vyvolána službou Application Gateway pro kontejnery.

Hodnota Popis

"Přijato"

AlbReasonAccepted označuje, že správce přijímá prostředek Application Gateway for Containers.

"Ready"

AlbReasonDeploymentReady označuje stav nasazení prostředků služby Application Gateway for Containers.

InProgress

AlbReasonInProgress označuje, jestli je prostředek služby Application Gateway for Containers v procesu vytváření, aktualizace nebo odstranění.

AlbConditionType (string alias)

AlbConditionType je typ podmínky přidružené k prostředku služby Application Gateway for Containers. Tento typ by měl být použit s polem AlbStatus.Conditions.

Hodnota Popis

"Přijato"

AlbConditionTypeAccepted označuje, jestli správce přijímá prostředek Application Gateway for Containers.

"Nasazení"

AlbConditionTypeDeployment označuje stav nasazení prostředku služby Application Gateway for Containers.

AlbSpec

(Zobrazí se na:ApplicationLoadBalancer)

AlbSpec definuje specifikace prostředku Application Gateway for Containers.

Pole Popis
associations
[]řetězec

Přidružení jsou ID prostředků podsítě, ke kterým je přidružený prostředek služby Application Gateway for Containers.

AlbStatus

(Zobrazí se na:ApplicationLoadBalancer)

AlbStatus definuje pozorovaný stav prostředku služby Application Gateway for Containers.

Pole Popis
conditions
[]Meta/v1 Kubernetes. Podmínka 		(Volitelné)

Známé typy podmínek:

  • “Přijata”
  • “Připraven”

ApplicationLoadBalancer

ApplicationLoadBalancer je schéma pro prostředek Application Gateway for Containers.

Pole Popis
metadata
Meta/v1 Kubernetes ObjectMeta 		(Volitelné)

Metadata objektu’.

Informace o polích metadata pole najdete v dokumentaci k rozhraní API Kubernetes.
spec
AlbSpec

Specifikace jsou specifikace prostředku služby Application Gateway for Containers.



associations
[]řetězec

Přidružení jsou ID prostředků podsítě, ke kterým je přidružený prostředek služby Application Gateway for Containers.
status
AlbStatus

Stav definuje aktuální stav prostředku služby Application Gateway pro kontejnery.

BackendTLSPolicy

BackendTLSPolicy je schéma pro rozhraní API BackendTLSPolicys.

Pole Popis
metadata
Meta/v1 Kubernetes ObjectMeta 		(Volitelné)

Metadata objektu’.

Informace o polích metadata pole najdete v dokumentaci k rozhraní API Kubernetes.
spec
BackendTLSPolicySpec

Specifikace je specifikace BackendTLSPolicy.



targetRef
CustomTargetRef

TargetRef identifikuje objekt rozhraní API pro použití zásad.
override
BackendTLSPolicyConfig 		(Volitelné)

Přepsání definuje konfiguraci zásad, která by měla přepsat konfiguraci zásad připojenou pod cílovým prostředkem v hierarchii.

Poznámka: Přepsání se v současné době nepodporuje a výsledkem bude chyba ověření. Podpora přepsání bude přidána v budoucí verzi.
default
BackendTLSPolicyConfig 		(Volitelné)

Výchozí nastavení definuje výchozí konfiguraci zásad pro cílový prostředek.
status
BackendTLSPolicyStatus

Stav definuje aktuální stav BackendTLSPolicy.

BackendTLSPolicyConditionReason (string alias)

BackendTLSPolicyConditionReason definuje sadu důvodů, které vysvětlují, proč je vyvolán konkrétní typ podmínky BackendTLSPolicy.

Hodnota Popis

"Přijato"

BackendTLSPolicyReasonAccepted se používá k nastavení BackendTLSPolicyConditionReason na Hodnotu Accepted When the given BackendTLSPolicy is správně nakonfigurovaný

InvalidBackendTLSPolicy

BackendTLSPolicyReasonInvalid je důvod, kdy backendTLSPolicy není’přijat.

InvalidCertificateRef

BackendTLSPolicyReasonInvalidCertificateRef se používá, když se odkazuje na neplatný certifikát.

InvalidGroup

BackendTLSPolicyReasonInvalidGroup se používá, když je skupina neplatná.

InvalidKind

BackendTLSPolicyReasonInvalidKind se používá, když je druh nebo skupina neplatná.

InvalidName

BackendTLSPolicyReasonInvalidName se používá, když je název neplatný.

InvalidSecret

BackendTLSPolicyReasonInvalidSecret se používá, když je tajný kód neplatný.

InvalidService

BackendTLSPolicyReasonInvalidService se používá, když je služba neplatná.

NoTargetReference

BackendTLSPolicyReasonNoTargetReference se používá, pokud neexistuje’žádný cílový odkaz.

"OverrideNotSupported"

BackendTLSPolicyReasonOverrideNotSupported se používá, když se’přepsání nepodporuje.

"RefNotPermitted"

BackendTLSPolicyReasonRefNotPermitted se používá, pokud odkaz není’povolený.

"SectionNamesNotPermitted"

BackendTLSPolicyReasonSectionNamesNotPermitted se používá, když názvy oddílů nejsou’povolené.

BackendTLSPolicyConditionType (string alias)

BackendTLSPolicyConditionType je typ podmínky přidružené k BackendTLSPolicy. Tento typ by se měl použít s polem BackendTLSPolicyStatus.Conditions.

Hodnota Popis

"Přijato"

BackendTLSPolicyConditionAccepted slouží k nastavení BackendTLSPolicyConditionType na Přijato.

"ResolvedRefs"

BackendTLSPolicyConditionResolvedRefs slouží k nastavení BackendTLSPolicyCondition na ResolvedRefs.

BackendTLSPolicyConfig

(Zobrazí se na:BackendTLSPolicySpec)

BackendTLSPolicyConfig definuje specifikaci zásad pro zásady TLS back-endu.

Pole Popis
CommonTLSPolicy
CommonTLSPolicy

(Členové CommonTLSPolicy jsou vloženi do tohoto typu.)

sni
Řetězec 		(Volitelné)

Sni je název serveru, který se má použít pro připojení TLS k back-endu.
ports
[]BackendTLSPolicyPort

Porty určují seznam portů, ve kterých se zásady použijí.
clientCertificateRef
Rozhraní API brány . SecretObjectReference 		(Volitelné)

ClientCertificateRef je odkaz na klientský certifikát, který se má použít pro připojení TLS k back-endu.

BackendTLSPolicyPort

(Zobrazí se na:BackendTLSPolicyConfig)

BackendTLSPolicyPort definuje port, který se má použít pro připojení TLS k back-endu.

Pole Popis
port
Int

Port je port, který se má použít pro připojení TLS k back-endu.

BackendTLSPolicySpec

(Zobrazí se na:BackendTLSPolicy)

BackendTLSPolicySpec definuje požadovaný stav BackendTLSPolicy.

Pole Popis
targetRef
CustomTargetRef

TargetRef identifikuje objekt rozhraní API pro použití zásad.
override
BackendTLSPolicyConfig 		(Volitelné)

Přepsání definuje konfiguraci zásad, která by měla přepsat konfiguraci zásad připojenou pod cílovým prostředkem v hierarchii.

Poznámka: Přepsání se v současné době nepodporuje a výsledkem bude chyba ověření. Podpora přepsání bude přidána v budoucí verzi.
default
BackendTLSPolicyConfig 		(Volitelné)

Výchozí nastavení definuje výchozí konfiguraci zásad pro cílový prostředek.

BackendTLSPolicyStatus

(Zobrazí se na:BackendTLSPolicy)

BackendTLSPolicyStatus definuje pozorovaný stav BackendTLSPolicy.

Pole Popis
conditions
[]Meta/v1 Kubernetes. Podmínka 		(Volitelné)

Podmínky popisují aktuální podmínky backendTLSPolicy.

Implementace by měly raději vyjádřit podmínky BackendTLSPolicy pomocí BackendTLSPolicyConditionType a BackendTLSPolicyConditionReason konstant, aby operátory a nástroje mohly konvergovat na běžné slovní zásobě popisovat stav BackendTLSPolicy.

Známé typy podmínek:

  • “Přijata”

CommonTLSPolicy

(Zobrazí se na:BackendTLSPolicyConfig)

CommonTLSPolicy je schéma pro rozhraní COMMONTLSPolicy API.

Pole Popis
verify
CommonTLSPolicyVerify 		(Volitelné)

Ověřte, že poskytuje možnosti ověření back-endového certifikátu.

CommonTLSPolicyVerify

(Zobrazí se na:CommonTLSPolicy)

CommonTLSPolicyVerify definuje schéma pro rozhraní COMMONTLSPolicyVerify API.

Pole Popis
caCertificateRef
Rozhraní API brány . SecretObjectReference

CaCertificateRef je certifikát certifikační autority použitý k ověření partnerského certifikátu back-endu.
subjectAltName
Řetězec

SubjectAltName je alternativní název subjektu použitý k ověření partnerského certifikátu back-endu.

CustomTargetRef

(Zobrazí se na:BackendTLSPolicySpec, FrontendTLSPolicySpec, HealthCheckPolicySpec, RoutePolicySpec)

CustomTargetRef je odkaz na vlastní prostředek, který není’součástí základního rozhraní API Kubernetes.

Pole Popis
PolicyTargetReference
Rozhraní API brány . PolicyTargetReference

(Členové PolicyTargetReference jsou vloženi do tohoto typu.)

sectionNames
[]řetězec 		(Volitelné)

SectionNames je název oddílu v rámci cílového prostředku. Pokud není zadaný, cíl cílí na celý prostředek. V následujících zdrojích se název SectionNames interpretuje takto:

  • Brána: Název naslouchacího procesu
  • Služba: Název portu

Pokud je zadán sectionNames, ale neexistuje u cílového objektu, zásady se nepodaří připojit a implementace zásady zaznamená ResolvedRefs nebo podobnou podmínku ve stavu Zásady’.

FrontendTLSPolicy

FrontendTLSPolicy je schéma pro rozhraní API FrontendTLSPolicy.

Pole Popis
metadata
Meta/v1 Kubernetes ObjectMeta 		(Volitelné)

Metadata objektu’.

Informace o polích metadata pole najdete v dokumentaci k rozhraní API Kubernetes.
spec
FrontendTLSPolicySpec

Specifikace je specifikace FrontendTLSPolicy.



targetRef
CustomTargetRef

TargetRef identifikuje objekt rozhraní API pro použití zásad.
default
FrontendTLSPolicyConfig 		(Volitelné)

Výchozí nastavení definuje výchozí konfiguraci zásad pro cílový prostředek.
override
FrontendTLSPolicyConfig 		(Volitelné)

Přepsání definuje konfiguraci zásad, která by měla přepsat konfiguraci zásad připojenou pod cílovým prostředkem v hierarchii.

Poznámka: Přepsání se v současné době nepodporuje a výsledkem bude chyba ověření. Podpora přepsání bude přidána v budoucí verzi.
status
FrontendTLSPolicyStatus

Stav definuje aktuální stav FrontendTLSPolicy.

FrontendTLSPolicyConditionReason (string alias)

FrontendTLSPolicyConditionReason definuje sadu důvodů, které vysvětlují, proč je vyvolán konkrétní typ podmínky FrontendTLSPolicy.

Hodnota Popis

"Přijato"

FrontendTLSPolicyReasonAccepted se používá k nastavení frontendTLSPolicyConditionReason na Hodnotu Accepted When the given FrontendTLSPolicy is correctly configured

InvalidFrontendTLSPolicy

FrontendTLSPolicyReasonInvalid je důvod, proč frontendTLSPolicy není’přijato.

InvalidGateway

FrontendTLSPolicyReasonInvalidGateway se používá, když je brána neplatná.

InvalidGroup

FrontendTLSPolicyReasonInvalidGroup se používá, když je skupina neplatná.

InvalidKind

FrontendTLSPolicyReasonInvalidKind se používá, když je druh nebo skupina neplatná.

InvalidName

FrontendTLSPolicyReasonInvalidName se používá, pokud je název neplatný.

InvalidPolicyName

FrontendTLSPolicyReasonInvalidPolicyName se používá, když je název zásady neplatný.

InvalidPolicyType

FrontendTLSPolicyReasonInvalidPolicyType se používá, když je typ zásady neplatný.

NoTargetReference

FrontendTLSPolicyReasonNoTargetReference se používá, pokud neexistuje’žádný cílový odkaz.

"OverrideNotSupported"

FrontendTLSPolicyReasonOverrideNotSupported se používá, když se’přepsání nepodporuje.

"RefNotPermitted"

FrontendTLSPolicyReasonRefNotPermitted se používá, pokud odkaz není’povolený.

"SectionNamesNotPermitted"

FrontendTLSPolicyReasonSectionNamesNotPermitted se používá, když názvy oddílů nejsou’povolené.

FrontendTLSPolicyConditionType (string alias)

FrontendTLSPolicyConditionType je typ podmínky přidružené k frontendTLSPolicy. Tento typ by se měl použít s polem FrontendTLSPolicyStatus.Conditions.

Hodnota Popis

"Přijato"

FrontendTLSPolicyConditionAccepted se používá k nastavení FrontendTLSPolicyCondition na Přijato.

"ResolvedRefs"

FrontendTLSPolicyConditionResolvedRefs slouží k nastavení FrontendTLSPolicyCondition na ResolvedRefs.

FrontendTLSPolicyConfig

(Zobrazí se na:FrontendTLSPolicySpec)

FrontendTLSPolicyConfig definuje specifikaci zásad pro zásady TLS front-endu.

Pole Popis
policyType
PolicyType

Typ je typ zásady.

FrontendTLSPolicySpec

(Zobrazí se na:FrontendTLSPolicy)

FrontendTLSPolicySpec definuje požadovaný stav FrontendTLSPolicy.

Pole Popis
targetRef
CustomTargetRef

TargetRef identifikuje objekt rozhraní API pro použití zásad.
default
FrontendTLSPolicyConfig 		(Volitelné)

Výchozí nastavení definuje výchozí konfiguraci zásad pro cílový prostředek.
override
FrontendTLSPolicyConfig 		(Volitelné)

Přepsání definuje konfiguraci zásad, která by měla přepsat konfiguraci zásad připojenou pod cílovým prostředkem v hierarchii.

Poznámka: Přepsání se v současné době nepodporuje a výsledkem bude chyba ověření. Podpora přepsání bude přidána v budoucí verzi.

FrontendTLSPolicyStatus

(Zobrazí se na:FrontendTLSPolicy)

FrontendTLSPolicyStatus definuje pozorovaný stav FrontendTLSPolicy.

Pole Popis
conditions
[]Meta/v1 Kubernetes. Podmínka 		(Volitelné)

Podmínky popisují aktuální podmínky frontendTLSPolicy.

Implementace by měly raději vyjádřit podmínky FrontendTLSPolicy pomocí FrontendTLSPolicyConditionType a FrontendTLSPolicyConditionReason konstant, aby operátory a nástroje mohly konvergovat na běžné slovní zásobě popisovat stav FrontendTLSPolicy.

Známé typy podmínek:

  • “Přijata”

FrontendTLSPolicyType (string alias)

(Zobrazí se na:PolicyType)

FrontendTLSPolicyType je typ zásad TLS front-endu.

Hodnota Popis

"předdefinováno"

PredefinedFrontendTLSPolicyType je typ předdefinované zásady TLS front-endu.

FrontendTLSPolicyTypeName (string alias)

(Zobrazí se na:PolicyType)

FrontendTLSPolicyTypeName je název zásady TLS front-endu.

Hodnota Popis

"2023-06"

PredefinedPolicy202306 je název předdefinované zásady TLS front-endu pro zásadu “2023-06”.

"2023-06-S"

PredefinedPolicy202306Strict je název předdefinované zásady TLS front-endu pro zásadu “2023-06-S”. Jedná se o striktní verzi zásady “2023-06”.

HttpHeader

(Zobrazí se na:HeaderFilter)

HttpHeader představuje název a hodnotu hlavičky HTTP, jak je definováno RFC 7230.

Pole Popis
name
HTTPHeaderName

Název je název hlavičky HTTP, která se má shodovat. Porovnávání názvů musí být nerozlišující velká a malá písmena. (Viz https://tools.ietf.org/html/rfc7230#section-3.2).

Pokud více položek určuje ekvivalentní názvy hlaviček, první položka s ekvivalentním názvem musí být považována za shodu. Další položky s ekvivalentním názvem hlavičky musí být ignorovány. Vzhledem k tomu, že názvy hlaviček jsou bez rozlišování malých a velkých písmen považovány “”“” za ekvivalentní.
value
Řetězec

Hodnota je hodnota hlavičky HTTP, která se má shodovat.

HTTPHeaderName (string alias)

(Zobrazí se na adrese:HTTPHeader)

HttpHeaderName je název hlavičky HTTP.

Mezi platné hodnoty patří:

  • “Autorizace”
  • “Set-Cookie”

Mezi neplatné hodnoty patří:

  • ”:method” - “:” je neplatný znak. To znamená, že tento typ v současné době nepodporuje pseudo hlavičky’HTTP/2.
  • ”/invalid” – “/ ” je neplatný znak.

HttpMatch

(Zobrazí se na:HTTPSpecifiers)

HttpMatch definuje, které shody HTTP se mají použít pro kontroly HealthCheck.

Pole Popis
body
Řetězec 		(Volitelné)

Tělo definuje shody textu HTTP, které se mají použít pro kontroly HealthCheck.
statusCodes
[]StatusCodes 		(Volitelné)

StatusCodes definuje shody stavového kódu HTTP, které se mají použít pro kontroly HealthCheck.

HTTPPathModifier

(Zobrazí se on:Redirect, URLRewriteFilter)

HttpPathModifier definuje konfiguraci modifikátorů cesty.

Pole Popis
type
HTTPPathModifierType

Typ definuje typ modifikátoru cesty. V budoucí verzi rozhraní API se můžou přidat další typy.

Hodnoty mohou být přidány do tohoto výčtu, implementace musí zajistit, aby neznámé hodnoty nezpůsobily’chybové ukončení.

V této části musí být neznámé hodnoty výsledkem nastavení implementace Akceptovaná podmínka, aby pravidlo mělo hodnotu false.
replaceFullPath
Řetězec 		(Volitelné)

ReplaceFullPath určuje hodnotu, pomocí které se má během přepsání nebo přesměrování nahradit úplná cesta požadavku.
replacePrefixMatch
Řetězec 		(Volitelné)

ReplacePrefixMatch určuje hodnotu, se kterou se má nahradit shoda předpony požadavku během přepsání nebo přesměrování. Například požadavek na “/foo/bar” s předponou “/foo” a parametr ReplacePrefixMatch z “/xyz” by se změnil na “/xyz/bar”.

Odpovídá chování typu shody PathPrefix. Odpovídá prvkům úplné cesty. Element cesty odkazuje na seznam popisků v cestě rozdělené oddělovačem / . Pokud je zadáno, koncové ho ignorujte / . Například cesty /abc, /abc/a /abc/def všechny by odpovídaly předponě /abc, ale cesta /abcd by ne’.

ReplacePrefixMatch je kompatibilní pouze s PathPrefix httpRouteMatch. Při použití jakéhokoli jiného typu HTTPRouteMatch ve stejném protokolu HTTPRouteRule se nastaví implementační podmínka pro trasu do status: False.

Cesta požadavku Shoda předpony Nahradit předponu Změněná cesta
/foo/bar /Foo /Xyz /xyz/bar
/foo/bar /Foo /Xyz/ /xyz/bar
/foo/bar /Foo/ /Xyz /xyz/bar
/foo/bar /Foo/ /Xyz/ /xyz/bar
/Foo /Foo /Xyz /Xyz
/Foo/ /Foo /Xyz /Xyz/
/foo/bar /Foo   /Bar
/Foo/ /Foo   /
/Foo /Foo   /
/Foo/ /Foo / /
/Foo /Foo / /

HTTPPathModifierType (string alias)

(Zobrazí se na:HTTPPathModifier)

HTTPPathModifierType definuje typ přesměrování cesty nebo přepsání.

Hodnota Popis

"ReplaceFullPath"

FullPathHTTPPathModifier nahradí úplnou cestu zadanou hodnotou.

"ReplacePrefixMatch"

PrefixMatchHTTPPathModifier nahradí jakoukoli cestu předpony hodnotou nahrazení. Například cesta s předponou / “foo” a nahrazení “NahrazeníPrefixMatch /bar” nahradit “/foo /foo” za “/bar” v odpovídajících požadavcích.

Odpovídá chování typu shody PathPrefix. Odpovídá prvkům úplné cesty. Element cesty odkazuje na seznam popisků v cestě rozdělené oddělovačem / . Pokud je zadáno, koncové ho ignorujte / . Například cesty /abc, /abc/a /abc/def všechny by odpovídaly předponě /abc, ale cesta /abcd by ne’.

Klasifikátory HTTP

(Zobrazí se na:HealthCheckPolicyConfig)

Parametry HTTPSpecifiers definují schéma pro specifikaci kontroly stavu HTTP.

Pole Popis
host
Řetězec 		(Volitelné)

Hostitel je hodnota hlavičky hostitele, která se má použít pro kontroly HealthCheck.
path
Řetězec 		(Volitelné)

Cesta je cesta, která se má použít pro kontroly HealthCheck.
match
HttpMatch 		(Volitelné)

Shoda definuje nástroje pro porovnávání HTTP, které se mají použít pro kontroly HealthCheck.

HeaderFilter

(Zobrazí se na:IngressRewrites)

HeaderFilter definuje filtr, který upravuje hlavičky požadavku HTTP nebo odpovědi. Je povolena pouze jedna akce pro daný název záhlaví. Filtry určující více akcí stejného nebo jiného typu pro libovolný název záhlaví jsou neplatné a budou odmítnuty. Konfigurace pro nastavení nebo přidání více hodnot pro hlavičku musí používat formátování hodnot hlaviček RFC 7230 a oddělit každou hodnotu čárkou.

Pole Popis
set
[]HTTPHeader 		(Volitelné)

Nastavte přepsání požadavku s danou hlavičkou (název, hodnota) před akcí.

Vstup: GET /foo HTTP/1.1 my-header: foo

Konfigurace: set: - name: “my-header” value: “bar”

Výstup: GET /foo HTTP/1.1 my-header: bar
add
[]HTTPHeader 		(Volitelné)

Před akci přidejte do požadavku danou hlavičku (název, hodnotu). Připojí se k jakýmkoli existujícím hodnotám přidruženým k názvu záhlaví.

Vstup: GET /foo HTTP/1.1 my-header: foo

Konfigurace: add: - name: “my-header” value: “bar,baz”

Výstup: GET /foo HTTP/1.1 my-header: foo,bar,baz
remove
[]řetězec 		(Volitelné)

Před akcí odeberte dané hlavičky z požadavku HTTP. Hodnota Remove je seznam názvů hlaviček HTTP. Názvy záhlaví nerozlišují malá a velká písmena (viz https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).

Vstup: GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz

Konfigurace: remove: [“my-header1”, “my-header3”]

Výstup: GET /foo HTTP/1.1 my-header2: bar

HeaderName (string alias)

HeaderName je název hlavičky nebo parametru dotazu.

HealthCheckPolicy

HealthCheckPolicy je schéma pro rozhraní HealthCheckPolicy API.

Pole Popis
metadata
Meta/v1 Kubernetes ObjectMeta 		(Volitelné)

Metadata objektu’.

Informace o polích metadata pole najdete v dokumentaci k rozhraní API Kubernetes.
spec
HealthCheckPolicySpec

Specifikace HealthCheckPolicy.



targetRef
CustomTargetRef

TargetRef identifikuje objekt rozhraní API pro použití zásad.
override
HealthCheckPolicyConfig 		(Volitelné)

Přepsání definuje konfiguraci zásad, která by měla přepsat konfiguraci zásad připojenou pod cílovým prostředkem v hierarchii.

Poznámka: Přepsání se v současné době nepodporuje a výsledkem bude chyba ověření. Podpora přepsání bude přidána v budoucí verzi.
default
HealthCheckPolicyConfig 		(Volitelné)

Výchozí nastavení definuje výchozí konfiguraci zásad pro cílový prostředek.
status
HealthCheckPolicyStatus

Stav definuje aktuální stav HealthCheckPolicy.

HealthCheckPolicyConditionReason (string alias)

HealthCheckPolicyConditionReason definuje sadu důvodů, které vysvětlují, proč je vyvolán konkrétní typ podmínky HealthCheckPolicy.

Hodnota Popis

"Přijato"

HealthCheckPolicyReasonAccepted se používá k nastavení HealthCheckPolicyConditionReason na hodnotu Accepted When the healthCheckPolicy is správně nakonfigurovaný

InvalidHealthCheckPolicy

HealthCheckPolicyReasonInvalid je důvod, kdy healthCheckPolicy není’přijat.

InvalidGroup

HealthCheckPolicyReasonInvalidGroup se používá, když je skupina neplatná.

InvalidKind

HealthCheckPolicyReasonInvalidKind se používá, když je druh nebo skupina neplatná.

InvalidName

HealthCheckPolicyReasonInvalidName se používá, když je název neplatný.

"InvalidPort"

HealthCheckPolicyReasonInvalidPort se používá, když je port neplatný.

InvalidService

HealthCheckPolicyReasonInvalidService se používá, když je služba neplatná.

NoTargetReference

HealthCheckPolicyReasonNoTargetReference se používá v případě, že neexistuje’žádný cílový odkaz.

"OverrideNotSupported"

HealthCheckPolicyReasonOverrideNotSupported se používá, když se’přepsání nepodporuje.

"RefNotPermitted"

HealthCheckPolicyReasonRefNotPermitted se používá, když odkaz není’povolený.

"SectionNamesNotPermitted"

HealthCheckPolicyReasonSectionNamesNotPermitted se používá, když názvy oddílů nejsou’povolené.

HealthCheckPolicyConditionType (string alias)

HealthCheckPolicyConditionType je typ podmínky přidružené ke HealthCheckPolicy. Tento typ by se měl použít s polem HealthCheckPolicyStatus.Conditions.

Hodnota Popis

"Přijato"

HealthCheckPolicyConditionAccepted slouží k nastavení HealthCheckPolicyConditionType na Accepted

"ResolvedRefs"

HealthCheckPolicyConditionResolvedRefs slouží k nastavení HealthCheckPolicyCondition na ResolvedRefs.

HealthCheckPolicyConfig

(Zobrazí se na:HealthCheckPolicySpec)

HealthCheckPolicyConfig definuje schéma pro specifikaci kontroly HealthCheck.

Pole Popis
interval
Meta/v1 Kubernetes Doba trvání 		(Volitelné)

Interval je počet sekund mezi kontrolami stavu.
timeout
Meta/v1 Kubernetes Doba trvání 		(Volitelné)

Časový limit je počet sekund, po které se kontrola stavu považuje za neúspěšnou.
unhealthyThreshold
int32 		(Volitelné)

Není v pořádku. Jedná se o počet po sobě jdoucích kontrol kontroly stavu, které selhaly.
healthyThreshold
int32 		(Volitelné)

HealthyThreshold je počet po sobě jdoucích úspěšných kontrol HealthCheck
http
Klasifikátory HTTP 		(Volitelné)

HTTP definuje specifikaci omezení HTTP pro HealthCheck cílového prostředku.

HealthCheckPolicySpec

(Zobrazí se na:HealthCheckPolicy)

HealthCheckPolicySpec definuje požadovaný stav HealthCheckPolicy.

Pole Popis
targetRef
CustomTargetRef

TargetRef identifikuje objekt rozhraní API pro použití zásad.
override
HealthCheckPolicyConfig 		(Volitelné)

Přepsání definuje konfiguraci zásad, která by měla přepsat konfiguraci zásad připojenou pod cílovým prostředkem v hierarchii.

Poznámka: Přepsání se v současné době nepodporuje a výsledkem bude chyba ověření. Podpora přepsání bude přidána v budoucí verzi.
default
HealthCheckPolicyConfig 		(Volitelné)

Výchozí nastavení definuje výchozí konfiguraci zásad pro cílový prostředek.

HealthCheckPolicyStatus

(Zobrazí se na:HealthCheckPolicy)

HealthCheckPolicyStatus definuje pozorovaný stav HealthCheckPolicy.

Pole Popis
conditions
[]Meta/v1 Kubernetes. Podmínka 		(Volitelné)

Podmínky popisují aktuální podmínky HealthCheckPolicy.

Implementace by měly upřednostňovat podmínky HealthCheckPolicy pomocí HealthCheckPolicyConditionType a HealthCheckPolicyConditionReason konstant, aby operátory a nástroje mohly konvergovat na běžné slovní zásobě popis stavu HealthCheckPolicy.

Známé typy podmínek:

  • “Přijata”

IngressBackendPort

(Zobrazí se na:IngressBackend Nastavení)

IngressBackendPort popisuje port na back-endu. Je třeba definovat pouze jeden název/číslo.

Pole Popis
port
int32 		(Volitelné)

Port označuje port v back-endové službě.
name
Řetězec 		(Volitelné)

Název musí odkazovat na název na portu back-endové služby.
protocol
Protokol

Protokol by měl být jedním z “HTTP”, HTTPS. “”

IngressBackendSettingStatus

(Zobrazí se na:IngressExtensionStatus)

IngressBackendSettingStatus popisuje stav BackendSetting.

Pole Popis
service
Řetězec

Služba identifikuje back-endsetting, který tento stav popisuje.
validationErrors
[]řetězec 		(Volitelné)

Chyby jsou seznamem chyb týkajících se tohoto nastavení.
valid
Bool

Platné označuje, že v tomto back-endsettingu neexistují žádné chyby ověření.

Příchozí přenos dat Nastavení

(Zobrazí se na:IngressExtensionSpec)

IngressBackend Nastavení poskytuje rozšířené možnosti konfigurace back-endové služby.

Pole Popis
service
Řetězec

Služba je název back-endové služby, na kterou se tato konfigurace vztahuje.
ports
[]IngressBackendPort 		(Volitelné)

Porty se dají použít k označení, jestli back-endová služba naslouchá na protokolu HTTP nebo HTTPS.
trustedRootCertificate
Řetězec 		(Volitelné)

TrustedRootCertificate se dá použít k zadání certifikátu pro bránu, který má důvěřovat při komunikaci s back-endem na portu určeném jako https.
sessionAffinity
RelaceAffinity 		(Volitelné)

SessionAffinity umožňuje konzistentně udělovat požadavky klientů stejnému back-endu.
timeouts
IngressTimeouts 		(Volitelné)

Časové limity definují sadu parametrů časového limitu, které se mají použít u příchozího přenosu dat.

IngressExtension

IngressExtension je schéma pro rozhraní API ingressExtension.

Pole Popis
metadata
Meta/v1 Kubernetes ObjectMeta 		(Volitelné)

Metadata objektu’.

Informace o polích metadata pole najdete v dokumentaci k rozhraní API Kubernetes.
spec
IngressExtensionSpec

Spec je specifikace IngressExtension.



rules
[]IngressRuleSetting 		(Volitelné)

Pravidla definují pravidla pro jednotlivé hostitele.
backendSettings
[]IngressBackend Nastavení 		(Volitelné)

Back-end Nastavení definuje sadu možností konfigurace back-endů služby Příchozí přenos dat.
status
IngressExtensionStatus

IngressExtensionConditionReason (string alias)

IngressExtensionConditionReason definuje sadu důvodů, které vysvětlují, proč je vyvolán konkrétní typ podmínky IngressExtension.

Hodnota Popis

"Přijato"

IngressExtensionReasonAccepted se používá k nastavení IngressExtensionConditionAccepted na Accepted

HasValidationErrors

IngressExtensionReasonHasErrors indikuje, že došlo k nějakým chybám ověření.

NoValidationErrors

IngressExtensionReasonNoErrors indikuje, že nedošlo k žádným chybám ověření

ČástečněAcceptedWithErrors

IngressExtensionReasonPartiallyAccepted se používá k nastavení IngressExtensionConditionAccepted na Přijato, ale s méně závažnou chybou ověření

IngressExtensionConditionType (string alias)

IngressExtensionConditionType je typ podmínky přidružené k IngressExtension. Tento typ by měl být použit s ingressExtensionStatus.Conditions pole.

Hodnota Popis

"Přijato"

IngressExtensionConditionAccepted označuje, jestli kontroler přijme (odsouhlasí) ingressExtension.

"Chyby"

IngressExtensionConditionErrors indikuje, jestli v rozšíření dochází k chybám ověření nebo sestavení.

IngressExtensionSpec

(Zobrazí se na:IngressExtension)

IngressExtensionSpec definuje požadovanou konfiguraci ingressExtension.

Pole Popis
rules
[]IngressRuleSetting 		(Volitelné)

Pravidla definují pravidla pro jednotlivé hostitele.
backendSettings
[]IngressBackend Nastavení 		(Volitelné)

Back-end Nastavení definuje sadu možností konfigurace back-endů služby Příchozí přenos dat.

IngressExtensionStatus

(Zobrazí se na:IngressExtension)

IngressExtensionStatus popisuje aktuální stav IngressExtension

Pole Popis
rules
[]IngressRuleStatus 		(Volitelné)

Pravidla obsahují podrobné informace o stavu jednotlivých pravidel.
backendSettings
[]IngressBackendSettingStatus 		(Volitelné)

Back-end Nastavení obsahuje podrobné informace o stavu jednotlivých back-endů Nastavení
conditions
[]Meta/v1 Kubernetes. Podmínka 		(Volitelné)

Podmínky popisují aktuální podmínky ingressExtension. Známé typy podmínek:

  • “Přijata”
  • “Chyby”

Příchozí přenos dat

(Zobrazí se na:IngressRuleSetting)

IngressRewrites poskytuje různé přepisy podporované v pravidle.

Pole Popis
type
Přepisovat typ

Typ identifikuje typ přepsání.
requestHeaderModifier
HeaderFilter 		(Volitelné)

RequestHeaderModifier definuje schéma, které upravuje hlavičky požadavku.
responseHeaderModifier
HeaderFilter 		(Volitelné)

RequestHeaderModifier definuje schéma, které upravuje hlavičky odpovědi.
urlRewrite
UrlRewriteFilter 		(Volitelné)

Adresa URLRewrite definuje schéma, které upravuje požadavek během přeposílání.

IngressRuleSetting

(Zobrazí se na:IngressExtensionSpec)

IngressRuleSetting poskytuje možnosti konfigurace pro pravidla.

Pole Popis
host
Řetězec

Hostitel se používá ke shodě s pravidly příchozího přenosu dat se stejným názvem hostitele, aby bylo možné určit, která pravidla mají vliv na tato nastavení.
additionalHostnames
[]řetězec 		(Volitelné)

AdditionalHostnames určuje více názvů hostitelů, na které se mají naslouchat
rewrites
[]Příchozí přenos dat 		(Volitelné)

Přepsání definuje přepsání pravidla.
requestRedirect
Přesměrování 		(Volitelné)

RequestRedirect definuje chování přesměrování pravidla.

IngressRuleStatus

(Zobrazí se na:IngressExtensionStatus)

IngressRuleStatus popisuje stav pravidla.

Pole Popis
host
Řetězec

Hostitel identifikuje pravidlo, které tento stav popisuje.
validationErrors
[]řetězec 		(Volitelné)

Chyby jsou seznamem chyb týkajících se tohoto nastavení.
valid
Bool 		(Volitelné)

Platné označuje, že v tomto pravidlu neexistují žádné chyby ověření.

IngressTimeouts

(Zobrazí se na:IngressBackend Nastavení)

IngressTimeouts lze použít ke konfiguraci vlastností časového limitu pro příchozí přenos dat.

Pole Popis
requestTimeout
Meta/v1 Kubernetes Doba trvání 		(Volitelné)

RequestTimeout definuje časový limit používaný nástrojem pro vyrovnávání zatížení při předávání požadavků do back-endové služby.

PolicyType

(Zobrazí se na:FrontendTLSPolicyConfig)

PolicyType je typ zásady.

Pole Popis
name
FrontendTLSPolicyTypeName

Název je název zásady.
type
FrontendTLSPolicyType

PredefinedFrontendTLSPolicyType je typ předdefinované zásady TLS front-endu.

PortNumber (int32 alias)

(Zobrazí se v:Redirect)

PortNumber definuje síťový port.

PreciseHostname (string alias)

(Zobrazí se on:Redirect, URLRewriteFilter)

PreciseHostname je plně kvalifikovaný název domény síťového hostitele. To odpovídá definici RFC 1123 názvu hostitele s jednou z kritelných výjimek, že číselné IP adresy nejsou’povoleny.

Na RFC1035 a RFC1123 musí popisek obsahovat malá písmena alfanumerické znaky nebo ‘-’, a musí začínat a končit alfanumerickým znakem. Není povolena žádná jiná interpunkce.

Protokol (string alias)

(Zobrazí se na:IngressBackendPort)

Protokol definuje protokol použitý pro určité vlastnosti. Platné hodnoty protokolu:

  • HTTP
  • HTTPS
  • TCP
Hodnota Popis

"HTTP"

HTTP znamená, že služba používá protokol HTTP.

„HTTPS“

HTTPS znamená, že služba používá HTTPS.

"TCP"

TCP znamená, že služba používá prostý protokol TCP.

Přesměrování

(Zobrazí se na:IngressRuleSetting)

Redirect definuje filtr, který přesměruje požadavek. Nesmí se používat ve stejném pravidle, které má také adresu URLRewriteFilter.

Pole Popis
scheme
Řetězec 		(Volitelné)

Schéma je schéma, které se má použít v hodnotě Location hlavičky v odpovědi. Pokud je schéma požadavku prázdné, použije se schéma požadavku.
hostname
PreciseHostname 		(Volitelné)

Název hostitele je název hostitele, který se má použít v hodnotě Location hlavičky v odpovědi. Pokud je název hostitele prázdný, použije se název hostitele v Host hlavičce požadavku.
path
HTTPPathModifier 		(Volitelné)

Cesta definuje parametry používané k úpravě cesty příchozího požadavku. Upravená cesta se pak použije k vytvoření hlavičky Location . Pokud je cesta požadavku prázdná, použije se tak, jak je.
port
Portnumber 		(Volitelné)

Port je port, který se má použít v hodnotě Location hlavičky v odpovědi.

Pokud není zadaný žádný port, port přesměrování musí být odvozen pomocí následujících pravidel:

  • Pokud schéma přesměrování není prázdné, musí být port přesměrování známým portem přidruženým k schématu přesměrování. “Konkrétně http” na port 80 a “https” na port 443. Pokud schéma přesměrování nemá’dobře známý port, měl by se použít port naslouchacího procesu brány.
  • Pokud je schéma přesměrování prázdné, port přesměrování musí být port naslouchacího procesu brány.

Implementace BY NEMĚLY v hlavičce Umístění’ přidávat číslo ‘portu v následujících případech:

  • Hlavička umístění, která používá protokol HTTP (ať už je určen prostřednictvím protokolu naslouchacího procesu nebo pole Scheme) a používá port 80.
  • Hlavička umístění, která používá protokol HTTPS (ať už je určen protokolem naslouchacího procesu nebo polem Schéma) a používá port 443.
statusCode
Int 		(Volitelné)

StatusCode je stavový kód HTTP, který se má použít v odpovědi.

Hodnoty mohou být přidány do tohoto výčtu, implementace musí zajistit, aby neznámé hodnoty’nezpůsobily chybové ukončení.

Přepsání typu (string alias)

(Zobrazí se na:IngressRewrites)

Typ přepsání identifikuje typ přepsání.

Hodnota Popis

"RequestHeaderModifier"

RequestHeaderModifier lze použít k přidání nebo odebrání hlavičky HTTP z požadavku HTTP před’odesláním do upstreamového cíle.

"ResponseHeaderModifier"

ResponseHeaderModifier lze použít k přidání nebo odebrání hlavičky HTTP z odpovědi HTTP před’odesláním do klienta.

"UrlRewrite"

Adresu URLRewrite je možné použít k úpravě požadavku během předávání.

RoutePolicy

RoutePolicy je schéma pro rozhraní API RoutePolicy.

Pole Popis
metadata
Meta/v1 Kubernetes ObjectMeta 		(Volitelné)

Metadata objektu’.

Informace o polích metadata pole najdete v dokumentaci k rozhraní API Kubernetes.
spec
RoutePolicySpec

Specifikace RoutePolicy je specifikace.



targetRef
CustomTargetRef

TargetRef identifikuje objekt rozhraní API pro použití zásad.
override
RoutePolicyConfig 		(Volitelné)

Přepsání definuje konfiguraci zásad, která by měla přepsat konfiguraci zásad připojenou pod cílovým prostředkem v hierarchii.

Poznámka: Přepsání se v současné době nepodporuje a výsledkem bude chyba ověření. Podpora přepsání bude přidána v budoucí verzi.
default
RoutePolicyConfig 		(Volitelné)

Výchozí nastavení definuje výchozí konfiguraci zásad pro cílový prostředek.
status
RoutePolicyStatus

Stav definuje aktuální stav RoutePolicy.

RoutePolicyConditionReason (string alias)

RoutePolicyConditionReason definuje sadu důvodů, které vysvětlují, proč je vyvolán konkrétní typ podmínky RoutePolicy.

Hodnota Popis

"Přijato"

RoutePolicyReasonAccepted se používá k nastavení RoutePolicyConditionReason na Accepted When the routePolicy is correctly configured

InvalidRoutePolicy

RoutePolicyReasonInvalid je důvod, proč není’zásada RoutePolicy přijata.

InvalidGroup

RoutePolicyReasonInvalidGroup se používá, když je skupina neplatná.

"InvalidHTTPRoute"

RoutePolicyReasonInvalidHTTPRoute se používá, když je httpRoute neplatný.

InvalidKind

RoutePolicyReasonInvalidKind se používá, když je druh nebo skupina neplatná.

InvalidName

RoutePolicyReasonInvalidName se používá, když je název neplatný.

NoTargetReference

RoutePolicyReasonNoTargetReference se používá, pokud neexistuje’žádný cílový odkaz.

"OverrideNotSupported"

RoutePolicyReasonOverrideNotSupported se používá, pokud se’přepsání nepodporuje.

"RefNotPermitted"

RoutePolicyReasonRefNotPermitted se používá v případech, kdy není’povolený odkaz.

"SectionNamesNotPermitted"

RoutePolicyReasonSectionNamesNotPermitted se používá, když nejsou’povolené názvy oddílů.

RoutePolicyConditionType (string alias)

RoutePolicyConditionType je typ podmínky přidružené ke RoutePolicy. Tento typ by se měl použít s polem RoutePolicyStatus.Conditions.

Hodnota Popis

"Přijato"

RoutePolicyConditionAccepted se používá k nastavení RoutePolicyConditionType na Accepted

"ResolvedRefs"

RoutePolicyConditionResolvedRefs slouží k nastavení RoutePolicyCondition na ResolvedRefs.

RoutePolicyConfig

(Zobrazí se na:RoutePolicySpec)

RoutePolicyConfig definuje schéma pro specifikaci RoutePolicy. To umožňuje specifikaci následujících atributů: * Časové limity * Spřažení relací

Pole Popis
timeouts
RouteTimeouts 		(Volitelné)

Časový limit vlastního časového limitu pro cílový prostředek
sessionAffinity
RelaceAffinity

SessionAffinity definuje schéma pro specifikaci spřažení relací.

RoutePolicySpec

(Zobrazí se na:RoutePolicy)

RoutePolicySpec definuje požadovaný stav RoutePolicy.

Pole Popis
targetRef
CustomTargetRef

TargetRef identifikuje objekt rozhraní API pro použití zásad.
override
RoutePolicyConfig 		(Volitelné)

Přepsání definuje konfiguraci zásad, která by měla přepsat konfiguraci zásad připojenou pod cílovým prostředkem v hierarchii.

Poznámka: Přepsání se v současné době nepodporuje a výsledkem bude chyba ověření. Podpora přepsání bude přidána v budoucí verzi.
default
RoutePolicyConfig 		(Volitelné)

Výchozí nastavení definuje výchozí konfiguraci zásad pro cílový prostředek.

RoutePolicyStatus

(Zobrazí se na:RoutePolicy)

RoutePolicyStatus definuje pozorovaný stav RoutePolicy.

Pole Popis
conditions
[]Meta/v1 Kubernetes. Podmínka 		(Volitelné)

Podmínky popisují aktuální podmínky RoutePolicy.

Implementace by měly raději vyjádřit podmínky RoutePolicy pomocí RoutePolicyConditionType a RoutePolicyConditionReason konstant, aby operátory a nástroje mohly konvergovat se společným slovníkem pro popis stavu RoutePolicy.

Známé typy podmínek:

  • “Přijata”

RouteTimeouts

(Zobrazí se na:RoutePolicyConfig)

RouteTimeouts definuje schéma pro specifikaci časových limitů.

Pole Popis
routeTimeout
Meta/v1 Kubernetes Doba trvání 		(Volitelné)

RouteTimeout je časový limit trasy.

RelaceAffinity

(Zobrazí se on:IngressBackend Nastavení, RoutePolicyConfig)

SessionAffinity definuje schéma pro specifikaci spřažení relací.

Pole Popis
affinityType
AffinityType
cookieName
Řetězec 		(Volitelné)
cookieDuration
Meta/v1 Kubernetes Doba trvání 		(Volitelné)

StatusCodes

(Zobrazí se na adrese:HTTPMatch)

StatusCodes definuje shody stavového kódu HTTP, které se mají použít pro kontroly HealthCheck.

Pole Popis
start
int32 		(Volitelné)

Start definuje začátek rozsahu stavových kódů, které se mají použít pro kontroly HealthCheck. To je inkluzivní.
end
int32 		(Volitelné)

End definuje konec rozsahu stavových kódů, které se mají použít pro kontroly HealthCheck. To je inkluzivní.

UrlRewriteFilter

(Zobrazí se na:IngressRewrites)

UrlRewriteFilter definuje filtr, který upravuje požadavek během předávání. Nejméně jeden z těchto filtrů se dá použít pro pravidlo. Nesmí se používat ve stejném pravidlu, které má sslRedirect.

Pole Popis
hostname
PreciseHostname 		(Volitelné)

Název hostitele je hodnota, která se má použít k nahrazení hodnoty hlavičky hostitele během předávání.
path
HTTPPathModifier 		(Volitelné)

Cesta definuje přepsání cesty.