Skip to content

ThingsBoard 信创支持 ​

ThingsBoard 信创支持更新维护

1、概述 ​

随着现在网络安全的要求,国产的信息化技术逐步正在全部使用国产化替代,当然,我认为最优秀的物联网平台ThingsBoard也应该跟随脚步,所以在闲暇时光我把ThingsBoard 单独维护了一个分支来进行适配国产化。

2、ThingsBoard的版本 ​

我使用的是ThingsBoard-4.3的分支,因为这个4.3.x的版本的license还是Apache-2.0,可以免费商用,因为后面的ThingsBoard-4.4.x分支就开始改变了协议,所以不适合拿来做国产化。

3、信创要求的数据库 ​

业务数据库:我使用的是人大金仓(Kingbase)替换 PostgreSQL,但是人大金仓是收费的,我使用的是默认免费3个月来进行测试的。

时序数据库:我使用的是TDEngine 替换 Cassandra,使用的国产开源的。

4、为什么选择呢? ​

人大金仓数据就是基于当初的PostgreSQL的9.6分支来做的,所以最适配。

选择TDEngine是因为目前国内炒的最热的,但是性能咋样还不知道。

5、镜像地址 ​

我自己维护的ThingsBoard信创版本,所以自己构建的镜像放在了我的阿里云镜像仓库,版本是跟随这ThingsBoard的4.3.x的小版本。

bash
docker pull registry.cn-hangzhou.aliyuncs.com/zd-thingsboard/tb-node-kingbase-tdengine:4.3.1.8

6、部署 ​

可能后续每个办法会有所改变,所以我的每一个小版本的部署都单独分开,这样大家才方便部署选择。

6.1、部署 4.3.1.8 版本 ​

6.1.1、服务器环境 ​

我使用的是Ubuntu-24.04,并且需要安装 docker 和 docker-compose

6.1.2、使用脚本部署 ​

添加 .env

bash
# Which standalone compose file docker compose uses when you omit -f.
# Switch BOTH COMPOSE_FILE and DATABASE_TS_TYPE together:
#   king:   COMPOSE_FILE=docker-compose.king.yml   DATABASE_TS_TYPE=sql
#   hybrid: COMPOSE_FILE=docker-compose.hybrid.yml DATABASE_TS_TYPE=tdengine
COMPOSE_FILE=docker-compose.king.yml
# Images (Maven: mvn clean install -DskipTests -Ddockerfile.skip=false
# builds thingsboard/tb-node:latest and thingsboard/tb-node:4.3.1.8)
TB_NODE_IMAGE=thingsboard/tb-node:4.3.1.8
KINGBASE_IMAGE=kingbase-pg:v9r1c10
TDENGINE_IMAGE=tdengine/tsdb:3.4.3.3
# Timezone
TZ=Asia/Shanghai
# KingbaseES
KINGBASE_USER=system
KINGBASE_PASSWORD=system
KINGBASE_HOST=kingbase
# Port inside the Compose network (container listen port). Keep 54321 unless the image changes.
KINGBASE_PORT=54321
# Host port published to the machine
KINGBASE_HOST_PORT=54321
KINGBASE_DB=thingsboard
# Maintenance DB used by kingbase-init to run CREATE DATABASE
KINGBASE_ADMIN_DB=kingbase
# ThingsBoard -> Kingbase JDBC (keep host/port/db aligned with KINGBASE_* above)
SPRING_DRIVER_CLASS_NAME=com.kingbase8.Driver
SPRING_DATASOURCE_URL=jdbc:kingbase8://kingbase:54321/thingsboard
SPRING_DATASOURCE_USERNAME=system
SPRING_DATASOURCE_PASSWORD=system
SPRING_JPA_DIALECT=org.thingsboard.server.dao.ThingsboardKingbaseDialect
# ThingsBoard node
TB_SERVICE_ID=tb-ce-node
TB_QUEUE_TYPE=in-memory
# Telemetry storage mode (MUST match COMPOSE_FILE)
DATABASE_TS_TYPE=sql
DATABASE_TS_LATEST_TYPE=sql
# TDengine (docker-compose.hybrid.yml)
# Password must be at least 8 characters on TDengine 3.4.3.3.
# Keep TDENGINE_PASSWORD and TAOS_ROOT_PASSWORD the same on first init.
TDENGINE_HOST=tdengine
TDENGINE_PORT=6041
TDENGINE_HOST_PORT=6041
TDENGINE_USERNAME=root
TDENGINE_PASSWORD=taosdata
TDENGINE_URL=jdbc:TAOS-WS://tdengine:6041/thingsboard?varcharAsString=true
TAOS_ROOT_PASSWORD=taosdata
TAOS_FQDN=tdengine

添加 docker-compose.king.yml 和 docker-compose.hybrid.yml

docker-compose.king.yml:

yaml
#
# SPDX-FileCopyrightText: Copyright The Thingsboard Authors
# SPDX-License-Identifier: Apache-2.0
#
#
# Standalone CE-style deployment: ThingsBoard + KingbaseES.
# Entity data and telemetry both use KingbaseES (DATABASE_TS_TYPE=sql).
#
# Maven build:
#   mvn clean install -DskipTests -Ddockerfile.skip=false
#
# Deploy (root .env: COMPOSE_FILE=docker-compose.king.yml, DATABASE_TS_TYPE=sql):
#   docker compose up -d kingbase
#   docker compose --profile init run --rm kingbase-init   # once: CREATE DATABASE (then auto-removed)
#   docker compose run --rm -e INSTALL_TB=true -e LOAD_DEMO=true thingsboard
#   docker compose up -d
#   # steady state: only kingbase + thingsboard (init is profile=init, not started by up -d)
#
services:
  kingbase:
    restart: always
    image: "${KINGBASE_IMAGE:-kingbase-pg:v9r1c10}"
    container_name: kingbase
    privileged: true
    ports:
      - "${KINGBASE_HOST_PORT:-54321}:${KINGBASE_PORT:-54321}"
    environment:
      DB_USER: ${KINGBASE_USER:-system}
      DB_PASSWORD: ${KINGBASE_PASSWORD:-system}
      DB_MODE: pg
      ENCODING: utf8
      NEED_START: "yes"
      ENABLE_CI: "no"
      TZ: ${TZ:-Asia/Shanghai}
    volumes:
      - kingbase-data:/home/kingbase/userdata
    command: ["/usr/sbin/init"]
    healthcheck:
      # Image already runs as user kingbase; do not use "su - kingbase".
      test: ["CMD-SHELL", "ksql -U ${KINGBASE_USER:-system} -d ${KINGBASE_ADMIN_DB:-kingbase} -c 'select 1'"]
      interval: 10s
      timeout: 5s
      retries: 10
      start_period: 60s
  # One-shot CREATE DATABASE. Not started by "up -d"; use:
  #   docker compose --profile init run --rm kingbase-init
  kingbase-init:
    profiles: ["init"]
    image: "${KINGBASE_IMAGE:-kingbase-pg:v9r1c10}"
    restart: "no"
    depends_on:
      kingbase:
        condition: service_healthy
    environment:
      KINGBASE_USER: ${KINGBASE_USER:-system}
      KINGBASE_PASSWORD: ${KINGBASE_PASSWORD:-system}
      KINGBASE_HOST: ${KINGBASE_HOST:-kingbase}
      KINGBASE_PORT: ${KINGBASE_PORT:-54321}
      KINGBASE_DB: ${KINGBASE_DB:-thingsboard}
      KINGBASE_ADMIN_DB: ${KINGBASE_ADMIN_DB:-kingbase}
    entrypoint: ["/bin/bash", "-lc"]
    command:
      - |
        set -euo pipefail
        # Kingbase ksql ignores PGPASSWORD; pass credentials via conninfo.
        KB_CONN="host=$$KINGBASE_HOST port=$$KINGBASE_PORT dbname=$$KINGBASE_ADMIN_DB user=$$KINGBASE_USER password=$$KINGBASE_PASSWORD"
        echo "Waiting for Kingbase TCP at $$KINGBASE_HOST:$$KINGBASE_PORT ..."
        for i in $$(seq 1 60); do
          if ksql "$$KB_CONN" -c "select 1" >/dev/null 2>&1; then
            break
          fi
          sleep 2
        done
        exists="$$(ksql "$$KB_CONN" -tAc "SELECT 1 FROM pg_database WHERE datname='$$KINGBASE_DB';" 2>/dev/null | tr -d '[:space:]' || true)"
        if [ "$$exists" = "1" ]; then
          echo "Database $$KINGBASE_DB already exists"
        else
          echo "Creating database $$KINGBASE_DB..."
          ksql "$$KB_CONN" -c "CREATE DATABASE \"$$KINGBASE_DB\" WITH OWNER = \"$$KINGBASE_USER\" ENCODING = 'UTF8' TEMPLATE = template0;"
          echo "Database $$KINGBASE_DB created"
        fi
  thingsboard:
    restart: always
    image: "${TB_NODE_IMAGE:-thingsboard/tb-node:4.3.1.8}"
    ports:
      - "8080:8080"
      - "7070:7070"
      - "1883:1883"
      - "8883:8883"
      - "5683-5688:5683-5688/udp"
    logging:
      driver: "json-file"
      options:
        max-size: "100m"
        max-file: "10"
    environment:
      TB_SERVICE_ID: ${TB_SERVICE_ID:-tb-ce-node}
      TB_QUEUE_TYPE: ${TB_QUEUE_TYPE:-in-memory}
      DATABASE_TS_TYPE: ${DATABASE_TS_TYPE:-sql}
      DATABASE_TS_LATEST_TYPE: ${DATABASE_TS_LATEST_TYPE:-sql}
      SPRING_DRIVER_CLASS_NAME: ${SPRING_DRIVER_CLASS_NAME:-com.kingbase8.Driver}
      SPRING_DATASOURCE_URL: ${SPRING_DATASOURCE_URL:-jdbc:kingbase8://kingbase:54321/thingsboard}
      SPRING_DATASOURCE_USERNAME: ${SPRING_DATASOURCE_USERNAME:-system}
      SPRING_DATASOURCE_PASSWORD: ${SPRING_DATASOURCE_PASSWORD:-system}
      SPRING_JPA_DIALECT: ${SPRING_JPA_DIALECT:-org.thingsboard.server.dao.ThingsboardKingbaseDialect}
    depends_on:
      kingbase:
        condition: service_healthy
volumes:
  kingbase-data:
    name: tb-kingbase-data
    driver: local

docker-compose.hybrid.yml:

yaml
#
# SPDX-FileCopyrightText: Copyright The Thingsboard Authors
# SPDX-License-Identifier: Apache-2.0
#
#
# Standalone CE-style deployment: ThingsBoard + KingbaseES + community TDengine.
# Entities and latest telemetry in KingbaseES; historical telemetry in TDengine.
#
# Maven build:
#   mvn clean install -DskipTests -Ddockerfile.skip=false
#
# Deploy (root .env: COMPOSE_FILE=docker-compose.hybrid.yml, DATABASE_TS_TYPE=tdengine):
#   docker compose up -d kingbase tdengine
#   docker compose --profile init run --rm kingbase-init   # once: CREATE DATABASE (then auto-removed)
#   docker compose run --rm -e INSTALL_TB=true -e LOAD_DEMO=true thingsboard
#   docker compose up -d
#   # steady state: kingbase + tdengine + thingsboard (init is profile=init, not started by up -d)
#
services:
  kingbase:
    restart: always
    image: "${KINGBASE_IMAGE:-kingbase-pg:v9r1c10}"
    container_name: kingbase
    privileged: true
    ports:
      - "${KINGBASE_HOST_PORT:-54321}:${KINGBASE_PORT:-54321}"
    environment:
      DB_USER: ${KINGBASE_USER:-system}
      DB_PASSWORD: ${KINGBASE_PASSWORD:-system}
      DB_MODE: pg
      ENCODING: utf8
      NEED_START: "yes"
      ENABLE_CI: "no"
      TZ: ${TZ:-Asia/Shanghai}
    volumes:
      - kingbase-data:/home/kingbase/userdata
    command: ["/usr/sbin/init"]
    healthcheck:
      # Image already runs as user kingbase; do not use "su - kingbase".
      test: ["CMD-SHELL", "ksql -U ${KINGBASE_USER:-system} -d ${KINGBASE_ADMIN_DB:-kingbase} -c 'select 1'"]
      interval: 10s
      timeout: 5s
      retries: 10
      start_period: 60s
  # One-shot CREATE DATABASE. Not started by "up -d"; use:
  #   docker compose --profile init run --rm kingbase-init
  kingbase-init:
    profiles: ["init"]
    image: "${KINGBASE_IMAGE:-kingbase-pg:v9r1c10}"
    restart: "no"
    depends_on:
      kingbase:
        condition: service_healthy
    environment:
      KINGBASE_USER: ${KINGBASE_USER:-system}
      KINGBASE_PASSWORD: ${KINGBASE_PASSWORD:-system}
      KINGBASE_HOST: ${KINGBASE_HOST:-kingbase}
      KINGBASE_PORT: ${KINGBASE_PORT:-54321}
      KINGBASE_DB: ${KINGBASE_DB:-thingsboard}
      KINGBASE_ADMIN_DB: ${KINGBASE_ADMIN_DB:-kingbase}
    entrypoint: ["/bin/bash", "-lc"]
    command:
      - |
        set -euo pipefail
        # Kingbase ksql ignores PGPASSWORD; pass credentials via conninfo.
        KB_CONN="host=$$KINGBASE_HOST port=$$KINGBASE_PORT dbname=$$KINGBASE_ADMIN_DB user=$$KINGBASE_USER password=$$KINGBASE_PASSWORD"
        echo "Waiting for Kingbase TCP at $$KINGBASE_HOST:$$KINGBASE_PORT ..."
        for i in $$(seq 1 60); do
          if ksql "$$KB_CONN" -c "select 1" >/dev/null 2>&1; then
            break
          fi
          sleep 2
        done
        exists="$$(ksql "$$KB_CONN" -tAc "SELECT 1 FROM pg_database WHERE datname='$$KINGBASE_DB';" 2>/dev/null | tr -d '[:space:]' || true)"
        if [ "$$exists" = "1" ]; then
          echo "Database $$KINGBASE_DB already exists"
        else
          echo "Creating database $$KINGBASE_DB..."
          ksql "$$KB_CONN" -c "CREATE DATABASE \"$$KINGBASE_DB\" WITH OWNER = \"$$KINGBASE_USER\" ENCODING = 'UTF8' TEMPLATE = template0;"
          echo "Database $$KINGBASE_DB created"
        fi
  tdengine:
    restart: always
    image: "${TDENGINE_IMAGE:-tdengine/tsdb:3.4.3.3}"
    container_name: tdengine
    hostname: ${TAOS_FQDN:-tdengine}
    environment:
      TZ: ${TZ:-Asia/Shanghai}
      TAOS_FQDN: ${TAOS_FQDN:-tdengine}
      TAOS_ROOT_PASSWORD: ${TAOS_ROOT_PASSWORD:-taosdata}
    volumes:
      - tdengine-data:/var/lib/taos
      - tdengine-log:/var/log/taos
    ports:
      - "6030:6030"
      - "${TDENGINE_HOST_PORT:-6041}:${TDENGINE_PORT:-6041}"
    ulimits:
      nofile:
        soft: 65535
        hard: 65535
    healthcheck:
      test: ["CMD-SHELL", "curl -fsS -u ${TDENGINE_USERNAME:-root}:${TDENGINE_PASSWORD:-taosdata} -d 'select server_version()' http://127.0.0.1:${TDENGINE_PORT:-6041}/rest/sql | grep -q '\"code\":0'"]
      interval: 10s
      timeout: 5s
      retries: 12
      start_period: 30s
  thingsboard:
    restart: always
    image: "${TB_NODE_IMAGE:-thingsboard/tb-node:4.3.1.8}"
    ports:
      - "8080:8080"
      - "7070:7070"
      - "1883:1883"
      - "8883:8883"
      - "5683-5688:5683-5688/udp"
    logging:
      driver: "json-file"
      options:
        max-size: "100m"
        max-file: "10"
    environment:
      TB_SERVICE_ID: ${TB_SERVICE_ID:-tb-ce-node}
      TB_QUEUE_TYPE: ${TB_QUEUE_TYPE:-in-memory}
      DATABASE_TS_TYPE: ${DATABASE_TS_TYPE:-tdengine}
      DATABASE_TS_LATEST_TYPE: ${DATABASE_TS_LATEST_TYPE:-sql}
      TDENGINE_URL: ${TDENGINE_URL:-jdbc:TAOS-WS://tdengine:6041/thingsboard?varcharAsString=true}
      TDENGINE_USERNAME: ${TDENGINE_USERNAME:-root}
      TDENGINE_PASSWORD: ${TDENGINE_PASSWORD:-taosdata}
      SPRING_DRIVER_CLASS_NAME: ${SPRING_DRIVER_CLASS_NAME:-com.kingbase8.Driver}
      SPRING_DATASOURCE_URL: ${SPRING_DATASOURCE_URL:-jdbc:kingbase8://kingbase:54321/thingsboard}
      SPRING_DATASOURCE_USERNAME: ${SPRING_DATASOURCE_USERNAME:-system}
      SPRING_DATASOURCE_PASSWORD: ${SPRING_DATASOURCE_PASSWORD:-system}
      SPRING_JPA_DIALECT: ${SPRING_JPA_DIALECT:-org.thingsboard.server.dao.ThingsboardKingbaseDialect}
    depends_on:
      kingbase:
        condition: service_healthy
      tdengine:
        condition: service_healthy
volumes:
  kingbase-data:
    name: tb-kingbase-data
    driver: local
  tdengine-data:
    name: tb-tdengine-data
    driver: local
  tdengine-log:
    name: tb-tdengine-log
    driver: local

6.1.3、初始化数据库 ​

这里提供了两种部署方式,如果你是想把遥测放在kingbase中,就在 .env 配置文件中指定:

bash
COMPOSE_FILE=docker-compose.king.yml
DATABASE_TS_TYPE=sql

初始化命令:

bash
docker compose up -d kingbase

如果你是想使用kingbase + TDEngine 混合模式,就在 .env 配置文件中指定:

bash
COMPOSE_FILE=docker-compose.hybrid.yml
DATABASE_TS_TYPE=tdengine

初始化命令:

bash
docker compose up -d kingbase tdengine

6.1.4、执行 kingbase-init ​

此命令只会执行一次,为了去创建thingsboard库名:

bash
docker compose --profile init run --rm kingbase-init

6.1.5、初始化 ​

ThingsBoard的表结构

bash
docker compose run --rm -e INSTALL_TB=true -e LOAD_DEMO=true thingsboard

6.1.6、启动 ​

bash
docker compose up -d

6.1.7、注意 ​

默认是使用kingbase部署,如果需要使用TDEngine,需要改 .env配置。

数据库的密码需要更换为自己的负责密码。