Partilhar via

Especificação da API do Application Gateway for Containers para Kubernetes

  • Artigo

Pacote

O pacote v1 é a versão v1 da API.

alb.networking.azure.io/v1

Este documento define cada um dos tipos de recursos para alb.networking.azure.io/v1.

Tipos de Recursos:

AffinityType (string alias)

(Aparece em:SessionAffinity)

AffinityType define o tipo de afinidade para o Serviço

valor Description

"cookie-aplicativo"

AffinityTypeApplicationCookie é um tipo de afinidade de sessão para um cookie de aplicativo

"Cookie gerenciado"

AffinityTypeManagedCookie é um tipo de afinidade de sessão para um cookie gerenciado

AlbConditionReason (string alias)

AlbConditionReason define o conjunto de razões que explicam por que um determinado tipo de condição é gerado pelo recurso Application Gateway for Containers.

valor Description

"Aceito"

AlbReasonAccepted indica que o recurso Application Gateway for Containers é aceito pelo controlador.

“Pronto”

AlbReasonDeploymentReady indica o status de implantação do recurso Application Gateway for Containers.

"Em andamento"

AlbReasonInProgress indica se o recurso Application Gateway for Containers está em processo de criação, atualização ou exclusão.

AlbConditionType (string alias)

AlbConditionType é um tipo de condição associada a um recurso do Application Gateway for Containers. Este tipo deve ser usado com o campo AlbStatus.Conditions.

valor Description

"Aceito"

AlbConditionTypeAccepted indica se o recurso Application Gateway for Containers é aceito pelo controlador.

"Implantação"

AlbConditionTypeDeployment indica o status de implantação do recurso Application Gateway for Containers.

AlbSpec

(Aparece em:ApplicationLoadBalancer)

AlbSpec define as especificações para o recurso Application Gateway for Containers.

Campo Descrição
associations
[]string

As associações são IDs de recursos de sub-rede aos quais o recurso Application Gateway for Containers está associado.

AlbStatus

(Aparece em:ApplicationLoadBalancer)

AlbStatus define o estado observado do recurso Application Gateway for Containers.

Campo Descrição
conditions
[]Kubernetes meta/v1. Condição 		(Opcional)

Os tipos de condição conhecidos são:

  • “Aceito”
  • “Pronto”

ApplicationLoadBalancer

ApplicationLoadBalancer é o esquema para o recurso Application Gateway for Containers.

Campo Descrição
metadata
Kubernetes meta/v1. ObjectMeta 		(Opcional)

Metadados do objeto’.

Consulte a documentação da API do Kubernetes para obter os campos do metadata campo.
spec
AlbSpec

Spec é a especificação do recurso Application Gateway for Containers.



associations
[]string

As associações são IDs de recursos de sub-rede aos quais o recurso Application Gateway for Containers está associado.
status
AlbStatus

Status define o estado atual do recurso Application Gateway for Containers.

BackendTLSPolicy

BackendTLSPolicy é o esquema para a API BackendTLSPolicys

Campo Descrição
metadata
Kubernetes meta/v1. ObjectMeta 		(Opcional)

Metadados do objeto’.

Consulte a documentação da API do Kubernetes para obter os campos do metadata campo.
spec
BackendTLSPolicySpec

Spec é a especificação BackendTLSPolicy.



targetRef
CustomTargetRef

TargetRef identifica um objeto de API ao qual aplicar a política.
override
BackendTLSPolicyConfig 		(Opcional)

A substituição define a configuração da política que deve substituir a configuração da política anexada abaixo do recurso de destino na hierarquia.

Nota: A substituição não é suportada no momento e resultará em um erro de validação. O suporte para Override será adicionado em uma versão futura.
default
BackendTLSPolicyConfig 		(Opcional)

Default define a configuração de política padrão para o recurso de destino.
status
BackendTLSPolicyStatus

Status define o estado atual de BackendTLSPolicy.

BackendTLSPolicyConditionReason (string alias)

BackendTLSPolicyConditionReason define o conjunto de razões que explicam por que um determinado tipo de condição BackendTLSPolicy é gerado.

valor Description

"Aceito"

BackendTLSPolicyReasonAccepted é usado para definir o BackendTLSPolicyConditionReason como Accepted quando o BackendTLSPolicy dado está configurado corretamente

"InvalidBackendTLSPolicy"

BackendTLSPolicyReasonInvalid é o motivo quando o BackendTLSPolicy não é’aceito

"InvalidCertificateRef"

BackendTLSPolicyReasonInvalidCertificateRef é usado quando um certificado inválido é referenciado

"Grupo Inválido"

BackendTLSPolicyReasonInvalidGroup é usado quando o grupo é inválido

"Inválido"

BackendTLSPolicyReasonInvalidKind é usado quando o tipo/grupo é inválido

"Nome inválido"

BackendTLSPolicyReasonInvalidName é usado quando o nome é inválido

"Segredo inválido"

BackendTLSPolicyReasonInvalidSecret é usado quando o segredo é inválido

"Serviço inválido"

BackendTLSPolicyReasonInvalidService é usado quando o Serviço é inválido

"NoTargetReference"

BackendTLSPolicyReasonNoTargetReference é usado quando não há’referência de destino

"OverrideNotSupported"

BackendTLSPolicyReasonOverrideNotSupported é usado quando a substituição não é’suportada

"RefNotAllowed"

BackendTLSPolicyReasonRefNotAllowed é usado quando a ref não é’permitida

"SectionNamesNotPermitted"

BackendTLSPolicyReasonSectionNamesNotAllowed é usado quando os nomes das seções não são’permitidos

BackendTLSPolicyConditionType (string alias)

BackendTLSPolicyConditionType é um tipo de condição associada a um BackendTLSPolicy. Esse tipo deve ser usado com o campo BackendTLSPolicyStatus.Conditions.

valor Description

"Aceito"

BackendTLSPolicyConditionAccepted é usado para definir o BackendTLSPolicyConditionType como Accepted

"ResolvedRefs"

BackendTLSPolicyConditionResolvedRefs é usado para definir o BackendTLSPolicyCondition como ResolvedRefs

BackendTLSPolicyConfig

(Aparece em:BackendTLSPolicySpec)

BackendTLSPolicyConfig define a especificação de política para a Política TLS de back-end.

Campo Descrição
CommonTLSPolicy
CommonTLSPolicy

(Os membros do CommonTLSPolicy estão incorporados neste tipo.)

sni
string 		(Opcional)

Sni é o nome do servidor a ser usado para a conexão TLS com o back-end.
ports
[]BackendTLSPolicyPort

Ports especifica a lista de portas onde a política é aplicada.
clientCertificateRef
API de gateway . SecretObjectReference 		(Opcional)

ClientCertificateRef é a referência ao certificado do cliente a ser usado para a conexão TLS com o back-end.

BackendTLSPolicyPort

(Aparece em:BackendTLSPolicyConfig)

BackendTLSPolicyPort define a porta a ser usada para a conexão TLS com o back-end

Campo Descrição
port
Int

Porta é a porta a ser usada para a conexão TLS com o back-end

BackendTLSPolicySpec

(Aparece em:BackendTLSPolicy)

BackendTLSPolicySpec define o estado desejado de BackendTLSPolicy

Campo Descrição
targetRef
CustomTargetRef

TargetRef identifica um objeto de API ao qual aplicar a política.
override
BackendTLSPolicyConfig 		(Opcional)

A substituição define a configuração da política que deve substituir a configuração da política anexada abaixo do recurso de destino na hierarquia.

Nota: A substituição não é suportada no momento e resultará em um erro de validação. O suporte para Override será adicionado em uma versão futura.
default
BackendTLSPolicyConfig 		(Opcional)

Default define a configuração de política padrão para o recurso de destino.

BackendTLSPolicyStatus

(Aparece em:BackendTLSPolicy)

BackendTLSPolicyStatus define o estado observado de BackendTLSPolicy.

Campo Descrição
conditions
[]Kubernetes meta/v1. Condição 		(Opcional)

As condições descrevem as condições atuais do BackendTLSPolicy.

As implementações devem preferir expressar as condições de BackendTLSPolicy usando as constantes e BackendTLSPolicyConditionReason para que os operadores e as ferramentas possam convergir em um vocabulário comum para descrever o BackendTLSPolicyConditionType estado BackendTLSPolicy.

Os tipos de condição conhecidos são:

  • “Aceito”

CommonTLSPolicy

(Aparece em:BackendTLSPolicyConfig)

CommonTLSPolicy é o esquema para a API CommonTLSPolicy

Campo Descrição
verify
CommonTLSPolicyVerify 		(Opcional)

Verify fornece as opções para verificar o certificado de back-end

CommonTLSPolicyVerify

(Aparece em:CommonTLSPolicy)

CommonTLSPolicyVerify define o esquema para a API CommonTLSPolicyVerify

Campo Descrição
caCertificateRef
API de gateway . SecretObjectReference

CaCertificateRef é o certificado de autoridade de certificação usado para verificar o certificado de mesmo nível do back-end.
subjectAltName
string

SubjectAltName é o nome alternativo da entidade usado para verificar o certificado de mesmo nível do back-end.

CustomTargetRef

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

CustomTargetRef é uma referência a um recurso personalizado que não faz’parte da API principal do Kubernetes.

Campo Descrição
PolicyTargetReference
API de gateway . PolicyTargetReference

(Os membros do PolicyTargetReference estão incorporados neste tipo.)

sectionNames
[]string 		(Opcional)

SectionNames é o nome da seção dentro do recurso de destino. Quando não especificado, este targetRef destina-se a todo o recurso. Nos recursos a seguir, SectionNames é interpretado da seguinte forma:

  • Gateway: Nome do ouvinte
  • Serviço: Nome da porta

Se um SectionNames for especificado, mas não existir no objeto de destino, a Política não será anexada e a implementação da política registrará uma ResolvedRefs Condição ou semelhante no status da Política’.

FrontendTLSPolicy

FrontendTLSPolicy é o esquema para a API FrontendTLSPolicy

Campo Descrição
metadata
Kubernetes meta/v1. ObjectMeta 		(Opcional)

Metadados do objeto’.

Consulte a documentação da API do Kubernetes para obter os campos do metadata campo.
spec
FrontendTLSPolicySpec

Spec é a especificação FrontendTLSPolicy.



targetRef
CustomTargetRef

TargetRef identifica um objeto de API ao qual aplicar a política.
default
FrontendTLSPolicyConfig 		(Opcional)

Default define a configuração de política padrão para o recurso de destino.
override
FrontendTLSPolicyConfig 		(Opcional)

A substituição define a configuração da política que deve substituir a configuração da política anexada abaixo do recurso de destino na hierarquia.

Nota: A substituição não é suportada no momento e resultará em um erro de validação. O suporte para Override será adicionado em uma versão futura.
status
FrontendTLSPolicyStatus

Status define o estado atual do FrontendTLSPolicy.

FrontendTLSPolicyConditionReason (string alias)

FrontendTLSPolicyConditionReason define o conjunto de razões que explicam por que um determinado tipo de condição FrontendTLSPolicy é gerado.

valor Description

"Aceito"

FrontendTLSPolicyReasonAccepted é usado para definir o FrontendTLSPolicyConditionReason como Accepted quando o FrontendTLSPolicy fornecido está configurado corretamente

"InválidoFrontendTLSPolicy"

FrontendTLSPolicyReasonInvalid é a razão pela qual o FrontendTLSPolicy não é’aceito

"InvalidGateway"

FrontendTLSPolicyReasonInvalidGateway é usado quando o gateway é inválido

"Grupo Inválido"

FrontendTLSPolicyReasonInvalidGroup é usado quando o grupo é inválido

"Inválido"

FrontendTLSPolicyReasonInvalidKind é usado quando o tipo/grupo é inválido

"Nome inválido"

FrontendTLSPolicyReasonInvalidName é usado quando o nome é inválido

"InvalidPolicyName"

FrontendTLSPolicyReasonInvalidPolicyName é usado quando o nome da política é inválido

"InvalidPolicyType"

FrontendTLSPolicyReasonInvalidPolicyType é usado quando o tipo de diretiva é inválido

"NoTargetReference"

FrontendTLSPolicyReasonNoTargetReference é usado quando não há’referência de destino

"OverrideNotSupported"

FrontendTLSPolicyReasonOverrideNotSupported é usado quando a substituição não é’suportada

"RefNotAllowed"

FrontendTLSPolicyReasonRefNotAllowed é usado quando a ref não é’permitida

"SectionNamesNotPermitted"

FrontendTLSPolicyReasonSectionNamesNotAllowed é usado quando os nomes de seção não são’permitidos

FrontendTLSPolicyConditionType (string alias)

FrontendTLSPolicyConditionType é um tipo de condição associada a um FrontendTLSPolicy. Esse tipo deve ser usado com o campo FrontendTLSPolicyStatus.Conditions.

valor Description

"Aceito"

FrontendTLSPolicyConditionAccepted é usado para definir o FrontendTLSPolicyCondition como Accepted

"ResolvedRefs"

FrontendTLSPolicyConditionResolvedRefs é usado para definir o FrontendTLSPolicyCondition como ResolvedRefs

FrontendTLSPolicyConfig

(Aparece em:FrontendTLSPolicySpec)

FrontendTLSPolicyConfig define a especificação de política para a Política TLS Frontend.

Campo Descrição
policyType
Tipo de política

Type é o tipo da política.

FrontendTLSPolicySpec

(Aparece em:FrontendTLSPolicy)

FrontendTLSPolicySpec define o estado desejado de FrontendTLSPolicy

Campo Descrição
targetRef
CustomTargetRef

TargetRef identifica um objeto de API ao qual aplicar a política.
default
FrontendTLSPolicyConfig 		(Opcional)

Default define a configuração de política padrão para o recurso de destino.
override
FrontendTLSPolicyConfig 		(Opcional)

A substituição define a configuração da política que deve substituir a configuração da política anexada abaixo do recurso de destino na hierarquia.

Nota: A substituição não é suportada no momento e resultará em um erro de validação. O suporte para Override será adicionado em uma versão futura.

FrontendTLSPolicyStatus

(Aparece em:FrontendTLSPolicy)

FrontendTLSPolicyStatus define o estado observado de FrontendTLSPolicy.

Campo Descrição
conditions
[]Kubernetes meta/v1. Condição 		(Opcional)

As condições descrevem as condições atuais do FrontendTLSPolicy.

As implementações devem preferir expressar as condições FrontendTLSPolicy usando as constantes e FrontendTLSPolicyConditionReason para que os operadores e ferramentas possam convergir em um vocabulário comum para descrever o FrontendTLSPolicyConditionType estado FrontendTLSPolicy.

Os tipos de condição conhecidos são:

  • “Aceito”

FrontendTLSPolicyType (string alias)

(Aparece em:PolicyType)

FrontendTLSPolicyType é o tipo de política TLS Frontend.

valor Description

"predefinido"

PredefinedFrontendTLSPolicyType é o tipo da política TLS Frontend predefinida.

FrontendTLSPolicyTypeName (string alias)

(Aparece em:PolicyType)

FrontendTLSPolicyTypeName é o nome da Política TLS Frontend.

valor Description

"2023-06"

PredefinedPolicy202306 é o nome da Política TLS Frontend predefinida para a política “2023-06”.

"2023-06-S"

PredefinedPolicy202306Strict é o nome da Política TLS Frontend predefinida para a política “2023-06-S”. Esta é uma versão estrita da política “2023-06”.

HTTPHeader

(Aparece em:HeaderFilter)

HTTPHeader representa um nome e valor de cabeçalho HTTP conforme definido pela RFC 7230.

Campo Descrição
name
HTTPHeaderName

Nome é o nome do cabeçalho HTTP a ser correspondido. A correspondência de nomes DEVE diferenciar maiúsculas de minúsculas. (Ver https://tools.ietf.org/html/rfc7230#section-3.2).

Se várias entradas especificarem nomes de cabeçalho equivalentes, a primeira entrada com um nome equivalente DEVE ser considerada para uma correspondência. As entradas subsequentes com um nome de cabeçalho equivalente DEVEM ser ignoradas. Devido à insensibilidade a maiúsculas e minúsculas dos nomes de cabeçalho, “foo” e “Foo” são considerados equivalentes.
value
string

Valor é o valor do cabeçalho HTTP a ser correspondido.

HTTPHeaderName (string alias)

(Aparece em:HTTPHeader)

HTTPHeaderName é o nome de um cabeçalho HTTP.

Os valores válidos incluem:

  • “Autorização”
  • “Set-Cookie”

Os valores inválidos incluem:

  • ”:method” - “:” é um caractere inválido. Isso significa que pseudocabeçalhos HTTP/2 não são’atualmente suportados por esse tipo.
  • ”/invalid” - “/ ” é um caractere inválido

HTTPMatch

(Aparece em:HTTPSpecifiers)

HTTPMatch define os correspondentes HTTP a serem usados para verificações de HealthCheck.

Campo Descrição
body
string 		(Opcional)

Body define os correspondentes de corpo HTTP a serem usados para verificações de HealthCheck.
statusCodes
[]StatusCodes 		(Opcional)

StatusCodes define os correspondentes de código de status HTTP a serem usados para verificações de Verificação de Saúde.

HTTPPathModifier

(Aparece em:Redirect, URLRewriteFilter)

HTTPPathModifier define a configuração para modificadores de caminho.

Campo Descrição
type
HTTPPathModifierType

Type define o tipo de modificador de caminho. Mais tipos podem ser adicionados em uma versão futura da API.

Valores podem ser adicionados a este enum, implementações devem garantir que valores desconhecidos não causarão’uma falha.

Valores desconhecidos aqui devem resultar na implementação definindo a condição aceita para que a regra seja falsa
replaceFullPath
string 		(Opcional)

ReplaceFullPath especifica o valor com o qual substituir o caminho completo de uma solicitação durante uma regravação ou redirecionamento.
replacePrefixMatch
string 		(Opcional)

ReplacePrefixMatch especifica o valor com o qual substituir a correspondência de prefixo de uma solicitação durante uma regravação ou redirecionamento. Por exemplo, uma solicitação para “/foo/bar” com uma correspondência de prefixo de “/foo” e um ReplacePrefixMatch de “/xyz” seria modificada para “/xyz/bar”.

Isso corresponde ao comportamento do tipo de correspondência PathPrefix. Isso corresponde aos elementos de caminho completo. Um elemento path refere-se à lista de rótulos no caminho dividido pelo / separador. Quando especificado, um trailing é ignorado / . Por exemplo, os caminhos /abc, /abc/, e /abc/def todos corresponderiam ao prefixo /abc, mas o caminho /abcd’não.

ReplacePrefixMatch só é compatível com um PathPrefix HTTPRouteMatch. O uso de qualquer outro tipo HTTPRouteMatch no mesmo HTTPRouteRule resulta na implementação definindo a Condição Aceita para a Rota para status: False.

Caminho da solicitação Correspondência de prefixo Substituir prefixo Caminho modificado
/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)

(Aparece em:HTTPPathModifier)

HTTPPathModifierType define o tipo de redirecionamento ou regravação de caminho.

valor Description

"ReplaceFullPath"

FullPathHTTPPathModifier substitui o caminho completo pelo valor especificado.

"ReplacePrefixMatch"

PrefixMatchHTTPPathModifier substitui qualquer caminho de prefixo pelo valor de substituição. Por exemplo, um caminho com uma correspondência de prefixo de “/foo” e uma substituição ReplacePrefixMatch de “/bar” substituem “/foo” por “/bar” em solicitações correspondentes.

Isso corresponde ao comportamento do tipo de correspondência PathPrefix. Isso corresponde aos elementos de caminho completo. Um elemento path refere-se à lista de rótulos no caminho dividido pelo / separador. Quando especificado, um trailing é ignorado / . Por exemplo, os caminhos /abc, /abc/, e /abc/def todos corresponderiam ao prefixo /abc, mas o caminho /abcd’não.

HTTPSpecifiers

(Aparece em:HealthCheckPolicyConfig)

HTTPSpecifiers define o esquema para a especificação HTTP HealthCheck

Campo Descrição
host
string 		(Opcional)

Host é o valor do cabeçalho do host a ser usado para verificações de verificação de saúde.
path
string 		(Opcional)

Path é o caminho a ser usado para verificações de HealthCheck.
match
HTTPMatch 		(Opcional)

Match define os correspondentes HTTP a serem usados para verificações de HealthCheck.

HeaderFilter

(Aparece em:IngressRewrites)

HeaderFilter define um filtro que modifica os cabeçalhos de uma solicitação ou resposta HTTP. Apenas uma ação para um determinado nome de cabeçalho é permitida. Os filtros que especificam várias ações do mesmo tipo ou de tipo diferente para qualquer nome de cabeçalho são inválidos e serão rejeitados. A configuração para definir ou adicionar vários valores para um cabeçalho deve usar a formatação de valor de cabeçalho RFC 7230, separando cada valor com uma vírgula.

Campo Descrição
set
[]HTTPHeader 		(Opcional)

Set substitui a solicitação com o cabeçalho fornecido (nome, valor) antes da ação.

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

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

Saída: GET /foo HTTP/1.1 my-header: barra
add
[]HTTPHeader 		(Opcional)

Adicionar adiciona o(s) cabeçalho(s) fornecido(s) (nome, valor) à solicitação antes da ação. Ele acrescenta a quaisquer valores existentes associados ao nome do cabeçalho.

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

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

Saída: GET / foo HTTP / 1.1 my-header: foo, bar, baz
remove
[]string 		(Opcional)

Remova o(s) cabeçalho(s) fornecido(s) da solicitação HTTP antes da ação. O valor de Remove é uma lista de nomes de cabeçalho HTTP. Os nomes dos cabeçalhos não diferenciam maiúsculas de minúsculas (consulte https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).

Entrada: GET /foo HTTP/1.1 my-header1: foo my-header2: barra my-header3: baz

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

Saída: GET /foo HTTP/1.1 my-header2: barra

HeaderName (string alias)

HeaderName é o nome de um cabeçalho ou parâmetro de consulta.

Política de verificação de saúde

HealthCheckPolicy é o esquema para a API HealthCheckPolicy

Campo Descrição
metadata
Kubernetes meta/v1. ObjectMeta 		(Opcional)

Metadados do objeto’.

Consulte a documentação da API do Kubernetes para obter os campos do metadata campo.
spec
HealthCheckPolicySpec

Spec é a especificação HealthCheckPolicy.



targetRef
CustomTargetRef

TargetRef identifica um objeto de API ao qual aplicar a política.
override
HealthCheckPolicyConfig 		(Opcional)

A substituição define a configuração da política que deve substituir a configuração da política anexada abaixo do recurso de destino na hierarquia.

Nota: A substituição não é suportada no momento e resultará em um erro de validação. O suporte para Override será adicionado em uma versão futura.
default
HealthCheckPolicyConfig 		(Opcional)

Default define a configuração de política padrão para o recurso de destino.
status
HealthCheckPolicyStatus

Status define o estado atual de HealthCheckPolicy.

HealthCheckPolicyConditionReason (string alias)

HealthCheckPolicyConditionReason define o conjunto de razões que explicam por que um determinado tipo de condição HealthCheckPolicy é gerado.

valor Description

"Aceito"

HealthCheckPolicyReasonAccepted é usado para definir o HealthCheckPolicyConditionReason como Accepted quando o HealthCheckPolicy fornecido está configurado corretamente

"InvalidHealthCheckPolicy"

HealthCheckPolicyReasonInvalid é o motivo pelo qual a HealthCheckPolicy não é’aceita

"Grupo Inválido"

HealthCheckPolicyReasonInvalidGroup é usado quando o grupo é inválido

"Inválido"

HealthCheckPolicyReasonInvalidKind é usado quando o tipo/grupo é inválido

"Nome inválido"

HealthCheckPolicyReasonInvalidName é usado quando o nome é inválido

"InvalidPort"

HealthCheckPolicyReasonInvalidPort é usado quando a porta é inválida

"Serviço inválido"

HealthCheckPolicyReasonInvalidService é usado quando o Serviço é inválido

"NoTargetReference"

HealthCheckPolicyReasonNoTargetReference é usado quando não há’referência de destino

"OverrideNotSupported"

HealthCheckPolicyReasonOverrideNotSupported é usado quando a substituição não é’suportada

"RefNotAllowed"

HealthCheckPolicyReasonRefNotAllowed é usado quando a ref não é’permitida

"SectionNamesNotPermitted"

HealthCheckPolicyReasonSectionNamesNotAllowed é usado quando os nomes de seção não são’permitidos

HealthCheckPolicyConditionType (string alias)

HealthCheckPolicyConditionType é um tipo de condição associada a um HealthCheckPolicy. Esse tipo deve ser usado com o campo HealthCheckPolicyStatus.Conditions.

valor Description

"Aceito"

HealthCheckPolicyConditionAccepted é usado para definir o HealthCheckPolicyConditionType como Accepted

"ResolvedRefs"

HealthCheckPolicyConditionResolvedRefs é usado para definir HealthCheckPolicyCondition como ResolvedRefs

HealthCheckPolicyConfig

(Aparece em:HealthCheckPolicySpec)

HealthCheckPolicyConfig define o esquema para a especificação de verificação de saúde

Campo Descrição
interval
Kubernetes meta/v1. Duração 		(Opcional)

Intervalo é o número de segundos entre as verificações do HealthCheck.
timeout
Kubernetes meta/v1. Duração 		(Opcional)

Tempo limite é o número de segundos após os quais a verificação de integridade é considerada falha.
unhealthyThreshold
Int32 		(Opcional)

UnhealthyThreshold é o número de verificações consecutivas com falha no HealthCheck
healthyThreshold
Int32 		(Opcional)

HealthyThreshold é o número de verificações consecutivas bem-sucedidas do HealthCheck
http
HTTPSpecifiers 		(Opcional)

HTTP define a especificação de restrição HTTP para o HealthCheck de um recurso de destino.

HealthCheckPolicySpec

(Aparece em:HealthCheckPolicy)

HealthCheckPolicySpec define o estado desejado de HealthCheckPolicy

Campo Descrição
targetRef
CustomTargetRef

TargetRef identifica um objeto de API ao qual aplicar a política.
override
HealthCheckPolicyConfig 		(Opcional)

A substituição define a configuração da política que deve substituir a configuração da política anexada abaixo do recurso de destino na hierarquia.

Nota: A substituição não é suportada no momento e resultará em um erro de validação. O suporte para Override será adicionado em uma versão futura.
default
HealthCheckPolicyConfig 		(Opcional)

Default define a configuração de política padrão para o recurso de destino.

HealthCheckPolicyStatus

(Aparece em:HealthCheckPolicy)

HealthCheckPolicyStatus define o estado observado de HealthCheckPolicy.

Campo Descrição
conditions
[]Kubernetes meta/v1. Condição 		(Opcional)

As condições descrevem as condições atuais da HealthCheckPolicy.

As implementações devem preferir expressar as condições HealthCheckPolicy usando as constantes e HealthCheckPolicyConditionReason para que os operadores e as ferramentas possam convergir em um vocabulário comum para descrever o HealthCheckPolicyConditionType estado HealthCheckPolicy.

Os tipos de condição conhecidos são:

  • “Aceito”

IngressBackendPort

(Aparece em:IngressBackendSettings)

IngressBackendPort descreve uma porta em um back-end. Apenas um de Nome/Número deve ser definido.

Campo Descrição
port
Int32 		(Opcional)

Porta indica a porta no serviço de back-end
name
string 		(Opcional)

Nome deve se referir a um nome em uma porta no serviço de back-end
protocol
Protocolo

Protocolo deve ser um de “HTTP,”“ HTTPS”

IngressBackendSettingStatus

(Aparece em:IngressExtensionStatus)

IngressBackendSettingStatus descreve o estado de um BackendSetting

Campo Descrição
service
string

Service identifica o BackendSetting que este status descreve
validationErrors
[]string 		(Opcional)

Os erros são uma lista de erros relacionados a essa configuração
valid
Bool

Valid indica que não há erros de validação presentes neste BackendSetting

IngressBackendSettings

(Aparece em:IngressExtensionSpec)

IngressBackendSettings fornece opções de configuração estendidas para um serviço de back-end

Campo Descrição
service
string

Serviço é o nome de um serviço de back-end ao qual essa configuração se aplica
ports
[]IngressBackendPort 		(Opcional)

As portas podem ser usadas para indicar se o serviço de back-end está escutando em HTTP ou HTTPS
trustedRootCertificate
string 		(Opcional)

TrustedRootCertificate pode ser usado para fornecer um certificado para o gateway confiar ao se comunicar com o back-end em uma porta especificada como https
sessionAffinity
SessionAffinity 		(Opcional)

SessionAffinity permite que as solicitações do cliente sejam consistentemente dadas ao mesmo back-end
timeouts
IngressTimeouts 		(Opcional)

Os tempos limite definem um conjunto de parâmetros de tempo limite a serem aplicados a um ingresso

IngressExtension

IngressExtension é o esquema para a API IngressExtension

Campo Descrição
metadata
Kubernetes meta/v1. ObjectMeta 		(Opcional)

Metadados do objeto’.

Consulte a documentação da API do Kubernetes para obter os campos do metadata campo.
spec
IngressExtensionSpec

Spec é a especificação IngressExtension.



rules
[]IngressRuleSetting 		(Opcional)

As regras definem as regras por anfitrião
backendSettings
[]IngressBackendSettings 		(Opcional)

BackendSettings define um conjunto de opções de configuração para back-ends de serviço de entrada
status
IngressExtensionStatus

IngressExtensionConditionReason (string alias)

IngressExtensionConditionReason define o conjunto de razões que explicam por que um determinado tipo de condição IngressExtension é gerado.

valor Description

"Aceito"

IngressExtensionReasonAccepted é usado para definir o IngressExtensionConditionAccepted como Accepted

"HasValidationErrors"

IngressExtensionReasonHasErrors indica que existem alguns erros de validação

"NoValidationErrors"

IngressExtensionReasonNoErrors indica que não há erros de validação

"ParcialmenteAceitoWithErrors"

IngressExtensionReasonPartiallyAccepted é usado para definir o IngressExtensionConditionAccepted como Accepted, mas com erros de validação não fatais

IngressExtensionConditionType (string alias)

IngressExtensionConditionType é um tipo de condição associada a um IngressExtension. Esse tipo deve ser usado com o campo IngressExtensionStatus.Conditions.

valor Description

"Aceito"

IngressExtensionConditionAccepted indica se o IngressExtension é aceito (reconciliado) pelo controlador

"Erros"

IngressExtensionConditionErrors indica se há erros de validação ou compilação na extensão

IngressExtensionSpec

(Aparece em:IngressExtension)

IngressExtensionSpec define a configuração desejada de IngressExtension

Campo Descrição
rules
[]IngressRuleSetting 		(Opcional)

As regras definem as regras por anfitrião
backendSettings
[]IngressBackendSettings 		(Opcional)

BackendSettings define um conjunto de opções de configuração para back-ends de serviço de entrada

IngressExtensionStatus

(Aparece em:IngressExtension)

IngressExtensionStatus descreve o estado atual do IngressExtension

Campo Descrição
rules
[]IngressRuleStatus 		(Opcional)

As regras têm informações detalhadas sobre o status de cada regra
backendSettings
[]IngressBackendSettingStatus 		(Opcional)

BackendSettings tem informações detalhadas de status sobre cada BackendSettings
conditions
[]Kubernetes meta/v1. Condição 		(Opcional)

As condições descrevem as condições atuais do IngressExtension. Os tipos de condição conhecidos são:

  • “Aceito”
  • “Erros”

IngressReescreve

(Aparece em:IngressRuleSetting)

IngressRewrites fornece as várias regravações suportadas em uma regra

Campo Descrição
type
RewriteType

Type identifica o tipo de reescrita
requestHeaderModifier
HeaderFilter 		(Opcional)

RequestHeaderModifier define um esquema que modifica cabeçalhos de solicitação.
responseHeaderModifier
HeaderFilter 		(Opcional)

RequestHeaderModifier define um esquema que modifica cabeçalhos de resposta.
urlRewrite
URLRewriteFilter 		(Opcional)

URLRewrite define um esquema que modifica uma solicitação durante o encaminhamento.

IngressRuleSetting

(Aparece em:IngressExtensionSpec)

IngressRuleSetting fornece opções de configuração para regras

Campo Descrição
host
string

O host é usado para fazer a correspondência com as regras de entrada com o mesmo nome de host, a fim de identificar quais regras afetam essas configurações
additionalHostnames
[]string 		(Opcional)

AdditionalHostnames especifica mais nomes de host para ouvir
rewrites
[]IngressReescreve 		(Opcional)

Regravações define as regravações para a regra
requestRedirect
Redirecionamento 		(Opcional)

RequestRedirect define o comportamento de redirecionamento para a regra

IngressRuleStatus

(Aparece em:IngressExtensionStatus)

IngressRuleStatus descreve o estado de uma regra

Campo Descrição
host
string

O host identifica a regra descrita neste status
validationErrors
[]string 		(Opcional)

Os erros são uma lista de erros relacionados a essa configuração
valid
Bool 		(Opcional)

Valid indica que não há erros de validação presentes nesta regra

IngressTimeouts

(Aparece em:IngressBackendSettings)

IngressTimeouts pode ser usado para configurar propriedades de tempo limite para um Ingress

Campo Descrição
requestTimeout
Kubernetes meta/v1. Duração 		(Opcional)

RequestTimeout define o tempo limite usado pelo balanceador de carga ao encaminhar solicitações para um serviço de back-end

Tipo de política

(Aparece em:FrontendTLSPolicyConfig)

PolicyType é o tipo da política.

Campo Descrição
name
FrontendTLSPolicyTypeName

Nome é o nome da política.
type
FrontendTLSPolicyType

PredefinedFrontendTLSPolicyType é o tipo da política TLS Frontend predefinida.

PortNumber (int32 alias)

(Aparece em:Redirecionar)

PortNumber define uma porta de rede.

PreciseHostname (string alias)

(Aparece em:Redirect, URLRewriteFilter)

PreciseHostname é o nome de domínio totalmente qualificado de um host de rede. Isso corresponde à definição RFC 1123 de um nome de host, com uma exceção notável de que endereços IP numéricos não são’permitidos.

Por RFC1035 e RFC1123, um rótulo deve consistir em caracteres alfanuméricos minúsculos ou ‘-’, e deve começar e terminar com um caractere alfanumérico. Nenhuma outra pontuação é permitida.

Protocolo (string alias)

(Aparece em:IngressBackendPort)

O protocolo define o protocolo usado para determinadas propriedades. Os valores de protocolo válidos são:

  • HTTP
  • HTTPS
  • TCP
valor Description

"HTTP"

HTTP implica que o serviço usa HTTP

"HTTPS"

HTTPS implica que o serviço usa HTTPS

"TCP"

TCP implica que o serviço usa TCP simples

Redirecionamento

(Aparece em:IngressRuleSetting)

O redirecionamento define um filtro que redireciona uma solicitação. Isso NÃO DEVE ser usado na mesma regra que também tem um URLRewriteFilter.

Campo Descrição
scheme
string 		(Opcional)

Esquema é o esquema a ser usado no valor do Location cabeçalho na resposta. Quando vazio, o esquema da solicitação é usado.
hostname
PreciseHostname 		(Opcional)

Hostname é o nome do host a ser usado no valor do Location cabeçalho na resposta. Quando vazio, o Host nome do host no cabeçalho da solicitação é usado.
path
HTTPPathModifier 		(Opcional)

Path define parâmetros usados para modificar o caminho da solicitação de entrada. O caminho modificado é então usado para construir o Location cabeçalho. Quando vazio, o caminho da solicitação é usado como está.
port
Número da porta 		(Opcional)

Porta é a porta a ser usada no valor do Location cabeçalho na resposta.

Se nenhuma porta for especificada, a porta de redirecionamento DEVE ser derivada usando as seguintes regras:

  • Se o esquema de redirecionamento não estiver vazio, a porta de redirecionamento DEVE ser a porta bem conhecida associada ao esquema de redirecionamento. Especificamente “http” para a porta 80 e “https para a” porta 443. Se o esquema’de redirecionamento não tiver uma porta conhecida, a porta de ouvinte do Gateway DEVE ser usada.
  • Se o esquema de redirecionamento estiver vazio, a porta de redirecionamento DEVE ser a porta do Gateway Listener.

As implementações NÃO DEVEM adicionar o número da ‘porta no cabeçalho Location’ nos seguintes casos:

  • Um cabeçalho Location que usa HTTP (seja determinado por meio do protocolo Listener ou do campo Scheme) e usa a porta 80.
  • Um cabeçalho Location que usa HTTPS (seja isso determinado por meio do protocolo Listener ou do campo Scheme) e usa a porta 443.
statusCode
Int 		(Opcional)

StatusCode é o código de status HTTP a ser usado em resposta.

Valores podem ser adicionados a este enum, implementações devem garantir que valores desconhecidos não causarão’uma falha.

RewriteType (string alias)

(Aparece em:IngressRewrites)

RewriteType identifica o tipo de reescrita

valor Description

"RequestHeaderModifier"

RequestHeaderModifier pode ser usado para adicionar ou remover um cabeçalho HTTP de uma solicitação HTTP antes de ser’enviado para o destino upstream.

"ResponseHeaderModifier"

ResponseHeaderModifier pode ser usado para adicionar ou remover um cabeçalho HTTP de uma resposta HTTP antes de ser’enviado ao cliente.

"URLRewrite"

URLRewrite pode ser usado para modificar uma solicitação durante o encaminhamento.

Política de Rotas

RoutePolicy é o esquema para a API RoutePolicy

Campo Descrição
metadata
Kubernetes meta/v1. ObjectMeta 		(Opcional)

Metadados do objeto’.

Consulte a documentação da API do Kubernetes para obter os campos do metadata campo.
spec
RoutePolicySpec

Spec é a especificação RoutePolicy.



targetRef
CustomTargetRef

TargetRef identifica um objeto de API ao qual aplicar a política.
override
RoutePolicyConfig 		(Opcional)

A substituição define a configuração da política que deve substituir a configuração da política anexada abaixo do recurso de destino na hierarquia.

Nota: A substituição não é suportada no momento e resultará em um erro de validação. O suporte para Override será adicionado em uma versão futura.
default
RoutePolicyConfig 		(Opcional)

Default define a configuração de política padrão para o recurso de destino.
status
RoutePolicyStatus

Status define o estado atual de RoutePolicy.

RoutePolicyConditionReason (string alias)

RoutePolicyConditionReason define o conjunto de razões que explicam por que um determinado tipo de condição RoutePolicy é gerado.

valor Description

"Aceito"

RoutePolicyReasonAccepted é usado para definir o RoutePolicyConditionReason como Accepted quando o determinado RoutePolicy está configurado corretamente

"InvalidRoutePolicy"

RoutePolicyReasonInvalid é o motivo pelo qual o RoutePolicy não é’aceito

"Grupo Inválido"

RoutePolicyReasonInvalidGroup é usado quando o grupo é inválido

"InvalidHTTPRoute"

RoutePolicyReasonInvalidHTTPRoute é usado quando o HTTPRoute é inválido

"Inválido"

RoutePolicyReasonInvalidKind é usado quando o tipo/grupo é inválido

"Nome inválido"

RoutePolicyReasonInvalidName é usado quando o nome é inválido

"NoTargetReference"

RoutePolicyReasonNoTargetReference é usado quando não há’referência de destino

"OverrideNotSupported"

RoutePolicyReasonOverrideNotSupported é usado quando a substituição não é’suportada

"RefNotAllowed"

RoutePolicyReasonRefNotAllowed é usado quando a ref não é’permitida

"SectionNamesNotPermitted"

RoutePolicyReasonSectionNamesNotAllowed é usado quando os nomes de seção não são’permitidos

RoutePolicyConditionType (string alias)

RoutePolicyConditionType é um tipo de condição associada a um RoutePolicy. Esse tipo deve ser usado com o campo RoutePolicyStatus.Conditions.

valor Description

"Aceito"

RoutePolicyConditionAccepted é usado para definir o RoutePolicyConditionType como Accepted

"ResolvedRefs"

RoutePolicyConditionResolvedRefs é usado para definir o RoutePolicyCondition como ResolvedRefs

RoutePolicyConfig

(Aparece em:RoutePolicySpec)

RoutePolicyConfig define o esquema para a especificação RoutePolicy. Isso permite a especificação dos seguintes atributos: * Tempos limite * Afinidade de sessão

Campo Descrição
timeouts
RouteTimeouts 		(Opcional)

Tempo limite de tempo limite personalizado para o recurso de destino.
sessionAffinity
SessionAffinity

SessionAffinity define o esquema para a especificação de afinidade de sessão

RoutePolicySpec

(Aparece em:RoutePolicy)

RoutePolicySpec define o estado desejado de RoutePolicy

Campo Descrição
targetRef
CustomTargetRef

TargetRef identifica um objeto de API ao qual aplicar a política.
override
RoutePolicyConfig 		(Opcional)

A substituição define a configuração da política que deve substituir a configuração da política anexada abaixo do recurso de destino na hierarquia.

Nota: A substituição não é suportada no momento e resultará em um erro de validação. O suporte para Override será adicionado em uma versão futura.
default
RoutePolicyConfig 		(Opcional)

Default define a configuração de política padrão para o recurso de destino.

RoutePolicyStatus

(Aparece em:RoutePolicy)

RoutePolicyStatus define o estado observado de RoutePolicy.

Campo Descrição
conditions
[]Kubernetes meta/v1. Condição 		(Opcional)

As condições descrevem as condições atuais da RoutePolicy.

As implementações devem preferir expressar as condições de RoutePolicy usando as constantes e RoutePolicyConditionReason para que os operadores e as ferramentas possam convergir em um vocabulário comum para descrever o RoutePolicyConditionType estado de RoutePolicy.

Os tipos de condição conhecidos são:

  • “Aceito”

RouteTimeouts

(Aparece em:RoutePolicyConfig)

RouteTimeouts define o esquema para a especificação Timeouts

Campo Descrição
routeTimeout
Kubernetes meta/v1. Duração 		(Opcional)

RouteTimeout é o tempo limite para a rota.

SessionAffinity

(Aparece em:IngressBackendSettings, RoutePolicyConfig)

SessionAffinity define o esquema para a especificação de afinidade de sessão

Campo Descrição
affinityType
Tipo de afinidade
cookieName
string 		(Opcional)
cookieDuration
Kubernetes meta/v1. Duração 		(Opcional)

StatusCodes

(Aparece em:HTTPMatch)

StatusCodes define os correspondentes de código de status HTTP a serem usados para verificações de Verificação de Saúde.

Campo Descrição
start
Int32 		(Opcional)

Start define o início do intervalo de códigos de status a serem usados para verificações de verificação de integridade. Isto é inclusivo.
end
Int32 		(Opcional)

End define o fim do intervalo de códigos de status a serem usados para verificações de Verificação de Integridade. Isto é inclusivo.

URLRewriteFilter

(Aparece em:IngressRewrites)

URLRewriteFilter define um filtro que modifica uma solicitação durante o encaminhamento. No máximo, um desses filtros pode ser usado em uma regra. Isso NÃO DEVE ser usado na mesma regra com um sslRedirect.

Campo Descrição
hostname
PreciseHostname 		(Opcional)

Hostname é o valor a ser usado para substituir o valor do cabeçalho Host durante o encaminhamento.
path
HTTPPathModifier 		(Opcional)

Path define uma reescrita de caminho.