Reconfiguração de cabeçalho para o Gateway de Aplicativo do Azure para Contêineres - API de Gateway

Artigo
05/09/2024

O Application Gateway for Containers permite reescrever cabeçalhos HTTP de solicitações de clientes e respostas de destinos de back-end.

Detalhes de utilização

As regravações de cabeçalho aproveitam os filtros conforme definido pela API do Kubernetes Gateway.

Fundo

As regravações de cabeçalho permitem que você modifique os cabeçalhos de solicitação e resposta de e para seus destinos de back-end.

A figura a seguir ilustra uma solicitação com um agente de usuário específico sendo reescrito em um valor simplificado chamado SearchEngine-BingBot quando a solicitação é iniciada no destino de back-end pelo Application Gateway for Containers:

Pré-requisitos

Se estiver seguindo a estratégia de implantação do BYO, certifique-se de configurar os recursos do Application Gateway for Containers e do ALB Controller
Se você estiver seguindo a estratégia de implantação gerenciada ALB, garanta o provisionamento dos recursos do Controlador ALB e do Application Gateway for Containers por meio do recurso personalizado ApplicationLoadBalancer.
Implantar aplicativo HTTP de exemplo Aplique o seguinte arquivo deployment.yaml em seu cluster para criar um aplicativo Web de exemplo para demonstrar a regravação do cabeçalho.
```
kubectl apply -f https://trafficcontrollerdocs.blob.core.windows.net/examples/traffic-split-scenario/deployment.yaml
```
Este comando cria o seguinte no cluster:
- um namespace chamado test-infra
- Dois serviços chamados backend-v1 e backend-v2 no test-infra namespace
- duas implantações chamadas backend-v1 e backend-v2 no test-infra namespace

Implantar os recursos necessários da API do Gateway

Implantação gerenciada ALB
Traga sua própria implantação (BYO)

Crie um gateway:

kubectl apply -f - <<EOF
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
  name: gateway-01
  namespace: test-infra
  annotations:
    alb.networking.azure.io/alb-namespace: alb-test-infra
    alb.networking.azure.io/alb-name: alb-test
spec:
  gatewayClassName: azure-alb-external
  listeners:
  - name: http-listener
    port: 80
    protocol: HTTP
    allowedRoutes:
      namespaces:
        from: Same
EOF

Nota

Quando o controlador ALB cria os recursos do Application Gateway for Containers em ARM, ele usará a seguinte convenção de nomenclatura para um recurso frontend: fe-8< caracteres gerados aleatoriamente>

Se você quiser alterar o nome do frontend criado no Azure, considere seguir a estratégia traga sua própria implantação.

Defina as seguintes variáveis de ambiente

RESOURCE_GROUP='<resource group name of the Application Gateway For Containers resource>'
RESOURCE_NAME='alb-test'

RESOURCE_ID=$(az network alb show --resource-group $RESOURCE_GROUP --name $RESOURCE_NAME --query id -o tsv)
FRONTEND_NAME='frontend'

Criar um gateway

kubectl apply -f - <<EOF
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
  name: gateway-01
  namespace: test-infra
  annotations:
    alb.networking.azure.io/alb-id: $RESOURCE_ID
spec:
  gatewayClassName: azure-alb-external
  listeners:
  - name: http-listener
    port: 80
    protocol: HTTP
    allowedRoutes:
      namespaces:
        from: Same
  addresses:
  - type: alb.networking.azure.io/alb-frontend
    value: $FRONTEND_NAME
EOF

Depois que o recurso de gateway for criado, verifique se o status é válido, se o ouvinte está programado e se um endereço é atribuído ao gateway.

kubectl get gateway gateway-01 -n test-infra -o yaml

Exemplo de saída da criação bem-sucedida do gateway.

status:
  addresses:
  - type: IPAddress
    value: xxxx.yyyy.alb.azure.com
  conditions:
  - lastTransitionTime: "2023-06-19T21:04:55Z"
    message: Valid Gateway
    observedGeneration: 1
    reason: Accepted
    status: "True"
    type: Accepted
  - lastTransitionTime: "2023-06-19T21:04:55Z"
    message: Application Gateway For Containers resource has been successfully updated.
    observedGeneration: 1
    reason: Programmed
    status: "True"
    type: Programmed
  listeners:
  - attachedRoutes: 0
    conditions:
    - lastTransitionTime: "2023-06-19T21:04:55Z"
      message: ""
      observedGeneration: 1
      reason: ResolvedRefs
      status: "True"
      type: ResolvedRefs
    - lastTransitionTime: "2023-06-19T21:04:55Z"
      message: Listener is accepted
      observedGeneration: 1
      reason: Accepted
      status: "True"
      type: Accepted
    - lastTransitionTime: "2023-06-19T21:04:55Z"
      message: Application Gateway For Containers resource has been successfully updated.
      observedGeneration: 1
      reason: Programmed
      status: "True"
      type: Programmed
    name: https-listener
    supportedKinds:
    - group: gateway.networking.k8s.io
      kind: HTTPRoute

Depois que o gateway for criado, crie um HTTPRoute que ouça o nome do host contoso.com e substitua o valor do agente do usuário para SearchEngine-BingBot.

Neste exemplo, procuramos o agente de usuário usado pelo mecanismo de pesquisa do Bing e simplificamos o cabeçalho para SearchEngine-BingBot para facilitar a análise de back-end.

Este exemplo também demonstra a adição de um novo cabeçalho chamado AGC-Header-Add com um valor de e remove um cabeçalho de AGC-value solicitação chamado client-custom-header.

Gorjeta

Para este exemplo, embora possamos usar o HTTPHeaderMatch de "Exact" para uma correspondência de cadeia de caracteres, uma demonstração é usada na expressão regular para ilustrar outros recursos.

kubectl apply -f - <<EOF
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
  name: header-rewrite-route
  namespace: test-infra
spec:
  parentRefs:
    - name: gateway-01
      namespace: test-infra
  hostnames:
    - "contoso.com"
  rules:
    - matches:
        - headers:
          - name: user-agent
            value: Mozilla/5\.0 AppleWebKit/537\.36 \(KHTML, like Gecko; compatible; bingbot/2\.0; \+http://www\.bing\.com/bingbot\.htm\) Chrome/
            type: RegularExpression
      filters:
        - type: RequestHeaderModifier
          requestHeaderModifier:
            set:
              - name: user-agent
                value: SearchEngine-BingBot
            add:
              - name: AGC-Header-Add
                value: AGC-value
            remove: ["client-custom-header"]
      backendRefs:
        - name: backend-v2
          port: 8080
    - backendRefs:
        - name: backend-v1
          port: 8080
EOF

Depois que o recurso HTTPRoute for criado, verifique se a rota é Aceita e se o recurso Application Gateway for Containers está Programado.

kubectl get httproute header-rewrite-route -n test-infra -o yaml

Verifique se o status do recurso Application Gateway for Containers foi atualizado com êxito.

status:
  parents:
  - conditions:
    - lastTransitionTime: "2023-06-19T22:18:23Z"
      message: ""
      observedGeneration: 1
      reason: ResolvedRefs
      status: "True"
      type: ResolvedRefs
    - lastTransitionTime: "2023-06-19T22:18:23Z"
      message: Route is Accepted
      observedGeneration: 1
      reason: Accepted
      status: "True"
      type: Accepted
    - lastTransitionTime: "2023-06-19T22:18:23Z"
      message: Application Gateway For Containers resource has been successfully updated.
      observedGeneration: 1
      reason: Programmed
      status: "True"
      type: Programmed
    controllerName: alb.networking.azure.io/alb-controller
    parentRef:
      group: gateway.networking.k8s.io
      kind: Gateway
      name: gateway-01
      namespace: test-infra

Testar o acesso à aplicação

Agora estamos prontos para enviar algum tráfego para o nosso aplicativo de exemplo, através do FQDN atribuído ao frontend. Use o seguinte comando para obter o FQDN:

fqdn=$(kubectl get gateway gateway-01 -n test-infra -o jsonpath='{.status.addresses[0].value}')

Se você especificar o indicador de nome do servidor usando o comando curl, contoso.com para o FQDN frontend, a saída deverá retornar uma resposta do serviço backend-v1.

fqdnIp=$(dig +short $fqdn)
curl -k --resolve contoso.com:80:$fqdnIp http://contoso.com

Através da resposta devemos ver:

{
 "path": "/",
 "host": "contoso.com",
 "method": "GET",
 "proto": "HTTP/1.1",
 "headers": {
  "Accept": [
   "*/*"
  ],
  "User-Agent": [
   "curl/7.81.0"
  ],
  "X-Forwarded-For": [
   "xxx.xxx.xxx.xxx"
  ],
  "X-Forwarded-Proto": [
   "http"
  ],
  "X-Request-Id": [
   "dcd4bcad-ea43-4fb6-948e-a906380dcd6d"
  ]
 },
 "namespace": "test-infra",
 "ingress": "",
 "service": "",
 "pod": "backend-v1-5b8fd96959-f59mm"
}

Especificar um cabeçalho de agente do usuário com o valor '' deve retornar uma resposta do serviço de back-end do SearchEngine-BingBot:

fqdnIp=$(dig +short $fqdn)
curl -k --resolve contoso.com:80:$fqdnIp http://contoso.com -H "user-agent: Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/"

Através da resposta devemos ver:

{
 "path": "/",
 "host": "fabrikam.com",
 "method": "GET",
 "proto": "HTTP/1.1",
 "headers": {
  "Accept": [
   "*/*"
  ],
  "User-Agent": [
   "curl/7.81.0"
  ],
  "X-Forwarded-For": [
   "xxx.xxx.xxx.xxx"
  ],
  "X-Forwarded-Proto": [
   "http"
  ],
  "X-Request-Id": [
   "adae8cc1-8030-4d95-9e05-237dd4e3941b"
  ]
 },
 "namespace": "test-infra",
 "ingress": "",
 "service": "",
 "pod": "backend-v2-5b8fd96959-f59mm"
}

A especificação de um client-custom-header cabeçalho com o valor moo deve ser removida da solicitação quando o Application Gateway for Containers iniciar a conexão com o serviço de back-end:

fqdnIp=$(dig +short $fqdn)
curl -k --resolve contoso.com:80:$fqdnIp http://contoso.com -H "client-custom-header: moo"

Através da resposta devemos ver:

{
 "path": "/",
 "host": "fabrikam.com",
 "method": "GET",
 "proto": "HTTP/1.1",
 "headers": {
  "Accept": [
   "*/*"
  ],
  "User-Agent": [
   "curl/7.81.0"
  ],
  "X-Forwarded-For": [
   "xxx.xxx.xxx.xxx"
  ],
  "X-Forwarded-Proto": [
   "http"
  ],
  "X-Request-Id": [
   "kd83nc84-4325-5d22-3d23-237dd4e3941b"
  ]
 },
 "namespace": "test-infra",
 "ingress": "",
 "service": "",
 "pod": "backend-v2-5b8fd96959-f59mm"
}

Parabéns, você instalou o ALB Controller, implantou um aplicativo de back-end e modificou os valores de cabeçalho via API do Gateway no Application Gateway for Containers.

Partilhar via

Reconfiguração de cabeçalho para o Gateway de Aplicativo do Azure para Contêineres - API de Gateway

Detalhes de utilização

Fundo

Pré-requisitos

Implantar os recursos necessários da API do Gateway

Testar o acesso à aplicação

Comentários

Recursos adicionais