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.

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

[improve] update docker compose and k8s helm deploy script #2076

Merged
merged 8 commits into from
Jun 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,13 +160,13 @@ Detailed config refer to [Install HertzBeat via Package](https://hertzbeat.apach

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

##### 4:Install All(hertzbeat+mysql+tsdb) via Docker-compose
##### 4:Install All(hertzbeat+postgresql+tsdb) via Docker-compose

Install the mysql/postgresql database, iotdb/tdengine/victoria-metrics database and hertzbeat at one time through [docker-compose deployment script](script/docker-compose).
Install the postgresql/mysql database, victoria-metrics/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)

##### 5. Install All(hertzbeat+collector+mysql+tsdb) via kubernetes helm charts
##### 5. Install All(hertzbeat+collector+postgresql+tsdb) via kubernetes helm charts

Install HertzBeat cluster in a Kubernetes cluster by Helm chart.

Expand Down
6 changes: 3 additions & 3 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,13 +159,13 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN

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

##### 方式四:Docker-Compose 统一安装 hertzbeat+mysql+tsdb
##### 方式四:Docker-Compose 统一安装 hertzbeat+postgresql+tsdb

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

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

##### 方式五:Kubernetes Helm Charts 部署 hertzbeat+collector+mysql+tsdb
##### 方式五:Kubernetes Helm Charts 部署 hertzbeat+collector+postgresql+tsdb

通过 Helm Chart 一次性将 HertzBeat 集群组件部署到 Kubernetes 集群中。

Expand Down
18 changes: 12 additions & 6 deletions home/docs/community/how-to-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -578,20 +578,25 @@ The rename the release-1.6.0-rc1 branch to release-1.6.0.

> `Send to`: general@incubator.apache.org <br />
> `cc`: dev@hertzbeat.apache.org <br />
> `Title`: [ANNOUNCE] Release Apache HertzBeat (incubating) 1.6.0 <br />
> `Title`: [ANNOUNCE] Apache HertzBeat (incubating) 1.6.0 released <br />
> `Body`:

```
Hi Incubator Community,
Hi Community,

We are glad to announce the release of Apache HertzBeat (incubating) 1.6.0.
Once again I would like to express my thanks to your help.
Thanks again for your help.

Apache HertzBeat (https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities.

Apache HertzBeat(https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities.
Download Link:
https://hertzbeat.apache.org/docs/download/

Download Links: https://hertzbeat.apache.org/download/
Release Note:
https://github.com/apache/hertzbeat/releases/tag/v1.6.0

Release Notes: https://github.com/apache/hertzbeat/releases/tag/v1.6.0
Website:
https://hertzbeat.apache.org/

HertzBeat Resources:
- Issue: https://github.com/apache/hertzbeat/issues
Expand All @@ -600,6 +605,7 @@ HertzBeat Resources:

Apache HertzBeat Team


Best,
ChunJin Mu
```
Expand Down
2 changes: 1 addition & 1 deletion home/docs/start/greptime-init.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: greptime-init
title: Use Time Series Database GreptimeDB to Store Metrics Data (Optional)
sidebar_label: Use GreptimeDB Store Metrics
sidebar_label: Metrics Store GreptimeDB
---

Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)
Expand Down
2 changes: 1 addition & 1 deletion home/docs/start/influxdb-init.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: influxdb-init
title: Use Time Series Database InfluxDB to Store Metrics Data (Optional)
sidebar_label: Use InfluxDB Store Metrics
sidebar_label: Metrics Store InfluxDB
---

Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)
Expand Down
2 changes: 1 addition & 1 deletion home/docs/start/iotdb-init.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: iotdb-init
title: Use Time Series Database IoTDB to Store Metrics Data (Optional)
sidebar_label: Use IoTDB Store Metrics
sidebar_label: Metrics Store IoTDB
---
Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)

Expand Down
58 changes: 37 additions & 21 deletions home/docs/start/mysql-change.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: mysql-change
title: Use MYSQL Replace H2 Database to Store Metadata(Optional)
sidebar_label: Use MYSQL Instead of H2
sidebar_label: Meta Store MYSQL
---
MYSQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat (incubating) allow you to use MYSQL to store structured relational data such as monitoring information, alarm information and configuration information.

Expand Down Expand Up @@ -49,29 +49,45 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data
Replace `spring.database` data source parameters, URL account and password.

For example:
```yaml
spring:
datasource:
driver-class-name: org.h2.Driver
username: sa
password: 123456
url: jdbc:h2:./data/hertzbeat;MODE=MYSQL
jpa:
database: h2
```
```yaml
spring:
datasource:
driver-class-name: org.h2.Driver
username: sa
password: 123456
url: jdbc:h2:./data/hertzbeat;MODE=MYSQL
hikari:
max-lifetime: 120000

jpa:
show-sql: false
database-platform: org.eclipse.persistence.platform.database.MySQLPlatform
database: h2
properties:
eclipselink:
logging:
level: SEVERE
```
Specific replacement parameters are as follows and you need to configure account according to the mysql environment:
```yaml
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: 123456
url: jdbc:mysql://localhost:3306/hertzbeat?useUnicode=true&characterEncoding=utf-8&useSSL=false
platform: mysql
```yaml
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: 123456
url: jdbc:mysql://mysql:3306/hertzbeat?useUnicode=true&characterEncoding=utf-8&allowPublicKeyRetrieval=true&useSSL=false
hikari:
max-lifetime: 120000
jpa:
show-sql: false
database-platform: org.eclipse.persistence.platform.database.MySQLPlatform
database: mysql
```
properties:
eclipselink:
logging:
level: SEVERE
```

- It is recommended to set the host field in the MySQL URL or Redis URL to the public IP address when using Hertzbeat in docker.
- It is recommended to set the host field in the MySQL URL to the public IP address when using Hertzbeat in docker.

**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat**
48 changes: 28 additions & 20 deletions home/docs/start/postgresql-change.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: postgresql-change
title: Use PostgreSQL Replace H2 Database to Store Metadata(Optional)
sidebar_label: Use PostgreSQL Instead of H2
title: Use PostgreSQL Replace H2 Database to Store Metadata(Recommended)
sidebar_label: Meta Store PostgreSQL (Recommended)
---
PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat (incubating) allow you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information.

Expand Down Expand Up @@ -46,28 +46,36 @@ spring:
username: sa
password: 123456
url: jdbc:h2:./data/hertzbeat;MODE=MYSQL
hikari:
max-lifetime: 120000

jpa:
show-sql: false
database-platform: org.eclipse.persistence.platform.database.MySQLPlatform
database: h2
properties:
eclipselink:
logging:
level: SEVERE
```
Specific replacement parameters are as follows and you need to configure account, ip, port according to the postgresql environment:
```yaml
spring:
config:
activate:
on-profile: prod
datasource:
driver-class-name: org.postgresql.Driver
username: root
password: 123456
url: jdbc:postgresql://127.0.0.1:5432/hertzbeat
hikari:
max-lifetime: 120000

jpa:
database: postgresql
hibernate:
ddl-auto: update
properties:
hibernate:
dialect: org.hibernate.dialect.PostgreSQLDialect
datasource:
driver-class-name: org.postgresql.Driver
username: root
password: 123456
url: jdbc:postgresql://postgresql:5432/hertzbeat
hikari:
max-lifetime: 120000
jpa:
show-sql: false
database-platform: org.eclipse.persistence.platform.database.PostgreSQLPlatform
database: postgresql
properties:
eclipselink:
logging:
level: SEVERE
```

**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat**
6 changes: 3 additions & 3 deletions home/docs/start/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,13 @@ Detailed config refer to [Install HertzBeat via Package](package-deploy)

Detailed steps refer to [CONTRIBUTING](../community/contribution)

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

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

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

##### 5. Install All(hertzbeat+collector+mysql+iotdb) via kubernetes helm charts
##### 5. Install All(hertzbeat+collector+postgresql+tsdb) via kubernetes helm charts

Install HertzBeat cluster in a Kubernetes cluster by Helm chart.

Expand Down
2 changes: 1 addition & 1 deletion home/docs/start/tdengine-init.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: tdengine-init
title: Use Time Series Database TDengine to Store Metrics Data (Optional)
sidebar_label: Use TDengine Store Metrics
sidebar_label: Metrics Store TDengine
---

Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)
Expand Down
2 changes: 1 addition & 1 deletion home/docs/start/victoria-metrics-init.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: victoria-metrics-init
title: Use Time Series Database VictoriaMetrics to Store Metrics Data (Recommended)
sidebar_label: Use VictoriaMetrics Store Metrics(Recommended)
sidebar_label: Metrics Store VictoriaMetrics (Recommended)
---

Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -580,19 +580,25 @@ release note: xxx

> `Send to`: general@incubator.apache.org <br />
> `cc`: dev@hertzbeat.apache.org <br />
> `Title`: [ANNOUNCE] Release Apache HertzBeat (incubating) 1.6.0 <br />
> `Title`: [ANNOUNCE] Apache HertzBeat (incubating) 1.6.0 released <br />
> `Body`:

```
Hi Incubator Community,
Hi Community,

We are glad to announce the release of Apache HertzBeat (incubating) 1.6.0.
Once again I would like to express my thanks to your help.
Thanks again for your help.

Apache HertzBeat (https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities.

Download Link:
https://hertzbeat.apache.org/docs/download/

Apache HertzBeat(https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities.
Release Note:
https://github.com/apache/hertzbeat/releases/tag/v1.6.0

Download Links: https://hertzbeat.apache.org/download/
Release Notes: https://github.com/apache/hertzbeat/releases/tag/v1.6.0
Website:
https://hertzbeat.apache.org/

HertzBeat Resources:
- Issue: https://github.com/apache/hertzbeat/issues
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: greptime-init
title: 依赖时序数据库服务GreptimeDB安装初始化
sidebar_label: 使用GreptimeDB存储指标数据(可选)
title: 依赖时序数据库服务GreptimeDB安装初始化(可选)
sidebar_label: 指标数据存储GreptimeDB
---

Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: influxdb-init
title: 依赖时序数据库服务InfluxDB安装初始化
sidebar_label: 使用InfluxDB存储指标数据(可选)
title: 依赖时序数据库服务InfluxDB安装初始化(可选)
sidebar_label: 指标数据存储InfluxDB
---

Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: iotdb-init
title: 依赖时序数据库服务IoTDB安装初始化
sidebar_label: 使用IoTDB存储指标数据(可选)
title: 依赖时序数据库服务IoTDB安装初始化(可选)
sidebar_label: 指标数据存储IoTDB
---
Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置)

Expand Down
Loading
Loading