[improve] prepare for release hertzbeat v1.6.0 (#1929)

This commit is contained in:
tomsun28 2024-05-09 15:22:53 +08:00 committed by GitHub
parent 81da126bfc
commit 915c92e6f8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
28 changed files with 463 additions and 183 deletions

3
.gitattributes vendored
View File

@ -16,5 +16,8 @@
#
/home export-ignore
/hip export-ignore
/.github export-ignore
/.idea export-ignore
.gitattributes export-ignore
.gitignore export-ignore

View File

@ -206,6 +206,7 @@ MIT License
The following components are provided under the MIT License
These files from https://github.com/ng-alain/ng-alain
The text of the license is included in material/licenses/frontend/LICENSE-ng-alain.txt
web-app/src/app/core/**
web-app/src/app/layout/**

View File

@ -207,7 +207,7 @@
<activeByDefault>true</activeByDefault>
</activation>
<build>
<finalName>hertzbeat-collector</finalName>
<finalName>apache-hertzbeat-collector</finalName>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@ -229,7 +229,7 @@
<profile>
<id>cluster</id>
<build>
<finalName>hertzbeat-collector</finalName>
<finalName>apache-hertzbeat-collector</finalName>
<resources>
<resource>
<directory>src/main/resources</directory>
@ -248,8 +248,83 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>11</source>
<target>11</target>
<source>17</source>
<target>17</target>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>${maven-jar-plugin.version}</version>
<configuration>
<classesDirectory>target/classes/</classesDirectory>
<archive>
<!--Generated JAR does not include Maven descriptor-related files-->
<addMavenDescriptor>false</addMavenDescriptor>
<manifest>
<!--Project startup class-->
<mainClass>org.apache.hertzbeat.collector.Collector</mainClass>
<useUniqueVersions>false</useUniqueVersions>
<!--Third-party JARs are added to the classpath using maven-dependency-plugin-->
<addClasspath>true</addClasspath>
<!--Location of external dependency JARs-->
<classpathPrefix>lib/</classpathPrefix>
</manifest>
<manifestEntries>
<Class-Path>. config</Class-Path>
</manifestEntries>
</archive>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>${maven-assembly-plugin.version}</version>
<executions>
<execution>
<id>without-jdk</id>
<!--Bound Maven operation-->
<phase>package</phase>
<!--Run once-->
<goals>
<goal>single</goal>
</goals>
<configuration>
<descriptors>
<descriptor>../script/assembly/collector/assembly.xml</descriptor>
</descriptors>
<outputDirectory>../dist</outputDirectory>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
<profile>
<id>runtime</id>
<build>
<finalName>apache-hertzbeat-collector</finalName>
<resources>
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
<includes>
<include>*.yml</include>
<include>*.properties</include>
<include>*.xml</include>
<include>banner.txt</include>
<include>META-INF/**</include>
</includes>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>17</source>
<target>17</target>
</configuration>
</plugin>
<plugin>

201
home/LICENSE Normal file
View File

@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

View File

@ -1,7 +1,6 @@
# HertzBeat Website
This website is built using [Docusaurus 2](https://docusaurus.io/).
Learn From [webdriverio](https://webdriver.io/)
This website is built with [Docusaurus](https://docusaurus.io/).
## Installation
@ -49,3 +48,34 @@ If you are using GitHub pages for hosting, this command is a convenient way to b
```console
GITHUB_HOST=gitee.com USE_SSH=true yarn deploy
```
## Directory Structure
```html
|-- docs
|-- blog
|-- i18n
| `-- zh-CN // internationalized chinese
| |-- code.json
| |-- docusaurus-plugin-content-blog
| |-- docusaurus-plugin-content-docs
| `-- docusaurus-theme-classic
|-- resource // static resource file
|-- src
| |-- theme
| |-- css
| |-- js
| |-- pages
| | |-- components
| | |-- index.js
| |-- constants.js
|-- static // picture static resource
| |-- img //
| | |-- blog // blog picture
| | |-- docs // document picture
| | |-- home // product picture
| | |-- icons // icon
|-- docusaurus.config.js
|-- sidebars.js // document sidebar menu configuration
```

View File

@ -60,7 +60,7 @@ sidebar_label: Development
2. Execute under the project root directory: `mvn clean package`
The HertzBeat install package will at `manager/target/hertzbeat-{version}.tar.gz`
The HertzBeat install package will at `dist/hertzbeat-{version}.tar.gz`
### Collector build
@ -72,4 +72,4 @@ The HertzBeat install package will at `manager/target/hertzbeat-{version}.tar.gz
4. Execute under `collector` directory: `mvn clean package -Pcluster`
The HertzBeat collector package will at `collector/target/hertzbeat-collector-{version}.tar.gz`
The HertzBeat collector package will at `dist/hertzbeat-collector-{version}.tar.gz`

View File

@ -94,8 +94,4 @@ css and other style files are placed in the `src/css` directory
> All pages doc can be directly jumped to the corresponding github resource modification page through the 'Edit this page' button at the bottom
### Page style modification
Visit the page https://hertzbeat.apache.org/
位于 `src/pages/components`

View File

@ -194,7 +194,7 @@ yarn package
> run script in root
```shell
mvn clean package
mvn clean install
```
> Build HertzBeat collector binary, run script in `collector`
@ -203,7 +203,11 @@ mvn clean package
mvn clean package -Pcluster
```
The release package are here `manager/target/hertzbeat-{version}.tar.gz`,`collector/target/hertzbeat-collector-{version}.tar.gz`,`collector/target/hertzbeat-collector-{version}-bin.tar.gz`。
The release package are here:
- `dist/apache-hertzbeat-{version}-incubating-bin.tar.gz`
- `dist/apache-hertzbeat-{version}-incubating-docker-compose.tar.gz`
- `dist/apache-hertzbeat-collector-{version}-incubating-bin.tar.gz`
#### 3.4 Package the source code
@ -212,23 +216,27 @@ The release package are here `manager/target/hertzbeat-{version}.tar.gz`,`coll
```shell
git archive \
--format=tar.gz \
--output="target/apache-hertzbeat-1.6.0-incubating-src.tar.gz" \
--output="dist/apache-hertzbeat-1.6.0-incubating-src.tar.gz" \
--prefix=apache-hertzbeat-1.6.0-incubating-src/ \
release-1.6.0-rc1
```
The archive package is here `target/apache-hertzbeat-1.6.0-incubating-src.tar.gz`
The archive package is here `dist/apache-hertzbeat-1.6.0-incubating-src.tar.gz`
#### 3.5 Sign binary and source packages
> The `gpg -u 33545C76` `33545C76` is your gpg secret ID, see from `gpg --keyid-format SHORT --list-keys`
```shell
cd dist
# sign
for i in *.tar.gz; do echo $i; gpg --armor --output $i.asc --detach-sig $i ; done
for i in *.tar.gz; do echo $i; gpg -u 33545C76 --armor --output $i.asc --detach-sig $i ; done
# SHA512
for i in *.tar.gz; do echo $i; sha512sum $i > $i.sha512 ; done
# if macos sha512sum not found, you can install by brew install coreutils
```
> The final file list is as follows
@ -237,12 +245,15 @@ for i in *.tar.gz; do echo $i; sha512sum $i > $i.sha512 ; done
apache-hertzbeat-1.6.0-incubating-src.tar.gz
apache-hertzbeat-1.6.0-incubating-src.tar.gz.asc
apache-hertzbeat-1.6.0-incubating-src.tar.gz.sha512
apache-hertzbeat_2.11-1.6.0-incubating-bin.tar.gz
apache-hertzbeat_2.11-1.6.0-incubating-bin.tar.gz.asc
apache-hertzbeat_2.11-1.6.0-incubating-bin.tar.gz.sha512
apache-hertzbeat_2.12-1.6.0-incubating-bin.tar.gz
apache-hertzbeat_2.12-1.6.0-incubating-bin.tar.gz.asc
apache-hertzbeat_2.12-1.6.0-incubating-bin.tar.gz.sha512
apache-hertzbeat-1.6.0-incubating-bin.tar.gz
apache-hertzbeat-1.6.0-incubating-bin.tar.gz.asc
apache-hertzbeat-1.6.0-incubating-bin.tar.gz.sha512
apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz
apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz.asc
apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz.sha512
apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz
apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.asc
apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.sha512
```
#### 3.6 Verify signature
@ -271,10 +282,12 @@ $ for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done
apache-hertzbeat-1.6.0-incubating-src.tar.gz
apache-hertzbeat-1.6.0-incubating-src.tar.gz: OK
apache-hertzbeat_2.11-1.6.0-incubating-bin.tar.gz
apache-hertzbeat_2.11-1.6.0-incubating-bin.tar.gz: OK
apache-hertzbeat_2.12-1.6.0-incubating-bin.tar.gz
apache-hertzbeat_2.12-1.6.0-incubating-bin.tar.gz: OK
apache-hertzbeat-1.6.0-incubating-bin.tar.gz
apache-hertzbeat-1.6.0-incubating-bin.tar.gz: OK
apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz
apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz: OK
apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz
apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz: OK
```
#### 3.7 Publish the dev directory of the Apache SVN material package
@ -592,5 +605,6 @@ ChunJin Mu
This version release is over.
---
This doc refer from [Apache StreamPark](https://streampark.apache.org/)

View File

@ -103,14 +103,10 @@ $ for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done
### 2.4 Check the binary package
unzip `apache-hertzbeat_${scala.version}-${release.version}-incubating-bin.tar.gz`
unzip `apache-hertzbeat-${release.version}-incubating-bin.tar.gz`
```shell
# scala 2.11
tar -xzvf apache-hertzbeat_2.11-${release.version}-incubating-bin.tar.gz
# scala 2.12
tar -xzvf apache-hertzbeat_2.12-${release.version}-incubating-bin.tar.gz
tar -xzvf apache-hertzbeat-${release.version}-incubating-bin.tar.gz
```
check as follows:
@ -136,30 +132,12 @@ Unzip `apache-hertzbeat-${release_version}-incubating-src.tar.gz`
```shell
cd apache-hertzbeat-${release_version}-incubating-src
# execute build.sh
./build.sh
```
***package mode, just select mixed mode ***
>[HertzBeat] HertzBeat supports front-end and server-side mixed / detached packaging mode, Which mode do you need ?
>
>1. mixed mode
>
>2. detached mode
>
> select 1
>[HertzBeat] HertzBeat supports Scala 2.11 and 2.12. Which version do you need ?
>
>1. 2.11
>2. 2.12
>
It takes about 8 minutes to compile once. After the compilation is completed, the ***dist*** directory will be generated under the project root path, and the final compiled project binary will be placed here, and the following checks will be made:
compile the source code: [Build HertzBeat Binary Package](https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package)
and check as follows:
- [ ] There are `LICENSE` and `NOTICE` files
- [ ] There is a `DISCLAIMER` or `DISCLAIMER-WIP` file
- [ ] The year in the `NOTICE` file is correct
@ -185,7 +163,6 @@ When IPMC votes in the general@incubator.apache.org incubator community. Please
</font>
:::caution
If you have already voted on dev@hertzbeat.apache.org, you can take it directly to the incubator community when you reply to the vote, such as:
```html
@ -193,7 +170,6 @@ If you have already voted on dev@hertzbeat.apache.org, you can take it directly
Forward my +1 from dev@listhertzbeatnkis (non-binding)
Copy my +1 from hertzbeat DEV ML (non-binding)
````
:::
@ -223,12 +199,7 @@ I checked:
````
## 4. Precautions
<font color="red">
If you have maven tools installed, you can replace ./mvnw or mvnw.cmd with your own mvn command
mvnw is short for Maven Wrapper. It can support running Maven projects without installing Maven and configuring environment variables. If it can't find it, it will download the corresponding Maven version according to the configuration file
</font>
---
This doc refer from [Apache StreamPark](https://streampark.apache.org/)

View File

@ -29,5 +29,4 @@ These have not followed the usual ASF release process.
| Version | Date | Source | Binary | Release Notes |
|---------|------------|----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|
| v1.5.0 | 2024.03.08 | [source](https://github.com/apache/hertzbeat/archive/refs/tags/v1.5.0.zip) | [hertzbeat-1.5.0.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.5.0/hertzbeat-1.5.0.tar.gz) <br/> [hertzbeat-collector-1.5.0.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.5.0/hertzbeat-collector-1.5.0.tar.gz) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.5.0) |
| v1.4.4 | 2024.01.11 | [source](https://github.com/apache/hertzbeat/archive/refs/tags/v1.4.4.zip) | [hertzbeat-1.4.4.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.4.4/hertzbeat-1.4.4.tar.gz) <br/> [hertzbeat-collector-1.4.4.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-1.4.4.tar.gz) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.4.4) |
| v1.5.0 | 2024.03.08 | [source](https://github.com/apache/hertzbeat/archive/refs/tags/v1.5.0.zip) | [hertzbeat-1.5.0.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.5.0/hertzbeat-1.5.0.tar.gz) <br/> [hertzbeat-collector-1.5.0.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.5.0/hertzbeat-collector-1.5.0.tar.gz) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.5.0) |

View File

@ -59,7 +59,7 @@ sidebar_label: 运行编译
2. Execute under the project root directory: `mvn clean package`
The HertzBeat install package will at `manager/target/hertzbeat-{version}.tar.gz`
The HertzBeat install package will at `dist/hertzbeat-{version}.tar.gz`
### Collector build
@ -71,4 +71,4 @@ The HertzBeat install package will at `manager/target/hertzbeat-{version}.tar.gz
4. Execute under `collector` directory: `mvn clean package -Pcluster`
The HertzBeat collector package will at `collector/target/hertzbeat-collector-{version}.tar.gz`
The HertzBeat collector package will at `dist/hertzbeat-collector-{version}.tar.gz`

View File

@ -93,8 +93,3 @@ css 和其他样式文件放在 `src/css` 目录中。
### 页面内容修改
> 所有页面文档都可以通过底部的'编辑此页面'按钮直接跳转到相应的 github 资源修改页面。
### 页面样式修改
访问页面 https://hertzbeat.apache.org/
位于 `src/pages/components`

View File

@ -194,7 +194,7 @@ yarn package
> 在项目根目录下执行以下命令
```shell
mvn clean package
mvn clean install
```
> HertzBeat-Collector 编译打包,在项目`collector`目录下执行以下命令
@ -203,7 +203,11 @@ mvn clean package
mvn clean package -Pcluster
```
生成的二进制包在 `manager/target/hertzbeat-{version}.tar.gz`,`collector/target/hertzbeat-collector-{version}.tar.gz`,`collector/target/hertzbeat-collector-{version}-bin.tar.gz`。
生成的二进制包在:
- `dist/apache-hertzbeat-{version}-incubating-bin.tar.gz`
- `dist/apache-hertzbeat-{version}-incubating-docker-compose.tar.gz`
- `dist/apache-hertzbeat-collector-{version}-incubating-bin.tar.gz`
#### 3.4 打包项目源代码
@ -212,24 +216,29 @@ mvn clean package -Pcluster
```shell
git archive \
--format=tar.gz \
--output="target/apache-hertzbeat-1.6.0-incubating-src.tar.gz" \
--output="dist/apache-hertzbeat-1.6.0-incubating-src.tar.gz" \
--prefix=apache-hertzbeat-1.6.0-incubating-src/ \
release-1.6.0-rc1
```
生成的代码归档文件在 `target/apache-hertzbeat-1.6.0-incubating-src.tar.gz`
生成的代码归档文件在 `dist/apache-hertzbeat-1.6.0-incubating-src.tar.gz`
#### 3.5 对二进制和源码包进行签名
将上步骤生成的三个文件包放到`dist`目录下(若无则新建目录),然后对文件包进行签名和SHA512校验和生成。
将上步骤生成的三个文件包放到`dist`目录下(若无则新建目录),然后对文件包进行签名和SHA512校验和生成。
> 其中 `gpg -u 33545C76``33545C76` 是你的 GPG 密钥 ID,可以通过 `gpg --keyid-format SHORT --list-keys` 查看。
```shell
cd dist
# sign
for i in *.tar.gz; do echo $i; gpg --armor --output $i.asc --detach-sig $i ; done
for i in *.tar.gz; do echo $i; gpg -u 33545C76 --armor --output $i.asc --detach-sig $i ; done
# SHA512
for i in *.tar.gz; do echo $i; sha512sum $i > $i.sha512 ; done
# if macos sha512sum not found, you can install by brew install coreutils
```
> 最终文件列表如下
@ -238,12 +247,15 @@ for i in *.tar.gz; do echo $i; sha512sum $i > $i.sha512 ; done
apache-hertzbeat-1.6.0-incubating-src.tar.gz
apache-hertzbeat-1.6.0-incubating-src.tar.gz.asc
apache-hertzbeat-1.6.0-incubating-src.tar.gz.sha512
apache-hertzbeat_2.11-1.6.0-incubating-bin.tar.gz
apache-hertzbeat_2.11-1.6.0-incubating-bin.tar.gz.asc
apache-hertzbeat_2.11-1.6.0-incubating-bin.tar.gz.sha512
apache-hertzbeat_2.12-1.6.0-incubating-bin.tar.gz
apache-hertzbeat_2.12-1.6.0-incubating-bin.tar.gz.asc
apache-hertzbeat_2.12-1.6.0-incubating-bin.tar.gz.sha512
apache-hertzbeat-1.6.0-incubating-bin.tar.gz
apache-hertzbeat-1.6.0-incubating-bin.tar.gz.asc
apache-hertzbeat-1.6.0-incubating-bin.tar.gz.sha512
apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz
apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz.asc
apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz.sha512
apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz
apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.asc
apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.sha512
```
#### 3.6 验证签名
@ -257,25 +269,27 @@ $ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i ; done
apache-hertzbeat-1.6.0-incubating-src.tar.gz
gpg: Signature made Tue May 2 12:16:35 2023 CST
gpg: using RSA key 85778A4CE4DD04B7E07813ABACFB69E705016886
gpg: Good signature from "muchunjin (for apache HertzBeat release create at 20230501) <muchunjin@apache.org>" [ultimate]
apache-hertzbeat_2.11-1.6.0-incubating-bin.tar.gz
gpg: Good signature from "muchunjin (apache key) <muchunjin@apache.org>" [ultimate]
apache-hertzbeat-1.6.0-incubating-bin.tar.gz
gpg: Signature made Tue May 2 12:16:36 2023 CST
gpg: using RSA key 85778A4CE4DD04B7E07813ABACFB69E705016886
gpg: Good signature from "muchunjin (for apache HertzBeat release create at 20230501) <muchunjin@apache.org>" [ultimate]
apache-hertzbeat_2.12-1.6.0-incubating-bin.tar.gz
gpg: Good signature from "muchunjin (apache key) <muchunjin@apache.org>" [ultimate]
apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz
gpg: Signature made Tue May 2 12:16:37 2023 CST
gpg: using RSA key 85778A4CE4DD04B7E07813ABACFB69E705016886
gpg: BAD signature from "muchunjin (for apache HertzBeat release create at 20230501) <muchunjin@apache.org>" [ultimate]
gpg: BAD signature from "muchunjin (apache key) <muchunjin@apache.org>" [ultimate]
# 验证 SHA512
$ for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done
apache-hertzbeat-1.6.0-incubating-src.tar.gz
apache-hertzbeat-1.6.0-incubating-src.tar.gz: OK
apache-hertzbeat_2.11-1.6.0-incubating-bin.tar.gz
apache-hertzbeat_2.11-1.6.0-incubating-bin.tar.gz: OK
apache-hertzbeat_2.12-1.6.0-incubating-bin.tar.gz
apache-hertzbeat_2.12-1.6.0-incubating-bin.tar.gz: OK
apache-hertzbeat-1.6.0-incubating-bin.tar.gz
apache-hertzbeat-1.6.0-incubating-bin.tar.gz: OK
apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz
apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz: OK
apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz
apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz: OK
```
#### 3.7 发布 Apache SVN 仓库中 dev 目录的物料包

View File

@ -10,7 +10,7 @@ sidebar_position: 4
## 1. 下载候选版本到本地
>需要依赖gpg工具,如果没有,建议安装gpg2
> 需要依赖gpg工具,如果没有,建议安装gpg2
```shell
#如果本地有svn,可以clone到本地
@ -26,7 +26,6 @@ wget https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_versio
> 开始验证环节,验证包含但不局限于以下内容和形式
### 2.1 查看发布包是否完整
> 上传到dist的包必须包含源码包,二进制包可选
@ -37,7 +36,6 @@ wget https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_versio
4. 如果上传了二进制包,则同样检查(2)-(4)所列的内容
### 2.2 检查gpg签名
首先导入发布人公钥。从svn仓库导入KEYS到本地环境。(发布版本的人不需要再导入,帮助做验证的人需要导入,用户名填发版人的即可)
@ -103,14 +101,10 @@ for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done
### 2.4 检查二进制包
解压缩 `apache-hertzbeat_${scala.version}-${release.version}-incubating-bin.tar.gz`
解压缩 `apache-hertzbeat-${release.version}-incubating-bin.tar.gz`
```shell
# scala 2.11 二进制发行包
tar -xzvf apache-hertzbeat_2.11-${release.version}-incubating-bin.tar.gz
# scala 2.12 二进制发行包
tar -xzvf apache-hertzbeat_2.12-${release.version}-incubating-bin.tar.gz
tar -xzvf apache-hertzbeat-${release.version}-incubating-bin.tar.gz
```
进行如下检查:
@ -126,7 +120,8 @@ tar -xzvf apache-hertzbeat_2.12-${release.version}-incubating-bin.tar.gz
- [ ] 如果依赖的是Apache许可证并且存在`NOTICE`文件,那么这些`NOTICE`文件也需要加入到版本的`NOTICE`文件中
- [ ] .....
详细的检查项,可以参考此文章:[ASF第三方许可证策](
参考: https://apache.org/legal/resolved.html
### 2.5. 源码编译验证
@ -134,33 +129,12 @@ tar -xzvf apache-hertzbeat_2.12-${release.version}-incubating-bin.tar.gz
```shell
cd apache-hertzbeat-${release_version}-incubating-src
# 执行编译脚本, 选择
./build.sh
```
编译源码: https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package
进行如下检查:
***选择编译模式, 这里只能选择1***
>[HertzBeat] HertzBeat supports front-end and server-side mixed / detached packaging mode, Which mode do you need ?
>
>1. mixed mode
>
>2. detached mode
>
> 选 1
***选择 scala 版本, 第一次编译 scala 2.11版本选择 1, 第二次编译 scala 2.12版本选择 2***
>[HertzBeat] HertzBeat supports Scala 2.11 and 2.12. Which version do you need ?
>
>1. 2.11
>2. 2.12
>
一次编译大概8分钟左右,编译完成之后会在项目根路径下生成 ***dist*** 目录,会将最终的编译的项目二进制放在这里, 做如下检查:
- [ ] 检查源码包是否包含由于包含不必要文件,致使tar包过于庞大
- [ ] 文件夹包含单词`incubating`
- [ ] 存在`LICENSE`和`NOTICE`文件
@ -172,22 +146,20 @@ cd apache-hertzbeat-${release_version}-incubating-src
- [ ] 检查是否有多余文件或文件夹,例如空文件夹等
- [ ] .....
https://apache.org/legal/resolved.html)
参考: https://apache.org/legal/resolved.html
## 3. 邮件回复
如果发起了发布投票,验证后,可以参照此回复示例进行邮件回复
<font color="red">
:::caution 注意
回复的邮件一定要带上自己检查了那些项信息,仅仅回复`+1 approve`,是无效的。
PPMC在dev@hertzbeat.apache.org HertzBeat 的社区投票时,请带上 binding后缀,表示对 HertzBeat 社区中的投票具有约束性投票,方便统计投票结果。
PPMC dev@hertzbeat.apache.org HertzBeat 的社区投票时,请带上 binding 后缀,表示对 HertzBeat 社区中的投票具有约束性投票,方便统计投票结果。
IPMC在general@incubator.apache.org incubator社区投票,请带上 binding后缀,表示对incubator社区中的投票具有约束性投票,方便统计投票结果。
</font>
IPMC 在 general@incubator.apache.org incubator 社区投票,请带上 binding 后缀,表示对 incubator 社区中的投票具有约束性投票,方便统计投票结果。
:::
:::caution 注意
如果在dev@hertzbeat.apache.org已经投过票,在incubator社区进行投票回复时,可以直接带过去,<font color="red">需要注意约束性</font> 如:
@ -225,10 +197,6 @@ I checked:
```
## 4. 注意事项
<font color="red">
如果你有安装maven工具,你可以使用自己的mvn命令替换 ./mvnw或者mvnw.cmd
mvnw是Maven Wrapper的缩写。它可以支持运行 Maven 项目,而无需安装 Maven 并配置环境变量。如果找不到它,它会根据配置文件,下载对应的 Maven 版本
</font>
---
This doc refer from [Apache StreamPark](https://streampark.apache.org/)

View File

@ -29,5 +29,4 @@ Apache 版本即将到来!
| Version | Date | Source | Binary | Release Notes |
|---------|------------|----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|
| v1.5.0 | 2024.03.08 | [source](https://github.com/apache/hertzbeat/archive/refs/tags/v1.5.0.zip) | [hertzbeat-1.5.0.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.5.0/hertzbeat-1.5.0.tar.gz) <br/> [hertzbeat-collector-1.5.0.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.5.0/hertzbeat-collector-1.5.0.tar.gz) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.5.0) |
| v1.4.4 | 2024.01.11 | [source](https://github.com/apache/hertzbeat/archive/refs/tags/v1.4.4.zip) | [hertzbeat-1.4.4.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.4.4/hertzbeat-1.4.4.tar.gz) <br/> [hertzbeat-collector-1.4.4.tar.gz](https://github.com/dromara/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-1.4.4.tar.gz) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.4.4) |
| v1.5.0 | 2024.03.08 | [source](https://github.com/apache/hertzbeat/archive/refs/tags/v1.5.0.zip) | [hertzbeat-1.5.0.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.5.0/hertzbeat-1.5.0.tar.gz) <br/> [hertzbeat-collector-1.5.0.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.5.0/hertzbeat-collector-1.5.0.tar.gz) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.5.0) |

View File

@ -196,7 +196,7 @@
</dependencies>
<build>
<finalName>hertzbeat</finalName>
<finalName>apache-hertzbeat</finalName>
<resources>
<resource>
<directory>src/main/resources</directory>
@ -264,11 +264,27 @@
<goal>single</goal>
</goals>
<configuration>
<outputDirectory>../dist</outputDirectory>
<descriptors>
<descriptor>../script/assembly/server/assembly.xml</descriptor>
</descriptors>
</configuration>
</execution>
<execution>
<id>make-docker-compose-script</id>
<!--Bound maven operation-->
<phase>package</phase>
<!--Run once-->
<goals>
<goal>single</goal>
</goals>
<configuration>
<outputDirectory>../dist</outputDirectory>
<descriptors>
<descriptor>../script/assembly/server/assembly-docker-compose.xml</descriptor>
</descriptors>
</configuration>
</execution>
</executions>
</plugin>
</plugins>

View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2018-present 卡色<cipchk@qq.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@ -22,7 +22,7 @@
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd
http://maven.apache.org/ASSEMBLY/2.0.0 ">
<!--Required, will be appended to the end of the packaged file name-->
<id>1.5.0</id>
<id>1.6.0-incubating-bin</id>
<!--Packaging type, multiple types can be set, different types will be packaged when packaging-->
<formats>
<format>tar</format>

View File

@ -19,9 +19,10 @@
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd
http://maven.apache.org/ASSEMBLY/2.0.0 ">
<!--Required, will be appended to the end of the packaged file name-->
<id>docker-compose</id>
<id>1.6.0-incubating-docker-compose</id>
<!--Packaging type, multiple types can be set, different types will be packaged when packaging-->
<formats>
<format>tar.gz</format>
<format>zip</format>
</formats>

View File

@ -19,7 +19,7 @@
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd
http://maven.apache.org/ASSEMBLY/2.0.0 ">
<!--Required, will be appended to the end of the packaged file name-->
<id>1.5.0</id>
<id>1.6.0-incubating-bin</id>
<!--Packaging type, multiple types can be set, different types will be packaged when packaging-->
<formats>
<format>tar</format>

View File

@ -25,11 +25,11 @@ MAINTAINER Apache HertzBeat "dev@hertzbeat.apache.org"
RUN apt-get update && apt-get install -y openssh-server
RUN mkdir /var/run/sshd
ADD hertzbeat-collector-${VERSION}.tar /opt/
ADD apache-hertzbeat-collector-${VERSION}-incubating-bin.tar /opt/
ENV TZ=Asia/Shanghai
ENV LANG=en_US.UTF-8
WORKDIR /opt/hertzbeat-collector/
WORKDIR /opt/apache-hertzbeat-collector/
ENTRYPOINT ["./bin/entrypoint.sh"]

View File

@ -20,9 +20,9 @@ cd `dirname $0`
# current dir
CURRENT_DIR=`pwd`
# cd dist dir
cd ../../../collector/target
cd ../../../dist
# auto detect hertzbeat version
VERSION=`ls *.tar| awk -F"-" '{print $3}' | awk -F".tar" '{print $1}'`
VERSION=`ls apache-hertzbeat-collector-*-incubating-bin.tar| awk -F"-" '{print $4}'`
# use the version param
if [ -n "$1" ]; then
VERSION="$1";

View File

@ -29,13 +29,13 @@ RUN mkdir /var/run/sshd
RUN localedef -c -f UTF-8 -i zh_CN zh_CN.UTF-8
RUN localedef -c -f UTF-8 -i en_US en_US.UTF-8
ADD hertzbeat-${VERSION}.tar /opt/
ADD apache-hertzbeat-${VERSION}-incubating-bin.tar /opt/
ENV TZ=Asia/Shanghai
ENV LANG=en_US.UTF-8
EXPOSE 1157 1158 22
WORKDIR /opt/hertzbeat/
WORKDIR /opt/apache-hertzbeat/
ENTRYPOINT ["./bin/entrypoint.sh"]

View File

@ -20,9 +20,10 @@ cd `dirname $0`
# current dir
CURRENT_DIR=`pwd`
# cd dist dir
cd ../../../manager/target
cd ../../../dist
# auto detect hertzbeat version
VERSION=`ls *.tar| awk -F"-" '{print $2}' | awk -F".tar" '{print $1}'`
VERSION=`ls apache-hertzbeat-*-incubating-docker-compose.tar.gz| awk -F"-" '{print $3}'`
VERSION=`ls *.tar| awk -F"-" '{print $3}'`
# use the version param
if [ -n "$1" ]; then
VERSION="$1";

View File

@ -1,30 +0,0 @@
#!/bin/bash
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
TAG="$1"
if [ ! -n "$TAG" ]; then
echo "MUST INPUT THE IMAGE TAG"
exit 1
fi
echo "start pull and stop and replace hertzbeat container"
docker pull registry.cn-hangzhou.aliyuncs.com/tomsun28/hertzbeat:"$TAG"
docker stop hertzbeat
docker rm hertzbeat
docker run -d -p 11157:1157 -v /home/ubuntu/hertzbeat/application.yml:/opt/hertzbeat/config/application.yml --name hertzbeat registry.cn-hangzhou.aliyuncs.com/tomsun28/hertzbeat:"$TAG"

View File

@ -30,9 +30,9 @@ icon: https://raw.githubusercontent.com/apache/hertzbeat/master/home/static/img/
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 1.5.0
version: 1.6.0
# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
# It is recommended to use it with quotes.
appVersion: "v1.5.0"
appVersion: "v1.6.0"

View File

@ -1,5 +1,10 @@
## Hertzbeat Web-App
> [!NOTE]
>
> HertzBeat Web-App is a fork to [ng-alain](https://github.com/ng-alain/ng-alain/). Check [LICENSE](/LICENSE) and [license-ng-alain.txt](/material/licenses/frontend/LICENSE-ng-alain.txt) for more details.
### Quickly Start
1. Need `Node Yarn` Environment, Make sure `Node.js >= 18`

View File

@ -18,5 +18,5 @@
*/
export const CONSTANTS = {
VERSION: 'v1.5.0'
VERSION: 'v1.6.0'
};