Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[home]doc:update docker-deploy.md and tdengine-init.md #306

Merged
merged 1 commit into from
Sep 24, 2022
Merged

[home]doc:update docker-deploy.md and tdengine-init.md #306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 45 additions & 8 deletions home/docs/start/docker-deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 4,45 @@ title: 通过Docker方式安装HertzBeat
sidebar_label: Docker方式部署
---

> 推荐使用docker部署HertzBeat
> 推荐使用Docker部署HertzBeat

安装部署视频教程: [HertzBeat安装部署-BiliBili](https://www.bilibili.com/video/BV1GY41177YL)

1. 下载安装Docker环境
Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。
Docker 工具自身的下载请参考以下资料：
[Docker官网文档](https://docs.docker.com/get-docker/)
[菜鸟教程-Docker教程](https://www.runoob.com/docker/docker-tutorial.html)
安装完毕后终端查看Docker版本是否正常输出。

```
$ docker -v
Docker version 20.10.12, build e91ed57
```

2. 拉取HertzBeat Docker镜像
镜像版本TAG可查看[官方镜像仓库](https://hub.docker.com/r/tancloud/hertzbeat/tags)
```

``` shell
$ docker pull tancloud/hertzbeat
```
3. 配置HertzBeat的配置文件(可选)

3. 部署HertzBeat您可能需要掌握的几条命令

```shell
#查看所有容器(在运行和已经停止运行的容器)
$ docker ps -a
#启动/终止/重启/运行状态
$ docker start/stop/restart/stats 容器id或者容器名
#进入容器并打开容器的shell终端
$ docker exec -it 容器id或者容器名 /bin/bash
#退出容器终端
ctrl p然后ctrl q
#完全退出容器的终端
ctrl d或者
$ exit
```

4. 配置HertzBeat的配置文件(可选)
在主机目录下创建application.yml，eg:/opt/application.yml
配置文件内容参考 项目仓库[/script/application.yml](https://gitee.com/dromara/hertzbeat/raw/master/script/application.yml)，替换里面的`td-engine`服务参数，IP端口账户密码
注意⚠️（若使用邮件告警，需替换里面的邮件服务器参数。若使用MYSQL数据源，需替换里面的datasource参数 参见[H2数据库切换为MYSQL](mysql-change)）
Expand All @@ -43,7 64,6 @@ sidebar_label: Docker方式部署
若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤
在主机目录下创建sureness.yml，eg:/opt/sureness.yml
配置文件内容参考 项目仓库[/script/sureness.yml](https://gitee.com/dromara/hertzbeat/blob/master/script/sureness.yml)

```yaml

resourceRole:
Expand Down Expand Up @@ -123,7 143,7 @@ account:
credential: hertzbeat
role: [guest]
```

修改sureness.yml的如下**部分参数**：**[注意⚠️sureness配置的其它默认参数需保留]**

```yaml
Expand Down Expand Up @@ -155,20 175,37 @@ $ docker run -d -p 1157:1157 \
-v /opt/logs:/opt/hertzbeat/logs \
-v /opt/application.yml:/opt/hertzbeat/config/application.yml \
-v /opt/sureness.yml:/opt/hertzbeat/config/sureness.yml \
--restart=always \
--name hertzbeat tancloud/hertzbeat
```

这条命令启动一个运行HertzBeat的Docker容器，并且将容器的1157端口映射到宿主机的1157端口上。若宿主机已有进程占用该端口，则需要修改主机映射端口。
这条命令启动一个运行HertzBeat的Docker容器，并且将容器的1157端口映射到宿主机的1157端口上。若宿主机已有进程占用该端口，则需要修改主机映射端口。
- `docker run -d` : 通过Docker运行一个容器,使其在后台运行
- `-p 1157:1157` : 映射容器端口到主机端口

- `-p 1157:1157` : 映射容器端口到主机端口，请注意，前面是宿主机的端口号，后面是容器的端口号。

- `-e LANG=zh_CN.UTF-8` : (可选) 设置语言

- `-e TZ=Asia/Shanghai` : (可选) 设置时区

- `-v /opt/data:/opt/hertzbeat/data` : (可选，数据持久化)重要⚠️ 挂载H2数据库文件到本地主机，保证数据不会因为容器的创建删除而丢失

- `-v /opt/logs:/opt/hertzbeat/logs` : (可选，不需要可删除)挂载日志文件到本地主机，保证日志不会因为容器的创建删除而丢失，方便查看

- `-v /opt/application.yml:/opt/hertzbeat/config/application.yml` : (可选,不需要可删除)挂载上上一步修改的本地配置文件到容器中，即使用本地配置文件覆盖容器配置文件。我们需要修改此配置文件的MYSQL，TDengine配置信息来连接外部服务。

- `-v /opt/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (可选,不需要可删除)挂载上一步修改的账户配置文件到容器中，若无修改账户需求可删除此命令参数。

- 注意⚠️ 挂载文件时，前面参数为你自定义本地文件地址，后面参数为docker容器内文件地址(固定)

- `--name hertzbeat` : 命名容器名称 hertzbeat

- `--restart=always`：(可选，不需要可删除)使容器在Docker启动后自动重启。若您未在容器创建时指定该参数，可通过以下命令实现该容器自启。

```shell
$ docker update --restart=always hertzbeat
```

- `tancloud/hertzbeat` : 使用拉取最新的的HertzBeat官方发布的应用镜像来启动容器,版本可查看[官方镜像仓库](https://hub.docker.com/r/tancloud/hertzbeat/tags)

7. 开始探索HertzBeat
Expand Down
31 changes: 26 additions & 5 deletions home/docs/start/tdengine-init.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 13,7 @@ TDengine是一款开源物联网时序型数据库，我们用其存储采集到
> 可参考官方网站[安装教程](https://www.taosdata.com/docs/cn/v2.0/getting-started/docker)
1. 下载安装Docker环境
Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。
安装完毕后终端查看Docker版本是否正常输出。
安装完毕后终端查看Docker版本是否正常输出。
```
$ docker -v
Docker version 20.10.12, build e91ed57
Expand All @@ -32,31 32,53 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \
使用```$ docker ps```查看数据库是否启动成功

### 创建数据库实例

> [TDengine CLI 小技巧](https://docs.taosdata.com/2.4/reference/taos-shell/#tdengine-cli-小技巧)

1. 进入数据库Docker容器
```
$ docker exec -it tdengine /bin/bash
```
2. 创建名称为hertzbeat的数据库
进入容器后，执行 `taos` 命令, 如下:

2. 修改账户密码

> 我们强烈建议您修改密码。TDengine默认的账户密码是 root/taosdata
> 进入容器后，执行 `taos` 命令进入TDengine CLI , 如下:

```
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>
```
> 在 TDengine CLI 中使用 alter user 命令可以修改用户密码，缺省密码为 taosdata

3. 创建名称为hertzbeat的数据库

执行创建数据库命令

```
taos> show databases;
taos> CREATE DATABASE hertzbeat KEEP 90 DAYS 10 BLOCKS 6 UPDATE 1;
```

上述语句将创建一个名为 hertzbeat 的库，这个库的数据将保留90天（超过90天将被自动删除），每 10 天一个数据文件，内存块数为 6，允许更新数据
3. 查看hertzbeat数据库是否成功创建

4. 查看hertzbeat数据库是否成功创建

```
taos> show databases;
taos> use hertzbeat;
```

5. 退出TDengine CLI

```
输入 q 或 quit 或 exit 回车
```

**注意⚠️若是安装包安装的TDengine2.3 版本**

> 除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter

### 在hertzbeat的`application.yml`配置文件配置此数据库连接
Expand All @@ -71,7 93,6 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \
warehouse.store.td-engine.url
warehouse.store.td-engine.username
warehouse.store.td-engine.password

```

### 常见问题
Expand Down