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 配置身份验证。
流程
- 启动 OpenShift 4.x 服务器。
- 在 Web 浏览器中，导航到浏览器中的 OpenShift 控制台。使用您的凭证登录到控制台。
- 点 Operators，然后点 OperatorHub。
- 在搜索字段中，键入 API Designer。
- 点 API Designer 卡。API Designer operator install 页面将打开。
点 Install。此时会打开 Install Operator 页面。
- 对于 Installation mode，请从集群中的命名空间列表中选择一个命名空间（项目），
对于 Approval Strategy，选择 Automatic 或 Manual 来配置 OpenShift 如何处理对 API Designer Operator 的更新。
- 如果选择 Automatic 更新，当 API Designer Operator 的新版本可用时，OpenShift Operator Lifecycle Manager (OLM)将自动升级 API Designer 的运行实例，而无需人为干预。
- 如果选择手动 更新，则当有新版 Operator 可用时，OLM 会创建更新请求。作为集群管理员，您必须手动批准该更新请求，才能将 API Designer operator 更新至新版本。
- 点 Install 使 API Designer Operator 可供指定命名空间（项目）使用。
- 要验证项目中是否安装了 API Designer，请点 Operators，然后点 Installed Operators 查看列表中的 API Designer。
后续步骤
安装 API Designer 操作器后，必须通过创建 API Designer 实例，将 API Designer 添加为 OpenShift 项目。此任务可以通过两种方式来完成：
- OpenShift 管理员可以按照 第 2.3.1 节 “将 API Designer 作为服务添加到 OpenShift 4.x 项目” 中的步骤操作。
OpenShift 开发人员可按照设计 API 中所述的步骤操作。
API Designer 服务提供用于访问 API Designer Web 控制台的 URL。
2.3.1. 将 API Designer 作为服务添加到 OpenShift 4.x 项目
在 OpenShift 4.x 项目中安装了 API Designer 操作器后，您（或 OpenShift 开发人员）可以将它作为服务添加到 OpenShift 项目中。API Designer 服务提供开发人员用于访问 API Designer Web 控制台的 URL。
如需 OpenShift 开发人员遵循的步骤，请参阅 设计 API，将 API Designer 作为服务添加到 OpenShift 4.x 项目中。
先决条件
- 具有 OpenShift 集群的管理员访问权限。
- API Designer 操作器安装到当前的 OpenShift 项目中。
流程
- 在 OpenShift Web 控制台中，点 Operators，然后点 Installed Operators。
- 在 Name 列中，单击 API Designer。
在 Provided APIs 下，单击 Create Instance。
此时会打开 API Designer 实例的最小起始模板的默认表单。
接受默认值或可选编辑以下值：
大小 ：API Designer 实例的 pod 数量。
默认为两个新资源类型的 pod，其中包含专门用于管理 API Designer 的逻辑。
- Image: API Designer 镜像。如果您更改了此镜像，则会在集群中自动升级 API Designer Operator。
- 单击 Create 以创建新的 apicurito-service。OpenShift 为新的 API Designer 服务启动 pod、服务和其他组件。
验证 API Designer 服务是否可用：
- 点 Operators，然后点 Installed Operators。
在 Provided APIs 列中，点 Apicurito CRD。
在 Operator Details 页面中，列出了 apicurito-service。
获取 API Designer 的 URL：
- 点 Networking > Routes。
- 确保已选中了正确的项目。
- 在 apicurito-service-ui 行中，在 Location 列中找到 API Designer Web 控制台的 URL。
2.3.2. 在 OpenShift 4.x 上升级 API Designer
Red Hat OpenShift 4.x 处理 operator 的更新，包括 Red Hat Fuse operator。如需更多信息，请参阅 Operators OpenShift 文档。
然后，Operator 更新可能会触发应用程序升级。应用程序升级是如何配置的，具体取决于应用程序的配置方式。
对于 API Designer 应用程序，当您升级 API Designer operator 时，OpenShift 会自动升级集群中的任何 API 设计器应用程序。
2.3.3. API Designer 的 metering 标签
您可以使用 OpenShift Metering operator 来分析已安装的 API Designer operator、UI 组件和代码生成器，以确定您是否符合红帽订阅。如需有关 Metering 的更多信息，请参阅 OpenShift 文档。
下表列出了 API Designer 的 metering 标签。
| 标签 | 可能的值 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
例子
API Designer operator 示例：
apicurito-operator com.company: Red_Hat rht.prod_name: Red_Hat_Integration rht.prod_ver: 7.8 rht.comp: Fuse rht.comp_ver: 7.8 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.8 rht.comp: Fuse rht.comp_ver: 7.8 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.8 rht.comp: Fuse rht.comp_ver: 7.8 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 的本地镜像后，您可以执行后续步骤。
- 按照 OpenShift 4.x 上安装 API Designer 所述，使用镜像 OperatorHub 安装 API Designer。
- 根据将 API Designer 作为服务添加到 OpenShift 4.x 项目中所述的说明，将 API Designer 添加为服务。
