Você está lendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. info
Edge Microgateway v. 2.5.x
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 detenção de pico, 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.
É possível executar o Edge Microgateway como um processo independente ou em um contêiner do Docker. Consulte Como usar o Docker com o Edge Microgateway. Também é possível usar o Edge Microgateway para fornecer o gerenciamento de APIs da Apigee para serviços executados em um cluster do Kubernetes. Se você estiver migrando serviços e APIs atuais para a pilha do Kubernetes ou criando novos serviços e APIs, o Edge Microgateway ajudará a oferecer uma experiência de gerenciamento de APIs limpa, que inclui segurança, gerenciamento de tráfego, análise, publicação e muito mais. Consulte Integrar o Edge Microgateway ao Kubernetes.
Casos de uso típicos
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.
- Fornecer o gerenciamento de APIs da Apigee para serviços executados em um cluster do Kubernetes. Consulte Integrar o Edge Microgateway ao Kubernetes.
Para outros casos de uso, consulte este artigo da comunidade da Apigee (em inglês).
Principais recursos e benefícios
| Recurso | 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 | Não é necessário programar 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. |
| Logging | Os arquivos de registro detalham todos os eventos normais e excepcionais encontrados durante o processamento de API pelo Edge Microgateway. |
| CLI | Uma interface de linha de comando permite iniciar, parar 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. Uma única instância do Edge Microgateway pode ser usada para representar vários aplicativos de destino de back-end.
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.
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 3.
Implantação na intranet
Use o Edge Microgateway para proteger o tráfego da intranet enquanto protege o tráfego da Internet com
o Apigee Edge, conforme ilustrado na Figura 4. 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 (em inglês).
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 corretamente. 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 de API 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 de API 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 fornecido com o Edge Microgateway.
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 que são 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.
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 algumas 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 o Edge Microgateway é 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 vamos explicar os detalhes em Comoconfigurar e configurar o Edge Microgateway.
As características dos proxies compatíveis com o Edge Microgateway são:
- Eles fornecem ao Edge Microgateway duas informações importantes: um caminho base e um URL de destino.
- Eles 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. - Não é possível adicionar políticas ou fluxos condicionais a esses proxies. Se você tentar, eles serão ignorados. Caso contrário, os proxies compatíveis com o Edge Microgateway aparecem na interface de gerenciamento do Edge da mesma forma que qualquer outro proxy de API no Edge.
- Eles podem ser agrupados em produtos e associados a apps de desenvolvedor.
- As informações de trânsito aparecem no Edge Analytics.
- Não é possível rastreá-los usando a ferramenta de rastreamento do Apigee Edge.
Sobre o Edge Microgateway e o Apigee Edge Analytics
À medida que o tráfego da API flui pelo Edge Microgateway, o Edge Microgateway armazena em buffer e envia de forma assíncrona dados de execução de 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.
Para mais informações sobre o Edge Analytics, consulte Painéis do Analytics.
Sobre a segurança do Edge Microgateway
O papel 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. Os principais papéis 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.
- Fornecer a plataforma para agrupar recursos de API em produtos, registrar e gerenciar desenvolvedores e criar e gerenciar apps de desenvolvedor.
Autenticação de app cliente
O Edge Microgateway oferece suporte à autenticação do cliente por tokens de acesso e chaves de API. 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 e configurar o Edge Microgateway para conferir as etapas necessárias para receber e usar tokens de acesso e chaves de API.
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úblicas e privadas 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. Nenhuma política ou fluxo condicional nesses proxies será executado.
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 orienta você por todas as etapas necessárias para começar a representar chamadas de API pelo Edge Microgateway, incluindo algumas etapas simples que você precisa fazer no Apigee Edge para configurar uma configuração de que o Edge Microgateway precisa, incluindo a criação de proxies compatíveis com o microgateway. Consulte Como configurar e configurar o Edge Microgateway.
Saiba mais sobre o Edge Microgateway
A Apigee fornece estes recursos:
-
Documentação do Edge Microgateway (em inglês) – a documentação inclui um guia de instalação e um tutorial de primeiros passos, além de informações completas de referência e configuração.
-
Vídeos – a série de vídeos de quatro minutos da Apigee para desenvolvedores inclui um conjunto de episódios sobre o Edge Microgateway.
-
Fórum do Edge Micro – o fórum do Edge Micro na comunidade da Apigee é um ótimo lugar para fazer perguntas e aproveitar as perguntas feitas e respondidas por outras pessoas.