Spécification de l’API Passerelle d’application pour conteneurs pour Kubernetes
Packages
Le package v1 est la version v1 de l’API.
alb.networking.azure.io/v1
Ce document définit chacun des types de ressources pour alb.networking.azure.io/v1
.
Types de ressources :
AffinityType (alias string
)
(Apparaît sur :SessionAffinity)
AffinityType définit le type d’affinité pour le service
Valeur | Description |
---|---|
"application-cookie" |
AffinityTypeApplicationCookie est un type d’affinité de session pour un cookie d’application |
"managed-cookie" |
AffinityTypeManagedCookie est un type d’affinité de session pour un cookie managé |
AlbConditionReason (alias string
)
AlbConditionReason définit l’ensemble des raisons qui expliquent pourquoi un type de condition particulier est déclenché par la ressource Passerelle d’application pour conteneurs.
Valeur | Description |
---|---|
"Accepted" |
AlbReasonAccepted indique que la ressource Passerelle d’application pour conteneurs est acceptée par le contrôleur. |
« Prêt » |
AlbReasonDeploymentReady indique l’état du déploiement des ressources Passerelle d’application pour conteneurs. |
"InProgress" |
AlbReasonInProgress indique si la ressource Passerelle d’application pour conteneurs est en cours de création, de mise à jour ou de suppression. |
AlbConditionType (alias string
)
AlbConditionType est un type de condition associé à une ressource Passerelle d’application pour conteneurs. Ce type doit être utilisé avec le champ AlbStatus.Conditions.
Valeur | Description |
---|---|
"Accepted" |
AlbConditionTypeAccepted indique si la ressource Passerelle d’application pour conteneurs est acceptée par le contrôleur. |
"Deployment" |
AlbConditionTypeDeployment indique l’état de déploiement de la ressource Passerelle d’application pour conteneurs. |
AlbSpec
(Apparaît sur :ApplicationLoadBalancer)
AlbSpec définit les spécifications de la ressource Passerelle d’application pour conteneurs.
Champ | Description |
---|---|
associations []chaîne |
Les associations sont des ID de ressource de sous-réseau auxquels la ressource Passerelle d’application pour conteneurs est associée. |
AlbStatus
(Apparaît sur :ApplicationLoadBalancer)
AlbStatus définit l’état observé de la ressource Passerelle d’application pour conteneurs.
Champ | Description |
---|---|
conditions []Kubernetes meta/v1.Condition |
(Facultatif)
Les types de conditions connues sont les suivants :
|
ApplicationLoadBalancer
ApplicationLoadBalancer est le schéma de la ressource Passerelle d’application pour conteneurs.
Champ | Description | ||
---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
(Facultatif)
Métadonnées de l’objet. Reportez-vous à la documentation de l’API Kubernetes pour connaître les champs du champmetadata .
|
||
spec AlbSpec |
Spec correspond aux spécifications de la ressource Passerelle d’application pour conteneurs.
|
||
status AlbStatus |
Status définit l’état actuel de la ressource Passerelle d’application pour conteneurs. |
BackendTLSPolicy
BackendTLSPolicy est le schéma pour l’API BackendTLSPolicys.
Champ | Description | ||||||
---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
(Facultatif)
Métadonnées de l’objet. Reportez-vous à la documentation de l’API Kubernetes pour connaître les champs du champmetadata .
|
||||||
spec BackendTLSPolicySpec |
Spec est la spécification BackendTLSPolicy.
|
||||||
status BackendTLSPolicyStatus |
Status définit l’état actuel de BackendTLSPolicy. |
BackendTLSPolicyConditionReason (alias string
)
BackendTLSPolicyConditionReason définit l’ensemble des raisons qui expliquent pourquoi un type de condition BackendTLSPolicy particulier est déclenché.
Valeur | Description |
---|---|
"Accepted" |
BackendTLSPolicyReasonAccepted est utilisé pour définir BackendTLSPolicyConditionReason sur Accepted lorsque la BackendTLSPolicy donnée est configurée correctement |
"InvalidBackendTLSPolicy" |
BackendTLSPolicyReasonInvalid est la raison pour laquelle backendTLSPolicy n’est pas Accepted |
"InvalidCertificateRef" |
BackendTLSPolicyReasonInvalidCertificateRef est utilisé lorsqu’un certificat non valide est référencé |
"InvalidGroup" |
BackendTLSPolicyReasonInvalidGroup est utilisé lorsque le groupe n’est pas valide |
"InvalidKind" |
BackendTLSPolicyReasonInvalidKind est utilisé lorsque le type/groupe n’est pas valide |
"InvalidName" |
BackendTLSPolicyReasonInvalidName est utilisé lorsque le nom n’est pas valide |
"InvalidSecret" |
BackendTLSPolicyReasonInvalidSecret est utilisé lorsque le secret n’est pas valide |
"InvalidService" |
BackendTLSPolicyReasonInvalidService est utilisé lorsque le service n’est pas valide |
"NoTargetReference" |
BackendTLSPolicyReasonNoTargetReference est utilisé lorsqu’il n’existe aucune référence cible |
"OverrideNotSupported" |
BackendTLSPolicyReasonOverrideNotSupported est utilisé lorsque le remplacement n’est pas pris en charge |
"RefNotPermitted" |
BackendTLSPolicyReasonRefNotPermitted est utilisé lorsque la référence n’est pas autorisée |
"SectionNamesNotPermitted" |
BackendTLSPolicyReasonSectionNamesNotPermitted est utilisé lorsque les noms de section ne sont pas autorisés |
BackendTLSPolicyConditionType (alias string
)
BackendTLSPolicyConditionType est un type de condition associé à une BackendTLSPolicy. Ce type doit être utilisé avec le champ BackendTLSPolicyStatus.Conditions.
Valeur | Description |
---|---|
"Accepted" |
BackendTLSPolicyConditionAccepted est utilisé pour définir BackendTLSPolicyConditionType sur Accepted |
"ResolvedRefs" |
BackendTLSPolicyConditionResolvedRefs est utilisé pour définir BackendTLSPolicyCondition sur ResolvedRefs |
BackendTLSPolicyConfig
(Apparaît sur :BackendTLSPolicySpec)
BackendTLSPolicyConfig définit la spécification de stratégie pour la stratégie TLS de back-end.
Champ | Description |
---|---|
CommonTLSPolicy CommonTLSPolicy |
(Les membres de |
sni chaîne |
(Facultatif)
Sni est le nom du serveur à utiliser pour la connexion TLS au back-end. |
ports []BackendTLSPolicyPort |
Ports spécifie la liste des ports où la stratégie est appliquée. |
clientCertificateRef Gateway API .SecretObjectReference |
(Facultatif)
ClientCertificateRef est la référence au certificat client à utiliser pour la connexion TLS au back-end. |
BackendTLSPolicyPort
(Apparaît sur :BackendTLSPolicyConfig)
BackendTLSPolicyPort définit le port à utiliser pour la connexion TLS au back-end
Champ | Description |
---|---|
port int |
Port est le port à utiliser pour la connexion TLS au back-end |
BackendTLSPolicySpec
(Apparaît sur :BackendTLSPolicy)
BackendTLSPolicySpec définit l’état souhaité de BackendTLSPolicy.
Champ | Description |
---|---|
targetRef CustomTargetRef |
TargetRef identifie un objet API auquel appliquer la stratégie. |
override BackendTLSPolicyConfig |
(Facultatif)
Override définit la configuration de stratégie qui doit remplacer la configuration de stratégie attachée sous la ressource ciblée dans la hiérarchie. Remarque : le remplacement n’est actuellement pas pris en charge et génère une erreur de validation. La prise en charge du remplacement sera ajoutée dans une version ultérieure. |
default BackendTLSPolicyConfig |
(Facultatif)
Default définit la configuration de stratégie par défaut pour la ressource ciblée. |
BackendTLSPolicyStatus
(Apparaît sur :BackendTLSPolicy)
BackendTLSPolicyStatus définit l’état observé de BackendTLSPolicy.
Champ | Description |
---|---|
conditions []Kubernetes meta/v1.Condition |
(Facultatif)
conditions décrit les conditions actuelles de BackendTLSPolicy. Les implémentations doivent préférer exprimer des conditions BackendTLSPolicy à l’aide des constantes Les types de conditions connues sont les suivants :
|
CommonTLSPolicy
(Apparaît sur :BackendTLSPolicyConfig)
CommonTLSPolicy est le schéma pour l’API CommonTLSPolicy.
Champ | Description |
---|---|
verify CommonTLSPolicyVerify |
(Facultatif)
Verify fournit les options permettant de vérifier le certificat du pair. |
CommonTLSPolicyVerify
(Apparaît sur :CommonTLSPolicy)
CommonTLSPolicyVerify définit le schéma pour l’API CommonTLSPolicyVerify.
Champ | Description |
---|---|
caCertificateRef Gateway API .SecretObjectReference |
CaCertificateRef est le certificat d’autorité de certification utilisé pour vérifier le certificat du pair. |
subjectAltName chaîne |
(Facultatif)
SubjectAltName est l’autre nom de l’objet utilisé pour vérifier le certificat du pair. |
CustomTargetRef
(Apparaît sur :BackendTLSPolicySpec, FrontendTLSPolicySpec, HealthCheckPolicySpec, RoutePolicySpec)
CustomTargetRef est une référence à une ressource personnalisée qui ne fait pas partie de l’API principale Kubernetes.
Champ | Description |
---|---|
NamespacedPolicyTargetReference alpha2.NamespacedPolicyTargetReference de l’API Gateway |
(Les membres de |
sectionNames []chaîne |
(Facultatif)
SectionNames est le nom de la section dans la ressource cible. Lorsqu’il n’est pas spécifié, ce targetRef cible l’ensemble de la ressource. Dans les ressources suivantes, SectionNames est interprété de la manière suivante :
Si SectionNames est spécifié, mais qu’il n’existe pas sur l’objet ciblé, l’attachement de la stratégie échoue et l’implémentation de la stratégie enregistre une |
FrontendTLSPolicy
FrontendTLSPolicy est le schéma de l’API FrontendTLSPolicy
Champ | Description | ||||||
---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
(Facultatif)
Métadonnées de l’objet. Reportez-vous à la documentation de l’API Kubernetes pour connaître les champs du champmetadata .
|
||||||
spec FrontendTLSPolicySpec |
Spec est la spécification FrontendTLSPolicy.
|
||||||
status FrontendTLSPolicyStatus |
Status définit l’état actuel de FrontendTLSPolicy. |
FrontendTLSPolicyConditionReason (alias string
)
FrontendTLSPolicyConditionReason définit l’ensemble des raisons qui expliquent pourquoi un type de condition FrontendTLSPolicy particulier est déclenché.
Valeur | Description |
---|---|
"Accepted" |
FrontendTLSPolicyReasonAccepted est utilisé pour définir FrontendTLSPolicyConditionReason sur Accepted lorsque la FrontendTLSPolicy donnée est configurée correctement |
"InvalidFrontendTLSPolicy" |
FrontendTLSPolicyReasonInvalid est la raison pour laquelle FrontendTLSPolicy n’est pas Accepted |
"InvalidCertificateRef" |
FrontendTLSPolicyReasonInvalidCertificateRef est utilisé quand un certificat non valide est référencé. |
« InvalidDefault » |
FrontendTLSPolicyReasonInvalidDefault est utilisé quand le nom est non valide. |
"InvalidGateway" |
FrontendTLSPolicyReasonInvalidGateway est utilisé lorsque la passerelle n’est pas valide |
"InvalidGroup" |
FrontendTLSPolicyReasonInvalidGroup est utilisé lorsque le groupe n’est pas valide |
"InvalidKind" |
FrontendTLSPolicyReasonInvalidKind est utilisé lorsque le type/groupe n’est pas valide |
"InvalidName" |
FrontendTLSPolicyReasonInvalidName est utilisé lorsque le nom n’est pas valide |
"InvalidPolicyName" |
FrontendTLSPolicyReasonInvalidPolicyName est utilisé lorsque le nom de la stratégie n’est pas valide |
"InvalidPolicyType" |
FrontendTLSPolicyReasonInvalidPolicyType est utilisé lorsque le type de stratégie n’est pas valide |
« InvalidTargetReference » |
FrontendTLSPolicyReasonInvalidTargetReference est utilisé quand la référence cible est non valide. |
"NoTargetReference" |
FrontendTLSPolicyReasonNoTargetReference est utilisé lorsqu’il n’existe aucune référence cible |
"OverrideNotSupported" |
FrontendTLSPolicyReasonOverrideNotSupported est utilisé lorsque le remplacement n’est pas pris en charge |
"RefNotPermitted" |
FrontendTLSPolicyReasonRefNotPermitted est utilisé lorsque la référence n’est pas autorisée |
"SectionNamesNotPermitted" |
FrontendTLSPolicyReasonSectionNamesNotPermitted est utilisé lorsque les noms de section ne sont pas autorisés |
FrontendTLSPolicyConditionType (alias string
)
FrontendTLSPolicyConditionType est un type de condition associé à une FrontendTLSPolicy. Ce type doit être utilisé avec le champ FrontendTLSPolicyStatus.Conditions.
Valeur | Description |
---|---|
"Accepted" |
FrontendTLSPolicyConditionAccepted est utilisé pour définir FrontendTLSPolicyCondition sur Accepted |
"ResolvedRefs" |
FrontendTLSPolicyConditionResolvedRefs est utilisé pour définir FrontendTLSPolicyCondition sur ResolvedRefs |
FrontendTLSPolicyConfig
(Apparaît sur :FrontendTLSPolicySpec)
FrontendTLSPolicyConfig définit la spécification de stratégie pour la stratégie TLS de front-end.
Champ | Description |
---|---|
verify MTLSPolicyVerify |
(Facultatif)
Verify fournit les options permettant de vérifier le certificat du pair. |
policyType PolicyType |
(Facultatif)
Type est le type de la stratégie. |
FrontendTLSPolicySpec
(Apparaît sur :FrontendTLSPolicy)
FrontendTLSPolicySpec définit l’état souhaité de FrontendTLSPolicy
Champ | Description |
---|---|
targetRef CustomTargetRef |
TargetRef identifie un objet API auquel appliquer la stratégie. |
default FrontendTLSPolicyConfig |
(Facultatif)
Default définit la configuration de stratégie par défaut pour la ressource ciblée. |
override FrontendTLSPolicyConfig |
(Facultatif)
Override définit la configuration de stratégie qui doit remplacer la configuration de stratégie attachée sous la ressource ciblée dans la hiérarchie. Remarque : le remplacement n’est actuellement pas pris en charge et génère une erreur de validation. La prise en charge du remplacement sera ajoutée dans une version ultérieure. |
FrontendTLSPolicyStatus
(Apparaît sur :FrontendTLSPolicy)
FrontendTLSPolicyStatus définit l’état observé de FrontendTLSPolicy.
Champ | Description |
---|---|
conditions []Kubernetes meta/v1.Condition |
(Facultatif)
conditions décrit les conditions actuelles de FrontendTLSPolicy. Les implémentations doivent préférer exprimer des conditions FrontendTLSPolicy à l’aide des constantes Les types de conditions connues sont les suivants :
|
FrontendTLSPolicyType (alias string
)
(Apparaît sur :PolicyType)
FrontendTLSPolicyType est le type de la stratégie TLS front-end.
Valeur | Description |
---|---|
"predefined" |
PredefinedFrontendTLSPolicyType est le type de la stratégie TLS front-end prédéfinie. |
FrontendTLSPolicyTypeName (string
alias)
(Apparaît sur :PolicyType)
FrontendTLSPolicyTypeName est le nom de la stratégie TLS front-end.
Valeur | Description |
---|---|
"2023-06" |
PredefinedPolicy202306 est le nom de la stratégie TLS front-end prédéfinie pour la stratégie “2023-06”. |
"2023-06-S" |
PredefinedPolicy202306Strict est le nom de la stratégie TLS front-end prédéfinie pour la stratégie “2023-06-S”. Il s’agit d’une version stricte de la stratégie “2023-06”. |
GRPCSpecifiers
(Apparaît sur :HealthCheckPolicyConfig)
GRPCSpecifiers définit le schéma pour GRPC HealthCheck.
Champ | Description |
---|---|
authority chaîne |
(Facultatif)
Si elle est présente, l’autorité est utilisée comme valeur de l’en-tête Authority dans le contrôle d’intégrité. |
service chaîne |
(Facultatif)
Le service autorise la configuration d’un contrôle d’intégrité inscrit sous un autre nom de service. |
HTTPHeader
(Apparaît sur :HeaderFilter)
HTTPHeader représente un nom et une valeur d’en-tête HTTP définis par RFC 7230.
Champ | Description |
---|---|
name HTTPHeaderName |
Name est le nom de l’en-tête HTTP à mettre en correspondance. La mise en correspondance de noms NE DOIT PAS respecter la casse. (Voir https://tools.ietf.org/html/rfc7230#section-3.2.) Si plusieurs entrées spécifient des noms d’en-tête équivalents, la première entrée avec un nom équivalent DOIT être prise en compte pour une correspondance. Les entrées suivantes avec un nom d’en-tête équivalent DOIVENT être ignorées. En raison du non-respect de la casse des noms d’en-tête, “foo” et “Foo” sont considérés comme équivalents. |
value chaîne |
Value est la valeur de l’en-tête HTTP à mettre en correspondance. |
HTTPHeaderName (alias string
)
(Apparaît sur :HTTPHeader)
HTTPHeaderName est le nom d’un en-tête HTTP.
Les valeurs valides sont les suivantes :
- “Autorisation”
- “Set-Cookie”
Les valeurs non valides comprennent :
- ”:method” - “ :” est un caractère non valide Cela signifie que les pseudo-en-têtes HTTP/2 ne sont actuellement pas pris en charge par ce type.
- ”/invalid” - “/ ” est un caractère non valide
HTTPMatch
(Apparaît sur :HTTPSpecifiers)
HTTPMatch définit les correspondances HTTP à utiliser pour les vérifications HealthCheck.
Champ | Description |
---|---|
body chaîne |
(Facultatif)
Body définit les correspondances de corps HTTP à utiliser pour les vérifications HealthCheck. |
statusCodes []StatusCodes |
(Facultatif)
StatusCodes définit les correspondances de code d’état HTTP à utiliser pour les vérifications HealthCheck. |
HTTPPathModifier
(Apparaît sur :Redirect, URLRewriteFilter)
HTTPPathModifier définit la configuration des modificateurs de chemin d’accès.
Champ | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type HTTPPathModifierType |
Type définit le type de modificateur de chemin d’accès. Davantage de types pourront être ajoutés dans une prochaine version de l’API. Des valeurs peuvent être ajoutées à cette énumération ; les implémentations doivent s’assurer que les valeurs inconnues ne provoqueront pas d’incident. Les valeurs inconnues ici doivent entraîner la définition, par l’implémentation, de la condition Accepted pour que la règle soit false |
||||||||||||||||||||||||||||||||||||||||||||||||
replaceFullPath chaîne |
(Facultatif)
ReplaceFullPath spécifie la valeur par laquelle remplacer le chemin d’accès complet d’une requête lors d’une réécriture ou d’une redirection. |
||||||||||||||||||||||||||||||||||||||||||||||||
replacePrefixMatch chaîne |
(Facultatif)
ReplacePrefixMatch spécifie la valeur par laquelle remplacer la correspondance de préfixe d’une requête lors d’une réécriture ou d’une redirection. Par exemple, une requête à “/foo/bar” avec une correspondance de préfixe “/foo” et un ReplacePrefixMatch de “/xyz” sera remplacée par “/xyz/bar”. Cela correspond au comportement du type de correspondance PathPrefix. Cela correspond aux éléments de chemin d’accès complets. Un élément de chemin d’accès fait référence à la liste des étiquettes dans le chemin d’accès divisé par le séparateur ReplacePrefixMatch n’est compatible qu’avec un httpRouteMatch
|
HTTPPathModifierType (alias string
)
(Apparaît sur :HTTPPathModifier)
HTTPPathModifierType définit le type de redirection ou de réécriture du chemin d’accès.
Valeur | Description |
---|---|
"ReplaceFullPath" |
FullPathHTTPPathModifier remplace le chemin d’accès complet par la valeur spécifiée. |
"ReplacePrefixMatch" |
PrefixMatchHTTPPathModifier remplace tout chemin de préfixe par la valeur de substitution. Par exemple, un chemin d’accès avec une correspondance de préfixe de “/foo” et une substitution ReplacePrefixMatch de “/bar” remplace “/foo” par “/bar” dans les requêtes correspondantes. Cela correspond au comportement du type de correspondance PathPrefix. Cela correspond aux éléments de chemin d’accès complets. Un élément de chemin d’accès fait référence à la liste des étiquettes dans le chemin d’accès divisé par le séparateur |
HTTPSpecifiers
(Apparaît sur :HealthCheckPolicyConfig)
HTTPSpecifiers définit le schéma pour la spécification du contrôle HealthCheck HTTP.
Champ | Description |
---|---|
host chaîne |
(Facultatif)
Host est la valeur d’en-tête de l’hôte à utiliser pour les vérifications HealthCheck. |
path chaîne |
(Facultatif)
Path est le chemin d’accès à utiliser pour les vérifications HealthCheck. |
match HTTPMatch |
(Facultatif)
Match définit les correspondances HTTP à utiliser pour les vérifications HealthCheck. |
HeaderFilter
(Apparaît sur :IngressRewrites)
HeaderFilter définit un filtre qui modifie les en-têtes d’une requête ou d’une réponse HTTP. Une seule action pour un nom d’en-tête donné est autorisée. Les filtres spécifiant plusieurs actions du même type ou de types différents pour un même nom d’en-tête sont non valides et sont rejetés. La configuration permettant de définir ou d’ajouter plusieurs valeurs pour un en-tête doit utiliser la mise en forme de valeur d’en-tête RFC 7230, en séparant chaque valeur par une virgule.
Champ | Description |
---|---|
set []HTTPHeader |
(Facultatif)
Set remplace la requête par l’en-tête donné (nom, valeur) avant l’action. Entrée : GET /foo HTTP/1.1 my-header: foo Config : set: - name: “my-header” value: “bar” Sortie : GET /foo HTTP/1.1 my-header: bar |
add []HTTPHeader |
(Facultatif)
Add ajoute le ou les en-têtes donnés (nom, valeur) à la requête avant l’action. Il ajoute à toutes les valeurs existantes associées au nom d’en-tête. Entrée : GET /foo HTTP/1.1 my-header: foo Config : add: - name “my-header” value: “bar,baz” Sortie : GET /foo HTTP/1.1 my-header: foo,bar,baz |
remove []chaîne |
(Facultatif)
Remove supprime le ou les en-têtes donnés de la requête HTTP avant l’action. La valeur de Remove est une liste de noms d’en-tête HTTP. Les noms d’en-tête ne respectent pas la casse (consultez https://datatracker.ietf.org/doc/html/rfc2616#section-4.2). Entrée : GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz Config : remove: [“my-header1”, “my-header3”] Sortie : GET /foo HTTP/1.1 my-header2: bar |
HeaderName (alias string
)
HeaderName est le nom d’un paramètre de requête ou d’un en-tête.
HealthCheckPolicy
HealthCheckPolicy est le schéma pour l’API HealthCheckPolicy.
Champ | Description | ||||||
---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
(Facultatif)
Métadonnées de l’objet. Reportez-vous à la documentation de l’API Kubernetes pour connaître les champs du champmetadata .
|
||||||
spec HealthCheckPolicySpec |
Spec est la spécification HealthCheckPolicy.
|
||||||
status HealthCheckPolicyStatus |
Status définit l’état actuel de HealthCheckPolicy. |
HealthCheckPolicyConditionReason (alias string
)
HealthCheckPolicyConditionReason définit l’ensemble des raisons qui expliquent pourquoi un type de condition HealthCheckPolicy particulier est déclenché.
Valeur | Description |
---|---|
« BackendTLSPolicyNotFound » |
BackendTLSPolicyConditionNotFound est utilisé quand BackendTLSPolicy est introuvable pour le service. |
"Accepted" |
HealthCheckPolicyReasonAccepted est utilisé pour définir HealthCheckPolicyConditionReason sur Accepted. Quand la HealthCheckPolicy donnée est configurée correctement. |
"InvalidHealthCheckPolicy" |
HealthCheckPolicyReasonInvalid est la raison quand la HealthCheckPolicy n’est pas acceptée (Accepted). |
"InvalidGroup" |
HealthCheckPolicyReasonInvalidGroup est utilisé quand le groupe est non valide. |
"InvalidKind" |
HealthCheckPolicyReasonInvalidKind est utilisé quand le type/groupe est non valide. |
"InvalidName" |
HealthCheckPolicyReasonInvalidName est utilisé quand le nom est non valide. |
"InvalidPort" |
HealthCheckPolicyReasonInvalidPort est utilisé quand le port est non valide. |
"InvalidService" |
HealthCheckPolicyReasonInvalidService est utilisé quand le service est non valide. |
"NoTargetReference" |
HealthCheckPolicyReasonNoTargetReference est utilisé quand il n’existe pas de référence cible. |
"OverrideNotSupported" |
HealthCheckPolicyReasonOverrideNotSupported est utilisé quand le remplacement n’est pas pris en charge. |
"RefNotPermitted" |
HealthCheckPolicyReasonRefNotPermitted est utilisé quand la référence n’est pas autorisée. |
"SectionNamesNotPermitted" |
HealthCheckPolicyReasonSectionNamesNotPermitted est utilisé quand les noms de section ne sont pas autorisés. |
HealthCheckPolicyConditionType (alias string
)
HealthCheckPolicyConditionType est un type de condition associé à HealthCheckPolicy. Ce type doit être utilisé avec le champ HealthCheckPolicyStatus.Conditions.
Valeur | Description |
---|---|
"Accepted" |
HealthCheckPolicyConditionAccepted est utilisé pour définir HealthCheckPolicyConditionType sur Accepted. |
"ResolvedRefs" |
HealthCheckPolicyConditionResolvedRefs est utilisé pour définir HealthCheckPolicyCondition sur ResolvedRefs. |
HealthCheckPolicyConfig
(Apparaît sur :HealthCheckPolicySpec)
HealthCheckPolicyConfig définit le schéma pour la spécification du contrôle HealthCheck.
Champ | Description |
---|---|
interval Kubernetes meta/v1.Duration |
(Facultatif)
Interval est le nombre de secondes entre les vérifications HealthCheck. |
timeout Kubernetes meta/v1.Duration |
(Facultatif)
HealthCheck est le nombre de secondes après lesquelles la vérification HealthCheck est considérée comme ayant échoué. |
port int32 |
(Facultatif)
Port est le port à utiliser pour les vérifications HealthCheck. |
unhealthyThreshold int32 |
(Facultatif)
UnhealthyThreshold est le nombre de contrôles HealthCheck consécutifs ayant échoué. |
healthyThreshold int32 |
(Facultatif)
HealthyThreshold est le nombre de contrôles HealthCheck consécutifs ayant réussi. |
useTLS bool |
(Facultatif)
UseTLS indique si le contrôle d’intégrité doit appliquer le protocole TLS. Par défaut, le contrôle d’intégrité va utiliser le même protocole que le service si le même port est utilisé pour le contrôle d’intégrité. Si le port est différent, le contrôle d’intégrité sera en texte en clair. |
http HTTPSpecifiers |
(Facultatif)
HTTP définit la spécification de contrainte HTTP pour la vérification HealthCheck d’une ressource cible. |
grpc GRPCSpecifiers |
GRPC configure un contrôle d’intégrité gRPC v1 (https://github.com/grpc/grpc-proto/blob/master/grpc/health/v1/health.proto) sur la ressource cible. |
HealthCheckPolicySpec
(Apparaît sur :HealthCheckPolicy)
HealthCheckPolicySpec définit l’état souhaité de HealthCheckPolicy.
Champ | Description |
---|---|
targetRef CustomTargetRef |
TargetRef identifie un objet API auquel appliquer la stratégie. |
override HealthCheckPolicyConfig |
(Facultatif)
Override définit la configuration de stratégie qui doit remplacer la configuration de stratégie attachée sous la ressource ciblée dans la hiérarchie. Remarque : le remplacement n’est actuellement pas pris en charge et génère une erreur de validation. La prise en charge du remplacement sera ajoutée dans une version ultérieure. |
default HealthCheckPolicyConfig |
(Facultatif)
Default définit la configuration de stratégie par défaut pour la ressource ciblée. |
HealthCheckPolicyStatus
(Apparaît sur :HealthCheckPolicy)
HealthCheckPolicyStatus définit l’état observé de HealthCheckPolicy.
Champ | Description |
---|---|
conditions []Kubernetes meta/v1.Condition |
(Facultatif)
conditions décrit les conditions actuelles de HealthCheckPolicy. Les implémentations doivent préférer exprimer des conditions HealthCheckPolicy à l’aide des constantes Les types de conditions connues sont les suivants :
|
IngressBackendPort
(Apparaît sur :IngressBackendSettings)
IngressBackendPort décrit un port sur un back-end. Un seul nom/numéro doit être défini.
Champ | Description |
---|---|
port int32 |
(Facultatif)
Port indique le port sur le service back-end |
name chaîne |
(Facultatif)
Name doit faire référence à un nom sur un port sur le service back-end |
protocol Protocol |
Le protocole doit être “HTTP”, “HTTPS” |
IngressBackendSettingStatus
(Apparaît sur :IngressExtensionStatus)
IngressBackendSettingStatus décrit l’état d’un BackendSetting
Champ | Description |
---|---|
service chaîne |
Service identifie le BackendSetting décrit par cet état |
validationErrors []chaîne |
(Facultatif)
Les erreurs sont une liste d’erreurs relatives à ce paramètre |
valid bool |
Valid indique qu’aucune erreur de validation n’est présente sur ce BackendSetting |
IngressBackendSettings
(Apparaît sur :IngressExtensionSpec)
IngressBackendSettings fournit des options de configuration étendues pour un service back-end
Champ | Description |
---|---|
service chaîne |
Service est le nom d’un service back-end auquel cette configuration s’applique |
ports []IngressBackendPort |
(Facultatif)
Port peut être utilisé pour indiquer si le service back-end écoute sur HTTP ou HTTPS |
trustedRootCertificate chaîne |
(Facultatif)
TrustedRootCertificate peut être utilisé pour fournir un certificat pouvant être approuvé par la passerelle lors de la communication avec le back-end sur un port spécifié en tant que https |
sessionAffinity SessionAffinity |
(Facultatif)
SessionAffinity permet aux requêtes clientes d’être données de manière cohérente au même back-end |
timeouts IngressTimeouts |
(Facultatif)
Timeouts définit un ensemble de paramètres de délai d’expiration à appliquer à une entrée |
IngressExtension
IngressExtension est le schéma de l’API IngressExtension
Champ | Description | ||||
---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
(Facultatif)
Métadonnées de l’objet. Reportez-vous à la documentation de l’API Kubernetes pour connaître les champs du champmetadata .
|
||||
spec IngressExtensionSpec |
Spec est la spécification IngressExtension.
|
||||
status IngressExtensionStatus |
IngressExtensionConditionReason (alias string
)
IngressExtensionConditionReason définit l’ensemble des raisons qui expliquent pourquoi un type de condition IngressExtension particulier est déclenché.
Valeur | Description |
---|---|
"Accepted" |
IngressExtensionReasonAccepted est utilisé pour définir IngressExtensionConditionAccepted sur Accepted |
"HasValidationErrors" |
IngressExtensionReasonHasErrors indique qu’il existe des erreurs de validation |
"NoValidationErrors" |
IngressExtensionReasonNoErrors indique qu’il n’existe aucune erreur de validation |
"PartiallyAcceptedWithErrors" |
IngressExtensionReasonPartiallyAccepted est utilisé pour définir IngressExtensionConditionAccepted sur Accepté, mais avec des erreurs de validation non irrécupérables |
IngressExtensionConditionType (alias string
)
IngressExtensionConditionType est un type de condition associé à une IngressExtension. Ce type doit être utilisé avec le champ IngressExtensionStatus.Conditions.
Valeur | Description |
---|---|
"Accepted" |
IngressExtensionConditionAccepted indique si le ingressExtension est accepté (réconciliée) par le contrôleur |
"Errors" |
IngressExtensionConditionErrors indique s’il existe des erreurs de validation ou de build sur l’extension |
IngressExtensionSpec
(Apparaît sur :IngressExtension)
IngressExtensionSpec définit la configuration souhaitée d’IngressExtension
Champ | Description |
---|---|
rules []IngressRuleSetting |
(Facultatif)
Les règles définissent les règles par hôte |
backendSettings []IngressBackendSettings |
(Facultatif)
BackendSettings définit un ensemble d’options de configuration pour les back-ends du service d’entrée |
IngressExtensionStatus
(Apparaît sur :IngressExtension)
IngressExtensionStatus décrit l’état actuel de l’ingressExtension
Champ | Description |
---|---|
rules []IngressRuleStatus |
(Facultatif)
Les règles contiennent des informations détaillées sur l’état de chaque règle |
backendSettings []IngressBackendSettingStatus |
(Facultatif)
BackendSettings contient des informations détaillées sur l’état de chaque BackendSettings |
conditions []Kubernetes meta/v1.Condition |
(Facultatif)
conditions décri les conditions actuelles de l’IngressExtension. Les types de conditions connues sont les suivants :
|
IngressRewrites
(Apparaît sur :IngressRuleSetting)
IngressRewrites fournit les différentes réécritures prises en charge sur une règle
Champ | Description |
---|---|
type RewriteType |
Type identifie le type de réécriture |
requestHeaderModifier HeaderFilter |
(Facultatif)
RequestHeaderModifier définit un schéma qui modifie des en-têtes de requête. |
responseHeaderModifier HeaderFilter |
(Facultatif)
RequestHeaderModifier définit un schéma qui modifie des en-têtes de réponse. |
urlRewrite URLRewriteFilter |
(Facultatif)
URLRewrite définit un schéma qui modifie une requête pendant le transfert. |
IngressRuleSetting
(Apparaît sur :IngressExtensionSpec)
IngressRuleSetting fournit des options de configuration pour des règles
Champ | Description |
---|---|
host chaîne |
Host est utilisé pour la mise en correspondance avec les règles d’entrée ayant le même nom d’hôte, afin d’identifier quelles règles sont affectées par ces paramètres |
additionalHostnames []chaîne |
(Facultatif)
AdditionalHostnames spécifie des noms d’hôte supplémentaires sur lesquels écouter |
rewrites []IngressRewrites |
(Facultatif)
Rewrites définit les réécritures pour la règle |
requestRedirect Redirect |
(Facultatif)
RequestRedirect définit le comportement de redirection pour la règle |
IngressRuleStatus
(Apparaît sur :IngressExtensionStatus)
IngressRuleStatus décrit l’état d’une règle
Champ | Description |
---|---|
host chaîne |
Host identifie la règle décrite par cet état |
validationErrors []chaîne |
(Facultatif)
Les erreurs sont une liste d’erreurs relatives à ce paramètre |
valid bool |
(Facultatif)
Valid indique qu’aucune erreur de validation n’est présente sur cette règle |
IngressTimeouts
(Apparaît sur :IngressBackendSettings)
IngressTimeouts peut être utilisé pour configurer les propriétés de délai d’expiration d’une Ingress
Champ | Description |
---|---|
requestTimeout Kubernetes meta/v1.Duration |
(Facultatif)
RequestTimeout définit le délai d’expiration utilisé par l’équilibreur de charge lors du transfert de requêtes vers un service back-end |
MTLSPolicyVerify
(Apparaît sur :FrontendTLSPolicyConfig)
MTLSPolicyVerify définit le schéma pour l’API MTLSPolicyVerify.
Champ | Description |
---|---|
caCertificateRef Gateway API .SecretObjectReference |
CaCertificateRef est le certificat d’autorité de certification utilisé pour vérifier le certificat du pair. |
subjectAltNames []chaîne |
(Facultatif)
SubjectAltNames est la liste des autres noms de l’objet utilisés pour vérifier le certificat du pair. |
PolicyType
(Apparaît sur :FrontendTLSPolicyConfig)
PolicyType est le type de la stratégie.
Champ | Description |
---|---|
name FrontendTLSPolicyTypeName |
Name est le nom de la stratégie. |
type FrontendTLSPolicyType |
PredefinedFrontendTLSPolicyType est le type de la stratégie TLS front-end prédéfinie. |
PortNumber (alias int32
)
(Apparaît sur :Redirect)
PortNumber définit un port réseau.
PreciseHostname (alias string
)
(Apparaît sur :Redirect, URLRewriteFilter)
PreciseHostname est le nom de domaine complet d’un hôte réseau. Cela correspond à la définition RFC 1123 d’un nom d’hôte, avec une exception notable : les adresses IP numériques ne sont pas autorisées.
D’après la RFC1035 et la RFC1123, une étiquette doit contenir des caractères alphanumériques en minuscules ou ‘-’, et doit commencer et se terminer par un caractère alphanumérique. Aucune autre ponctuation n’est autorisée.
Protocol (alias string
)
(Apparaît sur :IngressBackendPort)
Protocol définit le protocole utilisé pour certaines propriétés. Les valeurs Protocol valides sont les suivantes :
- HTTP
- HTTPS
- TCP
Valeur | Description |
---|---|
"HTTP" |
ProtocolHTTP implique que le service utilise HTTP. |
« HTTPS » |
ProtocolHTTPS implique que le service utilise HTTPS. |
"TCP" |
ProtocolTCP implique que le service utilise le protocole TCP en clair. |
Rediriger
(Apparaît sur :IngressRuleSetting)
Redirect définit un filtre qui redirige une requête. Cela NE DOIT PAS être utilisé sur une règle qui a également un URLRewriteFilter.
Champ | Description |
---|---|
scheme chaîne |
(Facultatif)
Scheme est le schéma à utiliser dans la valeur de l’en-tête |
hostname PreciseHostname |
(Facultatif)
Hostname est le nom d’hôte à utiliser dans la valeur de l’en-tête |
path HTTPPathModifier |
(Facultatif)
Path définit les paramètres utilisés pour modifier le chemin d’accès de la requête entrante.
Le chemin d’accès modifié est ensuite utilisé pour construire l’en-tête |
port PortNumber |
(Facultatif)
Port est le port à utiliser dans la valeur de l’en-tête Si aucun port n’est spécifié, le port de redirection DOIT être dérivé à l’aide des règles suivantes :
Les implémentations NE DOIVENT PAS ajouter le numéro de port dans l’en-tête ‘Location’ dans les cas suivants :
|
statusCode int |
(Facultatif)
StatusCode est le code d’état HTTP à utiliser dans la réponse. Des valeurs peuvent être ajoutées à cette énumération. Les implémentations doivent s’assurer que les valeurs inconnues ne provoqueront pas d’incident. |
RewriteType (alias string
)
(Apparaît sur :IngressRewrites)
RewriteType identifie le type de réécriture
Valeur | Description |
---|---|
"RequestHeaderModifier" |
RequestHeaderModifier peut être utilisé pour ajouter ou supprimer un en-tête HTTP d’une requête HTTP avant son envoi à la cible en amont. |
"ResponseHeaderModifier" |
ResponseHeaderModifier peut être utilisé pour ajouter ou supprimer un en-tête HTTP d’une réponse HTTP avant son envoi au client. |
"URLRewrite" |
URLRewrite peut être utilisé pour modifier une requête pendant le transfert. |
RoutePolicy
RoutePolicy est le schéma pour l’API RoutePolicy.
Champ | Description | ||||||
---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
(Facultatif)
Métadonnées de l’objet. Reportez-vous à la documentation de l’API Kubernetes pour connaître les champs du champmetadata .
|
||||||
spec RoutePolicySpec |
Spec est la spécification RoutePolicy.
|
||||||
status RoutePolicyStatus |
Status définit l’état actuel de RoutePolicy. |
RoutePolicyConditionReason (alias string
)
RoutePolicyConditionReason définit l’ensemble des raisons qui expliquent pourquoi un type de condition RoutePolicy particulier est déclenché.
Valeur | Description |
---|---|
"Accepted" |
RoutePolicyReasonAccepted est utilisé pour définir RoutePolicyConditionReason sur Accepted lorsque la RoutePolicy donnée est configurée correctement |
"InvalidRoutePolicy" |
RoutePolicyReasonInvalid est la raison pour laquelle RoutePolicy n’est pas Accepted |
« InvalidGRPCRoute » |
RoutePolicyReasonInvalidGRPCRoute est utilisé quand GRPCRoute est non valide. |
"InvalidGroup" |
RoutePolicyReasonInvalidGroup est utilisé lorsque le groupe n’est pas valide |
"InvalidHTTPRoute" |
RoutePolicyReasonInvalidHTTPRoute est utilisé lorsque HTTPRoute n’est pas valide |
"InvalidKind" |
RoutePolicyReasonInvalidKind est utilisé lorsque le type/groupe n’est pas valide |
"InvalidName" |
RoutePolicyReasonInvalidName est utilisé lorsque le nom n’est pas valide |
"NoTargetReference" |
RoutePolicyReasonNoTargetReference est utilisé lorsqu’il n’existe aucune référence cible |
"OverrideNotSupported" |
RoutePolicyReasonOverrideNotSupported est utilisé lorsque le remplacement n’est pas pris en charge |
"RefNotPermitted" |
RoutePolicyReasonRefNotPermitted est utilisé lorsque la référence n’est pas autorisée |
"SectionNamesNotPermitted" |
RoutePolicyReasonSectionNamesNotPermitted est utilisé lorsque les noms de section ne sont pas autorisés |
RoutePolicyConditionType (alias string
)
RoutePolicyConditionType est un type de condition associé à une RoutePolicy. Ce type doit être utilisé avec le champ RoutePolicyStatus.Conditions.
Valeur | Description |
---|---|
"Accepted" |
RoutePolicyConditionAccepted est utilisé pour définir RoutePolicyConditionType sur Accepted |
"ResolvedRefs" |
RoutePolicyConditionResolvedRefs est utilisé pour définir RoutePolicyCondition sur ResolvedRefs |
RoutePolicyConfig
(Apparaît sur :RoutePolicySpec)
RoutePolicyConfig définit le schéma pour la spécification RoutePolicy. Cela permet la spécification des attributs suivants : * Délais d’expiration * Affinité de session
Champ | Description |
---|---|
timeouts RouteTimeouts |
(Facultatif)
Délais d’expiration personnalisés pour la ressource cible. |
sessionAffinity SessionAffinity |
SessionAffinity définit le schéma pour la spécification Session Affinity |
RoutePolicySpec
(Apparaît sur :RoutePolicy)
RoutePolicySpec définit l’état souhaité de RoutePolicy.
Champ | Description |
---|---|
targetRef CustomTargetRef |
TargetRef identifie un objet API auquel appliquer la stratégie. |
override RoutePolicyConfig |
(Facultatif)
Override définit la configuration de stratégie qui doit remplacer la configuration de stratégie attachée sous la ressource ciblée dans la hiérarchie. Remarque : le remplacement n’est actuellement pas pris en charge et génère une erreur de validation. La prise en charge du remplacement sera ajoutée dans une version ultérieure. |
default RoutePolicyConfig |
(Facultatif)
Default définit la configuration de stratégie par défaut pour la ressource ciblée. |
RoutePolicyStatus
(Apparaît sur :RoutePolicy)
RoutePolicyStatus définit l’état observé de RoutePolicy.
Champ | Description |
---|---|
conditions []Kubernetes meta/v1.Condition |
(Facultatif)
conditions décrit les conditions actuelles de RoutePolicy. Les implémentations doivent préférer exprimer des conditions RoutePolicy à l’aide des constantes Les types de conditions connues sont les suivants :
|
RouteTimeouts
(Apparaît sur :RoutePolicyConfig)
RouteTimeouts définit le schéma pour la spécification Timeouts.
Champ | Description |
---|---|
routeTimeout Kubernetes meta/v1.Duration |
(Facultatif)
RouteTimeout est le délai d’expiration pour la route. |
SessionAffinity
(Apparaît sur :IngressBackendSettings, RoutePolicyConfig)
SessionAffinity définit le schéma pour la spécification d’affinité de session.
Champ | Description |
---|---|
affinityType AffinityType |
|
cookieName chaîne |
(Facultatif) |
cookieDuration Kubernetes meta/v1.Duration |
(Facultatif) |
StatusCodes
(Apparaît sur :HTTPMatch)
StatusCodes définit les correspondances de code d’état HTTP à utiliser pour les vérifications HealthCheck.
Champ | Description |
---|---|
start int32 |
(Facultatif)
Start définit le début de la plage de codes d’état à utiliser pour les vérifications HealthCheck. Ceci est inclusif. |
end int32 |
(Facultatif)
End définit la fin de la plage de codes d’état à utiliser pour les vérifications HealthCheck. Ceci est inclusif. |
URLRewriteFilter
(Apparaît sur :IngressRewrites)
URLRewriteFilter définit un filtre qui modifie une requête pendant le transfert. Un de ces filtres au plus peut être utilisé sur une règle. NE DOIT PAS être utilisé sur une règle ayant un sslRedirect.
Champ | Description |
---|---|
hostname PreciseHostname |
(Facultatif)
Hostname est la valeur à utiliser pour remplacer la valeur d’en-tête de l’hôte pendant le transfert. |
path HTTPPathModifier |
(Facultatif)
Path définit une réécriture de chemin d’accès. |