Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xzchaoo committed Jun 8, 2023
1 parent 053d7bf commit 3a61ed1
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 8 deletions.
1 change: 1 addition & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,4 @@ jobs:
uses: helm/[email protected]
env:
CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
mark_as_latest: false
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ This repository contains the Helm Chart source code for the following 2 componen
- [HoloInsight](https://github.com/traas-stack/holoinsight)
- [HoloInsight-Agent](https://github.com/traas-stack/holoinsight)

This repository is maintained according to the guide in this document [Chart Releaser Action to Automate GitHub Page Charts](https://helm.sh/docs/howto/chart_releaser_action/).
The Helm Chart information of this repository can also be searched at [artifacthub.io](https://artifacthub.io/packages/search?org=holoinsight&sort=relevance&page=1).

This repository is maintained according to the guide in this document [Chart Releaser Action to Automate GitHub Page Charts](https://helm.sh/docs/howto/chart_releaser_action/).

# Usage
[Helm](https://helm.sh/) must be installed to use the charts. Please refer to Helm's [documentation](https://helm.sh/docs/) to get started.
Expand All @@ -23,6 +24,12 @@ You can then run `helm search repo holoinsight` to see the charts.

Check this [document](https://traas-stack.github.io/holoinsight-docs/operations/deployment/k8s.html) for more details.

# Update Chart Guide
1. Update Chart content
2. Update version/appVersion in Chart.yaml according to https://helm.sh/docs/topics/charts/ and https://semver.org/
3. Write changelogs in README.md of the Chart
4. Create a PR to main branch

# Licensing
[Apache 2.0 License](https://github.com/traas-stack/holoinsight-helm-charts/blob/main/LICENSE).

Expand Down
6 changes: 3 additions & 3 deletions charts/holoinsight-agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Helm's [documentation](https://helm.sh/docs) to get started.

Once Helm has been set up correctly, add the repo as follows:

helm repo add xzchaoo https://xzchaoo.github.io/holoinsight-helm-charts
helm repo add holoinsight https://traas-stack.github.io/holoinsight-helm-charts

If you had already added this repo earlier, run `helm repo update` to retrieve
the latest versions of the packages. You can then run `helm search repo
xzchaoo` to see the charts.
holoinsight` to see the charts.

To install the holoinsight chart:
kubectl create namespace holoinsight-agent
helm install -n holoinsight-agent holoinsight-server xzchaoo/holoinsight-agent
helm install -n holoinsight-agent holoinsight-server holoinsight/holoinsight-agent

To uninstall the chart:

Expand Down
8 changes: 4 additions & 4 deletions charts/holoinsight/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ Helm's [documentation](https://helm.sh/docs) to get started.

Once Helm has been set up correctly, add the repo as follows:

helm repo add xzchaoo https://xzchaoo.github.io/holoinsight-helm-charts
helm repo add holoinsight https://traas-stack.github.io/holoinsight-helm-charts

If you had already added this repo earlier, run `helm repo update` to retrieve
the latest versions of the packages. You can then run `helm search repo
xzchaoo` to see the charts.
holoinsight` to see the charts.

To install the holoinsight chart:
kubectl create namespace holoinsight
helm install -n holoinsight-server holoinsight-server xzchaoo/holoinsight
helm install -n holoinsight-server holoinsight holoinsight/holoinsight

To uninstall the chart:

helm delete -n holoinsight-server holoinsight-server
helm delete -n holoinsight-server holoinsight

## Changelogs
### To-0.2.3
Expand Down

0 comments on commit 3a61ed1

Please sign in to comment.