Compartilhar via

Implantar um gateway auto-hospedado do Gerenciamento de API do Azure nos Aplicativos de Contêiner do Azure

APLICA-SE A: Desenvolvedor | Premium

Este artigo fornece as etapas para implantar o componente de gateway auto-hospedado do Gerenciamento de API do Azure nos Aplicativos de Contêiner do Azure.

Implante um gateway auto-hospedado em um aplicativo de contêiner para acessar APIs hospedadas no mesmo ambiente de Aplicativos de Contêiner do Azure.

Pré-requisitos

Provisionar um gateway na sua instância do Gerenciamento de API do Azure

Antes de implantar um gateway auto-hospedado, provisione um recurso de gateway em sua instância de Gerenciamento de API do Azure. Para ver as etapas, consulte Provisionar um gateway autohospedado. Nos exemplos deste artigo, o gateway é nomeado my-gateway.

Obter configurações de implantação de gateway do Gerenciamento de API

Para implantar o gateway, você precisa dos valores de token e de ponto de extremidade de configuração do gateway. Você pode encontrá-los no portal do Azure:

  1. Entre no portal do Azure e acesse sua instância de Gerenciamento de API do Azure.
  2. No menu à esquerda, em Implantação + infraestrutura, selecione gateways autogerenciados.
  3. Selecione o recurso de gateway que você provisionou e selecione Configurações>Implantação.
  4. Copie os valores do token e do ponto de extremidade de configuração .

Implantar o gateway auto-hospedado em um aplicativo de contêiner

Você pode implantar a imagem de contêiner de gateway auto-hospedada em um aplicativo de contêiner usando o portal do Azure, a CLI do Azure ou outras ferramentas. Este artigo mostra as etapas usando a CLI do Azure.

Criar um ambiente de aplicativos de contêiner

Primeiro, crie um ambiente de aplicativos de contêiner usando o comando az containerapp env create :

#!/bin/bash
az containerapp env create --name my-environment --resource-group myResourceGroup \
    --location centralus

Este comando cria:

  • Um ambiente de aplicativo de contêiner chamado my-environment que você usa para agrupar aplicativos de contêiner.
  • Um workspace do Log Analytics

Criar um aplicativo de contêiner para o gateway hospedado localmente

Para implantar o gateway auto-hospedado em um aplicativo de contêiner no ambiente, execute o comando az containerapp create .

Primeiro, defina variáveis para os valores de Token e ponto de extremidade de configuração do recurso de gateway do Gerenciamento de API do Azure.

#!/bin/bash
endpoint="<API Management configuration endpoint>"
token="<API Management gateway token>"

Crie o aplicativo de contêiner usando o az containerapp create comando:

#!/bin/bash
az containerapp create --name my-gateway \
    --resource-group myResourceGroup --environment 'my-environment' \
    --image "mcr.microsoft.com/azure-api-management/gateway:2.9.2" \
    --target-port 8080 --ingress external \
    --min-replicas 1 --max-replicas 3 \
    --env-vars "config.service.endpoint"="$endpoint" "config.service.auth"="$token" "net.server.http.forwarded.proto.enabled"="true"

Este comando cria:

  • Um aplicativo denominado contêiner my-gateway no grupo de recursos myResourceGroup. Neste exemplo, o aplicativo de contêiner usa a mcr.microsoft.com/azure-api-management/gateway:2.9.2 imagem. Para obter mais informações sobre o gateway auto-hospedado, consulte imagens de contêiner.

  • Suporte para entrada externa para o aplicativo de contêiner na porta 8080.

  • Um mínimo de 1 e um máximo de 3 réplicas do aplicativo de contêiner.

  • Uma conexão do gateway auto-hospedado à instância de Gerenciamento de API do Azure, passando valores de configuração em variáveis de ambiente. Para obter detalhes, confira as configurações de contêiner de gateway auto-hospedado.

    Observação

    A entrada dos Aplicativos de Contêiner do Azure encaminha solicitações HTTPS para o aplicativo de contêiner de gateway auto-hospedado como HTTP. Aqui, a variável de ambiente net.server.http.forwarded.proto.enabled é definida para true para que o gateway auto-hospedado use o cabeçalho X-Forwarded-Proto para determinar o protocolo original da solicitação.

Confirme se o aplicativo de contêiner está em execução

  1. Entre no portal do Azure e acesse seu aplicativo de contêiner.

  2. Na página Visão geral do aplicativo de contêiner, verifique se o Status está em execução.

  3. Enviar uma solicitação de teste para o ponto de extremidade de status em /status-012345678990abcdef. Por exemplo, use um curl comando semelhante ao comando a seguir.

    curl -i https://my-gateway.happyvalley-abcd1234.centralus.azurecontainerapps.io/status-012345678990abcdef

    Uma solicitação bem-sucedida retorna uma 200 OK resposta.

Dica

Usando a CLI, você também pode executar o comando az containerapp show para verificar o status do aplicativo de contêiner.

Confirme se o gateway está funcionando corretamente

  1. Entre no portal do Azure e acesse sua instância de Gerenciamento de API do Azure.

  2. No menu à esquerda, em Implantação + infraestrutura, selecione gateways autogerenciados.

  3. Na página Visão geral , verifique o Status do gateway. Se o gateway estiver íntegro, ele relatará pulsações regulares do gateway.

    Captura de tela do status do gateway no portal.

Cenário de exemplo

O exemplo a seguir mostra como você pode usar o gateway auto-hospedado para acessar uma API hospedada em um aplicativo de contêiner no mesmo ambiente. Conforme mostrado no diagrama a seguir, o gateway auto-hospedado pode ser acessado pela Internet, enquanto a API só pode ser acessada no ambiente de aplicativos de contêiner.

Diagrama do cenário de exemplo com gateway auto-hospedado.

  1. Implante um aplicativo de contêiner que hospeda uma API no mesmo ambiente que o gateway auto-hospedado.
  2. Adicione a API à instância de Gerenciamento de API do Azure.
  3. Chame a API por meio do gateway auto-hospedado.

Implantar um aplicativo de contêiner que hospeda uma API no mesmo ambiente que o gateway auto-hospedado

Neste exemplo, você implanta uma API de álbum de música de exemplo em um aplicativo de contêiner. Para acessar a API posteriormente usando o gateway auto-hospedado, implante a API no mesmo ambiente que o gateway auto-hospedado. Para obter etapas detalhadas e informações sobre os recursos usados neste exemplo, consulte Início Rápido: Compilar e implantar do código-fonte local nos Aplicativos de Contêiner do Azure. As etapas abreviadas seguem:

  1. Baixe o código-fonte do Python no computador local. Se preferir, baixe o código-fonte em outro idioma de sua escolha.

  2. Extraia o código-fonte para uma pasta local e altere para a pasta containerapps-albumapi-python-main/src .

  3. Execute o comando az containerapp up a seguir para implantar a API em um aplicativo de contêiner no mesmo ambiente que o gateway auto-hospedado. Observe que no final do comando ., especifica-se a pasta atual como a origem do aplicativo de contêiner.

    #!/bin/bash
az containerapp up --name albums-api \
    --resource-group myResourceGroup --location centralus \
    --environment my-environment --source .

  4. Confirme se o aplicativo de contêiner está em execução e acessível externamente no FQDN retornado na saída do comando. Por padrão, a API está acessível na /albums endpoint. Exemplo: https://albums-api.happyvalley-abcd1234.centralus.azurecontainerapps.io/albums/albums.

Configurar a API para entrada interna

Agora atualize o aplicativo de contêiner que hospeda a API de exemplo para habilitar a entrada somente no ambiente de contêiner. Essa configuração restringe o acesso à API somente do gateway auto-hospedado que você implantou.

  1. Entre no portal do Azure e acesse seu aplicativo de contêiner.
  2. No menu à esquerda, selecione Rede>Ingress.
  3. Defina a entrada como Habilitada.
  4. Em Tráfego de entrada, selecione Limitado a ambiente de Aplicativos de Contêiner.
  5. Examine as configurações restantes e selecione Salvar.

Adicionar a API à instância de Gerenciamento de API do Azure

As etapas a seguir mostram como adicionar uma API à instância do Gerenciamento de API do Azure e configurar um back-end de API. Para obter mais informações, consulte Adicionar uma API ao Gerenciamento de API do Azure.

Adicionar a API à instância de Gerenciamento de API

  1. No portal do Azure, vá para a instância de Gerenciamento de API em que você configurou o gateway auto-hospedado.
  2. No menu à esquerda, selecione APIs>APIs>+ Adicionar API.
  3. Selecione HTTP e selecione Completo. Insira as seguintes configurações:
    1. Nome de exibição: insira um nome descritivo. Exemplo: API de álbuns.
    2. URL do serviço Web: insira o FQDN interno do aplicativo de contêiner que hospeda a API. Exemplo: http://albums-api.internal.happyvalley-abcd1234.centralus.azurecontainerapps.io.
    3. Esquema de URL: Selecione HTTP(S).
    4. Sufixo de URL da API: insira um sufixo de sua escolha. Exemplo: albumapi.
    5. Gateways: selecione o gateway auto-hospedado que você provisionou. Exemplo: my-gateway.
  4. Defina outras configurações de API de acordo com seu cenário. Selecione Criar.

Adicionar uma operação de API

  1. No menu à esquerda, selecioneAPIs>a API de Álbuns.
  2. Selecione + Adicionar operação.
  3. Insira as configurações de operação:
    1. Nome de exibição: insira um nome descritivo para a operação. Exemplo: Obter álbuns.
    2. URL: Selecione GET e insira /albums para o endpoint.
    3. Clique em Salvar.

Chame a API através do gateway auto-hospedado

Chame a API usando o FQDN do gateway auto-hospedado em execução no aplicativo de contêiner. Localize o FQDN na página visão geral do aplicativo de contêiner no portal do Azure ou execute o comando a seguir az containerapp show .

#!/bin/bash
az containerapp show --name my-gateway --resource-group myResourceGroup \
    --query "properties.configuration.ingress.fqdn" --output tsv

Por exemplo, execute o seguinte comando curl para chamar a API no endpoint /albumapi/albums. Se a API exigir uma chave de assinatura, passe uma chave de assinatura válida para sua instância de Gerenciamento de API como um cabeçalho na solicitação:

curl -i https://my-gateway.happyvalley-abcd1234.centralus.azurecontainerapps.io/albumapi/albums -H "Ocp-Apim-Subscription-Key: <subscription-key>"

Quando o teste é bem-sucedido, o back-end responde com um código de resposta HTTP bem-sucedido e alguns dados.

HTTP/1.1 200 OK
content-length: 751
content-type: application/json
date: Wed, 28 Feb 2024 22:45:09 GMT
[...]

[{"id":1,"title":"You, Me and an App Id","artist":"Daprize","price":10.99,"image_url":"https://aka.ms/albums-daprlogo"},{"id":2,"title":"Seven Revision Army","artist":"The Blue-Green Stripes","price":13.99,"image_url":"https://aka.ms/albums-containerappslogo"},{"id":3,"title":"Scale It Up","artist":"KEDA Club","price":13.99,"image_url":"https://aka.ms/albums-kedalogo"},{"id":4,"title":"Lost in Translation","artist":"MegaDNS","price":12.99,"image_url":"https://aka.ms/albums-envoylogo"},{"id":5,"title":"Lock Down Your Love","artist":"V is for VNET","price":12.99,"image_url":"https://aka.ms/albums-vnetlogo"},{"id":6,"title":"Sweet Container O' Mine","artist":"Guns N Probeses","price":14.99,"image_url":"https://aka.ms/albums-containerappslogo"}]

Dica

Se você habilitar o log da API no Application Insights, poderá consultar os logs para ver as solicitações e respostas.

Limitações

As instâncias de gateway auto-hospedadas dependem do protocolo UDP para comunicações de pulsação e limitação de taxa. Como os Aplicativos de Contêiner do Azure atualmente não dão suporte ao protocolo UDP, nem para entrada nem para tráfego interno, a rate-limit política não pode sincronizar seu contador entre instâncias. Consequentemente, manter três réplicas de um aplicativo de contêiner de gateway autogerenciado com limite X pode resultar em um tráfego três vezes maior até que o limite X seja atingido.

Os Aplicativos de Contêiner do Azure distribuem solicitações linearmente em cada réplica disponível e íntegra. Para implementar a limitação de taxa, você pode dividir o limite desejado pelo número de réplicas que deseja executar e definir o valor resultante na configuração. Essa abordagem tem suas próprias limitações, pois talvez não seja possível contabilizar contadores ajustados se, e quando, seus aplicativos de contêiner forem escalados.

Conteúdo relacionado

  • Last updated on