跳到主要内容
Documentation Hub

部署设置

概述

欢迎来到部署章节，这是私有 RainMaker 部署的四个阶段中的第三阶段。🚀
本节提供了一个分步骤指南，讲解如何使用 AWS CloudFormation 和 SAM 模型 (Serverless Application Model) 来部署私有 RainMaker。首先介绍一些部署设置，然后讲解如何构造 S3 部署 URL，学习如何创建 CloudFormation 堆栈。

注意
  • 在开始部署前，确保已完成所有预部署步骤。
  • 所有 AWS 相关问题必须在进入本部分前正确解决。

生成 S3 URL​

首先介绍如何生成部署 URL，供后续部署 ESP-RainMaker 组件时使用。

提示

建议将这些 URL 记录在 Word 文档中，以便在创建堆栈时，能够快速找到，并复制粘帖在 AWS 控制台中。

S3 URL 模板​

以下链接是所有 RainMaker 组件的 S3 URL 模板，其中包含以下 5 个标签，需要根据你的具体部署需求进行替换：

https://esp-rainmaker-sam-deployments-<MASKED_ACCOUNT_ID>-<REGION>.s3.<REGION>.<DOMAIN>/<VERSION>/packages/<PACKAGE_NAME>.yml
  1. <MASKED_ACCOUNT_ID>
  2. <REGION>
  3. <DOMAIN>
  4. <VERSION>
  5. <PACKAGE_NAME>

配置 S3 URL​

由于在全球和中国地区部署私有 RainMaker 时使用的的标签有所不同，请根据你部署 RainMaker 的区域选择相关选项。接下来，开始生成相应的 S3 URL。

  1. 将 <MASKED_ACCOUNT_ID> 替换为 192622e2680f。

    https://esp-rainmaker-sam-deployments-192622e2680f-<REGION>.s3.<REGION>.<DOMAIN>/<VERSION>/packages/<PACKAGE_NAME>.yml

  2. 选择要使用的 Rainmaker 后端版本和区域，并用来替换部署链接中的 <VERSION> 和 <REGION>。

    可用区域和兼容版本

    查找可用区域，并查看与相应的 RainMaker 组件兼容的可用后端版本。

  3. 将 <DOMAIN> 替换为 amazonaws.com。

  4. 将 <PACKAGE_NAME> 替换为需要的包的名称：

    a. ESP-Rainmaker-Base esprainmakersambase_package.yml
    b. ESP-Rainmaker-Core esprainmakersamcore_package.yml
    c. ESP-Nested-AddOns espnestedaddons_package.yml
    d. ESP-TimeSeries esptsdata_package.yml
    e. ESP-Rainmaker-Skills deploy-3p-integration-all-regions-add-ons_package.yml

    对于相应包的名称，示例 URL 如下：

    https://esp-rainmaker-sam-deployments-192622e2680f-.s3..amazonaws.com//packages/esprainmakersambase_package.yml
    https://esp-rainmaker-sam-deployments-192622e2680f-<region>.s3.<region>.amazonaws.com/<version>/packages/esprainmakersamcore_package.yml
    https://esp-rainmaker-sam-deployments-192622e2680f-<region>.s3.<region>.amazonaws.com/<version>/packages/espnestedaddons_package.yml
    https://esp-rainmaker-sam-deployments-192622e2680f-<region>.s3.<region>.amazonaws.com/<version>/packages/esptsdata_package.yml
    https://esp-rainmaker-sam-deployments-192622e2680f-<region>.s3.<region>.amazonaws.com/<version>/packages/deploy-3p-integration-all-regions-add-ons_package.yml
    提示

    你需要替换 <REGION> 和 <VERSION>。

    注意

    ESP-Rainmaker-Base 和 ESP-RainMaker-Core 是基本组件，必须生成；其他包取决于你的应用程序所需的服务类型。

创建 CloudFormation 堆栈的通用步骤​

概述

本小节列出了创建 CloudFormation 堆栈的通用步骤。在后续部署不同的堆栈时，仍会引用并参考这些步骤。

  1. 进入 AWS 管理控制台

    • 在 Services 中搜索 CloudFormation，点击进入。

    SAR22

  1. 创建堆栈

    • 在 CloudFormation 服务中点击 Create stack。

    SAR23

    • 替代步骤： 在堆栈页面，点击 Create stack 并选择 With new resources (standard)。

    Options for creating stack

  1. 选择模板
    • 选择 Choose an existing template。
    • 在 Amazon S3 URL 字段中粘贴相应的 S3 URL（参考 上述章节），然后点击 Next。
    • 具体截图和链接，请参考各个堆栈创建的详细介绍。
  1. 配置堆栈
    • 输入堆栈名称。
    • 填写所需的参数。
    • 点击 Next。
    • 有关截图、堆栈名称和参数描述，请参考各个堆栈创建的详细介绍。

  1. 添加标签

    • 输入版本标签，如下所示：

      • Key: Version
      • Value: <VERSION>（将 <VERSION> 替换为你的选定版本）

    • 点击 Add new tag 按钮，保持其他默认设置，然后点击 Next。

    CFVERSION

  1. 审核并创建

    • 勾选以下选项：

      • I acknowledge that AWS CloudFormation might create IAM resources.（我清楚了解 AWS CloudFormation 可能会创建 IAM 资源。）
      • I acknowledge that AWS CloudFormation might create IAM resources with custom names.（我清楚了解 AWS CloudFormation 可能会创建具有自定义名称的 IAM 资源。）
      • I acknowledge that AWS CloudFormation might require the following capability: CAPABILITY_AUTO_EXPAND.（我清楚了解 AWS CloudFormation 可能需要以下权限：CAPABILITY_AUTO_EXPAND。）

    • 点击Create stack，如下所示。

    SAR26

  1. 审核并提交

    • 审核堆栈详情，并点击 Submit。

    SAMCFCOMPLETE

  1. 等待完成
    • 等待堆栈创建完成。 有关截图和完成时间，请参考各个堆栈创建的详细介绍。
备注

现在你已掌握了创建 CloudFormation 堆栈的方法，接下来可以继续部署 RainMaker 后端和附加服务。

On this page