Visão geral do Edge Microgateway

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Edge Microgateway v. 2.4.x

Público-alvo

Este tópico é uma introdução geral ao Edge Microgateway destinada a todos os públicos.

O que é o Apigee Edge Microgateway?

O Apigee Edge Microgateway é um processador de mensagens seguro baseado em HTTP para APIs. O principal trabalho dele é processar solicitações e respostas de e para serviços de back-end com segurança, enquanto envia de forma assíncrona dados valiosos de execução de API para o Apigee Edge, onde são consumidos pelo sistema do Edge Analytics. O Edge Microgateway é fácil de instalar e implantar. Você pode ter uma instância em funcionamento em minutos.

Normalmente, o Edge Microgateway é instalado em uma rede confiável, bem perto dos serviços de destino de back-end. Ele oferece segurança de nível empresarial e alguns recursos importantes de plug-in, como proteção contra picos, cota e análise, mas não todos os recursos ou a capacidade total do Apigee Edge. Se quiser, você pode instalar o Edge Microgateway no mesmo data center ou até mesmo na mesma máquina que os serviços de back-end.

Principais casos de uso

Os casos de uso típicos de uma solução híbrida de gerenciamento de APIs na nuvem, como o Edge Microgateway incluem:

  • Reduzir a latência do tráfego de API para serviços executados na proximidade. Por exemplo, se os consumidores e produtores de API estiverem próximos, não será necessário que as APIs pas101}sem por um gateway central.

  • Manter o tráfego da API dentro dos limites aprovados pela empresa para fins de segurança ou conformidade propósitos.
  • Continuar processando mensagens se a conexão de Internet for perdida temporariamente.
  • Consulte também esta discussão de caso de uso na comunidade da Apigee.

Principais recursos e benefícios

  • Segurança. O Edge Microgateway autentica solicitações com um token de acesso assinado ou uma chave de API emitida para cada app cliente pelo Apigee Edge.
  • Implantação rápida. Ao contrário de uma implantação completa do Apigee Edge, é possível implantar e executar uma instância do Edge Microgateway em questão de minutos.
  • Proximidade da rede. É possível instalar e gerenciar o Edge Microgateway na mesma máquina, sub-rede ou data center que as APIs de destino de back-end com que o Edge Microgateway interage.
  • Analytics. O Edge Microgateway entrega dados de execução de API de forma assíncrona ao Apigee Edge, onde são processados pelo sistema do Edge Analytics. É possível usar o pacote completo de métricas, painéis e APIs do Edge Analytics.
  • Latência reduzida. Toda a comunicação com o Apigee Edge é assíncrona e não acontece como parte do processamento de solicitações da API do cliente. Isso permite que o Edge Microgateway colete dados de API e os envie ao Apigee Edge sem afetar a latência.
  • Familiaridade. O Edge Microgateway usa e interage com recursos do Apigee Edge que os administradores do Edge já conhecem bem, como proxies, produtos e apps de desenvolvedor.
  • Configuração. Nenhuma programação é necessária para configurar e gerenciar o Edge Microgateway. Tudo é processado pela configuração.
  • Conveniência. É possível integrar o Edge Microgateway à infraestrutura e aos processos de monitoramento e gerenciamento de aplicativos atuais.
  • Simples. É simples instalar, configurar e manter.
  • Geração de registros. Os arquivos de registro detalham todos os eventos normais e excepcionais encontrados durante o processamento da API pelo Edge Microgateway.
  • CLI. Uma interface de linha de comando permite iniciar, interromper e reiniciar o Edge Microgateway, extrair estatísticas operacionais, visualizar arquivos de registro, solicitar tokens de acesso e muito mais.

O que você precisa saber sobre o Edge Microgateway

Esta seção descreve como o Edge Microgateway funciona, a arquitetura básica, a configuração e a implantação dele.

Por que usar o Edge Microgateway?

Aproximar o componente de gerenciamento de APIs dos aplicativos de destino de back-end pode reduzir a latência da rede. Ainda que seja possível instalar o Apigee Edge no local em uma nuvem privada, uma implantação completa do Apigee Edge é grande e complexa o necessário para sustentar o conjunto completo de atributos e os recursos com grande volume de dados, como gerenciamento de chaves, monetização e análise. Isso significa que a implantação do Apigee Edge no local em cada data center nem sempre é desejável.

Com o Edge Microgateway, você recebe um aplicativo relativamente pequeno executado perto dos seus aplicativos de back-end. Além disso, você pode aproveitar o Apigee Edge completo para análise, segurança e outros recursos.

Exemplos de cenários de implantação

Esta seção ilustra vários cenários de implantação possíveis para o Edge Microgateway.

Mesma máquina

A Figura 1 mostra o caminho de processamento de solicitações quando o Edge Microgateway é implantado na configuração mais simples possível, em que o Edge Microgateway e as APIs de destino de back-end são instalados na mesma máquina.

Figura 1:a implantação mais simples do Edge Microgateway

Máquina diferente

Como toda a comunicação entre clientes, o Edge Microgateway e as implementações de API de back-end são HTTP, é possível instalar o Apigee Edge Microgateway em uma máquina diferente da implementação da API, conforme mostrado na Figura 2.

Figura 2:Edge Microgateway separado das APIs de destino de back-end

Proxy de vários aplicativos

Uma única instância do Edge Microgateway pode ser usada para representar vários aplicativos de destino de back-end, conforme mostrado na Figura 3.

Figura 3:o Edge Microgateway pode representar vários proxies de API

Com balanceador de carga

O Edge Microgateway pode ser representado por um proxy reverso padrão ou um balanceador de carga para encerramento de SSL e/ou balanceamento de carga, conforme mostrado na Figura 4.

Figura 4:execução do Edge Microgateway com um balanceador de carga

Implantação na intranet

Use o Edge Microgateway para proteger o tráfego da intranet e o tráfego da Internet com o Apigee Edge, conforme ilustrado na Figura 5. Digamos que um endpoint de API /orders seja representado por proxy pelo Apigee Edge Cloud e atinja o destino de back-end https://mycompany.com/orders. Isso é representado pela implementação da API de destino à esquerda. Essa API pode chamar vários endpoints de API representados pela implementação de destino à direita. Por exemplo, ela pode chamar internamente /customers e /transactions. Consulte também esta postagem na comunidade da Apigee.

Figura 5:execução do Edge Microgateway para proteger o tráfego da intranet

Dependência do Apigee Edge

O Edge Microgateway depende do Apigee Edge e interage com ele. O Edge Microgateway precisa se comunicar com o Apigee Edge para funcionar. As principais maneiras de interação do Edge Microgateway com o Edge são:

  • Na inicialização, o Edge Microgateway recebe uma lista de proxies especiais "compatíveis com o Edge Microgateway" e uma lista de todos os produtos da sua organização do Apigee Edge. Para cada solicitação de cliente recebida , o Edge Microgateway determina se a solicitação corresponde a um desses proxies de API e, em seguida, valida o token de acesso ou a chave de API recebida com base nas chaves do produto associado a esse proxy.
  • O sistema do Apigee Edge Analytics armazena e processa dados de API enviados de forma assíncrona pelo Edge Microgateway.
  • O Apigee Edge fornece credenciais usadas para assinar tokens de acesso ou fornecer chaves de API que são exigidas por clientes que fazem chamadas de API pelo Edge Microgateway. É possível receber esses tokens usando um comando da CLI.

Configuração única

Inicialmente, é necessário configurar o Edge Microgateway para que ele possa se comunicar com sua organização do Apigee Edge. Na inicialização, o Edge Microgateway inicia uma operação de inicialização com o Apigee Edge. O Edge Microgateway recupera do Apigee Edge as informações necessárias para processar chamadas de API por conta própria, incluindo a lista de proxies compatíveis com o Edge Microgateway implantados no Apigee Edge. Vamos falar mais sobre esses proxies em breve.

O Edge Microgateway não precisa estar colocalizado com o Apigee Edge. As ofertas de nuvem pública e privada do Apigee Edge funcionam igualmente bem.

Se você quiser aprender na prática, acesse Como configurar o Edge Microgateway, que explica o processo de configuração do Edge Microgateway usando um comando da CLI conveniente.

O que você precisa saber sobre proxies compatíveis com o Edge Microgateway

Os proxies compatíveis com o Edge Microgateway fornecem ao Edge Microgateway determinadas informações que permitem processar solicitações de API do cliente. As informações sobre esses proxies são transferidas por download do Apigee Edge para o Edge Microgateway quando ele é iniciado.

Você ou sua equipe de API podem criar esses proxies no Apigee Edge usando a interface de gerenciamento do Apigee Edge ou por outros meios, se quiser. É fácil fazer isso, e explicamos os detalhes em Como configurar o Edge Microgateway.

As características dos proxies compatíveis com o Edge Microgateway incluem:

  • Os proxies compatíveis com o Microgateway fornecem ao Edge Microgateway duas informações importantes: um caminho base e um URL de destino.
  • Os proxies compatíveis com o Microgateway precisam apontar para endpoints de destino HTTP. O destino de back-end não pode ser um app Node.js referenciado por um elemento ScriptTarget na definição TargetEndpoint. Consulte a observação anterior para mais informações.
  • Os nomes de proxy precisam ter o prefixo edgemicro_. Por exemplo: edgemicro_weather.
  • Os proxies do Edge Microgateway não podem ser editados no Editor de proxy da interface de gerenciamento do Apigee Edge Ou seja, não é possível adicionar políticas ou fluxos condicionais. Ou, se você tentar, eles serão ignorados.
  • Caso contrário, os proxies do Edge Microgateway aparecem na interface de gerenciamento do Edge da mesma forma que qualquer outro proxy de API no Edge.
  • Como acontece com qualquer proxy de API no Edge, os proxies do Edge Microgateway podem ser agrupados em produtos e associados a apps de desenvolvedor.
  • Como acontece com qualquer outro proxy, é possível acompanhar a análise de proxy do Edge Microgateway.
  • Os proxies do Edge Microgateway não podem ser rastreados usando a ferramenta de rastreamento do Apigee Edge.

Mais informações sobre o Edge Microgateway e o Apigee Edge Analytics

À medida que o tráfego da API flui pelo Edge Microgateway, ele armazena em buffer e envia de forma assíncrona dados de execução da API para o Apigee Edge, onde os dados são armazenados e processados pelo sistema do Edge Analytics. Essa comunicação assíncrona permite que o Edge Microgateway aproveite os recursos de análise do Edge, mantendo uma capacidade relativamente pequena com sobrecarga ou bloqueio de processamento mínimo. O pacote completo de painéis do Edge Analytics e os recursos de relatórios personalizados estão disponíveis para você e sua equipe analisarem o tráfego que passa pelo Edge Microgateway.

Figura 6:painel de tráfego de proxy no Edge

Para mais informações sobre o Edge Analytics, consulte Painéis do Analytics.

Sobre a segurança do Edge Microgateway

Função do Apigee Edge

Como mencionado anteriormente, o Apigee Edge desempenha um papel na proteção de todas as solicitações de clientes para o Edge Microgateway. As principais funções do Apigee Edge são:

  • Fornecer credenciais de cliente usadas como chaves de API ou para gerar tokens de acesso válidos usados por clientes para fazer chamadas de API seguras pelo Edge Microgateway.
  • Fornecer credenciais de que o Edge Microgateway precisa para enviar dados de execução de API ao sistema do Apigee Edge Analytics. Essas credenciais são recebidas uma vez pelo Edge Microgateway durante as etapas de configuração inicial. Consulte Como configurar o Edge Microgateway para conferir as etapas detalhadas.
  • Fornecer a plataforma para agrupar recursos de API em produtos, registrar e gerenciar desenvolvedores e criar e gerenciar apps de desenvolvedor.

Autenticação de apps clientes

  • O Edge Microgateway oferece suporte à autenticação de clientes por tokens de acesso e chaves de API chaves. As chaves e os tokens de segurança são gerados pelo Apigee Edge e validados pelo Edge Microgateway para cada chamada de API.
  • Se o plug-in oauth estiver ativado, o Edge Microgateway vai verificar um token de acesso assinado ou uma chave de API e, se for válido, a chamada de API vai para o destino de back-end. Se não for válido, um erro será retornado.
  • Consulte Como configurar o Edge Microgateway para conferir as etapas necessárias para receber e usar tokens de acesso. Para informações sobre chaves de API, consulte "Como usar a segurança de chaves de API" em Referência de operação e configuração do Edge Microgateway.

Autenticação do Edge Microgateway no Apigee Edge

  • As chamadas assíncronas que o Edge Microgateway faz para atualizar dados de análise no Apigee Edge exigem autenticação. Essa autenticação é fornecida por um par de chaves pública/secreta transmitido ao Edge Microgateway pela CLI ou usando variáveis de ambiente. Você recebe e usa essas chaves uma vez ao instalar e iniciar o Edge Microgateway.

Plataforma de gerenciamento de produtos de API

  • O Edge serve como uma plataforma para agrupar recursos de API em produtos, registrar e gerenciar desenvolvedores e criar e gerenciar apps de desenvolvedor. Por exemplo, assim como é possível criar e agrupar entidades como produtos e apps de desenvolvedor para proxies normais do Apigee Edge, é possível fazer exatamente o mesmo para proxies do Edge Microgateway. A segurança no nível da API é possível gerando chaves de segurança pública e privada para cada "pacote". Esse mecanismo é idêntico à maneira como a segurança da API funciona no Apigee Edge.

Posso migrar minhas implementações de proxy do Edge para o Edge Microgateway?

Não é possível migrar proxies atuais com políticas associadas ou fluxos condicionais para o Edge Microgateway. O Edge Microgateway exige que você crie novos proxies "compatíveis com o Microgateway". Esses proxies precisam ser nomeados com um prefixo especial, edgemicro_. Na inicialização, o Edge Microgateway descobre esses proxies edgemicro_* e faz o download das informações de configuração de cada um deles. Essas informações incluem os URLs de destino e os caminhos de recursos. A partir desse momento, os proxies não são usados. Todas as políticas ou fluxos condicionais nesses proxies nunca serão executados.

Outro motivo para ter proxies compatíveis com o Microgateway é que o Edge Microgateway envia dados de análise de forma assíncrona para o Edge de cada proxy compatível com o Microgateway. Em seguida, é possível visualizar os dados de análise de proxies compatíveis com o Microgateway da mesma forma que faria para qualquer outro proxy na interface do Edge Analytics.

O tópico de configuração explica todas as etapas necessárias para começar a representar chamadas de API pelo Edge Microgateway, incluindo algumas etapas simples que precisam ser feitas no Apigee Edge para configurar uma configuração necessária para o Edge Microgateway, incluindo a criação de proxies compatíveis com o Microgateway. Consulte Como configurar o Edge Microgateway.

Posso usar políticas com proxies do Edge Microgateway?

Conforme explicado na seção anterior, não é possível anexar políticas a proxies "compatíveis com o Microgateway" no Apigee Edge. O Edge Microgateway usa plug-ins para fornecer funcionalidades semelhantes às políticas no Edge, como cota, proteção contra picos, segurança de chaves de API e segurança OAuth2. Consulte Como usar plug-ins. Também é possível gravar plug-ins personalizados, conforme explicado em Como desenvolver plug-ins personalizados.

Qual é a melhor maneira de aprender sobre o Edge Microgateway?

A Apigee fornece estes recursos: