Você está visualizando a documentação do Apigee Edge.
Acesse a
documentação da
Apigee X. info
Edge Microgateway v. 3.0.x
O Apigee Edge Microgateway é um processador de mensagens seguro baseado em HTTP para APIs. A principal função dele é processar solicitações e respostas de e para serviços de back-end com segurança, enquanto envia dados de execução de API valiosos de forma assíncrona para o Apigee Edge, onde são consumidos pelo sistema de análise do Edge. O Edge Microgateway é fácil de instalar e implantar. Você pode configurar uma instância em poucos minutos.
Normalmente, o Edge Microgateway é instalado em uma rede confiável próxima aos serviços de destino de back-end. Ele oferece segurança de nível empresarial e alguns recursos importantes do plug-in, como limitação de picos, cota e análises, mas não os recursos completos ou a pegada do Apigee Edge. Se quiser, você pode instalar o Edge Microgateway no mesmo data center ou até mesmo na mesma máquina que seus 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 gerenciar a API Apigee para serviços executados em um cluster do Kubernetes. Se você estiver migrando serviços e APIs para a pilha do Kubernetes ou criando novos serviços e APIs, o Edge Microgateway ajuda a fornecer uma experiência de gerenciamento de API limpa que inclui segurança, gerenciamento de tráfego, análises, 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 da Cloud, como o Edge Microgateway, incluem:
- Redução da latência do tráfego de API para serviços executados na proximidade. Por exemplo, se os consumidores e produtores de APIs estiverem próximos, não é necessário que as APIs passem por uma porta-de-envio central.
- Mantém o tráfego da API dentro dos limites aprovados pela empresa para fins de segurança ou conformidade.
- Continuar processando mensagens se a conexão de Internet for perdida temporariamente.
- Ofereça gerenciamento de API da Apigee para serviços em execução em um cluster do Kubernetes. Consulte Integrar o Edge Microgateway com o Kubernetes.
Para mais casos de uso, consulte este artigo da comunidade da Apigee.
Principais recursos e benefícios
| Recurso | Vantagens |
|---|---|
| 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 do back-end com que o Edge Microgateway interage. |
| Analytics | O Edge Microgateway envia de forma assíncrona os dados de execução da API para o Apigee Edge, onde eles são processados pelo sistema Edge Analytics. Você pode 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 da API e os envie para o 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ária nenhuma programação 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. |
| 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, interromper e reiniciar o microgateway do Edge, 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, sua arquitetura básica, configuração e implantação.
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 de pegada relativamente pequeno executado perto dos seus aplicativos de back-end. Além disso, você pode aproveitar o Apigee Edge completo para análises, 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 da solicitação quando o Edge Microgateway é implantado na configuração mais simples possível, em que o Edge Microgateway e as APIs de destino do back-end são instalados na mesma máquina. Uma única instância do Edge Microgateway pode ser usada para apresentar vários aplicativos de destino de back-end.
Máquina diferente
Como toda a comunicação entre clientes, o microgateway do Edge e as implementações de API de back-end é HTTP, é possível instalar o microgateway do Apigee Edge em uma máquina diferente da implementação da API, conforme mostrado na Figura 2.
Com balanceador de carga
O próprio Edge Microgateway pode ser o front-end de um proxy reverso padrão ou balanceador de carga para terminação de SSL e/ou balanceamento de carga, conforme mostrado na Figura 3.
Implantação de intranet
Use o Edge Microgateway para proteger o tráfego da intranet e da Internet com o
Apigee Edge, conforme ilustrado na Figura 4. Digamos que um endpoint da API /orders seja
representado por um proxy pelo Apigee Edge Cloud e acesse 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, ele pode chamar /customers e
/transactions internamente. Consulte também
esta postagem na comunidade da Apigee.
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 microgateway do Edge 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 no produto da API associado a esse proxy.
- O sistema Apigee Edge Analytics armazena e processa dados da API enviados de forma assíncrona do microgateway do Edge.
- O Apigee Edge fornece credenciais usadas para assinar tokens de acesso ou fornecer chaves de API que são necessárias para clientes que fazem chamadas de API pelo microgateway do Edge. É possível receber esses tokens usando um comando da CLI fornecido com o Edge Microgateway.
Configuração única
Você precisa configurar o Edge Microgateway inicialmente 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.
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 o processamento de solicitações de API do cliente. As informações sobre esses proxies são transferidas 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 IU de gerenciamento do Apigee Edge ou por outros meios, se quiser. É fácil de fazer, e explicamos os detalhes em Como 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 aplicativo Node.js referenciado por um elemento ScriptTarget na definição de 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, elas serão ignoradas. Caso contrário, os proxies compatíveis com o microgateway do Edge 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 desenvolvedores.
- Os dados de tráfego aparecem no Edge Analytics.
- Eles não podem ser rastreados usando a ferramenta Apigee Edge Trace.
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 de análise do Edge. Essa comunicação assíncrona permite que o microgateway do Edge aproveite os recursos de análise do Edge, mantendo uma pegada relativamente pequena com o mínimo de processamento ou bloqueio. O pacote completo de painéis do Edge Analytics e recursos de relatórios personalizados está disponível 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 Google Analytics.
Sobre a segurança do Edge Microgateway
O papel do Apigee Edge
Como mencionado anteriormente, o Apigee Edge tem um papel na proteção de todas as solicitações de cliente para o Edge Microgateway. Os papéis principais do Apigee Edge são:
- Fornecer credenciais do cliente usadas como chaves de API ou para gerar tokens de acesso válidos usados por clientes para fazer chamadas de API seguras pelo microgateway do Edge.
- Fornecer as credenciais que o Edge Microgateway precisa para enviar dados de execução da API ao sistema de análise de borda da Apigee. Essas credenciais são obtidas uma vez pelo Edge Microgateway durante as etapas de configuração inicial.
- Oferecer a plataforma para agrupar recursos de API em produtos, registrar e gerenciar desenvolvedores e criar e gerenciar apps de desenvolvedor.
Autenticação do app cliente
O Edge Microgateway oferece suporte à autenticação do cliente por meio de 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. Se ele for válido, a chamada de API vai prosseguir para o destino de back-end. Se não for válido, um erro será retornado.
Consulte Como configurar e configurar a microgateway do Edge para ver 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úblico/secreto transmitido para a microgateway do Edge pela CLI ou usando variáveis de ambiente. Você vai receber e usar 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 para desenvolvedores. Por exemplo, assim como é possível criar e agrupar entidades, como produtos e apps para desenvolvedores, em proxies regulares do Apigee Edge, você pode 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 à forma como a segurança da API funciona no Apigee Edge.
Posso mover minhas implementações de proxy do Edge para o Edge Microgateway?
Não é possível migrar proxies existentes 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 ponto, os proxies não são usados. As políticas ou fluxos condicionais nesses proxies nunca serão executados.
Outro motivo para ter proxies compatíveis com microgateway é que o Edge Microgateway envia dados de análise de forma assíncrona para o Edge para cada proxy compatível com microgateway. Em seguida, você pode conferir os dados de análise de proxies compatíveis com microgateways da mesma forma que faria com qualquer outro proxy na interface da API de análise do Edge.
O tópico de configuração orienta você em todas as etapas necessárias para começar a usar o proxy de chamadas de API pelo Edge Microgateway, incluindo algumas etapas simples que você precisa realizar 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 instalar e configurar o Edge Microgateway.
Saiba mais sobre o Edge Microgateway
A Apigee oferece estes recursos:
-
Documentação do Edge Microgateway: inclui um guia de instalação e um tutorial para começar, 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 uma série de episódios sobre o Edge Microgateway.
-
A Comunidade da Apigee é um ótimo lugar para fazer perguntas e se beneficiar das perguntas e respostas de outras pessoas.