Обзор Edge Microgateway

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

Edge Microgateway v. 3.1.x

Apigee Edge Microgateway — это безопасный обработчик сообщений на основе HTTP для API. Его основная задача — безопасная обработка запросов и ответов от бэкэнд-сервисов, а также асинхронная передача ценных данных о выполнении API в Apigee Edge, где они используются системой Edge Analytics. Edge Microgateway легко устанавливается и развертывается — вы можете запустить экземпляр за считанные минуты.

Как правило, Edge Microgateway устанавливается в доверенной сети в непосредственной близости от целевых серверных служб. Он обеспечивает безопасность корпоративного уровня и некоторые ключевые функции плагина, такие как подавление пиковых нагрузок, квоты и аналитика, но не обладает всеми возможностями и ресурсами Apigee Edge. При желании вы можете установить Edge Microgateway в том же центре обработки данных или даже на той же машине, что и ваши серверные службы.

Edge Microgateway можно запустить как автономный процесс или в контейнере Docker. См. раздел «Использование Docker с Edge Microgateway» . Edge Microgateway также можно использовать для управления API Apigee для сервисов, работающих в кластере Kubernetes . Независимо от того, переносите ли вы существующие сервисы и API в стек Kubernetes или создаете новые сервисы и API, Edge Microgateway помогает обеспечить удобное управление API, включающее безопасность, управление трафиком, аналитику, публикацию и многое другое. См. раздел «Интеграция Edge Microgateway с Kubernetes» .

Типичные сценарии использования

Типичные сценарии использования гибридного облачного решения для управления API, такого как Edge Microgateway, включают:

  • Уменьшите задержку API-трафика для сервисов, работающих в непосредственной близости друг от друга. Например, если ваши потребители и производители API находятся в непосредственной близости, вам не обязательно нужно, чтобы API-трафик проходил через центральный шлюз.
  • В целях безопасности и соответствия нормативным требованиям, трафик API следует держать в пределах утвержденных предприятием границ.
  • Если интернет-соединение временно прервано, обработка сообщений должна продолжаться.
  • Обеспечьте управление API Apigee для сервисов, работающих в кластере Kubernetes. См. раздел «Интеграция Edge Microgateway с Kubernetes» .

Дополнительные примеры использования см. в этой статье сообщества Apigee .

Основные характеристики и преимущества

Особенность Преимущества
Безопасность Edge Microgateway аутентифицирует запросы с помощью подписанного токена доступа или ключа API, выданного каждому клиентскому приложению компанией Apigee Edge.
Быстрое развертывание В отличие от полноценного развертывания Apigee Edge, вы можете развернуть и запустить экземпляр Edge Microgateway за считанные минуты.
Близость сети Вы можете установить и управлять Edge Microgateway на том же компьютере, в той же подсети или центре обработки данных, что и целевые API-интерфейсы бэкэнда, с которыми взаимодействует Edge Microgateway.
Аналитика Edge Microgateway асинхронно передает данные о выполнении API в Apigee Edge, где они обрабатываются системой Edge Analytics. Вы можете использовать полный набор метрик, панелей мониторинга и API Edge Analytics.
Сниженная задержка Вся коммуникация с Apigee Edge осуществляется асинхронно и не происходит в процессе обработки запросов к клиентскому API. Это позволяет Edge Microgateway собирать данные API и отправлять их в Apigee Edge без влияния на задержку.
Знакомство Edge Microgateway использует и взаимодействует с функциями Apigee Edge, которые администраторы Edge уже хорошо знают, такими как прокси-серверы, продукты и приложения для разработчиков.
Конфигурация Для настройки и управления Edge Microgateway не требуется программирование. Все операции выполняются через конфигурацию.
Удобство Вы можете интегрировать Edge Microgateway с существующей инфраструктурой и процессами мониторинга и управления приложениями.
Ведение журнала В лог-файлах подробно описываются все обычные и нестандартные события, возникающие в процессе обработки API микрошлюзом Edge Microgateway.
CLI Интерфейс командной строки позволяет запускать, останавливать и перезапускать Edge Microgateway, извлекать статистику работы, просматривать файлы журналов, запрашивать токены доступа и многое другое.

Что вам нужно знать о Edge Microgateway

В этом разделе описывается принцип работы Edge Microgateway, его базовая архитектура, конфигурация и развертывание.

Почему стоит использовать Edge Microgateway?

Перемещение компонента управления API ближе к целевым бэкэнд-приложениям может уменьшить задержку в сети. Хотя Apigee Edge можно установить локально в частном облаке, полномасштабное развертывание Apigee Edge неизбежно является масштабным и сложным процессом для поддержки всего набора функций и ресурсоемких функций, таких как управление ключами, монетизация и аналитика. Это означает, что развертывание Apigee Edge локально в каждом центре обработки данных не всегда целесообразно.

С Edge Microgateway вы получаете приложение с относительно небольшими размерами, работающее в непосредственной близости от ваших бэкэнд-приложений. И вы можете использовать все возможности Apigee Edge для аналитики, безопасности и других функций.

Примеры сценариев развертывания

В этом разделе показаны несколько возможных сценариев развертывания Edge Microgateway.

Та же машина

На рисунке 1 показан путь обработки запроса при развертывании Edge Microgateway в максимально простой конфигурации, где Edge Microgateway и целевые API бэкэнда установлены на одной машине. Один экземпляр Edge Microgateway может использоваться для взаимодействия с несколькими целевыми приложениями бэкэнда.

Микрошлюз Edge развертывается в вашей сети. Он обрабатывает API-запросы от клиентов и вызывает целевые сервисы. Микрошлюз передает данные прокси-сервера и аналитики в облако Apigee Edge.
Рисунок 1: Простейший вариант развертывания Edge Microgateway.

Другая машина

Поскольку вся связь между клиентами, Edge Microgateway и серверными API-реализациями осуществляется по протоколу HTTP, вы можете установить Apigee Edge Microgateway на другом компьютере, отличном от компьютера, на котором установлена ​​реализация API, как показано на рисунке 2.

Edge Microgateway развертывается на одной машине, а бэкэнд-сервисы развертываются в другом месте. Запросы API обрабатываются микрошлюзом, и отправляются на целевые серверы. Микрошлюз передает данные прокси-сервера и аналитики в облако Apigee Edge Cloud.
Рисунок 2: Микрошлюз Edge, отделенный от целевых API бэкэнда.

С балансировщиком нагрузки

В качестве интерфейса для завершения SSL-соединения и/или балансировки нагрузки можно использовать сам Edge Microgateway, как показано на рисунке 3.

Балансировщик нагрузки направляет трафик на несколько экземпляров Edge Microgateway. Экземпляры микрошлюза взаимодействуют с облаком Edge и обрабатывают запросы к целевым сервисам.
Рисунок 3: Микрошлюз Running Edge с балансировщиком нагрузки.

Развертывание интранета

Используйте Edge Microgateway для защиты трафика внутренней сети, одновременно защищая интернет-трафик с помощью Apigee Edge, как показано на рисунке 4. Допустим, конечная точка API /orders проксируется через Apigee Edge Cloud и обращается к целевому бэкэнду https://mycompany.com/orders . Это представлено целевой реализацией API слева. Затем этот API может вызывать несколько конечных точек API, представленных целевой реализацией справа. Например, он может вызывать внутренние запросы /customers и /transactions . См. также эту публикацию в сообществе Apigee.

API-прокси, созданные для Edge Cloud, отправляются целевым сервисам в вашей интрасети, а целевые сервисы отправляют запросы к Edge Microgateway в вашей интрасети. Затем микрошлюз отправляет запросы к другим целевым API-сервисам в вашей интрасети.
Рисунок 4: Микрошлюз Running Edge для защиты трафика внутренней сети.

Зависимость от Apigee Edge

Микрошлюз Edge зависит от Apigee Edge и взаимодействует с ним. Для корректной работы микрошлюза Edge необходимо взаимодействовать с Apigee Edge. Основные способы взаимодействия микрошлюза Edge с Edge следующие:

  • При запуске Edge Microgateway получает список специальных прокси-серверов, поддерживающих Edge Microgateway, и список всех продуктов API из вашей организации Apigee Edge. Для каждого входящего запроса от клиента Edge Microgateway определяет, соответствует ли запрос одному из этих прокси-серверов API, а затем проверяет входящий токен доступа или ключ API на основе ключей в продукте API, связанном с этим прокси-сервером.
  • Система Apigee Edge Analytics хранит и обрабатывает данные API, отправляемые асинхронно с Edge Microgateway.
  • Apigee Edge предоставляет учетные данные, используемые для подписи токенов доступа или предоставления ключей API, необходимых клиентам, выполняющим вызовы API через Edge Microgateway. Вы можете получить эти токены с помощью команды CLI, входящей в состав Edge Microgateway.

Одноразовая настройка

Для обеспечения связи с вашей организацией Apigee Edge необходимо предварительно настроить Edge Microgateway. При запуске Edge Microgateway инициирует операцию начальной загрузки с Apigee Edge. Edge Microgateway получает от Apigee Edge необходимую информацию для самостоятельной обработки вызовов API, включая список прокси-серверов, поддерживающих Edge Microgateway и развернутых на Apigee Edge. Подробнее об этих прокси-серверах мы поговорим чуть позже.

Для работы Edge Microgateway не обязательно размещать его совместно с Apigee Edge; публичные и частные облачные решения Apigee Edge работают одинаково хорошо.

Что нужно знать о прокси-серверах, поддерживающих Edge Microgateway

Прокси-серверы, поддерживающие Edge Microgateway, предоставляют Edge Microgateway определенную информацию, позволяющую обрабатывать запросы API клиентов. Информация об этих прокси-серверах загружается из Apigee Edge в Edge Microgateway при запуске Edge Microgateway.

Вы или ваша команда разработчиков API можете создать эти прокси-серверы на Apigee Edge, используя пользовательский интерфейс управления Apigee Edge или другими способами, если хотите. Это легко сделать, и мы подробно расскажем об этом в разделе «Настройка и конфигурирование Edge Microgateway» .

Характеристики прокси-серверов, поддерживающих Edge Microgateway, следующие:

  • Они предоставляют Edge Microgateway две ключевые части информации: базовый путь и целевой URL-адрес.
  • Они должны указывать на целевые HTTP-конечные точки. Целевой бэкэнд не может быть приложением Node.js, на которое ссылается элемент ScriptTarget в определении TargetEndpoint. Дополнительную информацию см. в предыдущем примечании.
  • Имена прокси-серверов должны начинаться с префикса edgemicro_ . Например: edgemicro_weather .
  • К этим прокси-серверам нельзя добавлять политики или условные потоки. Попытка будет проигнорирована. В остальном, прокси-серверы, поддерживающие Edge Microgateway, отображаются в пользовательском интерфейсе управления Edge так же, как и любые другие API-прокси на Edge.
  • Их можно включать в состав продуктов и связывать с приложениями для разработчиков.
  • Данные о трафике отображаются в Edge Analytics.
  • Их невозможно отследить с помощью инструмента Apigee Edge Trace.

О Edge Microgateway и Apigee Edge Analytics

Когда API-трафик проходит через Edge Microgateway, Edge Microgateway буферизует и асинхронно отправляет данные выполнения API в Apigee Edge, где эти данные хранятся и обрабатываются системой Edge Analytics. Эта асинхронная связь позволяет Edge Microgateway использовать преимущества функций Edge Analytics, сохраняя при этом относительно небольшой объем занимаемой памяти с минимальными накладными расходами на обработку или блокировками. Полный набор панелей мониторинга Edge Analytics и возможностей создания пользовательских отчетов доступен вам и вашей команде для анализа трафика, проходящего через Edge Microgateway.

Панель мониторинга трафика прокси отображает объем трафика API с течением времени, данные об активности разработчиков и состав трафика с разбивкой по разработчикам и приложениям.
Рисунок 5: Панель мониторинга трафика прокси-сервера на Edge.

Для получения дополнительной информации об Edge Analytics см. раздел «Панели мониторинга аналитики» .

О безопасности Edge Microgateway

роль Apigee Edge

Как уже упоминалось ранее, Apigee Edge играет роль в обеспечении безопасности всех клиентских запросов к Edge Microgateway. Основные функции Apigee Edge включают:

  • Предоставление учетных данных клиента, используемых в качестве ключей API или для генерации действительных токенов доступа, используемых клиентами для выполнения безопасных вызовов API через Edge Microgateway.
  • Предоставление учетных данных, необходимых Edge Microgateway для отправки данных выполнения API в систему Apigee Edge Analytics. Эти учетные данные получаются Edge Microgateway один раз на этапе первоначальной настройки.
  • Предоставление платформы для объединения ресурсов API в продукты, регистрации и управления разработчиками, а также создания и управления приложениями для разработчиков.

Аутентификация клиентского приложения

Edge Microgateway поддерживает аутентификацию клиентов с помощью токенов доступа и ключей API. Ключи безопасности и токены генерируются Apigee Edge и проверяются Edge Microgateway для каждого вызова API. Если плагин OAuth включен, Edge Microgateway проверяет подписанный токен доступа или ключ API, и если он действителен, вызов API переходит к целевому бэкэнду. Если он недействителен, возвращается ошибка.

Для получения и использования токенов доступа и ключей API см. раздел «Настройка и конфигурирование Edge Microgateway» .

Аутентификация Edge Microgateway на Apigee Edge

Для асинхронных вызовов, которые Edge Microgateway выполняет для обновления аналитических данных в Apigee Edge, требуется аутентификация. Эта аутентификация обеспечивается с помощью пары открытого/секретного ключей, передаваемых в Edge Microgateway через CLI или с использованием переменных среды. Вы получаете и используете эти ключи один раз при первой установке и запуске Edge Microgateway.

Платформа управления API-продуктами

Edge служит платформой для объединения ресурсов API в продукты, регистрации и управления разработчиками, а также создания и управления приложениями для разработчиков. Например, точно так же, как вы можете создавать и объединять сущности, такие как продукты и приложения для разработчиков, для обычных прокси-серверов Apigee Edge, вы можете делать то же самое для прокси-серверов Edge Microgateway. Безопасность на уровне API обеспечивается генерацией открытых и закрытых ключей безопасности для каждого «пакета». Этот механизм идентичен тому, как работает безопасность API в Apigee Edge.

Могу ли я перенести существующие реализации прокси-сервера Edge на Edge Microgateway?

Вы не можете перенести существующие прокси-серверы с связанными политиками или условными потоками в Edge Microgateway. Edge Microgateway требует создания новых прокси-серверов, поддерживающих Microgateway. Эти прокси-серверы должны быть названы со специальным префиксом edgemicro_. При запуске Edge Microgateway обнаруживает эти прокси-серверы edgemicro_* и загружает информацию о конфигурации для каждого из них. Эта информация включает в себя целевые URL-адреса и пути к ресурсам. С этого момента прокси-серверы не используются. Любые политики или условные потоки в этих прокси-серверах никогда не будут выполняться.

Еще одна причина использования прокси-серверов, поддерживающих микрошлюзы, заключается в том, что Edge Microgateway асинхронно передает аналитические данные в Edge для каждого такого прокси-сервера. Затем вы можете просмотреть аналитические данные для прокси-серверов, поддерживающих микрошлюзы, так же, как и для любого другого прокси-сервера, в пользовательском интерфейсе Edge Analytics.

В разделе «Настройка» описаны все шаги, необходимые для начала проксирования вызовов API через Edge Microgateway, включая несколько простых действий, которые необходимо выполнить в Apigee Edge для настройки конфигурации, необходимой для Edge Microgateway, в том числе создание прокси-серверов, поддерживающих microgateway. См. раздел «Настройка и конфигурирование Edge Microgateway» .

Узнайте больше о Edge Microgateway

Компания Apigee предоставляет следующие ресурсы:

  • Документация по Edge Microgateway — документация включает руководство по установке и руководство по началу работы, а также полную справочную информацию и информацию по настройке.

  • Видеоролики — Серия четырехминутных видеороликов Apigee для разработчиков включает в себя ряд эпизодов, посвященных Edge Microgateway.

  • Сообщество Apigee — отличное место, чтобы задавать вопросы и получать пользу от вопросов, заданных и отвеченных другими пользователями.