概览和集成流程

本文档详细介绍了如何设置和配置适用于 Private Cloud 和 API Hub 的 Apigee API Hub 连接器,该连接器可将 API 元数据和运行时分析数据从 Apigee Edge for Private Cloud 安装传输到 Google Cloud 的 API Hub。

Apigee Edge for Private Cloud 和 API Hub 集成旨在将本地 Apigee 环境与 Google Cloud 的 API Hub 连接起来。此集成可让关键 API 元数据(例如 API 代理定义、政策等)和运行时分析数据从 Apigee Private Cloud 安装直接无缝地流入 API Hub,从而提供集中且全面的 API 概览。

概览

从根本上讲,此集成功能可让 Apigee for Private Cloud 用户将其 API 信息载入 API Hub。这意味着,您可以利用 API Hub 的功能来发现、治理和集中管理源自本地 Apigee 部署的 API。

关键组件

  • API Hub (Google Cloud):基于云的中央平台,用于整合和管理 API 元数据和运行时数据。
  • Apigee Hub 连接器:与 Apigee Edge for Private Cloud 环境一起安装的新组件。此连接器是负责从 Apigee Edge for Private Cloud 提取数据并安全地将其发布到 Google Cloud 的主要代理。
  • 消息处理器 (MP):经过重新配置的现有 Apigee 组件,可将运行时分析数据“双重写入”到共享的网络文件系统 (NFS),从而供 Apigee API Hub 连接器使用。
  • 网络文件系统 (NFS):一种共享存储卷,用于在 Apigee API Hub 连接器处理和上传分析数据之前,临时存储来自 MP 的分析数据。
  • Google Cloud Pub/Sub:一种消息传递服务,Apigee API Hub for Private Cloud 连接器使用该服务将 API 元数据和运行时数据安全地流式传输到 API Hub。
  • Google Cloud 服务账号:用于对 Apigee API Hub for Private Cloud 连接器进行安全身份验证和授权,以便与 Pub/Sub 和 API Hub 服务进行交互。

集成流程

集成遵循结构化流程,以确保数据传输和准确性:

  1. 初始设置和配置
    • 首先,设置一个 Google Cloud 项目,并在其中预配 API Hub。
    • 创建 Google Cloud 服务账号,并通过创建“插件实例”向 API Hub 注册您的 Apigee Private Cloud 组织。此步骤会提供对于配置至关重要的唯一 Pub/Sub 主题和插件实例 ID。
  2. Apigee API Hub for Private Cloud 连接器安装
    • Apigee API Hub for Private Cloud 连接器(一个 RPM 软件包)安装在专用虚拟机上,与 Apigee for Private Cloud 环境并排运行。这需要使用兼容的 Apigee Private Cloud 版本。
  3. Apigee API Hub for Private Cloud 连接器配置
    • 连接器配置了在创建 API Hub 插件期间获得的详细信息(Pub/Sub 主题、插件实例 ID、服务账号详细信息)。
    • 已建立对 Google Cloud 服务(通过服务账号密钥)和 Apigee Management Server(通过 base64 编码的凭据)的身份验证。
    • 共享 NFS 的路径也在此处配置。
  4. 消息处理器 (MP) 配置
    • 您的 Apigee 消息处理器已更新,可为分析数据启用“双重写入”机制。这意味着,分析记录会同时写入传统分析系统和指定的 NFS 共享。
  5. 数据流
    • API 元数据:Apigee API Hub for Private Cloud 连接器从 Apigee 管理服务器提取 API 元数据,并将其发布到 Google Cloud 中指定的元数据 Pub/Sub 主题,然后该主题将元数据馈送到 API Hub。
    • 运行时数据:消息处理器将分析数据写入共享 NFS。Apigee Hub 连接器会监控此 NFS,处理运行时数据,并将其发布到 Google Cloud 中指定的运行时数据 Pub/Sub 主题,以便将其提取到 API Hub 中。
  6. 监控和问题排查
    • 借助 Apigee API Hub for Private Cloud 连接器上的本地状态端点,您可以监控元数据和运行时数据上传进度。
    • 详细日志可用于排查与启动、数据传输或连接相关的任何问题。

相互依赖关系:

  • Apigee API Hub for Private Cloud 连接器依赖于 NFS 正确装载,并且可供自身和所有消息处理器访问。
  • 必须为消息处理器配置双重写入到 NFS,才能启用运行时数据收集。
  • 正确的 Google Cloud 服务账号角色和 API Hub 插件实例详细信息对于连接器的身份验证和数据发布功能至关重要。

此集成提供了一种强大的机制,可将本地 Apigee API 纳入 API Hub 提供的集中式管理和可见性,从而更好地实现 API 治理和洞见。