v0.2.0

hstreamdb · Dec 29, 2023 · c0e5cbd · c0e5cbd
1 parent 58cf7e0
commit c0e5cbd
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 3 deletions.
diff --git a/charts/hstreamdb/Chart.yaml b/charts/hstreamdb/Chart.yaml
@@ -1,6 +1,7 @@
 apiVersion: v2
 name: hstreamdb
 description: Helm charts for HStreamDB
+home: https://github.com/hstreamdb/helm-charts
 
 # A chart can be either an 'application' or a 'library' chart.
 #
@@ -15,10 +16,10 @@ type: application
 # 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: 0.1.0
+version: 0.2.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: "0.17.3"
+appVersion: "latest"
diff --git a/charts/hstreamdb/README.md b/charts/hstreamdb/README.md
@@ -37,3 +37,14 @@ Below table lists the configurable parameters of the HStreamDB chart and their d
 | `console.replicaCount`          | Console component replica count.                                                        | `1`                               |
 | `console.container`             | Console container configuration. <https://kubernetes.io/docs/concepts/containers/>      |                                   |
 | `console.servicePorts`          | Specify node ports for Console component. See [values.yaml](./values.yaml) for details. | `31777`                           |
+
+## Common usage
+
+### Provide storage
+
+Most of time, you need to specify the `storageClassName` value to provide storage for HStreamDB cluster. For example,
+below command will install HStreamDB cluster under microk8s with hostpath-storage enabled.
+
+```sh
+helm install hstreamdb hstreamdb/hstreamdb -n hstreamdb --create-namespace --set storageClassName=microk8s-hostpath
+```
diff --git a/charts/hstreamdb/templates/NOTES.txt b/charts/hstreamdb/templates/NOTES.txt
@@ -1 +1,6 @@
-A HStreamDB {{ .Chart.AppVersion }} instance has been deployed successfully!
+A HStreamDB cluster (version: {{ .Values.image.tag }}) has been deployed successfully!
+
+To learn more about the release, try:
+
+  $ helm status {{ .Release.Name }}
+  $ helm get all {{ .Release.Name }}