diff --git a/helm/README.md b/helm/README.md index cd0985f6e4..6b1d8d3a31 100644 --- a/helm/README.md +++ b/helm/README.md @@ -22,7 +22,7 @@ This chart deploys an Apache Fluss cluster on Kubernetes, following Helm best pr It requires a Zookeeper ensemble to be running in the same Kubernetes cluster. In future releases, we may add support for an embedded Zookeeper cluster. -## Development environment +## Development environment | component | version | | ------------------------------------------------------------------------------ | ------- | @@ -33,7 +33,7 @@ It requires a Zookeeper ensemble to be running in the same Kubernetes cluster. I | [Apache Fluss](https://fluss.apache.org/docs/) | v0.10.0-incubating | -## Image requirements +## Image requirements A container image for Fluss is available on DockerHub as `fluss/fluss`. You can use it directly or build your own from this repo. To use your own image you need to build the project with [Maven](https://fluss.apache.org/community/dev/building/) and build it with Docker. @@ -93,6 +93,78 @@ Important Fluss options surfaced by the chart: - internal.listener.name: Which listener is used for internal communication (defaults to INTERNAL). - tablet-server.id: Required to be unique per TabletServer. The chart auto‑derives this from the StatefulSet pod ordinal at runtime. +### Metrics and Prometheus Scraping + +The chart can enable Fluss metrics reporters and create dedicated metrics services for `coordinator` and `tablet` components. + +Example: + +```bash +helm install fluss ./fluss-helm \ + --set metrics.reporters=prometheus +``` + +When `metrics.reporters` is not `none`, the chart will: + +- configure `metrics.reporters` from reporter names in values +- configure `metrics.reporter..