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

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

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

先决条件

  • 具有 OpenShift 集群的管理员访问权限。
  • 您已为 Red Hat Container Registry 配置了身份验证。

流程

  1. 启动 OpenShift 4.x 服务器。
  2. 在 Web 浏览器中，导航到浏览器中的 OpenShift 控制台。使用您的凭证登录到控制台。
  3. 点 Catalog，然后点 OperatorHub。

  4. 在搜索字段中，键入 API Designer。

    您可以在右侧面板中看到 API Designer 卡。

  5. 点 API Designer。此时会出现 API Designer operator 安装窗口。

  6. 点 Install。Create Operator Subscription 表单将打开。

    1. 对于 Installation 模式，请从集群中的命名空间列表中选择命名空间（项目），

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

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

后续步骤

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

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

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

注意

如需了解 OpenShift 开发人员要作为服务添加到 OpenShift 4.x 项目的步骤，请参阅 设计 API。

先决条件

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

流程

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

  3. 在 Provided APIs 下，点 Create Instance。

    此时会打开 API Designer 实例的最小起始模板的默认表单。

  4. 接受默认值或选择性地编辑以下值：

    • 大小 ： API Designer 实例的 pod 数量。

      默认为三个用于新资源类型的 pod，其中包含特定于管理 API Designer 的逻辑。

    • 镜像 ：API 设计器镜像。如果您更改了此镜像，API Designer Operator 会自动在集群中升级。
  5. 单击 Create 以创建一个新的 apicurito-service。OpenShift 启动用于新 API Designer 服务的 pod、服务和其他组件。

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

    1. 点 Operators，然后点 Installed Operators。

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

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

  7. 获取 API Designer 的 URL：

    1. 点 Networking > Routes。
    2. 确保选择了正确的项目。
    3. 在 apicurito-service 行中，在 Location 列中找到 API Designer Web 控制台的 URL。

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

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

反过来，Operator 更新可触发应用程序升级。应用程序升级如何根据应用程序的配置方式的不同而有所不同。

对于 API Designer 应用程序，升级 API Designer 操作器时，OpenShift 会自动升级集群上的任何 API 设计程序应用程序。

注意

从 OCP 4.6 开始，API Designer 操作器(Apicurito operator)的 operator 频道的名称已从 alpha 改为 fuse-apicurito-7.7.x。如果在将 OpenShift 升级到 OCP 4.6 后无法看到新的 operator 频道，请参阅 已知问题 ENTESB-15232 以了解有关如何刷新 OpenShift 上 OperatorHub 可见的 Operator 频道的详细信息。