2.3. 在 OpenShift 4.x 上安装 API Designer

在 OpenShift 上的 Red Hat Fuse 提供了一个 API Designer，它是一个基于 Web 的 API 设计工具，可用于设计 REST API。API Designer Operator 简化了 OpenShift Container Platform 4.x 上的 API Designer 安装和升级。

作为 OpenShift 管理员，您要将 API Designer Operator 安装到 OpenShift 项目（命名空间）。安装 Operator 后，Operator 会在所选命名空间中运行。但是，要使 API Designer 作为服务（作为 OpenShift 管理员）提供，或者开发人员必须创建 API Designer 实例。API Designer 服务提供访问 API Designer Web 控制台的 URL。

先决条件

  • 具有对 OpenShift 集群的管理员访问权限。
  • 您已将身份验证配置为 registry.redhat.io。

流程

  1. 启动 OpenShift 4.x 服务器。
  2. 在 Web 浏览器中，导航到浏览器中的 OpenShift 控制台。使用您的凭证登录到控制台。
  3. 点 Operators，然后点 OperatorHub。
  4. 在搜索字段中，键入 API Designer。
  5. 点 Red Hat Integration - API Designer 卡。Red Hat Integration - API Designer Operator 安装页面将打开。

  6. 点 Install。此时会打开 Install Operator 页面。

    1. 对于 Update Channel，请选择 fuse-console-7.11.x。
    2. 对于 Installation 模式，从集群上的命名空间列表中选择命名空间（项目）。

    3. 对于 Approval Strategy，选择 Automatic 或 Manual 以配置 OpenShift 如何处理 API Designer Operator 的更新。

      • 如果选择自动 更新，当 API Designer Operator 的新版本可用时，OpenShift Operator Lifecycle Manager(OLM)将自动升级 API Designer 的运行实例，而无需人为干预。
      • 如果选择手动 更新，则当有新版 Operator 可用时，OLM 会创建更新请求。作为集群管理员，您必须手动批准该更新请求，才能让 API Designer Operator 更新至新版本。
  7. 点击 Install 使 API Designer Operator 可供指定的命名空间（项目）使用。
  8. 要验证 API Designer 是否安装到项目中，点 Operators，然后点 Installed Operators 查看列表中的 Red Hat Integration - API Designer。

后续步骤

安装 API Designer Operator 后，必须通过创建 API Designer 实例，将 API Designer 作为服务添加到 OpenShift 项目。此任务可通过两种方式完成：

2.3.1. 将 API Designer 作为服务添加到 OpenShift 4.x 项目

在 OpenShift 4.x 项目中安装了 API Designer 操作器后，您可以将它作为服务添加到 OpenShift 项目。API Designer 服务提供开发人员用于访问 API Designer Web 控制台的 URL。

注意

请参阅 设计 API 以了解 OpenShift 开发人员遵循的步骤将 API Designer 作为服务添加到 OpenShift 4.x 项目。

先决条件

  • 具有对 OpenShift 集群的管理员访问权限。
  • API Designer 操作器安装到当前的 OpenShift 项目中。

流程

  1. 在 OpenShift Web 控制台中，点 Operators，然后点 Installed Operators。
  2. 在 Name 列中，单击 Red Hat Integration - API Designer。

  3. 在 Provided APIs 下，点 Create instance。

    此时会打开一个默认表单，其中包含 API Designer 实例的最小起始模板。接受默认值，或者（可选）编辑它们。

  4. 单击 Create 以创建新的 apicurito-service。OpenShift 为新的 API Designer 服务启动 pod、服务和其他组件。

  5. 验证 API Designer 服务是否可用：

    1. 点 Operators，然后点 Installed Operators。

    2. 在 Provided APIs 列中，点 Apicurito CRD。

      在 Operator Details 页面中，列出 apicurito-service。

  6. 打开 API Designer：

    1. 选择 Networking > Routes。
    2. 确保已选中正确的项目。

    3. 在 apicurito-service-ui 行的 Location 列中，单击 URL。

      API Designer Web 控制台会在一个新的浏览器标签页中打开。

2.3.2. 在 OpenShift 4.x 上升级 API Designer

Red Hat OpenShift 4.x 处理对操作器的更新，包括红帽 Fuse 操作器。如需更多信息，请参阅 Operator OpenShift 文档。

然后，操作员更新可触发应用程序的升级。应用程序升级的发生方式根据应用程序的配置情况而有所不同。

对于 API Designer 应用，当您升级 API Designer operator 时，OpenShift 会自动升级集群中的任何 API 设计程序应用程序。

注意

当从 API Designer 7.8 升级到 API Designer 7.9 时，普通的 operator 升级过程无法正常工作。要将 API Designer 从 Fuse 7.8 升级到 Fuse 7.9，您必须删除 7.8 API Designer operator，然后安装 7.9 API Designer operator。

2.3.3. API Designer 的 metering 标签

您可以使用 OpenShift Metering operator 来分析已安装的 API Designer operator、UI 组件和代码生成器，以确定您是否遵守红帽订阅。如需有关 Metering 的更多信息，请参阅 OpenShift 文档。

下表列出了 API Designer 的 metering 标签。

表 2.1. API Designer Metering 标签

标签可能的值

com.company

Red_Hat

rht.prod_name

Red_Hat_Integration

rht.prod_ver

7.11

rht.comp

Fuse

rht.comp_ver

7.11

rht.subcomp

fuse-apicurito

apicurito-service-ui

apicurito-service-generator

rht.subcomp_t

基础架构

例子

  • API Designer operator 的示例： 

    apicurito-operator
com.company: Red_Hat
rht.prod_name: Red_Hat_Integration
rht.prod_ver: 7.11
rht.comp: Fuse
rht.comp_ver: 7.11
rht.subcomp: fuse-apicurito
rht.subcomp_t: infrastructure

  • API Designer UI 组件示例： 

    com.company: Red_Hat
rht.prod_name: Red_Hat_Integration
rht.prod_ver: 7.11
rht.comp: Fuse
rht.comp_ver: 7.11
rht.subcomp: apicurito-service-ui
rht.subcomp_t: infrastructure

  • API Designer Generator 组件示例： 

    com.company: Red_Hat
rht.prod_name: Red_Hat_Integration
rht.prod_ver: 7.11
rht.comp: Fuse
rht.comp_ver: 7.11
rht.subcomp: apicurito-service-generator
rht.subcomp_t: infrastructure

2.3.4. 在受限环境中安装 API Designer 的注意事项

在受限环境中安装的 OpenShift 集群，默认情况下无法访问红帽提供的 OperatorHub 源，因为这些远程源需要足够的互联网连接。在这种情况下，要安装 API 设计器 Operator，您必须完成以下先决条件：

  • 禁用 Operator Lifecycle Manager(OLM)的默认远程 OperatorHub 源。
  • 使用有完全互联网访问的工作站来创建 OperatorHub 内容的本地镜像。
  • 将 OLM 配置为，从本地源而不是默认的远程源安装和管理 Operator。

如需更多信息，请参阅 OpenShift 文档中的 在受限网络中使用 Operator Lifecycle Manager 部分。创建 OperatorHub 的本地镜像后，即可执行后续步骤。