Developer Portal 从版本 5 迁移到 版本 10

指导如何将 Developer Portal 网站从 IBM® API Connect Version 5 迁移到 IBM API Connect Version 10

IBM API Connect 第 10 版中的 Developer Portal 基于开源 Drupal 9 内容管理软件,可实现更先进、灵活和强大的自定义功能。 但是,在 IBM API Connect Version 5 中,Developer Portal 基于 Drupal 7。 迁移工具 在第 10 版中将创建一个新的开发人员门户网站站点,并将所有相关的应用程序接口和产品、用户信息以及订阅迁移过来。 但是,无法自动迁移模块和主题之类的定制,因为 Drupal 9 基线与 Drupal 7 有很大不同。 有关从 Drupal 7 基线升级到 Drupal 9 基线的更多信息,请参阅 Drupal 文档中的 升级 Drupal

以下部分将带您了解 Developer Portal 的迁移过程,并指导您如何将任何特定的自定义功能手动迁移到 Drupal 9

注: 只能从 IBM API Connect V 5.0.8.7 开始提供迁移功能。 如果部署处于较低版本,那么迁移前必须先进行升级。 请参阅 升级 API Connect 云 ,以获取有关在 V 5 中进行升级的信息。 有关受支持的迁移版本的更多信息,请参阅 迁移版本 5 部署
注意:在第 5 版中,可以直接修改 Developer Portal 服务器上的文件,但不建议这样做。 有关更多信息,请参阅 针对管理员的 Developer Portal 最佳实践。 但是,在 V10 中,您不应该进行任何系统更改。 请勿使用 kubectl exec 命令在开发人员门户容器内进行更改,在 OVA 部署中,请勿在 Developer Portal VM 上进行任何修改。 使用用户界面或 CLI 在 Developer Portal 上进行任何自定义。 除非 IBM 要求,否则不要在任何 Developer Portal 容器上运行 kubectl exec 命令。

开发人员门户网站的迁移过程

开发人员门户的迁移过程会将群集中每个站点的以下所有信息迁移到版本 10:
  • 用户信息 (如果启用了门户网站授权用户注册表,那么进程略有不同; 请参阅 门户网站授权用户注册表)。
  • 产品和 API。
  • 使用者组织。
  • 应用程序。
  • 预订。
有关主迁移过程的信息,请参阅 迁移版本 5 部署

门户网站授权用户注册表

IBM API Connect 版本 5 中,如果目录选择了门户委托用户注册表 (PDUR),则用户管理将从管理服务器委托给 Developer Portal。 然后,门户网站中的站点管理员执行用户注册表的配置,管理服务器记录该授权已发生,并存储目录中存在的用户的记录。 但是,管理服务未保留有关特定注册表配置或用户如何映射到这些注册表的任何信息。 在 IBM API Connect V10中,所有用户注册表配置都在管理服务器中进行,不再需要 PDUR。 因此,要将 PDUR 用户注册表和用户从 V5 迁移到 V10,必须从管理服务器和门户网站节点收集配置信息。

如果您的 IBM API Connect 版本 5 Developer Portal 使用 Portal 委托用户注册表 (PDUR),您必须首先导出存储在版本 5 Developer Portal 本地数据库中的用户信息。 然后,可以将此用户信息提供给迁移工具,以便可以在更新版本的 API Connect中创建正确的用户注册表。

有关如何从 v5导出 PDUR 信息的更多信息,请参阅 导出门户网站授权用户注册表用户信息。 有关 v10中的迁移过程的更多信息,请参阅 使用 PDUR 的迁移步骤

定制主题

如果您的第 5 版 Developer Portal 使用的是自定义主题,您需要为 Drupal 9 基线重新创建自定义主题。 首先,使用主题生成器为新的 Version 10 Developer Portal 网站创建一个子主题,然后使用层叠样式表 (CSS) 或 Sass CSS (SCSS) 按照您的规格手动自定义 Drupal 9 的子主题。 请注意,在主题中使用 SCSS 可简化颜色更改。 我们还添加了颜色模板主题生成器,这意味着可以快速生成用于构建定制站点品牌形象的基本颜色主题。 有关更多信息,请参阅 创建子主题

请注意,不允许或不支持直接编辑 API Connect 主题,因为安装修订包或 iFix 时会覆盖这些文件的已编辑版本。

其他有用资源:

定制模块

如果您的第 5 版 Developer Portal 使用了任何自定义模块,您需要为 Drupal 9 基线重新创建这些自定义模块。 有关编写自定义模块的更多信息,请参阅扩展

其他有用资源:

定制规则

如果您的第 5 版 Developer Portal 使用了任何自定义规则,您需要将它们创建为 Drupal 9 基线的自定义模块。 无法导出 Drupal 7 规则,然后将其导入到 Drupal 9 基线中,因为事件和操作以不同方式实现。 有关定制模块的更多信息,请参阅 定制模块 部分。

定制内容类型和字段

如果您的第 5 版 Developer Portal 使用了任何自定义内容,您需要为 Drupal 9 基线重新创建这些内容。

有关创建定制内容类型的信息,请参阅以下主题:

高级主题开发

如果您的第 5 版开发人员门户使用的是修改过的内容类型模板,则必须为Drupal9基线重新创建这些模板。 在Drupal9中,模板是 Twig 文件,它定义了特定内容的实际 HTML 输出。 您可以通过将原始模板复制到定制子主题的 templates 文件夹中,然后按规范编辑模板来覆盖 Twig 模板。 Developer Portal 将优先使用您的模板,而不是原始模板。 有关更多信息,请参阅应用修改后的内容类型模板创建子主题您也可以根据指导示例了解如何创建新主题,请参阅教程:为开发人员门户创建自定义主题

注:

通过修改 Twig 模板,能够以非常细粒度的方式控制页面的结构。 但是,这也意味着您可能会错过对原始模板进行的新功能和缺陷修复,因为您的 Developer Portal 使用的是您的覆盖而不是原始模板。 因此,如果覆盖模板,那么您应负责检查最新 API Connect V10 发行版中的模板,并确保对覆盖进行所需的任何等效更改以保持功能等同。

更改页面布局

如果您的第 5 版 Developer Portal 使用了不同的页面布局,则需要为 Drupal 9 基线重新创建此布局。 通过配置哪些块出现在哪些区域中来定义页面布局。 通过使用 "开发人员门户网站管理员仪表板上的 "结构 > 区块布局选项来控制块。

有关如何配置页面布局的信息,请参阅添加和更改开发人员门户页面上显示的区块

更改首页

如果您的第 5 版 Developer Portal 使用的是不同的前端页面,您需要为 Drupal 9 基线重新创建此前端页面。 通过开发人员门户管理员仪表板上的 "结构 > 页面"选项配置首页。

有关如何配置首页的信息,请参阅配置首页添加自定义页面

设计首页时可能要考虑的更多选项包括:

开发人员门户中不再提供的功能

IBM API Connect V 5中提供的以下功能在 IBM API Connect V10中不可用:
  • 安全问题 - 现在可在 OpenID Connect 提供程序中创建。
  • 双因子验证 - 现在可在 OpenID Connect 提供程序中执行。
  • 支持凭单-当前没有可用的 Drupal 9 等效模块。