[script,doc] update docker compose deploy script and doc (#542)

[script,doc] update docker compose deploy script and doc [script,doc] add gitignore
2026-09-17 09:40:58 +00:00 · 2023-01-04 15:12:59 +08:00
parent 80064e37f9
commit 21fdb4ae87
18 changed files with 208 additions and 78 deletions
@@ -87,9 +87,9 @@ Detailed config refer to [Install HertzBeat via Package](https://hertzbeat.com/d

 Detailed steps refer to [CONTRIBUTING](CONTRIBUTING.md)        

-##### 4：Install All(mysql+tdengine+hertzbeat) via Docker-compose  
+##### 4：Install All(hertzbeat+mysql+iotdb/tdengine) via Docker-compose  

-Install and deploy the mysql database, tdengine database and hertzbeat at one time through [docker-compose deployment script](script/docker-compose).
+Install and deploy the mysql database, iotdb/tdengine database and hertzbeat at one time through [docker-compose deployment script](script/docker-compose).

 Detailed steps refer to [Install via Docker-Compose](script/docker-compose/README.md)      

@@ -86,9 +86,9 @@

 详细步骤参考 [参与贡献之本地代码启动](CONTRIBUTING.md)

-##### 方式四：Docker-compose统一安装hertzbeat及其依赖服务
+##### 方式四：Docker-Compose 统一安装 hertzbeat+mysql+iotdb/tdengine

-通过 [docker-compose部署脚本](script/docker-compose) 一次性把mysql数据库,tdengine数据库和hertzbeat安装部署。
+通过 [docker-compose部署脚本](script/docker-compose) 一次性把 mysql 数据库, iotdb/tdengine 时序数据库和 hertzbeat 安装部署。

 详细步骤参考 [通过Docker-Compose安装HertzBeat](script/docker-compose/README.md)  

@@ -68,10 +68,10 @@ $ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \

 详细步骤参考 [参与贡献之本地代码启动](../others/contributing)

-#### 方式四：Docker-Compose统一安装hertzbeat及其依赖服务
+##### 方式四：Docker-Compose 统一安装 hertzbeat+mysql+iotdb/tdengine

-通过 [docker-compose部署脚本](https://github.com/dromara/hertzbeat/tree/master/script/docker-compose) 一次性把mysql数据库,tdengine数据库和hertzbeat安装部署。
+通过 [docker-compose部署脚本](https://github.com/dromara/hertzbeat/tree/master/script/docker-compose) 一次性把 mysql 数据库, iotdb/tdengine 时序数据库和 hertzbeat 安装部署。

-详细步骤参考 [docker-compose安装](https://github.com/dromara/hertzbeat/tree/master/script/docker-compose/README.md)  
+详细步骤参考 [docker-compose部署方案](https://github.com/dromara/hertzbeat/tree/master/script/docker-compose/README.md)  

 **HAVE FUN**
@@ -40,9 +40,9 @@ Detailed config refer to [Install HertzBeat via Package](https://hertzbeat.com/d

 Detailed steps refer to [CONTRIBUTING](../others/contributing)   

-##### 4：Install All(mysql+tdengine+hertzbeat) via Docker-compose
+##### 4：Install All(hertzbeat+mysql+iotdb/tdengine) via Docker-compose   

-Install and deploy the mysql database, tdengine database and hertzbeat at one time through [docker-compose deployment script](https://github.com/dromara/hertzbeat/tree/master/script/docker-compose).
+Install and deploy the mysql database, iotdb/tdengine database and hertzbeat at one time through [docker-compose deployment script](https://github.com/dromara/hertzbeat/tree/master/script/docker-compose).

 Detailed steps refer to [Install via Docker-Compose](https://github.com/dromara/hertzbeat/tree/master/script/docker-compose)

@@ -17,7 +17,7 @@ sidebar_label: 快速开始

 ##### 安装MYSQL  
 1. docker安装MYSQl  
-`docker run -d --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=123456 mysql:8.0`   
+`docker run -d --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=123456 mysql:5.7`   
 2. 创建名称为hertzbeat的数据库  
 3. 执行位于项目仓库/script/sql/目录下的数据库脚本 [schema.sql](https://gitee.com/dromara/hertzbeat/raw/master/script/sql/schema.sql)      

@@ -1,56 +1,10 @@
-##  docker-compose部署方案   
+##  Docker-Compose Deploy

- 如果不想部署而是直接使用，我们提供SAAS监控云-[TanCloud探云](https://console.tancloud.cn)，即刻 **[登录注册](https://console.tancloud.cn)** 免费使用。
- 如果想自己本地快速部署的话，可以参考下面进行操作。
-
-> docker-compose 部署方案默认使用了 Mysql + Tdengine 作为 Hertzbeat 依赖存储服务。   
-> 此方案会启动三个容器服务 Mysql, Tdengine, HertzBeat   
-
-##### 安装Docker & Docker-compose
-
-1. 下载安装 docker 环境 & docker-compose 环境
-   请参考 [Docker官网文档](https://docs.docker.com/get-docker/), [Compose安装](https://docs.docker.com/compose/install/)       
-   ```
-   $ docker -v
-   Docker version 20.10.12, build e91ed57
-   ```
-
-##### docker compose部署hertzbeat及其依赖服务     
-
-1. 下载hertzbeat-docker-compose安装部署脚本文件  
-   脚本文件位于代码仓库下`script/docker-compose` 链接 [script/docker-compose](https://gitee.com/dromara/hertzbeat/tree/master/script/docker-compose)   
+- Use Mysql + IoTDB as Hertzbeat dependent storage -> [HertzBeat+Mysql+IoTDB Solution](hertzbeat-mysql-iotdb)
+- Use Mysql + Tdengine as Hertzbeat dependent storage -> [HertzBeat+Mysql+Tdengine Solution](hertzbeat-mysql-tdengine)


-2. 进入部署脚本 docker-compose 目录, 执行  
+##  Docker-Compose 部署方案   

-   `docker compose up -d`
-
-3. 进入tdengine创建hertzbeat数据库     
-
-   `$ docker exec -it tdengine /bin/bash
-   root@tdengine-server:~/TDengine-server-2.4.0.4#`
-
-   创建名称为hertzbeat的数据库 进入容器后，执行 taos shell 客户端程序。
-
-   `root@tdengine-server:~/TDengine-server-2.4.0.4# taos
-   Welcome to the TDengine shell from Linux, Client Version:2.4.0.4
-   Copyright (c) 2020 by TAOS Data, Inc. All rights reserved.
-   taos>`
-
-   执行创建数据库命令
-
-   `taos> show databases;`
-
-   `taos> CREATE DATABASE hertzbeat KEEP 90 DAYS 10 BLOCKS 6 UPDATE 1;`
-
-##### 重启应用  
-
-`docker-compose restart hertzbeat`
-
-##### 开始探索HertzBeat   
-
-浏览器访问 `localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat`  
-
---   
-
-怎么样是不是很简单，只要几分钟就可以部署完成，赶紧试试吧！
+- 使用 Mysql + IoTDB 作为 Hertzbeat 依赖存储服务 -> [HertzBeat+Mysql+IoTDB 方案](hertzbeat-mysql-iotdb)
+- 使用 Mysql + Tdengine 作为 Hertzbeat 依赖存储服务 -> [HertzBeat+Mysql+Tdengine 方案](hertzbeat-mysql-tdengine)
@@ -0,0 +1,28 @@
+## docker-compose deployment HertzBeat+Mysql+IoTDB solution
+
+> The docker-compose deployment scheme uses Mysql + IoTDB as the dependent storage service of Hertzbeat.  
+> This solution will start three container services Mysql, IoTDB, HertzBeat
+
+##### Install Docker & Docker-compose
+
+1. Download and install docker environment & docker-compose environment
+   Please refer to [Docker official website documentation](https://docs.docker.com/get-docker/), [Compose installation](https://docs.docker.com/compose/install/)
+    ```
+    $ docker -v
+    Docker version 20.10.12, build e91ed57
+    ```
+
+##### docker compose deploys hertzbeat and its dependent services
+
+1. Download the hertzbeat-docker-compose installation deployment script file
+   The script file is located in `script/docker-compose/hertzbeat-mysql-iotdb` link [script/docker-compose](https://gitee.com/dromara/hertzbeat/tree/master/script/docker-compose/ hertzbeat-mysql-iotdb)
+
+
+2. Enter the deployment script docker-compose directory, execute
+
+   `docker compose up -d`
+
+
+##### Start exploring HertzBeat
+
+Browser access `localhost:1157` to start, the default account password `admin/hertzbeat`
@@ -0,0 +1,35 @@
+##  docker-compose部署 HertzBeat+Mysql+IoTDB 方案   
+
+- 如果不想部署而是直接使用，我们提供SAAS监控云-[TanCloud探云](https://console.tancloud.cn)，即刻 **[登录注册](https://console.tancloud.cn)** 免费使用。
+- 如果想自己本地快速部署的话，可以参考下面进行操作。
+
+> docker-compose 部署方案使用了 Mysql + IoTDB 作为 Hertzbeat 依赖存储服务。   
+> 此方案会启动三个容器服务 Mysql, IoTDB, HertzBeat   
+
+##### 安装Docker & Docker-compose
+
+1. 下载安装 docker 环境 & docker-compose 环境
+   请参考 [Docker官网文档](https://docs.docker.com/get-docker/), [Compose安装](https://docs.docker.com/compose/install/)       
+   ```
+   $ docker -v
+   Docker version 20.10.12, build e91ed57
+   ```
+
+##### docker compose部署hertzbeat及其依赖服务     
+
+1. 下载hertzbeat-docker-compose安装部署脚本文件  
+   脚本文件位于代码仓库下`script/docker-compose/hertzbeat-mysql-iotdb` 链接 [script/docker-compose](https://gitee.com/dromara/hertzbeat/tree/master/script/docker-compose/hertzbeat-mysql-iotdb)   
+
+
+2. 进入部署脚本 docker-compose 目录, 执行  
+
+   `docker compose up -d`
+
+
+##### 开始探索HertzBeat   
+
+浏览器访问 `localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat`  
+
+---   
+
+怎么样是不是很简单，只要几分钟就可以部署完成，赶紧试试吧！
@@ -62,7 +62,6 @@ spring:
      max-lifetime: 120000
  jpa:
    database: mysql
-    database-platform: org.hibernate.dialect.MySQL8Dialect
    hibernate:
      ddl-auto: update
  # Not Require, Please config if you need email notify
@@ -1,2 +1,3 @@
-.gitignore
 !.gitignore
+**.**
+**
@@ -1,2 +1,3 @@
-.gitignore
 !.gitignore
+**.**
+**
@@ -22,7 +22,7 @@ networks:
 services:
  mysql:
    image: mysql:8
-    container_name: mysql
+    container_name: compose-mysql
    hostname: mysql
    restart: always
    ports:
@@ -38,7 +38,7 @@ services:

  iotdb:
    image: apache/iotdb:0.13.3-node
-    container_name: iotdb
+    container_name: compose-iotdb
    hostname: iotdb
    restart: always
    environment:
@@ -47,22 +47,25 @@ services:
      - "8181:8181"
      - "6667:6667"
    volumes:
-      - ./dbdata/taosdata:/iotdb/data
+      - ./dbdata/iotdbdata:/iotdb/data
    networks:
      - heartzbeat

  hertzbeat:
    image: tancloud/hertzbeat
-    container_name: hertzbeat
+    container_name: compose-hertzbeat
    hostname: hertzbeat
    restart: always
    environment:
      TZ: Asia/Shanghai
      LANG: zh_CN.UTF-8
+    depends_on:
+      - mysql
+      - iotdb
    volumes:
      - ./conf/application.yml:/opt/hertzbeat/config/application.yml
      - ./conf/sureness.yml:/opt/hertzbeat/config/sureness.yml
    ports:
      - "1157:1157"
    networks:
-      - heartzbeat
+      - heartzbeat
@@ -0,0 +1,49 @@
+## Docker-Compose deployment HertzBeat+Mysql+Tdengine Solution
+
+> The docker-compose deployment scheme uses Mysql + Tdengine as the dependent storage service of Hertzbeat.
+> This solution will start three container services Mysql, Tdengine, HertzBeat
+
+##### Install Docker & Docker-compose
+
+1. Download and install docker environment & docker-compose environment
+   Please refer to [Docker official website documentation](https://docs.docker.com/get-docker/), [Compose installation](https://docs.docker.com/compose/install/)
+    ```
+    $ docker -v
+    Docker version 20.10.12, build e91ed57
+    ```
+
+##### docker compose deploys hertzbeat and its dependent services
+
+1. Download the hertzbeat-docker-compose installation deployment script file
+   The script file is located in `script/docker-compose/hertzbeat-mysql-tdengine` link [script/docker-compose](https://gitee.com/dromara/hertzbeat/tree/master/script/docker-compose/ hertzbeat-mysql-tdengine)
+
+
+2. Enter the deployment script docker-compose directory, execute
+
+   `docker compose up -d`
+
+3. Enter tdengine to create hertzbeat database
+
+   `$ docker exec -it tdengine /bin/bash
+   root@tdengine-server:~/TDengine-server-2.4.0.4#`
+
+   Create a database named hertzbeat After entering the container, execute the taos shell client program.
+
+   `root@tdengine-server:~/TDengine-server-2.4.0.4# taos
+   Welcome to the TDengine shell from Linux, Client Version: 2.4.0.4
+   Copyright (c) 2020 by TAOS Data, Inc. All rights reserved.
+   taos>`
+
+   Execute the create database command
+
+   `taos> show databases;`
+
+   `taos> CREATE DATABASE hertzbeat KEEP 90 DAYS 10 BLOCKS 6 UPDATE 1;`
+
+##### Restart the application
+
+`docker-compose restart hertzbeat`
+
+##### Start exploring HertzBeat
+
+Browser access `localhost:1157` to start, the default account password `admin/hertzbeat`
@@ -0,0 +1,56 @@
+##  docker-compose部署 HertzBeat+Mysql+Tdengine 方案   
+
+- 如果不想部署而是直接使用，我们提供SAAS监控云-[TanCloud探云](https://console.tancloud.cn)，即刻 **[登录注册](https://console.tancloud.cn)** 免费使用。
+- 如果想自己本地快速部署的话，可以参考下面进行操作。
+
+> docker-compose 部署方案使用了 Mysql + Tdengine 作为 Hertzbeat 依赖存储服务。   
+> 此方案会启动三个容器服务 Mysql, Tdengine, HertzBeat   
+
+##### 安装Docker & Docker-compose
+
+1. 下载安装 docker 环境 & docker-compose 环境
+   请参考 [Docker官网文档](https://docs.docker.com/get-docker/), [Compose安装](https://docs.docker.com/compose/install/)       
+   ```
+   $ docker -v
+   Docker version 20.10.12, build e91ed57
+   ```
+
+##### docker compose部署hertzbeat及其依赖服务     
+
+1. 下载hertzbeat-docker-compose安装部署脚本文件  
+   脚本文件位于代码仓库下`script/docker-compose/hertzbeat-mysql-tdengine` 链接 [script/docker-compose](https://gitee.com/dromara/hertzbeat/tree/master/script/docker-compose/hertzbeat-mysql-tdengine)   
+
+
+2. 进入部署脚本 docker-compose 目录, 执行  
+
+   `docker compose up -d`
+
+3. 进入tdengine创建hertzbeat数据库     
+
+   `$ docker exec -it tdengine /bin/bash
+   root@tdengine-server:~/TDengine-server-2.4.0.4#`
+
+   创建名称为hertzbeat的数据库 进入容器后，执行 taos shell 客户端程序。
+
+   `root@tdengine-server:~/TDengine-server-2.4.0.4# taos
+   Welcome to the TDengine shell from Linux, Client Version:2.4.0.4
+   Copyright (c) 2020 by TAOS Data, Inc. All rights reserved.
+   taos>`
+
+   执行创建数据库命令
+
+   `taos> show databases;`
+
+   `taos> CREATE DATABASE hertzbeat KEEP 90 DAYS 10 BLOCKS 6 UPDATE 1;`
+
+##### 重启应用  
+
+`docker-compose restart hertzbeat`
+
+##### 开始探索HertzBeat   
+
+浏览器访问 `localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat`  
+
+---   
+
+怎么样是不是很简单，只要几分钟就可以部署完成，赶紧试试吧！
@@ -62,7 +62,6 @@ spring:
      max-lifetime: 120000
  jpa:
    database: mysql
-    database-platform: org.hibernate.dialect.MySQL8Dialect
    hibernate:
      ddl-auto: update
  # Not Require, Please config if you need email notify
@@ -91,4 +90,4 @@ warehouse:
      driver-class-name: com.taosdata.jdbc.rs.RestfulDriver
      url: jdbc:TAOS-RS://tdengine:6041/hertzbeat
      username: root
-      password: taosdata
+      password: taosdata
@@ -1,2 +1,3 @@
-.gitignore
 !.gitignore
+**.**
+**
@@ -1,2 +1,3 @@
-.gitignore
 !.gitignore
+**.**
+**
@@ -22,7 +22,7 @@ networks:
 services:
  mysql:
    image: mysql:8
-    container_name: mysql
+    container_name: compose-mysql
    hostname: mysql
    restart: always
    ports:
@@ -38,7 +38,7 @@ services:

  tdengine:
    image: tdengine/tdengine:2.4.0.12
-    container_name: tdengine
+    container_name: compose-tdengine
    hostname: tdengine
    restart: always
    environment:
@@ -53,16 +53,19 @@ services:

  hertzbeat:
    image: tancloud/hertzbeat
-    container_name: hertzbeat
+    container_name: compose-hertzbeat
    hostname: hertzbeat
    restart: always
    environment:
      TZ: Asia/Shanghai
      LANG: zh_CN.UTF-8
+    depends_on:
+      - mysql
+      - tdengine
    volumes:
      - ./conf/application.yml:/opt/hertzbeat/config/application.yml
      - ./conf/sureness.yml:/opt/hertzbeat/config/sureness.yml
    ports:
      - "1157:1157"
    networks:
-      - heartzbeat
+      - heartzbeat