From 8c7a34bd985a6bb186345fed006efd81863f5798 Mon Sep 17 00:00:00 2001 From: tomsun28 Date: Sun, 12 Nov 2023 13:32:40 +0800 Subject: [PATCH] update package deploy doc (#1330) --- README.md | 14 ++- README_CN.md | 14 ++- home/docs/start/package-deploy.md | 63 ++++++------- home/docs/start/quickstart.md | 14 ++- .../current/start/package-deploy.md | 62 ++++++------- .../current/start/quickstart.md | 93 +++++++++---------- .../collector/assembly-windows-64.xml | 2 +- web-app/src/assets/i18n/en-US.json | 2 +- web-app/src/assets/i18n/zh-CN.json | 2 +- web-app/src/assets/i18n/zh-TW.json | 2 +- 10 files changed, 128 insertions(+), 140 deletions(-) diff --git a/README.md b/README.md index 015e77c91da..d87d73c333f 100644 --- a/README.md +++ b/README.md @@ -124,14 +124,12 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do ##### 2：Install via package -1. Download the release package `hertzbeat-xx.zip` [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) -2. Need `java jdk11` Environment -3. Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml` (optional) -4. Run command `$ ./bin/startup.sh ` or `bin/startup.bat` -5. Access `http://localhost:1157` to start, default account: `admin/hertzbeat` -6. Deploy collector clusters - - Download the release package `hertzbeat-collector-xx.zip` to new machine [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) - - Need `java jdk11` Environment +1. Download the release package `hertzbeat-xx.tar.gz` [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) +2. Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml` (optional) +3. Run command `$ ./bin/startup.sh ` or `bin/startup.bat` +4. Access `http://localhost:1157` to start, default account: `admin/hertzbeat` +5. Deploy collector clusters + - Download the release package `hertzbeat-collector-xx.tar.gz` to new machine [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) - Configure the collector configuration yml file `hertzbeat-collector/config/application.yml`: unique `identity` name, running `mode` (public or private), hertzbeat `manager-host`, hertzbeat `manager-port` ```yaml collector: diff --git a/README_CN.md b/README_CN.md index 013feedf508..394f3ff2367 100644 --- a/README_CN.md +++ b/README_CN.md @@ -122,14 +122,12 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN ##### 方式二：通过安装包安装 -1. 下载您系统环境对应的安装包`hertzbeat-xx.zip` [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) -2. 需要提前已安装`java jdk11`环境 -3. 配置 HertzBeat 的配置文件 `hertzbeat/config/application.yml`(可选) -4. 部署启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` -5. 浏览器访问 `http://localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat` -6. 部署采集器集群 - - 下载采集器安装包`hertzbeat-collector-xx.zip`到规划的另一台部署主机上 [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) - - 需要提前已安装`java jdk11`环境 +1. 下载您系统环境对应的安装包`hertzbeat-xx.tar.gz` [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) +2. 配置 HertzBeat 的配置文件 `hertzbeat/config/application.yml`(可选) +3. 部署启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` +4. 浏览器访问 `http://localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat` +5. 部署采集器集群 + - 下载采集器安装包`hertzbeat-collector-xx.tar.gz`到规划的另一台部署主机上 [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) - 配置采集器的配置文件 `hertzbeat-collector/config/application.yml` 里面的连接主HertzBeat服务的对外IP，端口，当前采集器名称(需保证唯一性)等参数 `identity` `mode` (public or private) `manager-host` `manager-port` ```yaml collector: diff --git a/home/docs/start/package-deploy.md b/home/docs/start/package-deploy.md index 2b3e3c4a41d..60ef163c0a4 100644 --- a/home/docs/start/package-deploy.md +++ b/home/docs/start/package-deploy.md @@ -3,31 +3,19 @@ id: package-deploy title: Install HertzBeat via Package sidebar_label: Install via Package --- -> You can install and run HertzBeat on Linux Windows Mac system, and CPU supports X86/ARM64. Due to the installation package itself does not include the JAVA runtime environment, you need to prepare JAVA runtime environment in advance. +> You can install and run HertzBeat on Linux Windows Mac system, and CPU supports X86/ARM64. -1. Install JAVA runtime environment-refer to [official website](http://www.oracle.com/technetwork/java/javase/downloads/index.html) - requirement：JDK11 ENV - download JAVA installation package: [mirror website](https://repo.huaweicloud.com/java/jdk/) - After installation use command line to check whether you install it successfully. - ``` - $ java -version - java version "11.0.12" - Java(TM) SE Runtime Environment 18.9 (build 11.0.12+8-LTS-237) - Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.12+8-LTS-237, mixed mode) - - ``` - -2. Download HertzBeat installation package - Download installation package `hertzbeat-xx.zip` `hertzbeat-collector-xx.zip` corresponding to your system environment +1. Download HertzBeat installation package + Download installation package `hertzbeat-xx.tar.gz` `hertzbeat-collector-xx.tar.gz` corresponding to your system environment - download from [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) repository - download from [GITHUB Release](https://github.com/dromara/hertzbeat/releases) repository -3. Configure HertzBeat's configuration file(optional) +2. Configure HertzBeat's configuration file(optional) Unzip the installation package to the host eg: /opt/hertzbeat ``` - $ tar zxvf hertzbeat-[version].tar.gz + $ tar zxvf hertzbeat-xx.tar.gz or - $ unzip -o hertzbeat-[version].zip + $ unzip -o hertzbeat-xx.zip ``` Modify the configuration file `hertzbeat/config/application.yml` params according to your needs. - If you need to use email to send alarms, you need to replace the email server parameters `spring.mail` in `application.yml` @@ -35,29 +23,24 @@ sidebar_label: Install via Package - **Recommended** If you need to use the time series database TDengine to store indicator data, you need to replace the `warehouse.store.td-engine` parameter in `application.yml` for specific steps, see [Using TDengine to store metrics data](tdengine-init) - **Recommended** If you need to use the time series database IotDB to store the indicator database, you need to replace the `warehouse.storeiot-db` parameter in `application.yml` For specific steps, see [Use IotDB to store metrics data](iotdb-init) -4. Configure the account file(optional) +3. Configure the account file(optional) HertzBeat default built-in three user accounts, respectively `admin/hertzbeat tom/hertzbeat guest/hertzbeat` If you need add, delete or modify account or password, configure `hertzbeat/config/sureness.yml`. Ignore this step without this demand. For detail steps, please refer to [Configure Account Password](account-modify) -5. Start the service +4. Start the service Execute the startup script `startup.sh` in the installation directory `hertzbeat/bin/`, or `startup.bat` in windows. ``` $ ./startup.sh ``` -⚠️Note, If there are multiple Java environments configured in the system environment variables and `java11` is not included, modify `$ ./startup.sh` or `startup.bat` to specify the Java path manually. -In `startup.sh`, add `JAVA_HOME=${JAVA_DIR}` at the first line. -In `startup.bat`, modify `javaw` to the path of `java11`, such as `C:\Users\user\.jdks\corretto-11.0.18\bin\javaw` - -6. Begin to explore HertzBeat +5. Begin to explore HertzBeat Access http://localhost:1157/ using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! -7. Deploy collector clusters (Optional) +6. Deploy collector clusters (Optional) - - Download and unzip the collector release package `hertzbeat-collector-xx.zip` to new machine [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) - - Also need to install `java jdk11` environment like above. + - Download and unzip the collector release package `hertzbeat-collector-xx.tar.gz` to new machine [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) - Configure the collector configuration yml file `hertzbeat-collector/config/application.yml`: unique `identity` name, running `mode` (public or private), hertzbeat `manager-host`, hertzbeat `manager-port` ```yaml collector: @@ -77,25 +60,39 @@ In `startup.bat`, modify `javaw` to the path of `java11`, such as `C:\Users\user ### FAQ -1. **According to the process deploy，visit http://ip:1157/ no interface** +1. **If using the package not contains JDK, you need to prepare the JAVA environment in advance** + + Install JAVA runtime environment-refer to [official website](http://www.oracle.com/technetwork/java/javase/downloads/index.html) + requirement：JDK11 ENV + download JAVA installation package: [mirror website](https://repo.huaweicloud.com/java/jdk/) + After installation use command line to check whether you install it successfully. + ``` + $ java -version + java version "11.0.12" + Java(TM) SE Runtime Environment 18.9 (build 11.0.12+8-LTS-237) + Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.12+8-LTS-237, mixed mode) + + ``` + +2. **According to the process deploy，visit http://ip:1157/ no interface** Please refer to the following points to troubleshoot issues: > 1：If you switch to dependency service MYSQL database，check whether the database is created and started successfully. > 2：Check whether dependent services, IP account and password configuration is correct in HertzBeat's configuration file `hertzbeat/config/application.yml`. > 3：Check whether the running log has errors in `hertzbeat/logs/` directory. If you haven't solved the issue, report it to the communication group or community. -2. **Log an error TDengine connection or insert SQL failed** +3. **Log an error TDengine connection or insert SQL failed** > 1：Check whether database account and password configured is correct, the database is created. > 2：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. -3. **Historical monitoring charts have been missing data for a long time** +4. **Historical monitoring charts have been missing data for a long time** > 1：Check whether you configure Tdengine or IoTDB. No configuration means no historical chart data. > 2：Check whether Tdengine database `hertzbeat` is created. > 3: Check whether IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. -4. **The historical picture of monitoring details is not displayed or has no data, and TDengine has been deployed** +5. **The historical picture of monitoring details is not displayed or has no data, and TDengine has been deployed** > Please confirm whether the installed TDengine version is near 2.4.0.12, version 3.0 and 2.2 are not compatible. -5. **The time series database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure dependent time series database]** +6. **The time series database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure dependent time series database]** > Please check if the configuration parameters are correct > Is iot-db or td-engine enable set to true > Note⚠️If both hertzbeat and IotDB, TDengine are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed diff --git a/home/docs/start/quickstart.md b/home/docs/start/quickstart.md index e41ba92bb03..9b17c34e846 100644 --- a/home/docs/start/quickstart.md +++ b/home/docs/start/quickstart.md @@ -39,14 +39,12 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do ##### 2：Install via package -1. Download the release package `hertzbeat-xx.zip` [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) -2. Need `java jdk11` Environment -3. Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml` (optional) -4. Run command `$ ./bin/startup.sh ` or `bin/startup.bat` -5. Access `http://localhost:1157` to start, default account: `admin/hertzbeat` -6. Deploy collector clusters - - Download the release package `hertzbeat-collector-xx.zip` to new machine [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) - - Need `java jdk11` Environment +1. Download the release package `hertzbeat-xx.tar.gz` [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) +2. Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml` (optional) +3. Run command `$ ./bin/startup.sh ` or `bin/startup.bat` +4. Access `http://localhost:1157` to start, default account: `admin/hertzbeat` +5. Deploy collector clusters + - Download the release package `hertzbeat-collector-xx.tar.gz` to new machine [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) - Configure the collector configuration yml file `hertzbeat-collector/config/application.yml`: unique `identity` name, running `mode` (public or private), hertzbeat `manager-host`, hertzbeat `manager-port` ```yaml collector: diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md index 53a52873257..ae1af5b989d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md @@ -3,32 +3,19 @@ id: package-deploy title: 通过安装包安装 HertzBeat sidebar_label: 安装包方式部署 --- -> HertzBeat支持在Linux Windows Mac系统安装运行，CPU支持X86/ARM64。 -> 由于安装包自身不包含JAVA运行环境，需您提前准备JAVA运行环境。 - -1. 安装JAVA运行环境-可参考[官方网站](http://www.oracle.com/technetwork/java/javase/downloads/index.html) - 要求：JAVA11环境 - 下载JAVA安装包: [镜像站](https://repo.huaweicloud.com/java/jdk/) - 安装后命令行检查是否成功安装 - ``` - $ java -version - java version "11.0.12" - Java(TM) SE Runtime Environment 18.9 (build 11.0.12+8-LTS-237) - Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.12+8-LTS-237, mixed mode) - - ``` +> HertzBeat支持在Linux Windows Mac系统安装运行，CPU支持X86/ARM64。 -2. 下载HertzBeat安装包 - 下载您系统环境对应的安装包 `hertzbeat-xx.zip` `hertzbeat-collector-xx.zip` +1. 下载HertzBeat安装包 + 下载您系统环境对应的安装包 `hertzbeat-xx.tar.gz` `hertzbeat-collector-xx.tar.gz` - 从[GITEE Release](https://gitee.com/dromara/hertzbeat/releases) 仓库下载 - 从[GITHUB Release](https://github.com/dromara/hertzbeat/releases) 仓库下载 -3. 配置HertzBeat的配置文件(可选) +2. 配置HertzBeat的配置文件(可选) 解压安装包到主机 eg: /opt/hertzbeat ``` - $ tar zxvf hertzbeat-[版本号].tar.gz + $ tar zxvf hertzbeat-xx.tar.gz or - $ unzip -o hertzbeat-[版本号].zip + $ unzip -o hertzbeat-xx.zip ``` 修改位于 `hertzbeat/config/application.yml` 的配置文件(可选)，您可以根据需求修改配置文件 - 若需使用邮件发送告警，需替换`application.yml`里面的邮件服务器参数 @@ -36,26 +23,22 @@ sidebar_label: 安装包方式部署 - **推荐**若需使用时序数据库TDengine来存储指标数据，需替换`application.yml`里面的`warehouse.store.td-engine`参数 具体步骤参见 [使用TDengine存储指标数据](tdengine-init) - **推荐**若需使用时序数据库IotDB来存储指标数据库，需替换`application.yml`里面的`warehouse.storeiot-db`参数 具体步骤参见 [使用IotDB存储指标数据](iotdb-init) -4. 配置用户配置文件(可选,自定义配置用户密码) +3. 配置用户配置文件(可选,自定义配置用户密码) HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat 若需要新增删除修改账户或密码，可以通过修改位于 `hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤 具体参考 [配置修改账户密码](account-modify) -5. 部署启动 +4. 部署启动 执行位于安装目录hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat ``` $ ./startup.sh ``` - -⚠️注意，如果在多java环境中，环境变量中JAVA已经配置了其他java环境如`java8`，没有`java11`，需编辑`$ ./startup.sh ` 或 `startup.bat`手动指定java路径。 -`startup.sh`在第一行添加`JAVA_HOME=${JAVA_DIR}`，`startup.bat`修改`start javaw %JAVA_OPTS% %JAVA_MEM_OPTS% %CONFIG_FILES% -jar %DEPLOY_DIR%\%JAR_NAME% >logs\startup.log 2>&1 &`中的`javaw`为`java11`的路径，如`C:\Users\user\.jdks\corretto-11.0.18\bin\javaw` -6. 开始探索HertzBeat +5. 开始探索HertzBeat 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 -7. 部署采集器集群(可选) - - 下载解压采集器安装包`hertzbeat-collector-xx.zip`到规划的另一台部署主机上 [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) - - 也需要如上步骤一样提前安装`java jdk11`环境 +6. 部署采集器集群(可选) + - 下载解压您系统环境对应采集器安装包`hertzbeat-collector-xx.tar.gz`到规划的另一台部署主机上 [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) - 配置采集器的配置文件 `hertzbeat-collector/config/application.yml` 里面的连接主HertzBeat服务的对外IP，端口，当前采集器名称(需保证唯一性)等参数 `identity` `mode` (public or private) `manager-host` `manager-port` ```yaml collector: @@ -73,21 +56,36 @@ sidebar_label: 安装包方式部署 **HAVE FUN** + ### 安装包部署常见问题 -**最多的问题就是网络问题，请先提前排查** +**最多的问题就是网络环境问题，请先提前排查** + +1. **若您使用的是不含JDK的安装包，需您提前准备JAVA运行环境** + +安装JAVA运行环境-可参考[官方网站](http://www.oracle.com/technetwork/java/javase/downloads/index.html) +要求：JAVA11环境 +下载JAVA安装包: [镜像站](https://repo.huaweicloud.com/java/jdk/) +安装后命令行检查是否成功安装 + ``` + $ java -version + java version "11.0.12" + Java(TM) SE Runtime Environment 18.9 (build 11.0.12+8-LTS-237) + Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.12+8-LTS-237, mixed mode) + + ``` -1. **按照流程部署，访问 http://ip:1157/ 无界面** +2. **按照流程部署，访问 http://ip:1157/ 无界面** 请参考下面几点排查问题： > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 > 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 -2. **日志报错TDengine连接或插入SQL失败** +3. **日志报错TDengine连接或插入SQL失败** > 一：排查配置的数据库账户密码是否正确，数据库是否创建 > 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter -3. **监控历史图表长时间都一直无数据** +4. **监控历史图表长时间都一直无数据** > 一：Tdengine或IoTDB是否配置，未配置则无历史图表数据 > 二：若使用了Tdengine，排查Tdengine的数据库`hertzbeat`是否创建 > 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB 或 Tdengine IP账户密码等配置是否正确 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/quickstart.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/quickstart.md index f3090d3c556..7a21f7bbe47 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/quickstart.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/quickstart.md @@ -7,46 +7,8 @@ sidebar_label: 快速开始 ### 🐕 开始使用 - 如果您不想部署而是直接使用，我们提供SAAS监控云服务-TanCloud探云，**[即刻登录注册免费使用](https://console.tancloud.cn)**。 -- 如果您是想将HertzBeat部署到内网环境搭建监控系统，请参考下面的部署文档进行操作。 +- 如果您是想将HertzBeat部署到本地搭建监控系统，请参考下面的部署文档进行操作。 -### 🐵 依赖服务部署(可选) - -> HertzBeat依赖于 **关系型数据库** H2(默认已内置无需安装) 或 [Mysql](mysql-change) 和 **时序性数据库** [TDengine2+](tdengine-init) 或 [IOTDB](iotdb-init) (可选) - -**注意⚠️ 若需要部署时序数据库，IotDB 和 TDengine 任选其一即可！** - -##### 安装Mysql(可选) - -1. docker安装Mysql - ` $ docker run -d --name mysql -p 3306:3306 -v /opt/data:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=123456 mysql:5.7` - `-v /opt/data:/var/lib/mysql` - 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录 -2. 创建名称为hertzbeat的数据库 - `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` -3. 在hertzbeat的配置文件`application.yml`配置Mysql数据库替换H2内置数据库连接参数 - -详细步骤参考 [使用Mysql替换内置H2数据库](mysql-change) - -##### 安装TDengine(可选) - -1. docker安装TDengine - `docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp --name tdengine tdengine/tdengine:3.0.4.0` -2. 创建名称为hertzbeat的数据库 -3. 在hertzbeat的配置文件`application.yml`配置tdengine连接 - -详细步骤参考 [使用时序数据库TDengine存储指标数据(可选)](tdengine-init) - -##### 安装IotDB(可选) - -1. Docker安装IoTDB - -```shell -$ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ - -v /opt/iotdb/data:/iotdb/data \ - --name iotdb \ - apache/iotdb:0.13.3-node -``` - -详细步骤参考 [使用时序数据库IoTDB存储指标数据(可选)](iotdb-init) ### 🍞 HertzBeat安装 > HertzBeat支持通过源码安装启动，Docker容器运行和安装包方式安装部署，CPU架构支持X86/ARM64。 @@ -77,14 +39,12 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN #### 方式二：通过安装包安装 -1. 下载您系统环境对应的安装包`hertzbeat-xx.zip` [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) -2. 需要提前已安装`java jdk11`环境 -3. 配置 HertzBeat 的配置文件 `hertzbeat/config/application.yml`(可选) -4. 部署启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` -5. 浏览器访问 `http://localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat` -6. 部署采集器集群 - - 下载采集器安装包`hertzbeat-collector-xx.zip`到规划的另一台部署主机上 [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) - - 需要提前已安装`java jdk11`环境 +1. 下载您系统环境对应的安装包`hertzbeat-xx.tar.gz` [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) +2. 配置 HertzBeat 的配置文件 `hertzbeat/config/application.yml`(可选) +3. 部署启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` +4. 浏览器访问 `http://localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat` +5. 部署采集器集群 + - 下载您系统环境对应采集器安装包`hertzbeat-collector-xx.tar.gz`到规划的另一台部署主机上 [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) - 配置采集器的配置文件 `hertzbeat-collector/config/application.yml` 里面的连接主HertzBeat服务的对外IP，端口，当前采集器名称(需保证唯一性)等参数 `identity` `mode` (public or private) `manager-host` `manager-port` ```yaml collector: @@ -124,3 +84,42 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 详细步骤参考 [Artifact Hub](https://artifacthub.io/packages/helm/hertzbeat/hertzbeat) **HAVE FUN** + +### 🐵 依赖服务部署(可选) + +> HertzBeat依赖于 **关系型数据库** H2(默认已内置无需安装) 或 [Mysql](mysql-change) 和 **时序性数据库** [TDengine2+](tdengine-init) 或 [IOTDB](iotdb-init) (可选) + +**注意⚠️ 若需要部署时序数据库，IotDB 和 TDengine 任选其一即可！** + +##### 安装Mysql(可选) + +1. docker安装Mysql + ` $ docker run -d --name mysql -p 3306:3306 -v /opt/data:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=123456 mysql:5.7` + `-v /opt/data:/var/lib/mysql` - 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录 +2. 创建名称为hertzbeat的数据库 + `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` +3. 在hertzbeat的配置文件`application.yml`配置Mysql数据库替换H2内置数据库连接参数 + +详细步骤参考 [使用Mysql替换内置H2数据库](mysql-change) + +##### 安装TDengine(可选) + +1. docker安装TDengine + `docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp --name tdengine tdengine/tdengine:3.0.4.0` +2. 创建名称为hertzbeat的数据库 +3. 在hertzbeat的配置文件`application.yml`配置tdengine连接 + +详细步骤参考 [使用时序数据库TDengine存储指标数据(可选)](tdengine-init) + +##### 安装IotDB(可选) + +1. Docker安装IoTDB + +```shell +$ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ + -v /opt/iotdb/data:/iotdb/data \ + --name iotdb \ + apache/iotdb:0.13.3-node +``` + +详细步骤参考 [使用时序数据库IoTDB存储指标数据(可选)](iotdb-init) diff --git a/script/assembly/collector/assembly-windows-64.xml b/script/assembly/collector/assembly-windows-64.xml index 8db2ae34ff5..6a1d6cbeda8 100644 --- a/script/assembly/collector/assembly-windows-64.xml +++ b/script/assembly/collector/assembly-windows-64.xml @@ -6,7 +6,7 @@ http://maven.apache.org/ASSEMBLY/2.0.0 "> windows64_1.4.2 - tar.gz + zip diff --git a/web-app/src/assets/i18n/en-US.json b/web-app/src/assets/i18n/en-US.json index 58b11655f13..fb6c37dcca5 100644 --- a/web-app/src/assets/i18n/en-US.json +++ b/web-app/src/assets/i18n/en-US.json @@ -559,7 +559,7 @@ "collector.deploy.package": "Deploy via Package", "collector.deploy.package.github": "Download From Github", "collector.deploy.package.gitee": "Download From Gitee", - "collector.deploy.package.help": "# Installation package deployment requires you to install the JAVA11 environment in advance https://www.openlogic.com/openjdk-downloads", + "collector.deploy.package.help": "# Download the system corresponding release package hertzbeat-collector-xx.tar.gz", "collector.deploy.package.help.1": "# Unzip and configure the file hertzbeat-collector/config/application.yml", "collector.deploy.package.help.2": "# Replace the IDENTITY MANAGER_HOST MODE parameters in the file as follows.", "collector.deploy.package.help.3": "# Run bin/startup.sh or startup.bat(windows) to start the collector.", diff --git a/web-app/src/assets/i18n/zh-CN.json b/web-app/src/assets/i18n/zh-CN.json index fc8f9a83d5c..bde535e434c 100644 --- a/web-app/src/assets/i18n/zh-CN.json +++ b/web-app/src/assets/i18n/zh-CN.json @@ -558,7 +558,7 @@ "collector.deploy.package": "通过 安装包 方式部署", "collector.deploy.package.github": "下载安装包-Github", "collector.deploy.package.gitee": "下载安装包-Gitee", - "collector.deploy.package.help": "# 安装包部署需要您提前安装 JAVA11 环境 https://www.openlogic.com/openjdk-downloads", + "collector.deploy.package.help": "# 下载系统环境对应安装包 hertzbeat-collector-xx.tar.gz", "collector.deploy.package.help.1": "# 解压并配置文件 hertzbeat-collector/config/application.yml", "collector.deploy.package.help.2": "# 替换文件中的 IDENTITY MANAGER_HOST MODE 参数, 如下。", "collector.deploy.package.help.3": "# 启动脚本 bin/startup.sh 或者 startup.bat(windows) 来启动采集器进程。", diff --git a/web-app/src/assets/i18n/zh-TW.json b/web-app/src/assets/i18n/zh-TW.json index e993aa1883e..f4b04aa53d9 100644 --- a/web-app/src/assets/i18n/zh-TW.json +++ b/web-app/src/assets/i18n/zh-TW.json @@ -557,7 +557,7 @@ "collector.deploy.package": "通過 安裝包 方式部署", "collector.deploy.package.github": "下載安裝包-Github", "collector.deploy.package.gitee": "下載安裝包-Gitee", - "collector.deploy.package.help": "# 安裝包部署需要您提前安裝 JAVA11 環境 https://www.openlogic.com/openjdk-downloads", + "collector.deploy.package.help": "# 下載系統環境對應安裝包 hertzbeat-collector-xx.tar.gz", "collector.deploy.package.help.1": "# 解壓並配置文件 hertzbeat-collector/config/application.yml", "collector.deploy.package.help.2": "# 替換文件中的 IDENTITY MANAGER_HOST MODE 參數, 如下。", "collector.deploy.package.help.3": "# 啟動腳本 bin/startup.sh 或者 startup.bat(windows) 來啟動採集器進程。",