Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
Edge Microgateway v. 3.3.x
O Apigee Edge Microgateway é um processador de mensagens seguro e 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, enviando de maneira assíncrona dados de execução de API valiosos para o Apigee Edge, onde são consumidos pelo sistema Edge Analytics. O Edge Microgateway é fácil de instalar e implantar. Você pode ter uma instância funcionando em 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 de plug-in importantes, como detenção de pico, cota e análise, mas não todos os recursos ou a abrangência do Apigee Edge. É possível instalar o Edge Microgateway no mesmo data center ou na mesma máquina que seus serviços de back-end, se quiser.
É 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 gerenciamento da API Apigee para serviços em execução em um cluster do Kubernetes. Se você está migrando serviços e APIs atuais para a pilha do Kubernetes ou criando novos serviços e APIs, o Edge Microgateway ajuda a fornecer uma experiência limpa de gerenciamento de API 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 do Cloud, como o Edge Microgateway, incluem:
- Reduz a latência do tráfego de API para serviços executados nas proximidades. Por exemplo, se os consumidores e produtores de API estiverem próximos, você não quer necessariamente que as APIs passem por um gateway central.
- Mantenha o tráfego da API dentro dos limites aprovados pela empresa para fins de segurança ou conformidade.
- Continue processando mensagens se a conexão de Internet for temporariamente perdida.
- Fornecer gerenciamento da API Apigee para serviços em execução em um cluster do Kubernetes. Consulte Integrar o Edge Microgateway ao Kubernetes.
Para outros casos de uso, consulte este artigo da Comunidade 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 aplicativo 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 das APIs de destino do back-end com que o Edge Microgateway interage. |
| Analytics | O Edge Microgateway entrega dados de execução de API de maneira assíncrona para o Apigee Edge, onde eles são processados pelo sistema de 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 de 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 os recursos do Apigee Edge que os administradores de borda já entendem bem, como proxies, produtos e apps de desenvolvedores. |
| Configuração | Nenhuma programação é necessária para configurar e gerenciar o Edge Microgateway. Tudo é gerenciado com a configuração. |
| Conveniência | É possível integrar o Edge Microgateway à infraestrutura e processos de monitoramento e gerenciamento de aplicativos. O Monitoramento da API Apigee não é compatível com o Edge Microgateway. |
| Geração de registros | Os arquivos de registros 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, acessar arquivos de registros, solicitar tokens de acesso e muito mais. |
O que você precisa saber sobre o Edge Microgateway
Nesta seção, descrevemos como o Edge Microgateway funciona e 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ê consegue um aplicativo relativamente pequeno em execução perto dos seus aplicativos de back-end. Além disso, você aproveita ao máximo o Apigee Edge para análise, segurança e outros recursos.
Exemplos de cenários de implantação
Nesta seção, ilustramos 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 de back-end são instaladas na mesma máquina. Uma única instância do Edge Microgateway pode ser usada para liderar vários aplicativos de destino de back-end
Máquina diferente
Como toda a comunicação entre clientes, Edge Microgateway e implementações de API de back-end é HTTP, é possível instalar o Apigee Edge Microgateway em uma máquina diferente da implementação da API, como mostrado na Figura 2.
Com balanceador de carga
O próprio Edge Microgateway pode ser front-end de um proxy reverso ou balanceador de carga padrão para terminação SSL e/ou balanceamento de carga, como mostrado na Figura 3.
Implantação da 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 4. Digamos que um endpoint de API /orders seja
encaminhado 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, ele pode chamar internamente /customers e
/transactions. Consulte também
esta postagem na comunidade Apigee.
Dependência do Apigee Edge
O Edge Microgateway depende e interage com o Apigee Edge. O Edge Microgateway precisa se comunicar com o Apigee Edge para funcionar corretamente. Estas são as principais maneiras com que o Edge Microgateway interage com o Edge:
- Na inicialização, o Edge Microgateway recebe uma lista de proxies especiais "com reconhecimento do 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 valida o token de acesso de entrada ou a chave de API com base nas chaves do produto de API associado a esse proxy.
- O sistema do Apigee Edge Analytics armazena e processa dados da API enviados de maneira assíncrona do Edge Microgateway.
- O Apigee Edge fornece credenciais usadas para assinar tokens de acesso ou fornecer chaves de API exigidas pelos clientes que fazem chamadas de API pelo Edge Microgateway. É possível conseguir esses tokens usando um comando da CLI fornecido com o Edge Microgateway.
Configuração única
Inicialmente, você precisa configurar o Edge Microgateway para 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 as informações necessárias do Apigee Edge para processar chamadas de API por conta própria, incluindo a lista de proxies com reconhecimento do Edge Microgateway que são implantados no Apigee Edge. Falaremos mais sobre esses proxies em breve.
O Edge Microgateway não precisa ser 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 com reconhecimento do Edge Microgateway
Os proxies com reconhecimento do Edge Microgateway fornecem determinadas informações ao Edge Microgateway, que permitem processar solicitações de API do cliente. É possível fazer o download das informações sobre esses proxies do Apigee Edge para o Edge Microgateway quando o Edge Microgateway é iniciado.
Cabe a você ou à sua equipe de API criar esses proxies no Apigee Edge usando a interface de gerenciamento do Apigee Edge ou por outros meios, se quiser. É fácil de fazer, e examinaremos os detalhes em Como instalar e configurar o Edge Microgateway.
As características dos proxies com reconhecimento do Edge Microgateway são:
- Eles fornecem ao Edge Microgateway duas informações importantes: um caminho base e um URL de destino.
- Elas precisam apontar para endpoints de destino HTTP. O destino do back-end não pode ser um app Node.js referenciado por um elemento ScriptTarget na definição do TargetEndpoint. Para mais informações, consulte a observação anterior.
- 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 com reconhecimento do Edge Microgateway vão aparecer na interface do Edge Management 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 são mostrados 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 passa pelo Edge Microgateway, ele armazena em buffer e envia de maneira assíncrona os 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 um espaço relativamente pequeno com sobrecarga ou bloqueio mínimo de processamento. 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 de análise.
Sobre a segurança do Edge Microgateway
O papel do Apigee Edge
Conforme 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 que o Apigee Edge desempenha 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.
- Fornecendo as credenciais que o Edge Microgateway precisa para enviar dados de execução da API para o sistema de análise da Apigee Edge. Essas credenciais são recebidas uma vez pelo Edge Microgateway durante as etapas iniciais de configuração.
- Ele fornece a plataforma para agrupar recursos de API em produtos, registrar e gerenciar desenvolvedores e criar e gerenciar apps de desenvolvedores.
Autenticação de apps clientes
O Edge Microgateway oferece suporte à autenticação do cliente com 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 prosseguirá para o destino do back-end. Se não for válido, um erro será retornado.
Consulte Como instalar e configurar o Edge Microgateway 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úblicas/secretas transmitido para o Edge Microgateway por meio da CLI ou usando variáveis de ambiente. Você recebe e usa essas chaves uma vez ao instalar e inicializar 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 desenvolvedores. Por exemplo, assim como criar e agrupar entidades como produtos e apps de desenvolvedores 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 é possibilitada pela geração de chaves de segurança públicas e privadas para cada "pacote". Esse mecanismo é idêntico à maneira como a segurança da API funciona na Apigee Edge.
Posso mover 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 "com reconhecimento de 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 dos recursos. A partir desse ponto, os proxies não são usados. Quaisquer políticas ou fluxos condicionais nesses proxies nunca serão executados.
Outro motivo para ter proxies com reconhecimento de microgateway é que o Edge Microgateway envia dados de análise de maneira assíncrona para o Edge para cada proxy com reconhecimento de microgateway. É possível visualizar os dados de análise para proxies com reconhecimento de microgateway como faria para qualquer outro proxy na interface do Edge Analytics.
No tópico de configuração, apresentamos todas as etapas necessárias para começar a usar proxy de chamadas de API pelo Edge Microgateway, incluindo algumas etapas simples que você precisa realizar no Apigee Edge para definir uma configuração necessária, incluindo a criação de proxies com reconhecimento de 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: os documentos incluem um guia de instalação e um tutorial de iniciação, bem como 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 no Edge Microgateway.
-
A Comunidade Apigee é um ótimo lugar para fazer perguntas e se beneficiar das perguntas feitas e respondidas por outras pessoas.