Compartir a través de


Especificación de la API de Puerta de enlace de aplicaciones para contenedores para Kubernetes

Paquetes

Package v1 es la versión v1 de la API.

alb.networking.azure.io/v1

En este documento se define cada uno de los tipos de recursos para alb.networking.azure.io/v1.

Tipos de recursos:

AffinityType (alias string)

(Aparece en:SessionAffinity)

AffinityType define el tipo de afinidad para el servicio.

Value Descripción

"application-cookie"

AffinityTypeApplicationCookie es un tipo de afinidad de sesión de una cookie de aplicación.

"managed-cookie"

AffinityTypeManagedCookie es un tipo de afinidad de sesión de una cookie administrada.

AlbConditionReason (alias string)

AlbConditionReason define el conjunto de motivos que explican por qué se ha generado un tipo de condición determinado en el recurso de Puerta de enlace de aplicaciones para contenedores.

Valor Descripción

"Accepted"

AlbReasonAccepted indica que el controlador ha aceptado el recurso de Puerta de enlace de aplicaciones para contenedores.

"Ready"

AlbReasonDeploymentReady indica el estado de implementación de recursos de Puerta de enlace de aplicaciones para contenedores.

"InProgress"

AlbReasonInProgress indica si el recurso de Puerta de enlace de aplicaciones para contenedores está en proceso de creación, actualización o eliminación.

AlbConditionType (alias string)

AlbConditionType es un tipo de condición asociada a un recurso de Puerta de enlace de aplicaciones para contenedores. Este tipo debe usarse con el campo AlbStatus.Conditions.

Value Descripción

"Accepted"

AlbConditionTypeAccepted indica si el controlador ha aceptado el recurso de Puerta de enlace de aplicaciones para contenedores.

“Implementación”

AlbConditionTypeDeployment indica el estado de implementación del recurso de Puerta de enlace de aplicaciones para contenedores.

AlbSpec

(Aparece en:ApplicationLoadBalancer)

AlbSpec define las especificaciones del recurso Puerta de enlace de aplicaciones para contenedores.

Campo Descripción
associations
[]cadena

Las asociaciones son identificadores de recursos de subred a los que se asociará el recurso de Puerta de enlace de aplicaciones para contenedores.

AlbStatus

(Aparece en:ApplicationLoadBalancer)

AlbStatus define el estado observado del recurso de Puerta de enlace de aplicaciones para contenedores.

Campo Descripción
conditions
[]Kubernetes meta/v1.Condition
(Opcional)

Los tipos de condición conocidos son:

  • “Aceptado”
  • “Preparado”

ApplicationLoadBalancer

ApplicationLoadBalancer es el esquema del recurso de Puerta de enlace de aplicaciones para contenedores.

Campo Descripción
metadata
Kubernetes meta/v1.ObjectMeta
(Opcional)

Metadatos del objeto’.

Consulte la documentación de la API de Kubernetes para conocer los campos del campo metadata.
spec
AlbSpec

Spec es la especificación del recurso de Puerta de enlace de aplicaciones para contenedores.



associations
[]cadena

Las asociaciones son identificadores de recursos de subred a los que se asociará el recurso de Puerta de enlace de aplicaciones para contenedores.

status
AlbStatus

Status define el estado actual del recurso de Puerta de enlace de aplicaciones para contenedores.

BackendTLSPolicy

BackendTLSPolicy es el esquema de la API BackendTLSPolicys.

Campo Descripción
metadata
Kubernetes meta/v1.ObjectMeta
(Opcional)

Metadatos del objeto’.

Consulte la documentación de la API de Kubernetes para conocer los campos del campo metadata.
spec
BackendTLSPolicySpec

Spec es la especificación BackendTLSPolicy.



targetRef
CustomTargetRef

TargetRef identifica un objeto de API al que se va a aplicar la directiva.

override
BackendTLSPolicyConfig
(Opcional)

Override define la configuración de directiva que debe invalidar la configuración de directiva asociada debajo del recurso de destino en la jerarquía.

Nota: La invalidación no se admite actualmente y producirá un error de validación. La compatibilidad con la invalidación se agregará en una versión futura.

default
BackendTLSPolicyConfig
(Opcional)

Default define la configuración de directiva predeterminada para el recurso de destino.

status
BackendTLSPolicyStatus

Status define el estado actual de BackendTLSPolicy.

BackendTLSPolicyConditionReason (alias string)

BackendTLSPolicyConditionReason define el conjunto de motivos que explican por qué se ha generado un tipo de condición BackendTLSPolicy determinado.

Valor Descripción

"Accepted"

BackendTLSPolicyReasonAccepted se usa para establecer BackendTLSPolicyConditionReason en Accepted cuando el BackendTLSPolicy dado esté configurado correctamente.

"InvalidBackendTLSPolicy"

BackendTLSPolicyReasonInvalid es la razón por la que BackendTLSPolicy no se establece en Accepted.

"InvalidCertificateRef"

BackendTLSPolicyReasonInvalidCertificateRef se usa cuando se hace referencia a un certificado no válido.

"InvalidGroup"

BackendTLSPolicyReasonInvalidGroup se usa cuando el grupo no es válido.

"InvalidKind"

BackendTLSPolicyReasonInvalidKind se usa cuando el tipo o grupo no es válido.

"InvalidName"

BackendTLSPolicyReasonInvalidName se usa cuando el nombre no es válido.

"InvalidSecret"

BackendTLSPolicyReasonInvalidSecret se usa cuando el secreto no es válido.

"InvalidService"

BackendTLSPolicyReasonInvalidService se usa cuando el servicio no es válido.

"NoTargetReference"

BackendTLSPolicyReasonNoTargetReference se usa cuando no hay ninguna referencia de destino.’

"OverrideNotSupported"

BackendTLSPolicyReasonOverrideNotSupported se usa cuando la invalidación no se admite.’

"RefNotPermitted"

BackendTLSPolicyReasonRefNotPermitted se usa cuando no se permite la referencia.

"SectionNamesNotPermitted"

BackendTLSPolicyReasonSectionNamesNotPermitted se usa cuando no se permiten los nombres de sección.’

BackendTLSPolicyConditionType (alias string)

BackendTLSPolicyConditionType es un tipo de condición asociada a BackendTLSPolicy. Este tipo debe usarse con el campo BackendTLSPolicyStatus.Conditions.

Value Descripción

"Accepted"

BackendTLSPolicyConditionAccepted se usa para establecer BackendTLSPolicyConditionType como Aceptado.

"ResolvedRefs"

BackendTLSPolicyConditionResolvedRefs se usa para establecer BackendTLSPolicyCondition en ResolvedRefs.

BackendTLSPolicyConfig

(Aparece en:BackendTLSPolicySpec)

BackendTLSPolicyConfig define la especificación de directiva para la directiva TLS de back-end.

Campo Descripción
CommonTLSPolicy
CommonTLSPolicy

(Los miembros de CommonTLSPolicy se insertan en este tipo).

sni
string
(Opcional)

Sni es el nombre del servidor que se va a usar para la conexión TLS al back-end.

ports
[]BackendTLSPolicyPort

Ports especifica la lista de puertos en los que se aplica la directiva.

clientCertificateRef
API de puerta de enlace .SecretObjectReference
(Opcional)

ClientCertificateRef es la referencia al certificado de cliente que se va a usar para la conexión TLS al back-end.

BackendTLSPolicyPort

(Aparece en:BackendTLSPolicyConfig)

BackendTLSPolicyPort define el puerto que se va a usar para la conexión TLS al back-end

Campo Descripción
port
int

Port es el puerto que se va a usar para la conexión TLS al back-end.

BackendTLSPolicySpec

(Aparece en:BackendTLSPolicy)

BackendTLSPolicySpec define el estado deseado de BackendTLSPolicy.

Campo Descripción
targetRef
CustomTargetRef

TargetRef identifica un objeto de API al que se va a aplicar la directiva.

override
BackendTLSPolicyConfig
(Opcional)

Override define la configuración de directiva que debe invalidar la configuración de directiva asociada debajo del recurso de destino en la jerarquía.

Nota: La invalidación no se admite actualmente y producirá un error de validación. La compatibilidad con la invalidación se agregará en una versión futura.

default
BackendTLSPolicyConfig
(Opcional)

Default define la configuración de directiva predeterminada para el recurso de destino.

BackendTLSPolicyStatus

(Aparece en:BackendTLSPolicy)

BackendTLSPolicyStatus define el estado observado de BackendTLSPolicy.

Campo Descripción
conditions
[]Kubernetes meta/v1.Condition
(Opcional)

Conditions describe las condiciones actuales de BackendTLSPolicy.

Las implementaciones deben preferir expresar las condiciones BackendTLSPolicy mediante las constantes BackendTLSPolicyConditionType y BackendTLSPolicyConditionReason para que los operadores y las herramientas puedan converger en un vocabulario común para describir el estado de BackendTLSPolicy.

Los tipos de condición conocidos son:

  • “Aceptado”

CommonTLSPolicy

(Aparece en:BackendTLSPolicyConfig)

CommonTLSPolicy es el esquema de la API CommonTLSPolicy.

Campo Descripción
verify
CommonTLSPolicyVerify
(Opcional)

Verify proporciona las opciones para comprobar el certificado del mismo nivel.

CommonTLSPolicyVerify

(Aparece en:CommonTLSPolicy)

CommonTLSPolicyVerify define el esquema de la API CommonTLSPolicyVerify.

Campo Descripción
caCertificateRef
API de puerta de enlace .SecretObjectReference

CaCertificateRef es el certificado de entidad de certificación que se usa para comprobar el certificado del mismo nivel.

subjectAltName
string
(Opcional)

SubjectAltName es el nombre alternativo del firmante que se usa para comprobar el certificado del mismo nivel.

CustomTargetRef

(Aparece en:BackendTLSPolicySpec, FrontendTLSPolicySpec, HealthCheckPolicySpec, RoutePolicySpec)

CustomTargetRef es una referencia a un recurso personalizado que no forma parte de la API principal de Kubernetes.

Campo Descripción
NamespacedPolicyTargetReference
Gateway API alpha2.NamespacedPolicyTargetReference

(Los miembros de NamespacedPolicyTargetReference se insertan en este tipo).

sectionNames
[]cadena
(Opcional)

SectionNames es el nombre de la sección dentro del recurso de destino. Cuando no se especifica, targetRef tiene como destino todo el recurso. En los siguientes recursos, SectionNames se interpreta así:

  • Puerta de enlace: nombre del agente de escucha
  • Servicio: nombre del puerto

Si se especifica SectionNames, pero no existe en el objeto de destino, la directiva no se asociará y la implementación de la directiva registrará ResolvedRefs o una condición similar en el estado de la directiva.

FrontendTLSPolicy

FrontendTLSPolicy es el esquema de la API FrontendTLSPolicy.

Campo Descripción
metadata
Kubernetes meta/v1.ObjectMeta
(Opcional)

Metadatos del objeto’.

Consulte la documentación de la API de Kubernetes para conocer los campos del campo metadata.
spec
FrontendTLSPolicySpec

Spec es la especificación frontendTLSPolicy.



targetRef
CustomTargetRef

TargetRef identifica un objeto de API al que se va a aplicar la directiva.

default
FrontendTLSPolicyConfig
(Opcional)

Default define la configuración de directiva predeterminada para el recurso de destino.

override
FrontendTLSPolicyConfig
(Opcional)

Override define la configuración de directiva que debe invalidar la configuración de directiva asociada debajo del recurso de destino en la jerarquía.

Nota: La invalidación no se admite actualmente y producirá un error de validación. La compatibilidad con la invalidación se agregará en una versión futura.

status
FrontendTLSPolicyStatus

Status define el estado actual de FrontendTLSPolicy.

FrontendTLSPolicyConditionReason (alias string)

FrontendTLSPolicyConditionReason define el conjunto de motivos que explican por qué se ha generado un tipo de condición FrontendTLSPolicy determinado.

Valor Descripción

"Accepted"

FrontendTLSPolicyReasonAccepted se usa para establecer FrontendTLSPolicyConditionReason en Accepted cuando el FrontendTLSPolicy dado esté configurado correctamente.

"InvalidFrontendTLSPolicy"

FrontendTLSPolicyReasonInvalid es la razón por la que FrontendTLSPolicy no se establece como Accepted.

"InvalidCertificateRef"

FrontendTLSPolicyReasonInvalidCertificateRef se usa cuando se hace referencia a un certificado no válido.

"InvalidDefault"

FrontendTLSPolicyReasonInvalidDefault se usa cuando el valor predeterminado no es válido

"InvalidGateway"

FrontendTLSPolicyReasonInvalidGateway se usa cuando la puerta de enlace no es válida.

"InvalidGroup"

FrontendTLSPolicyReasonInvalidGroup se usa cuando el grupo no es válido.

"InvalidKind"

FrontendTLSPolicyReasonInvalidKind se usa cuando el tipo o grupo no es válido.

"InvalidName"

FrontendTLSPolicyReasonInvalidName se usa cuando el nombre no es válido.

"InvalidPolicyName"

FrontendTLSPolicyReasonInvalidPolicyName se usa cuando el nombre de la directiva no es válido.

"InvalidPolicyType"

FrontendTLSPolicyReasonInvalidPolicyType se usa cuando el tipo de directiva no es válido.

"InvalidTargetReference"

FrontendTLSPolicyReasonInvalidTargetReference se usa cuando la referencia de destino no es válida

"NoTargetReference"

FrontendTLSPolicyReasonNoTargetReference se usa cuando no hay ninguna referencia de destino.’

"OverrideNotSupported"

FrontendTLSPolicyReasonOverrideNotSupported se usa cuando la invalidación no se admite.’

"RefNotPermitted"

FrontendTLSPolicyReasonRefNotPermitted se usa cuando no se permite la referencia.

"SectionNamesNotPermitted"

FrontendTLSPolicyReasonSectionNamesNotPermitted se usa cuando no se permiten los nombres de sección.’

FrontendTLSPolicyConditionType (alias string)

FrontendTLSPolicyConditionType es un tipo de condición asociada a FrontendTLSPolicy. Este tipo debe usarse con el campo FrontendTLSPolicyStatus.Conditions.

Value Descripción

"Accepted"

FrontendTLSPolicyConditionAccepted se usa para establecer FrontendTLSPolicyCondition en Accepted.

"ResolvedRefs"

FrontendTLSPolicyConditionResolvedRefs se usa para establecer FrontendTLSPolicyCondition en ResolvedRefs.

FrontendTLSPolicyConfig

(Aparece en:FrontendTLSPolicySpec)

FrontendTLSPolicyConfig define la especificación de directiva para la directiva TLS de front-end.

Campo Descripción
verify
MTLSPolicyVerify
(Opcional)

Verify proporciona las opciones para comprobar el certificado del mismo nivel.

policyType
PolicyType
(Opcional)

Type es el tipo de la directiva.

FrontendTLSPolicySpec

(Aparece en:FrontendTLSPolicy)

FrontendTLSPolicySpec define el estado deseado de FrontendTLSPolicy.

Campo Descripción
targetRef
CustomTargetRef

TargetRef identifica un objeto de API al que se va a aplicar la directiva.

default
FrontendTLSPolicyConfig
(Opcional)

Default define la configuración de directiva predeterminada para el recurso de destino.

override
FrontendTLSPolicyConfig
(Opcional)

Override define la configuración de directiva que debe invalidar la configuración de directiva asociada debajo del recurso de destino en la jerarquía.

Nota: La invalidación no se admite actualmente y producirá un error de validación. La compatibilidad con la invalidación se agregará en una versión futura.

FrontendTLSPolicyStatus

(Aparece en:FrontendTLSPolicy)

FrontendTLSPolicyStatus define el estado observado de FrontendTLSPolicy.

Campo Descripción
conditions
[]Kubernetes meta/v1.Condition
(Opcional)

Conditions describe las condiciones actuales de FrontendTLSPolicy.

Las implementaciones deben preferir expresar las condiciones de FrontendTLSPolicy mediante las constantes FrontendTLSPolicyConditionType y FrontendTLSPolicyConditionReason para que los operadores y las herramientas puedan converger en un vocabulario común para describir el estado de FrontendTLSPolicy.

Los tipos de condición conocidos son:

  • “Aceptado”

FrontendTLSPolicyType (alias string)

(Aparece en:PolicyType)

FrontendTLSPolicyType es el tipo de la directiva TLS de front-end.

Value Descripción

“predefinido”

PredefinedFrontendTLSPolicyType es el tipo de la directiva TLS de front-end predefinida.

FrontendTLSPolicyTypeName (string alias)

(Aparece en:PolicyType)

FrontendTLSPolicyTypeName es el nombre de la directiva TLS de front-end.

Valor Descripción

"2023-06"

PredefinedPolicy202306 es el nombre de la directiva TLS de front-end predefinida para la directiva “2023-06”.

"2023-06-S"

PredefinedPolicy202306Strict es el nombre de la directiva TLS de front-end predefinida para la directiva “2023-06-S”. Se trata de una versión estricta de la directiva “2023-06”.

GRPCSpecifiers

(Aparece en:HealthCheckPolicyConfig)

GRPCSpecifiers define el esquema de GRPC HealthCheck.

Campo Descripción
authority
string
(Opcional)

La autoridad, si está presente, se utiliza como valor del encabezado Authority en la comprobación de estado.

service
string
(Opcional)

El servicio permite la configuración de una comprobación de estado registrada bajo un nombre de servicio diferente.

HTTPHeader

(Aparece en:HeaderFilter)

HTTPHeader representa un nombre y un valor de encabezado HTTP tal como se define en RFC 7230.

Campo Descripción
name
HTTPHeaderName

Name es el nombre del encabezado HTTP que se va a hacer coincidir. La coincidencia de nombres DEBE no distinguir mayúsculas de minúsculas. (Vea https://tools.ietf.org/html/rfc7230#section-3.2).

Si varias entradas especifican nombres de encabezado equivalentes, la primera entrada con un nombre equivalente DEBE tenerse en cuenta como una coincidencia. Las entradas posteriores con un nombre de encabezado equivalente DEBEN omitirse. No se distingue entre mayúsculas y minúsculas en los nombres de encabezado, por lo que “foo” y “Foo” se consideran equivalentes.

value
string

Value es el valor del encabezado HTTP que se va a hacer coincidir.

HTTPHeaderName (alias string)

(Aparece en:HTTPHeader)

HTTPHeaderName es el nombre de un encabezado HTTP.

Los valores válidos son:

  • “Autorización”
  • “Set-Cookie”

Los valores no válidos incluyen:

  • ”:method” - “:” es un carácter no válido. Esto significa que los pseudo encabezados HTTP/2 no son compatibles actualmente con este tipo.’
  • ”/invalid” - “/ ” es un carácter no válido

HTTPMatch

(Aparece en:HTTPSpecifiers)

HTTPMatch define los buscadores de coincidencias HTTP que se usarán para las comprobaciones HealthCheck.

Campo Descripción
body
string
(Opcional)

Body define los buscadores de coincidencias de cuerpo HTTP que se usarán para las comprobaciones HealthCheck.

statusCodes
[]StatusCodes
(Opcional)

StatusCodes define los buscadores de coincidencias de código de estado HTTP que se usarán para las comprobaciones HealthCheck.

HTTPPathModifier

(Aparece en:Redireccionamiento, URLRewriteFilter)

HTTPPathModifier define la configuración de los modificadores de ruta de acceso.

Campo Descripción
type
HTTPPathModifierType

Type define el tipo de modificador de ruta de acceso. Es posible que se agreguen tipos adicionales en una versión futura de la API.

Los valores se pueden agregar a esta enumeración y las implementaciones deben asegurarse de que los valores desconocidos no provocarán un bloqueo.’

Los valores desconocidos deben dar lugar a la configuración de implementación Condición aceptada para que la regla sea False.

replaceFullPath
string
(Opcional)

ReplaceFullPath especifica el valor con el que reemplazar la ruta de acceso completa de una solicitud durante una reescritura o redirección.

replacePrefixMatch
string
(Opcional)

ReplacePrefixMatch especifica el valor con el que reemplazar la coincidencia de prefijo de una solicitud durante una reescritura o redirección. Por ejemplo, una solicitud a “/foo/bar” con una coincidencia de prefijo de “/foo” y un ReplacePrefixMatch de “/xyz” se cambiaría a “/xyz/bar”.

Esto coincide con el comportamiento del tipo de coincidencia PathPrefix. Esto coincide con los elementos de ruta de acceso completa. Un elemento de ruta de acceso hace referencia a la lista de etiquetas de la ruta de acceso dividida por el separador /. Cuando se especifica, se omite un / final. Por ejemplo, las rutas de acceso /abc, /abc/ y /abc/def coincidirían con el prefijo /abc, pero la ruta de acceso /abcd no.’

ReplacePrefixMatch solo es compatible con un PathPrefix de HTTPRouteMatch. El uso de cualquier otro tipo de HTTPRouteMatch en el mismo HTTPRouteRule dará como resultado la configuración de la implementación Condición aceptada para la ruta a status: False.

Ruta de acceso de solicitud Coincidencia de prefijo Reemplazar prefijo Ruta de acceso modificada
/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 (alias string)

(Aparece en:HTTPPathModifier)

HTTPPathModifierType define el tipo de redirección o reescritura de la ruta de acceso.

Value Descripción

"ReplaceFullPath"

FullPathHTTPPathModifier reemplaza la ruta de acceso completa por el valor especificado.

"ReplacePrefixMatch"

PrefixMatchHTTPPathModifier reemplaza cualquier ruta de acceso de prefijo por el valor de sustitución. Por ejemplo, una ruta de acceso con una coincidencia de prefijo de “/foo” y una sustitución ReplacePrefixMatch de “/bar” reemplaza “/foo” por “/bar” en las solicitudes coincidentes.

Esto coincide con el comportamiento del tipo de coincidencia PathPrefix. Esto coincide con los elementos de ruta de acceso completa. Un elemento de ruta de acceso hace referencia a la lista de etiquetas de la ruta de acceso dividida por el separador /. Cuando se especifica, se omite un / final. Por ejemplo, las rutas de acceso /abc, /abc/ y /abc/def coincidirían con el prefijo /abc, pero la ruta de acceso /abcd no.’

HTTPSpecifiers

(Aparece en:HealthCheckPolicyConfig)

HTTPSpecifiers define el esquema para la especificación de comprobación HealthCheck.

Campo Descripción
host
string
(Opcional)

Host es el valor del encabezado de host que se va a usar para las comprobaciones HealthCheck.

path
string
(Opcional)

Path es la ruta de acceso que se va a usar para las comprobaciones HealthCheck.

match
HTTPMatch
(Opcional)

Match define los buscadores de coincidencias HTTP que se usarán para las comprobaciones HealthCheck.

HeaderFilter

(Aparece en:IngressRewrites)

HeaderFilter define un filtro que modifica los encabezados de una solicitud o respuesta HTTP. Solo se permite una acción para un nombre de encabezado determinado. Los filtros que especifican varias acciones del mismo tipo o de diferente tipo de cualquier nombre de encabezado no son válidos y se rechazarán. La configuración para establecer o agregar varios valores para un encabezado debe usar el formato de valor de encabezado RFC 7230, que separa cada valor con una coma.

Campo Descripción
set
[]HTTPHeader
(Opcional)

Set sobrescribe la solicitud con el encabezado especificado (nombre, valor) antes de la acción.

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

Config: set: - name: “my-header” valor: “bar”

Salida: GET /foo HTTP/1.1 my-header: bar

add
[]HTTPHeader
(Opcional)

Add agrega los encabezados especificados (nombre, valor) a la solicitud antes de la acción. Anexa a los valores existentes asociados al nombre del encabezado.

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

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

Salida: GET /foo HTTP/1.1 my-header: foo,bar,baz

remove
[]cadena
(Opcional)

Quite los encabezados especificados de la solicitud HTTP antes de la acción. El valor de Remove es una lista de nombres de encabezado HTTP. Los nombres de encabezado no distinguen mayúsculas de minúsculas (vea https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).

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

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

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

HeaderName (alias string)

HeaderName es el nombre de un encabezado o parámetro de consulta.

HealthCheckPolicy

HealthCheckPolicy es el esquema de la API HealthCheckPolicy.

Campo Descripción
metadata
Kubernetes meta/v1.ObjectMeta
(Opcional)

Metadatos del objeto’.

Consulte la documentación de la API de Kubernetes para conocer los campos del campo metadata.
spec
HealthCheckPolicySpec

Spec es la especificación HealthCheckPolicy.



targetRef
CustomTargetRef

TargetRef identifica un objeto de API al que se va a aplicar la directiva.

override
HealthCheckPolicyConfig
(Opcional)

Override define la configuración de directiva que debe invalidar la configuración de directiva asociada debajo del recurso de destino en la jerarquía.

Nota: La invalidación no se admite actualmente y producirá un error de validación. La compatibilidad con la invalidación se agregará en una versión futura.

default
HealthCheckPolicyConfig
(Opcional)

Default define la configuración de directiva predeterminada para el recurso de destino.

status
HealthCheckPolicyStatus

Status define el estado actual de HealthCheckPolicy.

HealthCheckPolicyConditionReason (alias string)

HealthCheckPolicyConditionReason define el conjunto de motivos que explican por qué se ha generado un tipo de condición HealthCheckPolicy determinado.

Valor Descripción

"BackendTLSPolicyNotFound"

BackendTLSPolicyConditionNotFound se usa cuando no se encuentra BackendTLSPolicy para el servicio.

"Accepted"

HealthCheckPolicyReasonAccepted se usa para establecer HealthCheckPolicyConditionReason en Accepted. Cuando el valor HealthCheckPolicy especificado está configurado correctamente.

"InvalidHealthCheckPolicy"

HealthCheckPolicyReasonInvalid es el motivo por el que HealthCheckPolicy no se establece en Accepted.

"InvalidGroup"

HealthCheckPolicyReasonInvalidGroup se usa cuando el grupo no es válido.

"InvalidKind"

HealthCheckPolicyReasonInvalidKind se usa cuando el tipo o grupo no es válido.

"InvalidName"

HealthCheckPolicyReasonInvalidName se usa cuando el nombre no es válido.

"InvalidPort"

HealthCheckPolicyReasonInvalidPort se usa cuando el puerto no es válido.

"InvalidService"

HealthCheckPolicyReasonInvalidService se usa cuando el servicio no es válido.

"NoTargetReference"

HealthCheckPolicyReasonNoTargetReference se usa cuando no hay ninguna referencia de destino.

"OverrideNotSupported"

HealthCheckPolicyReasonOverrideNotSupported se usa cuando la invalidación no se admite.

"RefNotPermitted"

HealthCheckPolicyReasonRefNotPermitted se usa cuando no se permite la referencia.

"SectionNamesNotPermitted"

HealthCheckPolicyReasonSectionNamesNotPermitted se usa cuando no se permiten los nombres de sección.’

HealthCheckPolicyConditionType (alias string)

HealthCheckPolicyConditionType es un tipo de condición asociada a HealthCheckPolicy. Este tipo debe usarse con el campo HealthCheckPolicyStatus.Conditions.

Value Descripción

"Accepted"

HealthCheckPolicyConditionAccepted se usa para establecer HealthCheckPolicyConditionType en Accepted.

"ResolvedRefs"

HealthCheckPolicyConditionResolvedRefs se usa para establecer HealthCheckPolicyCondition en ResolvedRefs.

HealthCheckPolicyConfig

(Aparece en:HealthCheckPolicySpec)

HealthCheckPolicyConfig define el esquema para la especificación de comprobación de HealthCheck.

Campo Descripción
interval
Kubernetes meta/v1.Duration
(Opcional)

Interval es el número de segundos entre comprobaciones HealthCheck.

timeout
Kubernetes meta/v1.Duration
(Opcional)

Timeout es el número de segundos después del cual se considera que se ha producido un error en la comprobación de HealthCheck.

port
int32
(Opcional)

Port es el puerto que se va a usar para las comprobaciones healthCheck.

unhealthyThreshold
int32
(Opcional)

UnhealthyThreshold es el número de comprobaciones de HealthCheck con errores consecutivas.

healthyThreshold
int32
(Opcional)

HealthyThreshold es el número de comprobaciones de HealthCheck correctas consecutivas.

useTLS
bool
(Opcional)

UseTLS indica si la comprobación de estado debe aplicar TLS. De forma predeterminada, la comprobación de estado usará el mismo protocolo que el servicio si se usa el mismo puerto para la comprobación de estado. Si el puerto es diferente, la comprobación de estado será texto no cifrado.

http
HTTPSpecifiers
(Opcional)

HTTP define la especificación de restricción HTTP para HealthCheck de un recurso de destino.

grpc
GRPCSpecifiers

GRPC configura un HealthCheck gRPC v1 (https://github.com/grpc/grpc-proto/blob/master/grpc/health/v1/health.proto) en el recurso de destino.

HealthCheckPolicySpec

(Aparece en:HealthCheckPolicy)

HealthCheckPolicySpec define el estado deseado de HealthCheckPolicy.

Campo Descripción
targetRef
CustomTargetRef

TargetRef identifica un objeto de API al que se va a aplicar la directiva.

override
HealthCheckPolicyConfig
(Opcional)

Override define la configuración de directiva que debe invalidar la configuración de directiva asociada debajo del recurso de destino en la jerarquía.

Nota: La invalidación no se admite actualmente y producirá un error de validación. La compatibilidad con la invalidación se agregará en una versión futura.

default
HealthCheckPolicyConfig
(Opcional)

Default define la configuración de directiva predeterminada para el recurso de destino.

HealthCheckPolicyStatus

(Aparece en:HealthCheckPolicy)

HealthCheckPolicyStatus define el estado observado de HealthCheckPolicy.

Campo Descripción
conditions
[]Kubernetes meta/v1.Condition
(Opcional)

Conditions describe las condiciones actuales de HealthCheckPolicy.

Las implementaciones deben preferir expresar las condiciones HealthCheckPolicy mediante las constantes HealthCheckPolicyConditionType y HealthCheckPolicyConditionReason para que los operadores y las herramientas puedan converger en un vocabulario común para describir el estado de HealthCheckPolicy.

Los tipos de condición conocidos son:

  • “Aceptado”

IngressBackendPort

(Aparece en:IngressBackendSettings)

IngressBackendPort describe un puerto en un back-end. Solo se debe definir un Name/Number.

Campo Descripción
port
int32
(Opcional)

Port indica el puerto del servicio back-end.

name
string
(Opcional)

Name debe hacer referencia a un nombre de un puerto del servicio back-end.

protocol
Protocolo

El protocolo debe ser “HTTP” o “HTTPS”.

IngressBackendSettingStatus

(Aparece en:IngressExtensionStatus)

IngressBackendSettingStatus describe el estado de un BackendSetting.

Campo Descripción
service
string

Service identifica el valor de BackendSetting que describe este estado.

validationErrors
[]cadena
(Opcional)

Los errores son una lista de errores relacionados con esta configuración

valid
bool

Valid indica que no hay errores de validación presentes en este backendSetting.

IngressBackendSettings

(Aparece en:IngressExtensionSpec)

IngressBackendSettings proporciona opciones de configuración extendidas para un servicio back-end.

Campo Descripción
service
string

Service es el nombre de un servicio back-end al que se aplica esta configuración.

ports
[]IngressBackendPort
(Opcional)

Ports se puede usar para indicar si el servicio back-end está escuchando en HTTP o HTTPS.

trustedRootCertificate
string
(Opcional)

TrustedRootCertificate se puede usar para proporcionar un certificado para que la puerta de enlace confíe al comunicarse con el back-end en un puerto especificado como https.

sessionAffinity
SessionAffinity
(Opcional)

SessionAffinity permite que las solicitudes de cliente entren de forma coherente al mismo back-end.

timeouts
IngressTimeouts
(Opcional)

Los tiempos de espera definen un conjunto de parámetros de tiempo de espera que se aplicarán a una entrada.

IngressExtension

IngressExtension es el esquema de la API IngressExtension.

Campo Descripción
metadata
Kubernetes meta/v1.ObjectMeta
(Opcional)

Metadatos del objeto’.

Consulte la documentación de la API de Kubernetes para conocer los campos del campo metadata.
spec
IngressExtensionSpec

Spec es la especificación IngressExtension.



rules
[]IngressRuleSetting
(Opcional)

Las reglas definen las reglas por host.

backendSettings
[]IngressBackendSettings
(Opcional)

BackendSettings define un conjunto de opciones de configuración para los back-end del servicio de entrada.

status
IngressExtensionStatus

IngressExtensionConditionReason (alias string)

IngressExtensionConditionReason define el conjunto de motivos que explican por qué se ha generado un tipo de condición IngressExtension determinado.

Valor Descripción

"Accepted"

IngressExtensionReasonAccepted se usa para establecer IngressExtensionConditionAccepted en Accepted.

"HasValidationErrors"

IngressExtensionReasonHasErrors indica que hay algunos errores de validación.

"NoValidationErrors"

IngressExtensionReasonNoErrors indica que no hay errores de validación.

"PartiallyAcceptedWithErrors"

IngressExtensionReasonPartiallyAccepted se usa para establecer IngressExtensionConditionAccepted en Accepted, pero con errores de validación no irrecuperables.

IngressExtensionConditionType (alias string)

IngressExtensionConditionType es un tipo de condición asociada a ingressExtension. Este tipo debe usarse con el campo IngressExtensionStatus.Conditions.

Value Descripción

"Accepted"

IngressExtensionConditionAccepted indica si el controlador ha aceptado (reconciliado) IngressExtension.

“Errores”

IngressExtensionConditionErrors indica si hay errores de validación o compilación en la extensión.

IngressExtensionSpec

(Aparece en:IngressExtension)

IngressExtensionSpec define la configuración deseada de IngressExtension.

Campo Descripción
rules
[]IngressRuleSetting
(Opcional)

Las reglas definen las reglas por host.

backendSettings
[]IngressBackendSettings
(Opcional)

BackendSettings define un conjunto de opciones de configuración para los back-end del servicio de entrada.

IngressExtensionStatus

(Aparece en:IngressExtension)

IngressExtensionStatus describe el estado actual de IngressExtension

Campo Descripción
rules
[]IngressRuleStatus
(Opcional)

Las reglas tienen información de estado detallada sobre cada regla.

backendSettings
[]IngressBackendSettingStatus
(Opcional)

BackendSettings tiene información de estado detallada sobre cada BackendSettings.

conditions
[]Kubernetes meta/v1.Condition
(Opcional)

Conditions describe las condiciones actuales de IngressExtension. Los tipos de condición conocidos son:

  • “Aceptado”
  • “Errores”

IngressRewrites

(Aparece en:IngressRuleSetting)

IngressRewrites proporciona las distintas reescrituras admitidas en una regla.

Campo Descripción
type
RewriteType

Type identifica el tipo de reescritura.

requestHeaderModifier
HeaderFilter
(Opcional)

RequestHeaderModifier define un esquema que modifica los encabezados de solicitud.

responseHeaderModifier
HeaderFilter
(Opcional)

RequestHeaderModifier define un esquema que modifica los encabezados de respuesta.

urlRewrite
URLRewriteFilter
(Opcional)

URLRewrite define un esquema que modifica una solicitud durante el reenvío.

IngressRuleSetting

(Aparece en:IngressExtensionSpec)

IngressRuleSetting proporciona opciones de configuración para las reglas.

Campo Descripción
host
string

Host se usa para buscar coincidencias con las reglas de entrada con el mismo nombre de host para identificar qué reglas se ven afectadas por esta configuración.

additionalHostnames
[]cadena
(Opcional)

AdditionalHostnames especifica nombres de host adicionales que escuchar.

rewrites
[]IngressRewrites
(Opcional)

Rewrites define las reescrituras de la regla

requestRedirect
Redirigir
(Opcional)

RequestRedirect define el comportamiento de redireccionamiento de la regla.

IngressRuleStatus

(Aparece en:IngressExtensionStatus)

IngressRuleStatus describe el estado de una regla.

Campo Descripción
host
string

Host identifica la regla que describe este estado.

validationErrors
[]cadena
(Opcional)

Los errores son una lista de errores relacionados con esta configuración

valid
bool
(Opcional)

Valid indica que no hay errores de validación presentes en esta regla.

IngressTimeouts

(Aparece en:IngressBackendSettings)

IngressTimeouts se puede usar para configurar las propiedades de tiempo de espera de una entrada.

Campo Descripción
requestTimeout
Kubernetes meta/v1.Duration
(Opcional)

RequestTimeout define el tiempo de espera utilizado por el equilibrador de carga al reenviar solicitudes a un servicio back-end.

MTLSPolicyVerify

(Aparece en:FrontendTLSPolicyConfig)

MTLSPolicyVerify define el esquema de la API MTLSPolicyVerify.

Campo Descripción
caCertificateRef
API de puerta de enlace .SecretObjectReference

CaCertificateRef es el certificado de entidad de certificación que se usa para comprobar el certificado del mismo nivel.

subjectAltNames
[]cadena
(Opcional)

SubjectAltNames es la lista de nombres alternativos del firmante que se usan para comprobar el certificado del mismo nivel.

PolicyType

(Aparece en:FrontendTLSPolicyConfig)

PolicyType es el tipo de la directiva.

Campo Descripción
name
FrontendTLSPolicyTypeName

Name es el nombre de la directiva.

type
FrontendTLSPolicyType

PredefinedFrontendTLSPolicyType es el tipo de la directiva TLS de front-end predefinida.

PortNumber (alias int32)

(Aparece en:Redirect)

PortNumber define un puerto de red.

PreciseHostname (alias string)

(Aparece en:Redireccionamiento, URLRewriteFilter)

PreciseHostname es el nombre de dominio completo de un host de red. Esto coincide con la definición RFC 1123 de un nombre de host con 1 excepción notable que no permite las direcciones IP numéricas.’

Según RFC1035 y RFC1123, una etiqueta debe constar de caracteres alfanuméricos en minúsculas o ‘-’, y debe comenzar y terminar con un carácter alfanumérico. No se permite ninguna otra puntuación.

Protocolo (alias string)

(Aparece en:IngressBackendPort)

Protocol define el protocolo usado para determinadas propiedades. Los valores de Protocol válidos son:

  • HTTP
  • HTTPS
  • TCP
Value Descripción

"HTTP"

ProtocolHTTP implica que el servicio usa HTTP.

"HTTPS"

ProtocolHTTPS implica que el servicio usa HTTPS.

"TCP"

ProtocolTCP implica que el servicio usa TCP sin formato.

Redirect

(Aparece en:IngressRuleSetting)

Redirect define un filtro que redirige una solicitud. NO SE DEBE usar en la misma regla que también tiene un URLRewriteFilter.

Campo Descripción
scheme
string
(Opcional)

Scheme es el esquema que se va a usar en el valor del encabezado Location en la respuesta. Cuando está vacío, se usa el esquema de la solicitud.

hostname
PreciseHostname
(Opcional)

Hostname es el nombre de host que se usará en el valor del encabezado Location en la respuesta. Cuando está vacío, se usa el nombre de host en el encabezado Host de la solicitud.

path
HTTPPathModifier
(Opcional)

Path define los parámetros usados para modificar la ruta de acceso de la solicitud entrante. A continuación, se usa la ruta de acceso modificada para construir el encabezado Location. Cuando está vacía, la ruta de acceso de la solicitud se usa tal como está.

port
PortNumber
(Opcional)

Port es el puerto que se va a usar en el valor del encabezado Location en la respuesta.

Si no se especifica ningún puerto, el puerto de redireccionamiento DEBE derivarse mediante las siguientes reglas:

  • Si el esquema de redireccionamiento no está vacío, el puerto de redireccionamiento DEBE ser el puerto conocido asociado al esquema de redireccionamiento. Específicamente, “http” al puerto 80 y “https” al puerto 443. Si el esquema de redireccionamiento no tiene un puerto conocido, se debe usar el puerto de escucha de la puerta de enlace.’
  • Si el esquema de redireccionamiento está vacío, el puerto de redireccionamiento DEBE ser el puerto de escucha de puerta de enlace.

Las implementaciones NO DEBEN agregar el número de puerto en el encabezado ‘Location’ en los casos siguientes:

  • Un encabezado Location que usará HTTP (si se determina a través del protocolo Listener o el campo Scheme) y usa el puerto 80.
  • Un encabezado Location que usará HTTP (si se determina a través del protocolo Listener o el campo Scheme) y usa el puerto 443.
statusCode
int
(Opcional)

StatusCode es el código de estado HTTP que se va a usar en respuesta.

Los valores se pueden agregar a esta enumeración y las implementaciones deben asegurarse de que los valores desconocidos no provocarán un bloqueo.’

RewriteType (alias string)

(Aparece en:IngressRewrites)

RewriteType identifica el tipo de reescritura.

Value Descripción

"RequestHeaderModifier"

RequestHeaderModifier se puede usar para agregar o quitar un encabezado HTTP de una solicitud HTTP antes de enviarlo al destino ascendente.’

"ResponseHeaderModifier"

ResponseHeaderModifier se puede usar para agregar o quitar un encabezado HTTP de una respuesta HTTP antes de enviarlo al cliente.’

"URLRewrite"

URLRewrite se puede usar para modificar una solicitud durante el reenvío.

RoutePolicy

RoutePolicy es el esquema de la API RoutePolicy.

Campo Descripción
metadata
Kubernetes meta/v1.ObjectMeta
(Opcional)

Metadatos del objeto’.

Consulte la documentación de la API de Kubernetes para conocer los campos del campo metadata.
spec
RoutePolicySpec

Spec es la especificación RoutePolicy.



targetRef
CustomTargetRef

TargetRef identifica un objeto de API al que se va a aplicar la directiva.

override
RoutePolicyConfig
(Opcional)

Override define la configuración de directiva que debe invalidar la configuración de directiva asociada debajo del recurso de destino en la jerarquía.

Nota: La invalidación no se admite actualmente y producirá un error de validación. La compatibilidad con la invalidación se agregará en una versión futura.

default
RoutePolicyConfig
(Opcional)

Default define la configuración de directiva predeterminada para el recurso de destino.

status
RoutePolicyStatus

Status define el estado actual de RoutePolicy.

RoutePolicyConditionReason (alias string)

RoutePolicyConditionReason define el conjunto de motivos que explican por qué se ha generado un tipo de condición RoutePolicy determinado.

Valor Descripción

"Accepted"

RoutePolicyReasonAccepted se usa para establecer RoutePolicyConditionReason en Accepted cuando la RoutePolicy dada esté configurada correctamente.

"InvalidRoutePolicy"

RoutePolicyReasonInvalid es la razón por la que RoutePolicy no se establece en Accepted.

"InvalidGRPCRoute"

RoutePolicyReasonInvalidGRPCRoute se usa cuando GRPCRoute no es válido.

"InvalidGroup"

RoutePolicyReasonInvalidGroup se usa cuando el grupo no es válido.

"InvalidHTTPRoute"

RoutePolicyReasonInvalidHTTPRoute se usa cuando HTTPRoute no es válido.

"InvalidKind"

RoutePolicyReasonInvalidKind se usa cuando el tipo o grupo no es válido.

"InvalidName"

RoutePolicyReasonInvalidName se usa cuando el nombre no es válido.

"NoTargetReference"

RoutePolicyReasonNoTargetReference se usa cuando no hay ninguna referencia de destino.’

"OverrideNotSupported"

RoutePolicyReasonOverrideNotSupported se usa cuando la invalidación no se admite.’

"RefNotPermitted"

RoutePolicyReasonRefNotPermitted se usa cuando no se permite la referencia.

"SectionNamesNotPermitted"

RoutePolicyReasonSectionNamesNotPermitted se usa cuando no se permiten los nombres de sección.’

RoutePolicyConditionType (alias string)

RoutePolicyConditionType es un tipo de condición asociada a RoutePolicy. Este tipo debe usarse con el campo RoutePolicyStatus.Conditions.

Value Descripción

"Accepted"

RoutePolicyConditionAccepted se usa para establecer RoutePolicyConditionType en Accepted.

"ResolvedRefs"

RoutePolicyConditionResolvedRefs se usa para establecer RoutePolicyCondition en ResolvedRefs.

RoutePolicyConfig

(Aparece eb:RoutePolicySpec)

RoutePolicyConfig define el esquema para la especificación RoutePolicy. Esto permite la especificación de los atributos siguientes: * Tiempos de espera * Afinidad de sesión.

Campo Descripción
timeouts
RouteTimeouts
(Opcional)

Tiempo de espera personalizado: tiempo de espera para el recurso de destino.

sessionAffinity
SessionAffinity

SessionAffinity define el esquema de la especificación de afinidad de sesión.

RoutePolicySpec

(Aparece en:RoutePolicy)

RoutePolicySpec define el estado deseado de RoutePolicy.

Campo Descripción
targetRef
CustomTargetRef

TargetRef identifica un objeto de API al que se va a aplicar la directiva.

override
RoutePolicyConfig
(Opcional)

Override define la configuración de directiva que debe invalidar la configuración de directiva asociada debajo del recurso de destino en la jerarquía.

Nota: La invalidación no se admite actualmente y producirá un error de validación. La compatibilidad con la invalidación se agregará en una versión futura.

default
RoutePolicyConfig
(Opcional)

Default define la configuración de directiva predeterminada para el recurso de destino.

RoutePolicyStatus

(Aparece en:RoutePolicy)

RoutePolicyStatus define el estado observado de RoutePolicy.

Campo Descripción
conditions
[]Kubernetes meta/v1.Condition
(Opcional)

Conditions describe las condiciones actuales de RoutePolicy.

Las implementaciones deben preferir expresar las condiciones de RoutePolicy mediante las constantes RoutePolicyConditionType y RoutePolicyConditionReason para que los operadores y las herramientas puedan converger en un vocabulario común para describir el estado de RoutePolicy.

Los tipos de condición conocidos son:

  • “Aceptado”

RouteTimeouts

(Aparece en:RoutePolicyConfig)

RouteTimeouts define el esquema para la especificación Timeouts.

Campo Descripción
routeTimeout
Kubernetes meta/v1.Duration
(Opcional)

RouteTimeout es el tiempo de espera de la ruta.

SessionAffinity

(Aparece en:IngressBackendSettings, RoutePolicyConfig)

SessionAffinity define el esquema de la especificación de afinidad de sesión.

Campo Descripción
affinityType
AffinityType
cookieName
string
(Opcional)
cookieDuration
Kubernetes meta/v1.Duration
(Opcional)

StatusCodes

(Aparece en:HTTPMatch)

StatusCodes define los buscadores de coincidencias de código de estado HTTP que se usarán para las comprobaciones HealthCheck.

Campo Descripción
start
int32
(Opcional)

Start define el inicio del intervalo de códigos de estado que se van a usar para las comprobaciones HealthCheck. Esto es inclusivo.

end
int32
(Opcional)

End define el final del intervalo de códigos de estado que se van a usar para las comprobaciones HealthCheck. Esto es inclusivo.

URLRewriteFilter

(Aparece en:IngressRewrites)

URLRewriteFilter define un filtro que modifica una solicitud durante el reenvío. Como máximo, se puede usar uno de estos filtros en una regla. NO se debe usar en la misma regla que tiene un sslRedirect.

Campo Descripción
hostname
PreciseHostname
(Opcional)

Hostname es el valor que se va a usar para reemplazar el valor del encabezado host durante el reenvío.

path
HTTPPathModifier
(Opcional)

Path define una ruta de acceso de reescritura.