This is an automated email from the ASF dual-hosted git repository.
zhaoqingran pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hertzbeat-helm-chart.git
The following commit(s) were added to refs/heads/main by this push:
new 74027a5 [doc] update helm doc and remove release action (#5)
74027a5 is described below
commit 74027a5fdaed41693842b343789d4e49a57a5771
Author: tomsun28 <[email protected]>
AuthorDate: Mon Aug 12 18:42:21 2024 +0800
[doc] update helm doc and remove release action (#5)
* [doc] update helm chart doc
Signed-off-by: tomsun28 <[email protected]>
* [doc] update helm chart doc
Signed-off-by: tomsun28 <[email protected]>
* [doc] update helm chart doc
Signed-off-by: tomsun28 <[email protected]>
* [doc] update helm chart doc
Signed-off-by: tomsun28 <[email protected]>
* [doc] update helm chart doc
Signed-off-by: tomsun28 <[email protected]>
* [doc] update helm chart doc
Signed-off-by: tomsun28 <[email protected]>
* [doc] update helm chart doc
Signed-off-by: tomsun28 <[email protected]>
* [doc] update helm chart doc
Signed-off-by: tomsun28 <[email protected]>
* [doc] update helm chart doc
Signed-off-by: tomsun28 <[email protected]>
* [doc] update helm chart doc
Signed-off-by: tomsun28 <[email protected]>
---------
Signed-off-by: tomsun28 <[email protected]>
---
.github/workflows/release.yml | 55 -------------------------------------------
README.md | 4 ++--
docs/README.md | 14 +++++------
3 files changed, 9 insertions(+), 64 deletions(-)
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
deleted file mode 100644
index e790d6d..0000000
--- a/.github/workflows/release.yml
+++ /dev/null
@@ -1,55 +0,0 @@
-# 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.
-
-name: Release Charts
-
-on:
- push:
- branches: [ main ]
- pull_request:
- branches: [ main ]
-
-jobs:
- release:
- # depending on default permission settings for your org (contents being
read-only or read-write for workloads), you will have to add permissions
- # see:
https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token
- permissions:
- contents: write
- runs-on: ubuntu-latest
- steps:
- - name: Checkout
- uses: actions/checkout@v3
- with:
- fetch-depth: 0
-
- - name: Configure Git
- run: |
- git config user.name "$GITHUB_ACTOR"
- git config user.email "[email protected]"
-
- - name: Install Helm
- uses: azure/setup-helm@v3
- env:
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
- - name: Run chart-releaser
- uses: helm/[email protected]
- with:
- config: ct.yaml
- env:
- CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
- CR_SKIP_EXISTING: true
diff --git a/README.md b/README.md
index 6b7633b..3cfe1c4 100644
--- a/README.md
+++ b/README.md
@@ -160,11 +160,11 @@ The following table lists the configurable parameters of
the HertzBeat chart and
[helm]: https://helm.sh/
-### Build Pages
+### Release and Build Pages
1. `helm package charts/* -d docs`
2. `helm repo index docs`
-3. `commit and push change`
+3. `commit and pr change`
### Build Local
diff --git a/docs/README.md b/docs/README.md
index 8a9b7c6..b0cfbe7 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,13 +1,13 @@
-# Helm Chart for Apache HertzBeat
+# Helm Chart for Apache HertzBeat (incubating)
[](https://artifacthub.io/packages/search?repo=hertzbeat)
<div class="artifacthub-widget"
data-url="https://artifacthub.io/packages/helm/hertzbeat/hertzbeat";
data-theme="light" data-header="true" data-stars="true"
data-responsive="false"><blockquote><p lang="en" dir="ltr"><b>hertzbeat</b>: An
open-source, real-time monitoring system with custom monitoring, high
performance cluster and agentless capabilities.</p>— Open in <a
href="https://artifacthub.io/packages/helm/hertzbeat/hertzbeat";>Artifact
Hub</a></blockquote></div><script async src [...]
-## What is Apache HertzBeat?
+## What is Apache HertzBeat (incubating)?
-[HertzBeat](https://github.com/apache/hertzbeat) is an open source, real-time
monitoring system with custom monitoring, high performance cluster,
prometheus-compatible and agentless capabilities.
+[Apache HertzBeat](https://github.com/apache/hertzbeat) (incubating) is an
easy-to-use, open source, real-time monitoring system with agentless, high
performance cluster, prometheus-compatible, offers powerful custom monitoring
and status page building capabilities.
### Features
@@ -17,10 +17,10 @@
* Compatible with the `Prometheus` ecosystem and more, can monitoring what
`Prometheus` can monitoring with few clicks on webui.
* High performance, supports horizontal expansion of multi-collector clusters,
multi-isolated network monitoring and cloud-edge collaboration.
* Provides flexible alarm threshold rules and timely notifications delivered
via `Discord` `Slack` `Telegram` `Email` `Dingtalk` `WeChat` `FeiShu`
`Webhook` `SMS` `ServerChan`.
+* Provides powerful status page building capabilities, easily communicate the
real-time status of your service to users.
-> HertzBeat's powerful customization, multi-type support, high performance,
easy expansion, and low coupling, aims to help users quickly build their own
monitoring system.
-> We also provide **[SaaS Monitoring Cloud](https://console.tancloud.cn)**,
users no longer need to deploy a cumbersome monitoring system to monitor their
resources. **[Get started online for free](https://console.tancloud.cn)**.
+> HertzBeat's powerful customization, multi-type support, high performance,
easy expansion, and low coupling, aims to help developers and teams quickly
build their own monitoring system.
## Helm Chart for HertzBeat
@@ -60,7 +60,7 @@ The external URL for HertzBeat core service is used to:
Format: `protocol://domain[:port]`. Usually:
-- if service exposed via `Ingress`, the `domain` should be the value of
`expose.ingress.hosts.core`
+- if service exposed via `Ingress`, the `domain` should be the value of
`expose.ingress.hosts`
- if service exposed via `ClusterIP`, the `domain` should be the value of
`expose.clusterIP.name`
- if service exposed via `NodePort`, the `domain` should be the IP address of
one Kubernetes node
- if service exposed via `LoadBalancer`, set the `domain` as your own domain
name and add a CNAME record to map the domain name to the one you got from the
cloud provider
@@ -95,7 +95,7 @@ The following table lists the configurable parameters of the
HertzBeat chart and
| Parameter | Description
| Default |
|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
| **Expose** |
| |
-| `expose.type` | How to expose the service:
`ingress`, `clusterIP`, `nodePort` or `loadBalancer`, other values will be
ignored and the creation of service will be skipped.
| `ingress` |
+| `expose.type` | How to expose the service:
`Ingress`, `ClusterIP`, `NodePort` or `LoadBalancer`, other values will be
ignored and the creation of service will be skipped.
| `Ingress` |
| `expose.clusterIP.name` | The name of ClusterIP service
| `hertzbeat` |
| `expose.clusterIP.annotations` | The annotations attached to the
ClusterIP service
| {} |
| `expose.clusterIP.ports.port` | The service port HertzBeat listens
on when serving HTTP
| `80` |
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
