Skip to content

Commit c5808a0

Browse files
tomsun28TJxiaobao
andauthored
[doc] update release 1.6.0 doc (apache#2074)
Signed-off-by: tomsun28 <[email protected]> Co-authored-by: 铁甲小宝 <[email protected]>
1 parent ed390a5 commit c5808a0

File tree

341 files changed

+19059
-3686
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

341 files changed

+19059
-3686
lines changed

home/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ If you are using GitHub pages for hosting, this command is a convenient way to b
4949
GITHUB_HOST=gitee.com USE_SSH=true yarn deploy
5050
```
5151

52+
### Archive Version
53+
54+
```shell
55+
yarn docusaurus docs:version v1.5.x
56+
```
57+
5258

5359
## Directory Structure
5460

home/docs/community/how-to-release.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,7 @@ One item of the email content is `Vote thread`, and the link is obtained here: h
434434
Send a voting email in the incubator community requires at least three `+1` and no `-1`.
435435
436436
> `Send to`: [email protected] <br />
437-
> `cc`: [email protected]tison@apache.org[email protected] <br />
437+
> `cc`: [email protected]private@hertzbeat.apache.org <br />
438438
> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1 <br />
439439
> `Body`:
440440
@@ -492,7 +492,6 @@ ChunJin Mu
492492
If there is no -1 after 72 hours, reply to the email as follows
493493
494494
> `Send to`: [email protected] <br />
495-
> `cc`: [email protected] <br />
496495
> `Body`:
497496
498497
```
@@ -505,27 +504,24 @@ Chunjin Mu
505504
Then the voting results will be counted, and the voting result email will be sent, as follows.
506505
507506
> `Send to`: [email protected] <br />
508-
509507
> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1 <br />
510508
> `Body`:
511509
512510
```
513-
Hi all,
511+
Hi Incubator Community,
514512
515-
Thanks for your review and vote for "Release Apache HertzBeat (incubating) 1.6.0-rc1"
516-
I'm happy to announce the vote has passed:
513+
The vote to release Apache HertzBeat (incubating) 1.6.0-rc4 has passed with 3 +1 binding and no +0 or -1 votes.
517514
518515
3 binding votes, no +0 or -1 votes.
519-
Thanks for reviewing and voting.
520516
521517
+3 (binding) +1, from:
522-
- cc
518+
- xxx
523519
524520
no 0 or -1 votes.
525521
526522
Vote thread:
527-
https://lists.apache.org/thread/k3cvcbzxqs6qy62d1o6r9pqpykcgvvhm
528523
524+
https://lists.apache.org/thread/m1kyn4l30y55p6q39m0ys5djvdd73h0f
529525
530526
Thanks everyone for your feedback and help with HertzBeat apache release. The HertzBeat team will take the steps to complete this release and will announce it soon.
531527
@@ -557,16 +553,20 @@ Open the official website address https://hertzbeat.apache.org/docs/download/ to
557553
558554
#### 4.3 Generate a release on github
559555
560-
Create a tag named v1.6.0 based on the release-1.6.0-rc1 branch, and set this tag to latest release.
556+
Update pre-release to create a tag named v1.6.0 based on the release-1.6.0-rc1 branch, and set this tag to latest release.
557+
558+
:::tip
559+
You can modify it on the original RC Release without creating a new Release.
560+
:::
561561
562562
Then enter Release Title and Describe
563563
- Release Title:
564564
```
565-
v1.6.0-incubating
565+
v1.6.0
566566
```
567567
- Describe:
568568
```
569-
Release-1.6.0-incubating
569+
xxx
570570
release note: xxx
571571
```
572572
@@ -582,14 +582,15 @@ The rename the release-1.6.0-rc1 branch to release-1.6.0.
582582
> `Body`:
583583
584584
```
585-
Hi all,
585+
Hi Incubator Community,
586586
587587
We are glad to announce the release of Apache HertzBeat (incubating) 1.6.0.
588588
Once again I would like to express my thanks to your help.
589589
590590
Apache HertzBeat(https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities.
591591
592592
Download Links: https://hertzbeat.apache.org/download/
593+
593594
Release Notes: https://github.com/apache/hertzbeat/releases/tag/v1.6.0
594595
595596
HertzBeat Resources:

home/docs/download.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,23 @@ sidebar_label: Download
1515
## The Latest Release
1616

1717
:::tip
18-
The Apache release coming soon!
18+
Previous releases of HertzBeat may be affected by security issues, please use the latest one.
1919
:::
2020

21-
----
2221

23-
## Non-Apache Release
22+
| Version | Date | Download | Release Notes |
23+
|---------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|
24+
| v1.6.0 | 2024.06.10 | [apache-hertzbeat-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.sha512) ) <br/> [apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.sha512) ) <br/> [apache-hertzbeat-1.6.0-incubating-src.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.sha512) ) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.6.0) |
2425

25-
:::tip
26-
These releases were made before the HertzBeat project joined the ASF Incubator.
27-
These have not followed the usual ASF release process.
28-
:::
2926

30-
| Version | Date | Source | Binary | Release Notes |
31-
|---------|------------|----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|
32-
| 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) |
27+
## Release Docker Image
28+
29+
> Apache HertzBeat provides a docker image for each release. You can pull the image from the [Docker Hub](https://hub.docker.com/r/apache/hertzbeat).
30+
31+
- HertzBeat https://hub.docker.com/r/apache/hertzbeat
32+
- HertzBeat Collector https://hub.docker.com/r/apache/hertzbeat-collector
33+
34+
35+
## All Archived Releases
36+
37+
For older releases, please check the [archive](https://archive.apache.org/dist/incubator/hertzbeat/).

home/docs/start/account-modify.md

Lines changed: 107 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -7,88 +7,110 @@ sidebar_label: Update Account Secret
77
## Update Account
88

99
Apache HertzBeat (incubating) default built-in three user accounts, respectively admin/hertzbeat tom/hertzbeat guest/hertzbeat
10-
If you need add, delete or modify account or password, configure `sureness.yml`. Ignore this step without this demand.
11-
The configuration file content refer to project repository[/script/sureness.yml](https://github.com/hertzbeat/hertzbeat/blob/master/script/sureness.yml)
10+
If you need add, delete or modify account or password, configure `sureness.yml`. Ignore this step without this demand.
1211
Modify the following **part parameters** in sureness.yml:**[Note⚠️Other default sureness configuration parameters should be retained]**
1312

1413
```yaml
1514

1615
resourceRole:
17-
- /api/account/auth/refresh===post===[admin,user,guest]
18-
- /api/apps/**===get===[admin,user,guest]
19-
- /api/monitor/**===get===[admin,user,guest]
20-
- /api/monitor/**===post===[admin,user]
21-
- /api/monitor/**===put===[admin,user]
22-
- /api/monitor/**===delete==[admin]
23-
- /api/monitors/**===get===[admin,user,guest]
24-
- /api/monitors/**===post===[admin,user]
25-
- /api/monitors/**===put===[admin,user]
26-
- /api/monitors/**===delete===[admin]
27-
- /api/alert/**===get===[admin,user,guest]
28-
- /api/alert/**===post===[admin,user]
29-
- /api/alert/**===put===[admin,user]
30-
- /api/alert/**===delete===[admin]
31-
- /api/alerts/**===get===[admin,user,guest]
32-
- /api/alerts/**===post===[admin,user]
33-
- /api/alerts/**===put===[admin,user]
34-
- /api/alerts/**===delete===[admin]
35-
- /api/notice/**===get===[admin,user,guest]
36-
- /api/notice/**===post===[admin,user]
37-
- /api/notice/**===put===[admin,user]
38-
- /api/notice/**===delete===[admin]
39-
- /api/tag/**===get===[admin,user,guest]
40-
- /api/tag/**===post===[admin,user]
41-
- /api/tag/**===put===[admin,user]
42-
- /api/tag/**===delete===[admin]
43-
- /api/summary/**===get===[admin,user,guest]
44-
- /api/summary/**===post===[admin,user]
45-
- /api/summary/**===put===[admin,user]
46-
- /api/summary/**===delete===[admin]
16+
- /api/account/auth/refresh===post===[admin,user,guest]
17+
- /api/apps/**===get===[admin,user,guest]
18+
- /api/monitor/**===get===[admin,user,guest]
19+
- /api/monitor/**===post===[admin,user]
20+
- /api/monitor/**===put===[admin,user]
21+
- /api/monitor/**===delete==[admin]
22+
- /api/monitors/**===get===[admin,user,guest]
23+
- /api/monitors/**===post===[admin,user]
24+
- /api/monitors/**===put===[admin,user]
25+
- /api/monitors/**===delete===[admin]
26+
- /api/alert/**===get===[admin,user,guest]
27+
- /api/alert/**===post===[admin,user]
28+
- /api/alert/**===put===[admin,user]
29+
- /api/alert/**===delete===[admin]
30+
- /api/alerts/**===get===[admin,user,guest]
31+
- /api/alerts/**===post===[admin,user]
32+
- /api/alerts/**===put===[admin,user]
33+
- /api/alerts/**===delete===[admin]
34+
- /api/notice/**===get===[admin,user,guest]
35+
- /api/notice/**===post===[admin,user]
36+
- /api/notice/**===put===[admin,user]
37+
- /api/notice/**===delete===[admin]
38+
- /api/tag/**===get===[admin,user,guest]
39+
- /api/tag/**===post===[admin,user]
40+
- /api/tag/**===put===[admin,user]
41+
- /api/tag/**===delete===[admin]
42+
- /api/summary/**===get===[admin,user,guest]
43+
- /api/summary/**===post===[admin,user]
44+
- /api/summary/**===put===[admin,user]
45+
- /api/summary/**===delete===[admin]
46+
- /api/collector/**===get===[admin,user,guest]
47+
- /api/collector/**===post===[admin,user]
48+
- /api/collector/**===put===[admin,user]
49+
- /api/collector/**===delete===[admin]
50+
- /api/status/page/**===get===[admin,user,guest]
51+
- /api/status/page/**===post===[admin,user]
52+
- /api/status/page/**===put===[admin,user]
53+
- /api/status/page/**===delete===[admin]
4754

48-
# Resources that need to be filtered and protected can be accessed directly without authentication
49-
# /api/v1/source3===get means /api/v1/source3===get it can be accessed by anyone. Don't need to authentication
55+
# config the resource restful api that need bypass auth protection
56+
# rule: api===method
57+
# eg: /api/v1/source3===get means /api/v1/source3===get can be access by anyone, no need auth.
5058
excludedResource:
51-
- /api/account/auth/**===*
52-
- /api/i18n/**===get
53-
- /api/apps/hierarchy===get
54-
# web ui the front-end static resource
55-
- /===get
56-
- /dashboard/**===get
57-
- /monitors/**===get
58-
- /alert/**===get
59-
- /account/**===get
60-
- /setting/**===get
61-
- /passport/**===get
62-
- /**/*.html===get
63-
- /**/*.js===get
64-
- /**/*.css===get
65-
- /**/*.ico===get
66-
- /**/*.ttf===get
67-
- /**/*.png===get
68-
- /**/*.gif===get
69-
- /**/*.jpg===get
70-
- /**/*.svg===get
71-
- /**/*.json===get
72-
# swagger ui resource
73-
- /swagger-resources/**===get
74-
- /v2/api-docs===get
75-
- /v3/api-docs===get
59+
- /api/alerts/report/**===*
60+
- /api/account/auth/**===*
61+
- /api/i18n/**===get
62+
- /api/apps/hierarchy===get
63+
- /api/push/**===*
64+
- /api/status/page/public/**===*
65+
# web ui resource
66+
- /===get
67+
- /dashboard/**===get
68+
- /monitors/**===get
69+
- /alert/**===get
70+
- /account/**===get
71+
- /setting/**===get
72+
- /passport/**===get
73+
- /status/**===get
74+
- /**/*.html===get
75+
- /**/*.js===get
76+
- /**/*.css===get
77+
- /**/*.ico===get
78+
- /**/*.ttf===get
79+
- /**/*.png===get
80+
- /**/*.gif===get
81+
- /**/*.jpg===get
82+
- /**/*.svg===get
83+
- /**/*.json===get
84+
- /**/*.woff===get
85+
- /**/*.eot===get
86+
# swagger ui resource
87+
- /swagger-resources/**===get
88+
- /v2/api-docs===get
89+
- /v3/api-docs===get
90+
# h2 database
91+
- /h2-console/**===*
7692

77-
# user account information
78-
# Here is admin tom lili three accounts
79-
# eg: admin includes[admin,user]roles, password is hertzbeat
80-
# eg: tom includes[user], password is hertzbeat
81-
# eg: lili includes[guest],text password is lili, salt password is 1A676730B0C7F54654B0E09184448289
93+
# account info config
94+
# eg: admin has role [admin,user], password is hertzbeat
95+
# eg: tom has role [user], password is hertzbeat
96+
# eg: lili has role [guest], plain password is lili, salt is 123, salted password is 1A676730B0C7F54654B0E09184448289
8297
account:
83-
- appId: admin
84-
credential: hertzbeat
85-
role: [admin,user]
86-
- appId: tom
87-
credential: hertzbeat
88-
role: [user]
89-
- appId: guest
90-
credential: hertzbeat
91-
role: [guest]
98+
- appId: admin
99+
credential: hertzbeat
100+
role: [admin]
101+
- appId: tom
102+
credential: hertzbeat
103+
role: [user]
104+
- appId: guest
105+
credential: hertzbeat
106+
role: [guest]
107+
- appId: lili
108+
# credential = MD5(password + salt)
109+
# plain password: hertzbeat
110+
# attention: digest authentication does not support salted encrypted password accounts
111+
credential: 94C6B34E7A199A9F9D4E1F208093B489
112+
salt: 123
113+
role: [user]
92114
```
93115
94116
Modify the following **part parameters** in sureness.yml **[Note⚠️Other default sureness configuration parameters should be retained]**:
@@ -97,19 +119,26 @@ Modify the following **part parameters** in sureness.yml **[Note⚠️Other defa
97119

98120
# user account information
99121
# Here is admin tom lili three accounts
100-
# eg: admin includes[admin,user]roles, password is hertzbeat
101-
# eg: tom includes[user], password is hertzbeat
102-
# eg: lili includes[guest], text password is lili, salt password is 1A676730B0C7F54654B0E09184448289
122+
# eg: admin has role [admin,user], password is hertzbeat
123+
# eg: tom has role [user], password is hertzbeat
124+
# eg: lili has role [guest], plain password is lili, salt is 123, salted password is 1A676730B0C7F54654B0E09184448289
103125
account:
104126
- appId: admin
105127
credential: hertzbeat
106-
role: [admin,user]
128+
role: [admin]
107129
- appId: tom
108130
credential: hertzbeat
109131
role: [user]
110132
- appId: guest
111133
credential: hertzbeat
112134
role: [guest]
135+
- appId: lili
136+
# credential = MD5(password + salt)
137+
# plain password: hertzbeat
138+
# attention: digest authentication does not support salted encrypted password accounts
139+
credential: 94C6B34E7A199A9F9D4E1F208093B489
140+
salt: 123
141+
role: [user]
113142
```
114143
115144
## Update Security Secret
@@ -122,7 +151,7 @@ Update the `application.yml` file in the `config` directory, modify the `surenes
122151
```yaml
123152
sureness:
124153
jwt:
125-
secret: 'CyaFv0bwq2Eik0jdrKUtsA6bx3sDJeFV643R
154+
secret: 'CyaFv0bwq2Eik0jdrKUtsA6bx4sDJeFV643R
126155
LnfKefTjsIfJLBa2YkhEqEGtcHDTNe4CU6+9
127156
8tVt4bisXQ13rbN0oxhUZR73M6EByXIO+SV5
128157
dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp'

0 commit comments

Comments
 (0)