Dela via

API-specifikation för Application Gateway för containrar för Kubernetes

  • Artikel

Paket

Package v1 är v1-versionen av API:et.

alb.networking.azure.io/v1

Det här dokumentet definierar var och en av resurstyperna för alb.networking.azure.io/v1.

Resurstyper:

AffinityType (string alias)

(Visas på:SessionAffinity)

AffinityType definierar tillhörighetstypen för tjänsten

Värde beskrivning

"application-cookie"

AffinityTypeApplicationCookie är en sessionstillhörighetstyp för en programcookie

"managed-cookie"

AffinityTypeManagedCookie är en sessionstillhörighetstyp för en hanterad cookie

AlbConditionReason (string alias)

AlbConditionReason definierar en uppsättning orsaker som förklarar varför en viss villkorstyp genereras av Resursen Application Gateway för containrar.

Värde beskrivning

"Accepterad"

AlbReasonAccepted anger att Application Gateway for Containers-resursen godkänns av kontrollanten.

Ready (Redo)

AlbReasonDeploymentReady anger resursdistributionsstatus för Application Gateway for Containers.

"InProgress"

AlbReasonInProgress anger om Application Gateway for Containers-resursen håller på att skapas, uppdateras eller tas bort.

AlbConditionType (string alias)

AlbConditionType är en typ av villkor som är associerat med en Application Gateway for Containers-resurs. Den här typen ska användas med fältet AlbStatus.Conditions.

Värde beskrivning

"Accepterad"

AlbConditionTypeAccepted anger om Application Gateway for Containers-resursen godkänns av kontrollanten.

"Distribution"

AlbConditionTypeDeployment anger distributionsstatusen för resursen Application Gateway for Containers.

AlbSpec

(Visas på:ApplicationLoadBalancer)

AlbSpec definierar specifikationerna för resursen Application Gateway for Containers.

Fält beskrivning
associations
[]sträng

Associationer är undernätsresurs-ID:t som Application Gateway for Containers-resursen är associerad med.

AlbStatus

(Visas på:ApplicationLoadBalancer)

AlbStatus definierar det observerade tillståndet för Application Gateway for Containers-resursen.

Fält beskrivning
conditions
[]Kubernetes meta/v1. Tillstånd 		(Valfritt)

Kända villkorstyper är:

  • “Accepterad”
  • “Klar”

ApplicationLoadBalancer

ApplicationLoadBalancer är schemat för resursen Application Gateway for Containers.

Fält beskrivning
metadata
Kubernetes meta/v1. ObjectMeta 		(Valfritt)

Objekts’metadata.

Se Kubernetes API-dokumentationen för fälten i metadata fältet.
spec
AlbSpec

Specifikationen är specifikationerna för Application Gateway for Containers-resursen.



associations
[]sträng

Associationer är undernätsresurs-ID:t som Application Gateway for Containers-resursen är associerad med.
status
AlbStatus

Status definierar det aktuella tillståndet för Application Gateway for Containers-resursen.

BackendTLSPolicy

BackendTLSPolicy är schemat för Api:et BackendTLSPolicys.

Fält beskrivning
metadata
Kubernetes meta/v1. ObjectMeta 		(Valfritt)

Objekts’metadata.

Se Kubernetes API-dokumentationen för fälten i metadata fältet.
spec
BackendTLSPolicySpec

Specifikationen är BackendTLSPolicy-specifikationen.



targetRef
CustomTargetRef

TargetRef identifierar ett API-objekt som principen ska tillämpas på.
override
BackendTLSPolicyConfig 		(Valfritt)

Åsidosättning definierar principkonfiguration som ska åsidosätta principkonfigurationen som är kopplad under målresursen i hierarkin.

Obs! Åsidosättning stöds inte för närvarande och resulterar i ett valideringsfel. Stöd för åsidosättning läggs till i en framtida version.
default
BackendTLSPolicyConfig 		(Valfritt)

Standard definierar standardprincipkonfigurationen för målresursen.
status
BackendTLSPolicyStatus

Status definierar det aktuella tillståndet för BackendTLSPolicy.

BackendTLSPolicyConditionReason (string alias)

BackendTLSPolicyConditionReason definierar den uppsättning orsaker som förklarar varför en viss BackendTLSPolicy-villkorstyp genereras.

Värde beskrivning

"Accepterad"

BackendTLSPolicyReasonAccepted används för att ange BackendTLSPolicyConditionReason till Godkänd När den angivna BackendTLSPolicy är korrekt konfigurerad

"InvalidBackendTLSPolicy"

BackendTLSPolicyReasonInvalid är orsaken till att BackendTLSPolicy’inte accepteras

"InvalidCertificateRef"

BackendTLSPolicyReasonInvalidCertificateRef används när ett ogiltigt certifikat refereras

"InvalidGroup"

BackendTLSPolicyReasonInvalidGroup används när gruppen är ogiltig

"InvalidKind"

BackendTLSPolicyReasonInvalidKind används när typen/gruppen är ogiltig

"InvalidName"

BackendTLSPolicyReasonInvalidName används när namnet är ogiltigt

"InvalidSecret"

BackendTLSPolicyReasonInvalidSecret används när hemligheten är ogiltig

"InvalidService"

BackendTLSPolicyReasonInvalidService används när tjänsten är ogiltig

"NoTargetReference"

BackendTLSPolicyReasonNoTargetReference används när det inte finns’någon målreferens

"OverrideNotSupported"

BackendTLSPolicyReasonOverrideNotSupported används när åsidosättningen’inte stöds

"RefNotPermitted"

BackendTLSPolicyReasonRefNotPermitted används när referensen inte tillåts’

"SectionNamesNotPermitted"

BackendTLSPolicyReasonSectionNamesNotPermitted används när avsnittsnamnen inte tillåts’

BackendTLSPolicyConditionType (string alias)

BackendTLSPolicyConditionType är en typ av villkor som är associerad med en BackendTLSPolicy. Den här typen ska användas med fältet BackendTLSPolicyStatus.Conditions.

Värde beskrivning

"Accepterad"

BackendTLSPolicyConditionAccepted används för att ange BackendTLSPolicyConditionType till Godkänd

"ResolvedRefs"

BackendTLSPolicyConditionResolvedRefs används för att ange BackendTLSPolicyCondition till ResolvedRefs

BackendTLSPolicyConfig

(Visas på:BackendTLSPolicySpec)

BackendTLSPolicyConfig definierar principspecifikationen för serverdels-TLS-principen.

Fält beskrivning
CommonTLSPolicy
CommonTLSPolicy

(Medlemmar i CommonTLSPolicy är inbäddade i den här typen.)

sni
sträng 		(Valfritt)

Sni är det servernamn som ska användas för TLS-anslutningen till serverdelen.
ports
[]BackendTLSPolicyPort

Portar anger listan över portar där principen tillämpas.
clientCertificateRef
Gateway-API . SecretObjectReference 		(Valfritt)

ClientCertificateRef är referensen till klientcertifikatet som ska användas för TLS-anslutningen till serverdelen.

BackendTLSPolicyPort

(Visas på:BackendTLSPolicyConfig)

BackendTLSPolicyPort definierar porten som ska användas för TLS-anslutningen till serverdelen

Fält beskrivning
port
Int

Port är porten som ska användas för TLS-anslutningen till serverdelen

BackendTLSPolicySpec

(Visas på:BackendTLSPolicy)

BackendTLSPolicySpec definierar önskat tillstånd för BackendTLSPolicy.

Fält beskrivning
targetRef
CustomTargetRef

TargetRef identifierar ett API-objekt som principen ska tillämpas på.
override
BackendTLSPolicyConfig 		(Valfritt)

Åsidosättning definierar principkonfiguration som ska åsidosätta principkonfigurationen som är kopplad under målresursen i hierarkin.

Obs! Åsidosättning stöds inte för närvarande och resulterar i ett valideringsfel. Stöd för åsidosättning läggs till i en framtida version.
default
BackendTLSPolicyConfig 		(Valfritt)

Standard definierar standardprincipkonfigurationen för målresursen.

BackendTLSPolicyStatus

(Visas på:BackendTLSPolicy)

BackendTLSPolicyStatus definierar det observerade tillståndet backendTLSPolicy.

Fält beskrivning
conditions
[]Kubernetes meta/v1. Tillstånd 		(Valfritt)

Villkor beskriver de aktuella villkoren för BackendTLSPolicy.

Implementeringar bör föredra att uttrycka BackendTLSPolicy-villkor med hjälp av BackendTLSPolicyConditionType konstanterna och BackendTLSPolicyConditionReason så att operatorer och verktyg kan konvergera i ett gemensamt ordförråd för att beskriva BackendTLSPolicy-tillstånd.

Kända villkorstyper är:

  • “Accepterad”

CommonTLSPolicy

(Visas på:BackendTLSPolicyConfig)

CommonTLSPolicy är schemat för CommonTLSPolicy-API:et.

Fält beskrivning
verify
CommonTLSPolicyVerify 		(Valfritt)

Verifiera innehåller alternativ för att verifiera peer-certifikatet.

CommonTLSPolicyVerify

(Visas på:CommonTLSPolicy)

CommonTLSPolicyVerify definierar schemat för CommonTLSPolicyVerify-API:et.

Fält beskrivning
caCertificateRef
Gateway-API . SecretObjectReference

CaCertificateRef är certifikatutfärdarcertifikatet som används för att verifiera peer-certifikatet.
subjectAltName
sträng 		(Valfritt)

SubjectAltName är det alternativa ämnesnamnet som används för att verifiera peer-certifikatet.

CustomTargetRef

(Visas på:BackendTLSPolicySpec, FrontendTLSPolicySpec, HealthCheckPolicySpec, RoutePolicySpec)

CustomTargetRef är en referens till en anpassad resurs som inte ingår’i Kubernetes-kärn-API:et.

Fält beskrivning
NamespacedPolicyTargetReference
Gateway-API:et alpha2. NamespacedPolicyTargetReference

(Medlemmar i NamespacedPolicyTargetReference är inbäddade i den här typen.)

sectionNames
[]sträng 		(Valfritt)

SectionNames är namnet på avsnittet i målresursen. När den är ospecificerad riktar sig denna targetRef mot hela resursen. I följande resurser tolkas SectionNames som följande:

  • Gateway: Lyssnarnamn
  • Tjänst: Portnamn

Om ett SectionNames har angetts, men’inte finns på målobjektet, kan principen inte kopplas och principimplementeringen registrerar ett ResolvedRefs eller liknande villkor i principens’status.

FrontendTLSPolicy

FrontendTLSPolicy är schemat för Api:et FrontendTLSPolicy

Fält beskrivning
metadata
Kubernetes meta/v1. ObjectMeta 		(Valfritt)

Objekts’metadata.

Se Kubernetes API-dokumentationen för fälten i metadata fältet.
spec
FrontendTLSPolicySpec

Specifikationen är FrontendTLSPolicy-specifikationen.



targetRef
CustomTargetRef

TargetRef identifierar ett API-objekt som principen ska tillämpas på.
default
FrontendTLSPolicyConfig 		(Valfritt)

Standard definierar standardprincipkonfigurationen för målresursen.
override
FrontendTLSPolicyConfig 		(Valfritt)

Åsidosättning definierar principkonfiguration som ska åsidosätta principkonfigurationen som är kopplad under målresursen i hierarkin.

Obs! Åsidosättning stöds inte för närvarande och resulterar i ett valideringsfel. Stöd för åsidosättning läggs till i en framtida version.
status
FrontendTLSPolicyStatus

Status definierar det aktuella tillståndet för FrontendTLSPolicy.

FrontendTLSPolicyConditionReason (string alias)

FrontendTLSPolicyConditionReason definierar en uppsättning orsaker som förklarar varför en viss villkorstyp för FrontendTLSPolicy har genererats.

Värde beskrivning

"Accepterad"

FrontendTLSPolicyReasonAccepted används för att ange FrontendTLSPolicyConditionReason till Godkänd När den angivna FrontendTLSPolicy är korrekt konfigurerad

"InvalidFrontendTLSPolicy"

FrontendTLSPolicyReasonInvalid är orsaken till att FrontendTLSPolicy’inte accepteras

"InvalidCertificateRef"

FrontendTLSPolicyReasonInvalidCertificateRef används när ett ogiltigt certifikat refereras

"InvalidDefault"

FrontendTLSPolicyReasonInvalidDefault används när standardvärdet är ogiltigt

"InvalidGateway"

FrontendTLSPolicyReasonInvalidGateway används när gatewayen är ogiltig

"InvalidGroup"

FrontendTLSPolicyReasonInvalidGroup används när gruppen är ogiltig

"InvalidKind"

FrontendTLSPolicyReasonInvalidKind används när typen/gruppen är ogiltig

"InvalidName"

FrontendTLSPolicyReasonInvalidName används när namnet är ogiltigt

"InvalidPolicyName"

FrontendTLSPolicyReasonInvalidPolicyName används när principnamnet är ogiltigt

"InvalidPolicyType"

FrontendTLSPolicyReasonInvalidPolicyType används när principtypen är ogiltig

"InvalidTargetReference"

FrontendTLSPolicyReasonInvalidTargetReference används när målreferensen är ogiltig

"NoTargetReference"

FrontendTLSPolicyReasonNoTargetReference används när det inte finns’någon målreferens

"OverrideNotSupported"

FrontendTLSPolicyReasonOverrideNotSupported används när åsidosättningen’inte stöds

"RefNotPermitted"

FrontendTLSPolicyReasonRefNotPermitted används när referensen inte tillåts’

"SectionNamesNotPermitted"

FrontendTLSPolicyReasonSectionNamesNotPermitted används när avsnittsnamnen inte tillåts’

FrontendTLSPolicyConditionType (string alias)

FrontendTLSPolicyConditionType är en typ av villkor som är associerat med en FrontendTLSPolicy. Den här typen ska användas med fältet FrontendTLSPolicyStatus.Conditions.

Värde beskrivning

"Accepterad"

FrontendTLSPolicyConditionAccepted används för att ange FrontendTLSPolicyCondition till Godkänd

"ResolvedRefs"

FrontendTLSPolicyConditionResolvedRefs används för att ange FrontendTLSPolicyCondition till ResolvedRefs

FrontendTLSPolicyConfig

(Visas på:FrontendTLSPolicySpec)

FrontendTLSPolicyConfig definierar principspecifikationen för klientdels-TLS-principen.

Fält beskrivning
verify
MTLSPolicyVerify 		(Valfritt)

Verifiera innehåller alternativ för att verifiera peer-certifikatet.
policyType
PolicyType 		(Valfritt)

Typ är principens typ.

FrontendTLSPolicySpec

(Visas på:FrontendTLSPolicy)

FrontendTLSPolicySpec definierar önskat tillstånd för FrontendTLSPolicy

Fält beskrivning
targetRef
CustomTargetRef

TargetRef identifierar ett API-objekt som principen ska tillämpas på.
default
FrontendTLSPolicyConfig 		(Valfritt)

Standard definierar standardprincipkonfigurationen för målresursen.
override
FrontendTLSPolicyConfig 		(Valfritt)

Åsidosättning definierar principkonfiguration som ska åsidosätta principkonfigurationen som är kopplad under målresursen i hierarkin.

Obs! Åsidosättning stöds inte för närvarande och resulterar i ett valideringsfel. Stöd för åsidosättning läggs till i en framtida version.

FrontendTLSPolicyStatus

(Visas på:FrontendTLSPolicy)

FrontendTLSPolicyStatus definierar det observerade tillståndet för FrontendTLSPolicy.

Fält beskrivning
conditions
[]Kubernetes meta/v1. Tillstånd 		(Valfritt)

Villkor beskriver de aktuella villkoren för FrontendTLSPolicy.

Implementeringar bör föredra att uttrycka FrontendTLSPolicy-villkor med hjälp av FrontendTLSPolicyConditionType konstanterna och FrontendTLSPolicyConditionReason så att operatorer och verktyg kan konvergera i ett gemensamt ordförråd för att beskriva FrontendTLSPolicy-tillstånd.

Kända villkorstyper är:

  • “Accepterad”

FrontendTLSPolicyType (string alias)

(Visas på:PolicyType)

FrontendTLSPolicyType är typen av klientdels-TLS-princip.

Värde beskrivning

"fördefinierad"

PredefinedFrontendTLSPolicyType är typen av den fördefinierade TLS-principen för klientdelen.

FrontendTLSPolicyTypeName (string alias)

(Visas på:PolicyType)

FrontendTLSPolicyTypeName är namnet på klientdelens TLS-princip.

Värde beskrivning

"2023-06"

PredefinedPolicy202306 är namnet på den fördefinierade klientdels-TLS-principen för principen “2023-06”.

"2023-06-S"

PredefinedPolicy202306Strict är namnet på den fördefinierade klientdels-TLS-principen för principen “2023-06-S”. Detta är en strikt version av policyn “2023-06”.

GRPCSpecifiers

(Visas på:HealthCheckPolicyConfig)

GRPCSpecifiers definierar schemat för GRPC HealthCheck.

Fält beskrivning
authority
sträng 		(Valfritt)

Utfärdare om den finns används som värdet för utfärdarhuvudet i hälsokontrollen.
service
sträng 		(Valfritt)

Tjänsten tillåter konfiguration av en hälsokontroll som registrerats under ett annat tjänstnamn.

HTTPHeader

(Visas på:HeaderFilter)

HTTPHeader representerar ett HTTP-huvudnamn och -värde enligt definitionen i RFC 7230.

Fält beskrivning
name
HTTPHeaderName

Namnet är namnet på HTTP-huvudet som ska matchas. Namnmatchning MÅSTE vara skiftlägesokänsligt. (Se https://tools.ietf.org/html/rfc7230#section-3.2).

Om flera poster anger motsvarande rubriknamn måste den första posten med motsvarande namn beaktas för en matchning. Efterföljande poster med motsvarande rubriknamn MÅSTE ignoreras. På grund av skiftlägeskänsligheten för rubriknamn “anses foo” och “Foo” vara likvärdiga.
value
sträng

Värdet är värdet för HTTP-huvudet som ska matchas.

HTTPHeaderName (string alias)

(Visas på:HTTPHeader)

HTTPHeaderName är namnet på ett HTTP-huvud.

Giltiga värden:

  • “Auktorisering”
  • “Set-Cookie”

Ogiltiga värden är:

  • ”:method” – “:” är ett ogiltigt tecken. Det innebär att HTTP/2 pseudohuvuden’för närvarande inte stöds av den här typen.
  • ”/invalid” - “/ ” är ett ogiltigt tecken

HTTPMatch

(Visas på:HTTPSpecifierare)

HTTPMatch definierar de HTTP-matchare som ska användas för HealthCheck-kontroller.

Fält beskrivning
body
sträng 		(Valfritt)

Brödtext definierar HTTP-brödtextmatchare som ska användas för HealthCheck-kontroller.
statusCodes
[]StatusCodes 		(Valfritt)

StatusCodes definierar HTTP-statuskoden matchare som ska användas för HealthCheck-kontroller.

HTTPPathModifier

(Visas på:Redirect, URLRewriteFilter)

HTTPPathModifier definierar konfiguration för sökvägsmodifierare.

Fält beskrivning
type
HTTPPathModifierType

Typ definierar typen av sökvägsmodifierare. Fler typer kan läggas till i en framtida version av API:et.

Värden kan läggas till i den här uppräkningen, implementeringar måste se till att okända värden’inte orsakar en krasch.

Okända värden här måste resultera i implementeringsinställningen Godkända villkor för att regeln ska vara false
replaceFullPath
sträng 		(Valfritt)

ReplaceFullPath anger det värde som du vill ersätta den fullständiga sökvägen för en begäran med under en omskrivning eller omdirigering.
replacePrefixMatch
sträng 		(Valfritt)

ReplacePrefixMatch anger det värde som prefixmatchningen för en begäran ska ersättas med under en omskrivning eller omdirigering. En begäran till “/foo/bar” med prefixmatchningen “/foo” och ReplacePrefixMatch för “/xyz” ändras till “/xyz/bar”.

Detta matchar beteendet för PathPrefix-matchningstypen. Detta matchar fullständiga sökvägselement. Ett sökvägselement refererar till listan över etiketter i sökvägen som delas av / avgränsaren. När det anges ignoreras en avslutande / . Sökvägarna /abc, /abc/och /abc/def skulle till exempel matcha prefixet /abc, men sökvägen /abcd skulle’inte göra det.

ReplacePrefixMatch är endast kompatibelt med en PathPrefix HTTPRouteMatch. Om du använder någon annan HTTPRouteMatch-typ på samma HTTPRouteRule resulterar det i implementeringsinställningen Godkända villkor för vägen till status: False.

Sökväg för begäran Prefixmatchning Ersätt prefix Ändrad sökväg
/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)

(Visas på:HTTPPathModifier)

HTTPPathModifierType definierar typen av sökvägsomdirigering eller omskrivning.

Värde beskrivning

"ReplaceFullPath"

FullPathHTTPPathModifier ersätter den fullständiga sökvägen med det angivna värdet.

"ReplacePrefixMatch"

PrefixMatchHTTPPathModifier ersätter alla prefixsökvägar med ersättningsvärdet. Till exempel en sökväg med en prefixmatchning av “/foo” och en ReplacePrefixMatch-ersättning av “/bar” ersätt “/foo” med “/bar” i matchande begäranden.

Detta matchar beteendet för PathPrefix-matchningstypen. Detta matchar fullständiga sökvägselement. Ett sökvägselement refererar till listan över etiketter i sökvägen som delas av / avgränsaren. När det anges ignoreras en avslutande / . Sökvägarna /abc, /abc/och /abc/def skulle till exempel matcha prefixet /abc, men sökvägen /abcd skulle’inte göra det.

HTTPSpecifierare

(Visas på:HealthCheckPolicyConfig)

HTTPSpecifiers definierar schemat för HTTP HealthCheck-kontrollspecifikationen.

Fält beskrivning
host
sträng 		(Valfritt)

Värden är det värdhuvudvärde som ska användas för HealthCheck-kontroller.
path
sträng 		(Valfritt)

Sökvägen är den sökväg som ska användas för HealthCheck-kontroller.
match
HTTPMatch 		(Valfritt)

Matchning definierar http-matchare som ska användas för HealthCheck-kontroller.

HeaderFilter

(Visas på:IngressRewrites)

HeaderFilter definierar ett filter som ändrar rubrikerna för en HTTP-begäran eller ett HTTP-svar. Endast en åtgärd för ett visst rubriknamn tillåts. Filter som anger flera åtgärder av samma eller annan typ för ett huvudnamn är ogiltiga och avvisade. Konfiguration för att ange eller lägga till flera värden för ett huvud måste använda RFC 7230-rubrikvärdesformatering och separera varje värde med kommatecken.

Fält beskrivning
set
[]HTTPHeader 		(Valfritt)

Ange skriver över begäran med det angivna huvudet (namn, värde) före åtgärden.

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

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

Utdata: GET /foo HTTP/1.1 my-header: bar
add
[]HTTPHeader 		(Valfritt)

Lägg till lägger till de angivna huvudena (namn, värde) i begäran före åtgärden. Den lägger till alla befintliga värden som är associerade med rubriknamnet.

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

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

Utdata: GET /foo HTTP/1.1 my-header: foo,bar,baz
remove
[]sträng 		(Valfritt)

Ta bort de angivna huvudena från HTTP-begäran före åtgärden. Värdet för Ta bort är en lista med HTTP-huvudnamn. Rubriknamn är skiftlägeskänsliga (se https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).

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

Konfiguration: ta bort: [“my-header1”, “my-header3”]

Utdata: GET /foo HTTP/1.1 my-header2: bar

HeaderName (string alias)

HeaderName är namnet på en rubrik- eller frågeparameter.

HealthCheckPolicy

HealthCheckPolicy är schemat för Api:et HealthCheckPolicy.

Fält beskrivning
metadata
Kubernetes meta/v1. ObjectMeta 		(Valfritt)

Objekts’metadata.

Se Kubernetes API-dokumentationen för fälten i metadata fältet.
spec
HealthCheckPolicySpec

Specifikation är HealthCheckPolicy-specifikationen.



targetRef
CustomTargetRef

TargetRef identifierar ett API-objekt som principen ska tillämpas på.
override
HealthCheckPolicyConfig 		(Valfritt)

Åsidosättning definierar principkonfiguration som ska åsidosätta principkonfigurationen som är kopplad under målresursen i hierarkin.

Obs! Åsidosättning stöds för närvarande inte och resulterar i ett valideringsfel. Stöd för åsidosättning läggs till i en framtida version.
default
HealthCheckPolicyConfig 		(Valfritt)

Standard definierar standardprincipkonfigurationen för målresursen.
status
HealthCheckPolicyStatus

Status definierar det aktuella tillståndet för HealthCheckPolicy.

HealthCheckPolicyConditionReason (string alias)

HealthCheckPolicyConditionReason definierar den uppsättning orsaker som förklarar varför en viss HealthCheckPolicy-villkorstyp genereras.

Värde beskrivning

"BackendTLSPolicyNotFound"

BackendTLSPolicyConditionNotFound används när BackendTLSPolicy inte hittas för tjänsten.

"Accepterad"

HealthCheckPolicyReasonAccepted används för att ange HealthCheckPolicyConditionReason till Godkänd. När den angivna HealthCheckPolicy är korrekt konfigurerad.

"InvalidHealthCheckPolicy"

HealthCheckPolicyReasonInvalid är orsaken till att HealthCheckPolicy’inte accepteras.

"InvalidGroup"

HealthCheckPolicyReasonInvalidGroup används när gruppen är ogiltig.

"InvalidKind"

HealthCheckPolicyReasonInvalidKind används när typen/gruppen är ogiltig.

"InvalidName"

HealthCheckPolicyReasonInvalidName används när namnet är ogiltigt.

"InvalidPort"

HealthCheckPolicyReasonInvalidPort används när porten är ogiltig.

"InvalidService"

HealthCheckPolicyReasonInvalidService används när tjänsten är ogiltig.

"NoTargetReference"

HealthCheckPolicyReasonNoTargetReference används när det inte finns’någon målreferens.

"OverrideNotSupported"

HealthCheckPolicyReasonOverrideNotSupported används när åsidosättningen’inte stöds.

"RefNotPermitted"

HealthCheckPolicyReasonRefNotPermitted används när referensen inte är’tillåten.

"SectionNamesNotPermitted"

HealthCheckPolicyReasonSectionNamesNotPermitted används när avsnittsnamnen inte tillåts’.

HealthCheckPolicyConditionType (string alias)

HealthCheckPolicyConditionType är en typ av villkor som är associerat med en HealthCheckPolicy. Den här typen ska användas med fältet HealthCheckPolicyStatus.Conditions.

Värde beskrivning

"Accepterad"

HealthCheckPolicyConditionAccepted används för att ange HealthCheckPolicyConditionType till Godkänd.

"ResolvedRefs"

HealthCheckPolicyConditionResolvedRefs används för att ange HealthCheckPolicyCondition till ResolvedRefs.

HealthCheckPolicyConfig

(Visas på:HealthCheckPolicySpec)

HealthCheckPolicyConfig definierar schemat för hälsokontrollspecifikationen.

Fält beskrivning
interval
Kubernetes meta/v1. Varaktighet 		(Valfritt)

Intervall är antalet sekunder mellan HealthCheck-kontroller.
timeout
Kubernetes meta/v1. Varaktighet 		(Valfritt)

Tidsgränsen är det antal sekunder efter vilken hälsokontrollen anses ha misslyckats.
port
int32 		(Valfritt)

Port är den port som ska användas för HealthCheck-kontroller.
unhealthyThreshold
int32 		(Valfritt)

UnhealthyThreshold är antalet efterföljande misslyckade HealthCheck-kontroller.
healthyThreshold
int32 		(Valfritt)

HealthyThreshold är antalet efterföljande lyckade HealthCheck-kontroller.
useTLS
Bool 		(Valfritt)

UseTLS anger om hälsokontrollen ska framtvinga TLS. Som standard använder hälsokontrollen samma protokoll som tjänsten om samma port används för hälsokontroll. Om porten är annorlunda är hälsokontrollen klartext.
http
HTTPSpecifierare 		(Valfritt)

HTTP definierar HTTP-villkorsspecifikationen för HealthCheck för en målresurs.
grpc
GRPCSpecifiers

GRPC konfigurerar en gRPC v1 HealthCheck (https://github.com/grpc/grpc-proto/blob/master/grpc/health/v1/health.proto) mot målresursen.

HealthCheckPolicySpec

(Visas på:HealthCheckPolicy)

HealthCheckPolicySpec definierar önskat tillstånd för HealthCheckPolicy.

Fält beskrivning
targetRef
CustomTargetRef

TargetRef identifierar ett API-objekt som principen ska tillämpas på.
override
HealthCheckPolicyConfig 		(Valfritt)

Åsidosättning definierar principkonfiguration som ska åsidosätta principkonfigurationen som är kopplad under målresursen i hierarkin.

Obs! Åsidosättning stöds för närvarande inte och resulterar i ett valideringsfel. Stöd för åsidosättning läggs till i en framtida version.
default
HealthCheckPolicyConfig 		(Valfritt)

Standard definierar standardprincipkonfigurationen för målresursen.

HealthCheckPolicyStatus

(Visas på:HealthCheckPolicy)

HealthCheckPolicyStatus definierar det observerade tillståndet för HealthCheckPolicy.

Fält beskrivning
conditions
[]Kubernetes meta/v1. Tillstånd 		(Valfritt)

Villkor beskriver de aktuella villkoren för HealthCheckPolicy.

Implementeringar bör föredra att uttrycka HealthCheckPolicy-villkor med hjälp av HealthCheckPolicyConditionType konstanterna och HealthCheckPolicyConditionReason så att operatorer och verktyg kan konvergera i ett gemensamt ordförråd för att beskriva HealthCheckPolicy-tillstånd.

Kända villkorstyper är:

  • “Accepterad”

IngressBackendPort

(Visas på:IngressBackendSettings)

IngressBackendPort beskriver en port på en serverdel. Endast ett av namn/nummer ska definieras.

Fält beskrivning
port
int32 		(Valfritt)

Port anger porten på serverdelstjänsten
name
sträng 		(Valfritt)

Namnet måste referera till ett namn på en port på serverdelstjänsten
protocol
Protokoll

Protokollet ska vara ett av “HTTP”, “HTTPS”

IngressBackendSettingStatus

(Visas på:IngressExtensionStatus)

IngressBackendSettingStatus beskriver tillståndet för en BackendSetting

Fält beskrivning
service
sträng

Tjänsten identifierar backendSetting som den här statusen beskriver
validationErrors
[]sträng 		(Valfritt)

Fel är en lista över fel som rör den här inställningen
valid
Bool

Giltigt anger att det inte finns några verifieringsfel på den här backendSetting

IngressBackendSettings

(Visas på:IngressExtensionSpec)

IngressBackendSettings tillhandahåller utökade konfigurationsalternativ för en serverdelstjänst

Fält beskrivning
service
sträng

Tjänsten är namnet på en serverdelstjänst som den här konfigurationen gäller för
ports
[]IngressBackendPort 		(Valfritt)

Portar kan användas för att ange om serverdelstjänsten lyssnar på HTTP eller HTTPS
trustedRootCertificate
sträng 		(Valfritt)

TrustedRootCertificate kan användas för att ange ett certifikat för gatewayen att lita på vid kommunikation till serverdelen på en port som anges som https
sessionAffinity
SessionAffinity 		(Valfritt)

SessionAffinity tillåter att klientbegäranden ges konsekvent till samma serverdel
timeouts
IngressTimeouts 		(Valfritt)

Tidsgränser definierar en uppsättning tidsgränsparametrar som ska tillämpas på en ingress

IngressExtension

IngressExtension är schemat för Api:et IngressExtension

Fält beskrivning
metadata
Kubernetes meta/v1. ObjectMeta 		(Valfritt)

Objekts’metadata.

Se Kubernetes API-dokumentationen för fälten i metadata fältet.
spec
IngressExtensionSpec

Spec är IngressExtension-specifikationen.



rules
[]IngressRuleSetting 		(Valfritt)

Regler definierar reglerna per värd
backendSettings
[]IngressBackendSettings 		(Valfritt)

BackendSettings definierar en uppsättning konfigurationsalternativ för serverdelar för inkommande tjänster
status
IngressExtensionStatus

IngressExtensionConditionReason (string alias)

IngressExtensionConditionReason definierar den uppsättning orsaker som förklarar varför en viss IngressExtension-villkorstyp har genererats.

Värde beskrivning

"Accepterad"

IngressExtensionReasonAccepted används för att ange IngressExtensionConditionAccepted till Godkänd

"HasValidationErrors"

IngressExtensionReasonHasErrors anger att det finns vissa verifieringsfel

"NoValidationErrors"

IngressExtensionReasonNoErrors anger att det inte finns några verifieringsfel

"PartiallyAcceptedWithErrors"

IngressExtensionReasonPartiallyAccepted används för att ange IngressExtensionConditionAccepted till Godkänd, men med icke-fatala valideringsfel

IngressExtensionConditionType (string alias)

IngressExtensionConditionType är en typ av villkor som är associerat med en IngressExtension. Den här typen ska användas med fältet IngressExtensionStatus.Conditions.

Värde beskrivning

"Accepterad"

IngressExtensionConditionAccepted anger om IngressExtension accepteras (stämmas av) av kontrollanten

"Fel"

IngressExtensionConditionErrors anger om det finns verifierings- eller byggfel i tillägget

IngressExtensionSpec

(Visas på:IngressExtension)

IngressExtensionSpec definierar önskad konfiguration av IngressExtension

Fält beskrivning
rules
[]IngressRuleSetting 		(Valfritt)

Regler definierar reglerna per värd
backendSettings
[]IngressBackendSettings 		(Valfritt)

BackendSettings definierar en uppsättning konfigurationsalternativ för serverdelar för inkommande tjänster

IngressExtensionStatus

(Visas på:IngressExtension)

IngressExtensionStatus beskriver det aktuella tillståndet för IngressExtension

Fält beskrivning
rules
[]IngressRuleStatus 		(Valfritt)

Reglerna har detaljerad statusinformation om varje regel
backendSettings
[]IngressBackendSettingStatus 		(Valfritt)

BackendSettings har detaljerad statusinformation om varje BackendSettings
conditions
[]Kubernetes meta/v1. Tillstånd 		(Valfritt)

Villkor beskriver de aktuella villkoren för IngressExtension. Kända villkorstyper är:

  • “Accepterad”
  • “Fel”

IngressRewrites

(Visas på:IngressRuleSetting)

IngressRewrites tillhandahåller de olika omskrivningar som stöds för en regel

Fält beskrivning
type
Skriv omType

Typ identifierar typ av omskrivning
requestHeaderModifier
HeaderFilter 		(Valfritt)

RequestHeaderModifier definierar ett schema som ändrar begärandehuvuden.
responseHeaderModifier
HeaderFilter 		(Valfritt)

RequestHeaderModifier definierar ett schema som ändrar svarshuvuden.
urlRewrite
URLRewriteFilter 		(Valfritt)

URLRewrite definierar ett schema som ändrar en begäran under vidarebefordran.

IngressRuleSetting

(Visas på:IngressExtensionSpec)

IngressRuleSetting tillhandahåller konfigurationsalternativ för regler

Fält beskrivning
host
sträng

Värden används för att matcha mot ingressregler med samma värdnamn för att identifiera vilka regler som påverkar de här inställningarna
additionalHostnames
[]sträng 		(Valfritt)

AdditionalHostnames anger fler värdnamn att lyssna på
rewrites
[]IngressRewrites 		(Valfritt)

Omskrivningar definierar omskrivningarna för regeln
requestRedirect
Omdirigera 		(Valfritt)

RequestRedirect definierar omdirigeringsbeteendet för regeln

IngressRuleStatus

(Visas på:IngressExtensionStatus)

IngressRuleStatus beskriver tillståndet för en regel

Fält beskrivning
host
sträng

Värden identifierar regeln som den här statusen beskriver
validationErrors
[]sträng 		(Valfritt)

Fel är en lista över fel som rör den här inställningen
valid
Bool 		(Valfritt)

Giltigt anger att det inte finns några verifieringsfel i den här regeln

IngressTimeouts

(Visas på:IngressBackendSettings)

IngressTimeouts kan användas för att konfigurera timeout-egenskaper för en ingress

Fält beskrivning
requestTimeout
Kubernetes meta/v1. Varaktighet 		(Valfritt)

RequestTimeout definierar tidsgränsen som används av lastbalanseraren när begäranden vidarebefordras till en serverdelstjänst

MTLSPolicyVerify

(Visas på:FrontendTLSPolicyConfig)

MTLSPolicyVerify definierar schemat för MTLSPolicyVerify-API:et.

Fält beskrivning
caCertificateRef
Gateway-API . SecretObjectReference

CaCertificateRef är certifikatutfärdarcertifikatet som används för att verifiera peer-certifikatet.
subjectAltNames
[]sträng 		(Valfritt)

SubjectAltNames är listan över alternativa ämnesnamn som används för att verifiera peer-certifikatet.

PolicyType

(Visas på:FrontendTLSPolicyConfig)

PolicyType är principens typ.

Fält beskrivning
name
FrontendTLSPolicyTypeName

Namnet är namnet på principen.
type
FrontendTLSPolicyType

PredefinedFrontendTLSPolicyType är typen av den fördefinierade TLS-principen för klientdelen.

PortNumber (int32 alias)

(Visas på:Omdirigering)

PortNumber definierar en nätverksport.

PreciseHostname (string alias)

(Visas på:Redirect, URLRewriteFilter)

PreciseHostname är det fullständigt kvalificerade domännamnet för en nätverksvärd. Detta matchar RFC 1123-definitionen för ett värdnamn med ett anmärkningsvärt undantag om att numeriska IP-adresser inte tillåts’.

Per RFC1035 och RFC1123 måste en etikett bestå av gemena alfanumeriska tecken eller ‘-’, och måste börja och sluta med ett alfanumeriskt tecken. Ingen annan interpunktion tillåts.

Protokoll (string alias)

(Visas på:IngressBackendPort)

Protokoll definierar det protokoll som används för vissa egenskaper. Giltiga protokollvärden är:

  • HTTP
  • HTTPS
  • TCP
Värde beskrivning

"HTTP"

ProtocolHTTP innebär att tjänsten använder HTTP.

HTTPS

ProtocolHTTPS innebär att tjänsten använder HTTPS.

"TCP"

ProtocolTCP innebär att tjänsten använder vanlig TCP.

Omdirigera

(Visas på:IngressRuleSetting)

Omdirigering definierar ett filter som omdirigerar en begäran. Detta får INTE användas på samma regel som även har en URLRewriteFilter.

Fält beskrivning
scheme
sträng 		(Valfritt)

Schema är det schema som ska användas i värdet för Location rubriken i svaret. När den är tom används schemat för begäran.
hostname
PreciseHostname 		(Valfritt)

Värdnamn är värdnamnet som ska användas i värdet för Location rubriken i svaret. När det är tomt används värdnamnet i Host rubriken för begäran.
path
HTTPPathModifier 		(Valfritt)

Sökvägen definierar parametrar som används för att ändra sökvägen för den inkommande begäran. Den ändrade sökvägen används sedan för att konstruera Location huvudet. När den är tom används sökvägen till begäran som den är.
port
PortNumber 		(Valfritt)

Port är den port som ska användas i värdet för Location huvudet i svaret.

Om ingen port anges måste omdirigeringsporten härledas med hjälp av följande regler:

  • Om omdirigeringsschemat inte är tomt måste omdirigeringsporten vara den välkända port som är associerad med omdirigeringsschemat. Specifikt “http” till port 80 och “https” till port 443. Om omdirigeringsschemat’inte har någon välkänd port ska lyssnarporten för gatewayen användas.
  • Om omdirigeringsschemat är tomt måste omdirigeringsporten vara gatewaylyssningsporten.

Implementeringar BÖR INTE lägga till portnumret i platsrubriken ‘’ i följande fall:

  • En platsrubrik som använder HTTP (oavsett om det bestäms via lyssnarprotokollet eller fältet Schema) och använder port 80.
  • En platsrubrik som använder HTTPS (oavsett om det bestäms via lyssnarprotokollet eller fältet Schema) och använder port 443.
statusCode
Int 		(Valfritt)

StatusCode är HTTP-statuskoden som ska användas som svar.

Värden kan läggas till i den här uppräkningen, implementeringar måste se till att okända värden’inte orsakar en krasch.

Omskrivningstyp (string alias)

(Visas på:IngressRewrites)

Omskrivningstyp identifierar omskrivningstypen

Värde beskrivning

"RequestHeaderModifier"

RequestHeaderModifier kan användas för att lägga till eller ta bort en HTTP-rubrik från en HTTP-begäran innan den skickas till det’överordnade målet.

"ResponseHeaderModifier"

ResponseHeaderModifier kan användas för att lägga till eller ta bort ett HTTP-huvud från ett HTTP-svar innan det’skickas till klienten.

"URLRewrite"

URLRewrite kan användas för att ändra en begäran under vidarebefordran.

RoutePolicy

RoutePolicy är schemat för RoutePolicy-API:et.

Fält beskrivning
metadata
Kubernetes meta/v1. ObjectMeta 		(Valfritt)

Objekts’metadata.

Se Kubernetes API-dokumentationen för fälten i metadata fältet.
spec
RoutePolicySpec

Specifikationen är RoutePolicy-specifikationen.



targetRef
CustomTargetRef

TargetRef identifierar ett API-objekt som principen ska tillämpas på.
override
RoutePolicyConfig 		(Valfritt)

Åsidosättning definierar principkonfiguration som ska åsidosätta principkonfigurationen som är kopplad under målresursen i hierarkin.

Obs! Åsidosättning stöds inte för närvarande och resulterar i ett valideringsfel. Stöd för åsidosättning läggs till i en framtida version.
default
RoutePolicyConfig 		(Valfritt)

Standard definierar standardprincipkonfigurationen för målresursen.
status
RoutePolicyStatus

Status definierar det aktuella tillståndet för RoutePolicy.

RoutePolicyConditionReason (string alias)

RoutePolicyConditionReason definierar den uppsättning orsaker som förklarar varför en viss RoutePolicy-villkorstyp genereras.

Värde beskrivning

"Accepterad"

RoutePolicyReasonAccepted används för att ange RoutePolicyConditionReason till Godkänd när den angivna RoutePolicy är korrekt konfigurerad

"InvalidRoutePolicy"

RoutePolicyReasonInvalid är orsaken till att RoutePolicy’inte accepteras

"OgiltigGRPCRoute"

RoutePolicyReasonInvalidGRPCRoute används när GRPCRoute är ogiltig

"InvalidGroup"

RoutePolicyReasonInvalidGroup används när gruppen är ogiltig

"OgiltigHTTPRoute"

RoutePolicyReasonInvalidHTTPRoute används när HTTPRoute är ogiltig

"InvalidKind"

RoutePolicyReasonInvalidKind används när typen/gruppen är ogiltig

"InvalidName"

RoutePolicyReasonInvalidName används när namnet är ogiltigt

"NoTargetReference"

RoutePolicyReasonNoTargetReference används när det inte finns’någon målreferens

"OverrideNotSupported"

RoutePolicyReasonOverrideNotSupported används när åsidosättningen’inte stöds

"RefNotPermitted"

RoutePolicyReasonRefNotPermitted används när referensen inte är’tillåten

"SectionNamesNotPermitted"

RoutePolicyReasonSectionNamesNotPermitted används när avsnittsnamnen inte tillåts’

RoutePolicyConditionType (string alias)

RoutePolicyConditionType är en typ av villkor som är associerat med en RoutePolicy. Den här typen ska användas med fältet RoutePolicyStatus.Conditions.

Värde beskrivning

"Accepterad"

RoutePolicyConditionAccepted används för att ange RoutePolicyConditionType till Godkänd

"ResolvedRefs"

RoutePolicyConditionResolvedRefs används för att ange RoutePolicyCondition till ResolvedRefs

RoutePolicyConfig

(Visas på:RoutePolicySpec)

RoutePolicyConfig definierar schemat för RoutePolicy-specifikationen. På så sätt kan du ange följande attribut: * Tidsgränser * Sessionstillhörighet

Fält beskrivning
timeouts
RouteTimeouts 		(Valfritt)

Tidsgräns för anpassade tidsgränser för målresursen.
sessionAffinity
SessionAffinity

SessionAffinity definierar schemat för specifikationen för sessionstillhörighet

RoutePolicySpec

(Visas på:RoutePolicy)

RoutePolicySpec definierar önskat tillstånd för RoutePolicy.

Fält beskrivning
targetRef
CustomTargetRef

TargetRef identifierar ett API-objekt som principen ska tillämpas på.
override
RoutePolicyConfig 		(Valfritt)

Åsidosättning definierar principkonfiguration som ska åsidosätta principkonfigurationen som är kopplad under målresursen i hierarkin.

Obs! Åsidosättning stöds inte för närvarande och resulterar i ett valideringsfel. Stöd för åsidosättning läggs till i en framtida version.
default
RoutePolicyConfig 		(Valfritt)

Standard definierar standardprincipkonfigurationen för målresursen.

RoutePolicyStatus

(Visas på:RoutePolicy)

RoutePolicyStatus definierar det observerade tillståndet för RoutePolicy.

Fält beskrivning
conditions
[]Kubernetes meta/v1. Tillstånd 		(Valfritt)

Villkor beskriver de aktuella villkoren för RoutePolicy.

Implementeringar bör föredra att uttrycka RoutePolicy-villkor med hjälp av RoutePolicyConditionType konstanterna och RoutePolicyConditionReason så att operatorer och verktyg kan konvergera i ett gemensamt ordförråd för att beskriva RoutePolicy-tillstånd.

Kända villkorstyper är:

  • “Accepterad”

RouteTimeouts

(Visas på:RoutePolicyConfig)

RouteTimeouts definierar schemat för Timeouts-specifikationen.

Fält beskrivning
routeTimeout
Kubernetes meta/v1. Varaktighet 		(Valfritt)

RouteTimeout är tidsgränsen för vägen.

SessionAffinity

(Visas på:IngressBackendSettings, RoutePolicyConfig)

SessionAffinity definierar schemat för specifikationen för sessionstillhörighet.

Fält beskrivning
affinityType
AffinityType
cookieName
sträng 		(Valfritt)
cookieDuration
Kubernetes meta/v1. Varaktighet 		(Valfritt)

StatusCodes

(Visas på:HTTPMatch)

StatusCodes definierar HTTP-statuskoden matchare som ska användas för HealthCheck-kontroller.

Fält beskrivning
start
int32 		(Valfritt)

Start definierar början av intervallet med statuskoder som ska användas för HealthCheck-kontroller. Detta är inkluderande.
end
int32 		(Valfritt)

End definierar slutet på det intervall med statuskoder som ska användas för HealthCheck-kontroller. Detta är inkluderande.

URLRewriteFilter

(Visas på:IngressRewrites)

URLRewriteFilter definierar ett filter som ändrar en begäran under vidarebefordran. Högst ett av dessa filter kan användas på en regel. Detta får INTE användas på samma regel med en sslRedirect.

Fält beskrivning
hostname
PreciseHostname 		(Valfritt)

Värdnamn är det värde som ska användas för att ersätta värdet för värdhuvud under vidarebefordring.
path
HTTPPathModifier 		(Valfritt)

Sökvägen definierar en sökvägsomskrivning.