部署升级

[English Version]

RainMaker 团队将会定期推出更新的 RainMaker 前端与后端版本。

前端服务、后端服务、节点注册模块、附加服务和语音助手 Skill 需要单独升级。

RainMaker 后端升级

备份 Cognito 配置

在升级 RainMaker 前，建议首先从 RainMaker 控制面板备份 Cognito 配置，防止升级后 Cognito 配置被重置为默认值。一旦 RainMaker 后端升级完成，用户可以通过备份恢复 Cognito 配置，以保留原先的偏好设置。

  • 使用超级管理员账号登录 RainMaker 控制面板。
  • 打开 Deployment Settings，点击 Backup & Restore。若之前已经进行过备份，页面中将会显示先前备份的 Cognito 配置，否则将显示 No backup found 的消息。

backup_restore_1

  • 点击 Backup Configurations 备份 Cognito 配置。备份完成后，页面右上角会显示信息 Successfully captured Cognito app client settings，表示备份成功。

backup_restore_2

后端升级

在进行此步骤之前，请按照 上文 中介绍的步骤备份 Cognito 配置。

您可以从 Serverless Application Repository (SAR) 仓库中检查 RainMaker 后端服务是否有可用的新版本。

您只能升级以下仓库：
  • serverlessrepo-ESP-RainMaker-Base
  • serverlessrepo-ESP-RainMaker-Core

注意： - 请勿升级以下仓库
ESP-RainMaker-Base-API

升级过程与首次部署 RainMaker 后端相似，不同之处在于您需要选择最新版本的 SAR 仓库。

前往 AWS 控制台，搜索 SAR 服务。

upgrade1

  • 点击 Available applications > Private applications。勾选复选框—— Show apps that create custom IAM roles or resource policies。
  • 在 SAR 仓库菜单中，搜索 "ESP-Rainmaker-Base" 仓库。
  • 点击 ESP-RainMaker-Base，您将看到最新版本的仓库。

upgrade2

  • 如果您现有的 ESP-RainMaker-Base 版本落后于最新版本，请对其进行升级。
  • 升级过程与部署 ESP-RainMaker-Base 仓库的过程相似。
  • 向下滚动并勾选复选框—— I acknowledge that this app deploys nested applications。
  • 点击 Deploy。

upgrade3

  • 部署过程将启动。此 SAR 仓库部署大约需要 10-15 分钟。
  • 可以从 CloudFormation 查看此 SAR 仓库的部署状态。
  • 前往 AWS 控制台 > Services > CloudFormation，即可查看已部署的堆栈列表。
  • 您将在列表中看到 serverlessrepo-ESP-RainMaker-Base 栈的条目，其中 CREATE_COMPLETE 状态表示此仓库已经成功部署，如下图所示：

upgrade4

升级完 ESP-RainMaker-Base 仓库后，需要继续升级 ESP-RainMaker-Core 仓库。

  • 从 SAR 仓库菜单中，搜索 "ESP-Rainmaker-Core"。
  • 点击 ESP-RainMaker-Core，您将看到最新版本的仓库。

upgrade5

  • 如果您现有的 ESP-RainMaker-Core 版本落后于最新版本，请对其进行升级。

  • 升级过程与部署 ESP-RainMaker-Base 仓库的过程相似。

  • 向下滚动翻页并输入相应参数值。

upgrade6

  • Email - 此电子邮件地址用于向用户发送通知。新用户在注册时将收到来自此电子邮件地址的验证码。请注意，此邮件地址应由 AWS Simple Email Service (SES) 验证，详情请参阅 配置电子邮件发送服务 小节。

  • Username - 此参数用于创建超级管理员用户的电子邮件地址。部署成功后，系统将为使用此电子邮件的用户自动创建超级管理员账号，登录凭证和部署细节都将发送至此邮箱。

  • 注意： 在部署过程中创建的该用户将拥有超级管理员权限，仅此用户可以访问批量节点注册 CLI 等服务。

  • 勾选复选框—— I acknowledge that this app creates custom IAM roles, resource policies and deploys nested applications。

  • 点击 Deploy，部署过程启动。

upgrade7

  • 此仓库的部署大约将持续 20-30 分钟。
  • 您可以从 CloudFormation 查看此 SAR 仓库的部署状态。
  • 前往 AWS 控制台 > Services > CloudFormation，即可查看已部署的堆栈列表。
  • 您将在列表中看到 serverlessrepo-ESP-RainMaker-Core 栈的条目，其中 CREATE_COMPLETE 状态表示此仓库已经成功部署，如下图所示：

upgrade8

请按照 下文 介绍的步骤恢复已备份的 Cognito 配置。

恢复 Cognito 配置

  • 完成 RainMaker 后端升级的所有步骤后，前往 Deployment Settings > Backup & Restore，
    即可看到进行 RainMaker 升级前创建的 Cognito 备份。
    backup_restore_3

  • 点击 Restore 即可恢复到您偏好的 Cognito 配置，页面右上角显示信息 Successfully restored Cognito app client settings 时，表示恢复成功。 backup_restore_4

RainMaker 前端升级

RainMaker 前端需要单独升级。

升级管理面板有两个步骤。

第一步 - 在 Serverless Application Repository 仓库控制台中升级。

这一步骤与升级 RainMaker 后端组件或首次部署 RainMaker 前端组件相类似。

  • 请进入 SAR 仓库管理面板，选择 espdashboard 以启动 RainMaker 前端部署的升级。

ui1

  • 向下滚动并勾选复选框—— I acknowledge that this app creates custom IAM roles and resource policies。

ui2

  • 管理面板将开始升级，升级状态可以在 AWS 控制台查看。

ui3

  • 当所有模块升级完毕后，模块状态将变为 CREATE_COMPLETE，您将看到如下信息。

ui4

第二步 - 在 RainMaker 管理面板中升级。

管理员用户需要在管理面板上查看是否有新版本，如果有可用的新版本，管理员用户可以进行升级。

以下是升级 RainMaker 前端的步骤：

登录 RainMaker 管理面板。

当前版本将会显示在左侧菜单的底部。

upgrade9

点击 Check Updates Button，查看是否有可用的新版本。若无，您将看到以下窗口弹出。

upgrade10

如果有可用的新版本，您将看到以下窗口弹出。

upgrade11

点击 Update Dashboard，管理面板的升级过程将启动。

升级过程一般需要 5 分钟左右。升级成功后，请刷新或注销并重新登录。

upgrade12

升级 RainMaker 节点注册模块

RainMaker 节点注册模块 (rainmaker-node-registration) 用于为节点批量生成证书，各 RainMaker 版本对应的节点注册模块版本请参见下表。

RainMaker 版本对应的节点注册模块版本

RainMaker 版本节点注册模块版本
2.0.2 - 最新v17
2.0.0 - 2.0.1v16
1.1.30 - 1.2.1v14
1.1.28 - 1.1.29v13
1.1.27v12
1.1.22 - 1.1.26v11
1.1.17 - 1.1.25v10
1.1.12 - 1.1.16v9

  • 在 AWS 控制台确认 Rainmaker 节点注册模块版本：

    前往 Cloudformation > Stacks > rainmaker-node-registration > Tags > Version。

node_registration_version

注意：如果上述版本低于上表中对应的版本，需首先将 rainmaker-node-registration 升级至所需版本。

以下是升级节点注册模块的步骤。

第一步 - 打开 AWS 控制台，在 Services 中搜索 CloudFormation 并点击，如下图所示。

node_registration_1


第二步 - 选择 rainmaker-node-registration 堆栈。

node_registration_2


第三步 - 点击 Update 并点击 Replace current template。

输入以下 Amazon S3 链接：

https://esp-bulknode-batchjob.s3.amazonaws.com/<module_version>/espnoderegistration.yml

例如，若版本为 v16，请输入 https://esp-bulknode-batchjob.s3.amazonaws.com/v16/espnoderegistration.yml。

node_registration_3

选择 Next。


第四步 - 将所有参数值保持默认，并点击 Next。

node_registration_4


第五步 - 选择所需版本，例如 14, 点击 Next。

node_registration_5


第六步 - 保持默认设置并勾选以下选项：

  • I acknowledge that AWS CloudFormation might create IAM resources.
  • I acknowledge that AWS CloudFormation might create IAM resources with custom names.
  • I acknowledge that AWS CloudFormation might require the following capability: CAPABILITY_AUTO_EXPAND

并点击 Update stack，如下图所示。

node_registration_6


rainmaker-node-registration 堆栈将完成升级，如下图所示。


node_registration_7

升级附加服务

按照首次部署时的步骤来进行升级： RainMaker 附加服务

注意： 请确保您使用的是最新版本。

升级 RainMaker 语音助手 Skill

详细步骤请参考： 升级语音助手集成仓库

← 推送通知配置 →