跳到主要内容
Documentation Hub

附加服务部署

概述

本节介绍了 ESP RainMaker 中各种附加服务的部署过程，包括：

  • ESP Time Series（ESP 时间序列服务，用于管理时间序列数据）
  • ESP Device Defender（ESP 设备防护，用于检测设备异常行为）
  • ESP API Rate Limiter（ESP API 限速工具，用于缓解 DoS/DDoS 攻击）
  • ESP Access Logs（ESP 访问日志，用于记录 API 和 MQTT 数据）

ESP Time Series​

信息

通过时间序列服务，可以获取和检索连接到 ESP RainMaker 云平台节点的时间序列数据。 该服务包含 2 个组件：

  • ESP-Rainmaker-Base-TimeSeries
  • ESP-Rainmaker-TimeSeries

部署基础组件​

时间序列服务的基础组件 ESP-Rainmaker-Base-TimeSeries 需要使用 CloudFormation 进行部署。以下是详细步骤。

  1. 进入 AWS Console。
  2. 在 Services 中搜索 CloudFormation，并点击进入 CloudFormation 服务，如下图所示。

SAR22

提示

当前，此模块仅能在以下 AWS 区域部署：N. Virginia(us-east-1)、Ohio(us-east-2)、Oregon(us-west-2)、Frankfurt(eu-central-1) 和 Ireland(eu-west-1)。请选择一个区域进行部署，并记住这个区域，供后续 API 部署时继续使用。建议选择 us-east-1。

  1. 在 CloudFormation 服务中,点击 Create stack 以创建堆栈，如下图所示。

SAR23

  1. 如果从堆栈页面点击 Create stack 选项，会弹出两个创建选项，如下图。选择 With new resources(standard)。

Options for creating stack

  1. 选择 Template is ready，并在 Amazon S3 URL 字段中粘贴以下 S3 URL，如下所示：
    Amazon S3 URL: https://esp-rainmaker-timeseries.s3.amazonaws.com/v2/espbasetsdata-package.yml

SAR35

  1. 输入堆栈名称 "esp-rainmaker-base-timeseries"，保持默认配置，然后点击 Next。

SAR36

  1. 点击 Next，并添加版本标签 (Version tag)，如下所示：
    • Key: Version
    • Value: 1

SAR37

  1. 点击 Add tag 按钮添加版本标签，其他保持默认，点击 Next。

  2. 勾选以下选项：

  • 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。）

  1. 点击 Create stack，如下所示。

SAR26

  1. 等待堆栈创建完成，如下所示。

SAR38

部署 API​

提醒

在继续之前，请确保为你的账户选择了 RainMaker 部署区域。

提示

堆栈的部署根据 创建 CloudFormation 堆栈的通用步骤 进行。

对于步骤 3（选择模板）：

  • 从 此处 构建 S3 URL 模板。

TSDATA1

对于步骤 4（配置堆栈）：

  • 输入堆栈名称应为 ESP-Rainmaker-TimeSeries。
  • 设置以下参数：
    • TSDataRegion - 输入之前基础模块所部署的区域，如 us-east-1。

TSDATA2

对于步骤 7（等待完成）：

  • 大约需要 10～15 分钟。

ESP 嵌套附加模块​

ESP 嵌套附加模块可以根据以下模块的需要，选择性地创建或删除：

ESP Device Defender​

ESP Device Defender 为设备防护模块，能够检测连接到 RainMaker 的 IoT 设备的异常行为，识别可能被攻击的设备，从而降低连接设备的安全风险。当设备表现出异常行为时，系统会触发警报。以下是会触发警报的行为列表：

  1. 每个设备每 5 分钟内的连接尝试次数超过设定的阈值。
  2. 每个设备每 5 分钟内的授权失败次数超过设定的阈值。
  3. 每个设备每 5 分钟内发送的消息数超过设定的阈值。

设备超过以上规则所设置的阈值时，会向超级管理员邮箱发送警报。阈值可以在部署模块时进行设置。

Device Defender 模块需要单独部署。具体步骤参考本节后续的内容。

ESP API Rate Limiter​

注意

目前，Oauth-only RainMaker 部署 暂不支持此功能。

通过配置 API 速率限制，可以保护 RainMaker API 免受 DoS 和 DDoS 攻击。配置 API 速率限制需要部署 ESP API Rate Limiter 服务。

API 速率限制是指在 5 分钟内来自单个 IP 地址的最大请求次数。当请求次数超过此限制时，将阻止来自该 IP 地址的请求。当 IP 地址请求次数低于速率限制后，会自动解封。

API 速率限制默认设置为 1000，此限制可以通过管理面板更新。

此堆栈部署成功后，你会通过上面提供的电子邮件地址收到一封邮件，确认在 IP 地址的请求被阻止时收到事件通知。点击确认链接以确认订阅。

ESP Access Logs​

ESP Access Logs 为访问日志服务，用于记录和检索 ESP RainMaker 云平台的 API 数据以及 MQTT 主题消息数据。

提示

堆栈的部署根据创建 CloudFormation 堆栈的通用步骤进行。

对于步骤 3（选择模板）：

  • 参考该 指南 构建 S3 URL 模板。

    SAMADDONSLINK

对于步骤 4（配置堆栈）：

  • 输入的堆栈名：ESP-Nested-AddOns，保持默认配置并点击 Next，如下所示。
配置以下参数：
Access Logs

类型：字符串
默认值：not_created
允许值：not_created、create、delete
描述：指定 create 部署，delete 删除，not_created 保持默认。创建或删除后避免设置为 not_created。

Device Defender:

类型：字符串
默认值：not_created
允许值：not_created、create、delete
描述：指定 create 部署，delete 删除，not_created 保持默认。

API Rate Limiter

类型：字符串
默认值：not_created
允许值：not_created、create、delete
描述：指定 create 部署，delete 删除，not_created 保持默认。

Persist Base Data

允许值：true、false
描述：设置为 true 表示在上述某个参数设置为delete 时，保留基础数据。

ESP SuperAdmin

类型：字符串
描述：指定接收违规警报的电子邮箱。默认使用 SuperAdmin 超级管理员邮箱，也可以添加其他邮箱。

SAMADDONSNAME

对于步骤 7（等待完成）

提示

大约需要 15～20 分钟。

SAMADDONSCOMPLETE

至此，你已成功部署 RainMaker 附加服务！ 🎉

On this page