cesarbr/knot-cloud-storage

knot-cloud-storage

镜像概述和主要用途

knot-cloud-storage是一个Web服务器，用于接收设备转发的消息并将其存储到数据库中。该服务目前正在用Golang重写，以适用于在受限板上运行，提供高效的设备数据管理能力。

核心功能和特性

• 接收设备转发的消息并持久化存储到数据库
• 采用Golang开发，优化资源占用，适合在资源受限的嵌入式环境运行
• 支持通过环境变量进行灵活配置
• 提供完整的RESTful API，支持消息的存储、查询和删除操作
• 支持开发模式（自动重载）和生产模式两种部署方式

使用场景和适用范围

• 物联网（IoT）设备数据采集与存储
• 受限嵌入式环境中的设备消息处理
• 需要高效管理设备传感器数据的应用场景
• 对资源占用有严格要求的边缘计算环境

使用方法和配置说明

基本安装和使用

要求

• Go 1.13+版本
• 确保本地Go包二进制路径已添加到系统PATH环境变量：

bash
export PATH=$PATH:<your_go_workspace>/bin

配置

可将ENV环境变量设置为development，并根据需要更新internal/config/development.yaml配置文件。对于Docker镜像部署，需使用环境变量进行配置。

主要配置参数如下（环境变量名称在括号中）：

• server
  • port (SERVER_PORT) 数字 服务器端口号（默认值：80）

设置

bash
make tools

编译和运行

bash
make run

可使用make watch命令以监视模式运行应用，当代码更改时自动重启服务。

Docker安装和使用

确保已安装Docker Engine。

构建和运行

生产环境

生产环境容器定义在docker/Dockerfile中，使用步骤如下：

1. 构建镜像：

   bash
   docker build . -f docker/Dockerfile -t cesarbr/knot-cloud-storage
   

2. 创建包含环境变量配置的文件（如knot-cloud-storage.env）。

3. 运行容器：

   bash
   docker run --env-file knot-cloud-storage.env -ti cesarbr/knot-cloud-storage
   

开发环境

开发环境容器定义在docker/Dockerfile-dev中，支持代码自动重载，使用步骤如下：

1. 构建镜像：

   bash
   docker build . -f docker/Dockerfile-dev -t cesarbr/knot-cloud-storage:dev
   

2. 创建包含环境变量配置的文件（如knot-cloud-storage.env）。

3. 运行容器：

   bash
   docker run --env-file knot-cloud-storage.env -p 8080:80 -v `pwd`:/usr/src/app -ti cesarbr/knot-cloud-storage:dev
   

-v参数的第一个路径必须是仓库根目录，若从其他目录运行，请将pwd替换为实际路径。

验证服务健康

验证方法

通过访问健康检查端点验证服务状态：

bash
curl http://<hostname>:<port>/healthcheck

API

POST /data

存储设备消息。

参数

请求头

请求体

示例

请求

bash
POST https://storage.knot.cloud/data

请求体

json
{
  "from": "188824f0-28c4-475b-ab36-2505402bebcb",
  "payload": {
    "sensor_id": 2,
    "value": 234
  }
}

响应

bash
201 Created

---

GET /data

获取所有设备消息。

参数

请求头

需以设备所有者身份进行身份验证：

URI参数

示例

请求

bash
GET https://storage.knot.cloud/data?take=15&order=1

响应

json
[
  {
    "from": "188824f0-28c4-475b-ab36-2505402bebcb",
    "payload": {
      "sensorId": 2,
      "value": 234
    },
    "timestamp": "2020-04-10T10:32:26.456753-03:00"
  },
  {
    "from": "188824f0-28c4-475b-ab36-2505402bebcb",
    "payload": {
      "sensorId": 1,
      "value": true
    },
    "timestamp": "2020-04-13T13:56:23.596301-03:00"
  }
]

---

GET /data/{deviceID}

按特定设备ID获取消息。

参数

请求头

需以设备所有者身份进行身份验证：

URI参数

示例

请求

bash
GET https://storage.knot.cloud/data/cc5429a29afcd158?startDate=2020-04-13 13:00:00

响应

json
[
  {
    "from": "188824f0-28c4-475b-ab36-2505402bebcb",
    "payload": {
      "sensorId": 1,
      "value": true
    },
    "timestamp": "2020-04-13T13:56:23.596301-03:00"
  }
]

---

GET /data/{deviceID}/sensor/{sensorID}

按特定设备和传感器ID获取消息。

参数

请求头

需以设备所有者身份进行身份验证：

URI参数

示例

请求

bash
GET https://storage.knot.cloud/data/cc5429a29afcd158/sensor/2

响应

json
[
  {
    "from": "188824f0-28c4-475b-ab36-2505402bebcb",
    "payload": {
      "sensorId": 2,
      "value": 234
    },
    "timestamp": "2020-04-10T10:32:26.456753-03:00"
  }
]

---

DELETE /data

删除所有设备消息。

参数

请求头

需以有效用户身份进行身份验证，仅删除该用户拥有的设备数据：

示例

请求

bash
DELETE https://storage.knot.cloud/data

响应

bash
200 OK

---

DELETE /data/{deviceID}

删除特定设备的所有消息。

参数

请求头

需以设备所有者身份进行身份验证：

示例

请求

bash
DELETE https://storage.knot.cloud/data/cc5429a29afcd158

响应

bash
200 OK