您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息
Edge Microgateway v. 3.1.5 及更高版本
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 为在 Kubernetes 集群中运行的服务提供 Apigee API 管理功能。无论您是将现有服务和 API 迁移到 Kubernetes 堆栈,还是创建新服务和 API,Edge Microgateway 都能帮助您获得简洁的 API 管理体验,包括安全性、流量管理、分析、发布等。请参阅 将 Edge Microgateway 与 Kubernetes 集成。
典型使用场景
混合云 API 管理解决方案(例如 Edge Microgateway)的典型用例如下:
- 降低了近距离运行的服务的 API 流量延迟时间。例如,如果您的 API 使用者和生产者距离很近,您不一定希望 API 通过中央网关。
- 出于安全或合规性目的,将 API 流量保留在企业批准的边界内。
- 如果互联网连接暂时中断,继续处理消息。
- 为在 Kubernetes 集群中运行的服务提供 Apigee API 管理。请参阅 将 Edge Microgateway 与 Kubernetes 集成。
如需了解其他使用情形,请参阅这篇 Apigee 社区文章。
主要功能和优势
| 功能 | 优势 |
|---|---|
| 安全 | Edge Microgateway 会使用由 Apigee Edge 向每个客户端应用签发的已签名访问令牌或 API 密钥对请求进行身份验证。 |
| 快速部署 | 与 Apigee Edge 的完整部署不同,您可以在几分钟内部署并运行 Edge Microgateway 实例。 |
| 网络邻近度 | 您可以在与 Edge Microgateway 交互的后端目标 API 所在的同一机器、子网或数据中心内安装和管理 Edge Microgateway。 |
| 分析 | Edge Microgateway 会将 API 执行数据异步传递给 Apigee Edge,然后由 Edge Analytics 系统进行处理。您可以使用整套 Edge Analytics 指标、信息中心和 API。 |
| 缩短了延迟时间 | 与 Apigee Edge 的所有通信都是异步的,并且不是作为处理客户端 API 请求的一部分发生。这样,Edge Microgateway 就可以收集 API 数据并将其发送到 Apigee Edge,而不会影响延迟。 |
| 熟悉度 | Edge Microgateway 使用并与 Edge 管理员已非常熟悉的 Apigee Edge 功能(例如代理、产品和开发者应用)进行交互。 |
| 配置 | 无需进行任何编程即可设置和管理 Edge Microgateway。一切都通过配置来处理。 |
| 便捷性 | 您可以将 Edge Microgateway 与现有的应用监控和管理基础架构及流程集成。请注意,Edge Microgateway 不支持 Apigee API 监控。 |
| 日志记录 | 日志文件详细记录了 Edge Microgateway 在 API 处理期间遇到的所有正常事件和异常事件。 |
| 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 Microgateway 和后端 API 实现之间的所有通信都是 HTTP,因此您可以将 Apigee Edge Microgateway 安装在与 API 实现不同的机器上,如图 2 所示。
使用负载平衡器
Edge Microgateway 本身可以由标准反向代理或负载平衡器作为前端,用于 SSL 终止和/或负载均衡,如图 3 所示。
内网部署
使用 Edge Microgateway 保护内网流量,同时使用 Apigee Edge 保护互联网流量,如图 4 所示。假设 API 端点 /orders 通过 Apigee Edge Cloud 进行代理,并命中后端目标 https://mycompany.com/orders。这以左侧的目标 API 实现表示。然后,此 API 可能会调用右侧目标实现所表示的多个 API 端点。例如,它可能会在内部调用 /customers 和 /transactions。另请参阅 Apigee 社区上的
这篇帖子。
对 Apigee Edge 的依赖关系
Edge Microgateway 依赖于 Apigee Edge 并与之交互。Edge Microgateway 必须与 Apigee Edge 通信才能正常运行。Edge Microgateway 与 Edge 互动的主要方式如下:
- 启动时,Edge Microgateway 会从您的 Apigee Edge 组织获取一个特殊的“Edge Microgateway 感知型”代理列表和一个 API 产品列表。对于每个传入的客户端请求,Edge Microgateway 会确定该请求是否与这些 API 代理之一匹配,然后根据与该代理关联的 API 产品中的密钥验证传入的访问令牌或 API 密钥。
- Apigee Edge Analytics 系统会存储和处理从 Edge Microgateway 异步发送的 API 数据。
- Apigee Edge 提供用于对访问令牌进行签名的凭据,或提供通过 Edge Microgateway 进行 API 调用的客户端所需的 API 密钥。您可以使用 Edge Microgateway 随附的 CLI 命令获取这些令牌。
一次性配置
您必须先配置 Edge Microgateway,使其能够与您的 Apigee Edge 组织通信。启动时,Edge Microgateway 会与 Apigee Edge 启动引导操作。 Edge Microgateway 会从 Apigee Edge 检索自行处理 API 调用所需的信息,包括部署在 Apigee Edge 上的 Edge Microgateway 感知代理的列表。我们稍后会详细介绍这些代理。
Edge Microgateway 不必与 Apigee Edge 位于同一位置;Apigee Edge 公有云和私有云产品同样适用。
关于 Edge Microgateway 感知代理的注意事项
支持 Edge Microgateway 的代理会向 Edge Microgateway 提供某些信息,以便其处理客户端 API 请求。当 Edge Microgateway 启动时,系统会从 Apigee Edge 下载有关这些代理的信息到 Edge Microgateway。
您可以自行决定是否使用 Apigee Edge 管理界面或其他方式在 Apigee Edge 上创建这些代理,也可以让 API 团队来创建。这很容易做到,我们在设置和配置 Edge Microgateway 中详细介绍了相关步骤。
支持 Edge Microgateway 的代理的特征如下:
- 它们为 Edge Microgateway 提供了两项关键信息:基本路径和目标网址。
- 它们必须指向 HTTP 目标端点。后端目标不能是 TargetEndpoint 定义中由 ScriptTarget 元素引用的 Node.js 应用。如需了解详情,请参阅上文中的注释。
- 代理名称必须以
edgemicro_为前缀。例如:edgemicro_weather。 - 您无法向这些代理添加政策或条件流。如果您尝试这样做,系统会忽略这些参数。否则,在 Edge 管理界面中,支持 Edge Microgateway 的代理与其他任何 Edge API 代理一样。
- 它们可以捆绑到产品中,并与开发者应用相关联。
- 路况数据会显示在 Edge Analytics 中。
- 无法使用 Apigee Edge Trace 工具跟踪这些消息。
Edge Microgateway 和 Apigee Edge Analytics 简介
当 API 流量流经 Edge Microgateway 时,Edge Microgateway 会缓冲 API 执行数据并将其异步发送到 Apigee Edge,然后 Edge Analytics 系统会在 Apigee Edge 中存储和处理这些数据。这种异步通信使 Edge Microgateway 能够利用 Edge 分析功能,同时保持相对较小的占用空间,并最大限度地减少处理开销或阻塞。您和您的团队可以使用整套 Edge Analytics 信息中心和自定义报告功能来分析通过 Edge Microgateway 的流量。
如需详细了解 Edge Analytics,请参阅分析信息中心。
Edge Microgateway 安全性简介
Apigee Edge 的作用
如前所述,Apigee Edge 在保护所有发送到 Edge Microgateway 的客户端请求方面发挥着重要作用。Apigee Edge 的主要作用包括:
- 提供用作 API 密钥或用于生成有效访问令牌的客户端凭据,客户端可通过 Edge Microgateway 使用这些凭据进行安全的 API 调用。
- 提供 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。
对 Apigee Edge 上的 Edge Microgateway 进行身份验证
Edge Microgateway 为更新 Apigee Edge 上的分析数据而进行的异步调用需要身份验证。此身份验证通过传递给 Edge Microgateway 的公钥/密钥对(通过 CLI 或使用环境变量)提供。您只需在首次安装并启动 Edge Microgateway 时获取并使用这些密钥一次。
API 产品管理平台
Edge 可作为平台,用于将 API 资源捆绑到产品中、注册和管理开发者,以及创建和管理开发者应用。例如,就像您可以为常规 Apigee Edge 代理创建和捆绑产品和开发者应用等实体一样,您也可以为 Edge Microgateway 代理执行完全相同的操作。通过为每个“软件包”生成公开和私有安全密钥,可以实现 API 级安全性。此机制与 Apigee Edge 上的 API 安全性机制相同。
我可以将现有的 Edge 代理实现迁移到 Edge Microgateway 吗?
您无法将具有关联政策或条件流的现有代理迁移到 Edge Microgateway。Edge Microgateway 要求您创建新的“微网关感知”代理。这些代理必须使用特殊前缀 edgemicro_ 命名。启动时,Edge Microgateway 会发现这些 edgemicro_* 代理,并下载每个代理的配置信息。 这些信息包括其目标网址和资源路径。从那时起,系统不再使用代理。这些代理中的任何政策或条件流都将永远不会执行。
需要使用微网关感知代理的另一个原因是,Edge Microgateway 会为每个微网关感知代理异步将分析数据推送到 Edge。然后,您可以像在 Edge Analytics 界面中查看任何其他代理的分析数据一样,查看支持微网关的代理的分析数据。
设置主题会引导您完成开始通过 Edge Microgateway 代理 API 调用的所有必要步骤,包括在 Apigee Edge 上执行的一些简单步骤,以设置 Edge Microgateway 所需的配置,包括创建微网关感知代理。 请参阅设置和配置 Edge Microgateway。
详细了解 Edge Microgateway
Apigee 提供以下资源:
-
Edge Microgateway 文档 - 这些文档包含安装指南和入门教程,以及完整的参考信息和配置信息。
-
视频 - Apigee“面向开发者的四分钟视频”系列包含一系列有关 Edge Microgateway 的剧集。
-
Apigee 社区是一个很好的平台,您可以在这里提问,还可以从其他人提出的问题和获得的解答中受益。