fix(chart/opensearch): metricsPort and plugins usage info in values.y…

…aml (#593) * fix(chart/opensearch): metricsPort and plugins usage info in values.yaml Signed-off-by: Toni Tauro <[email protected]> * fix(metricsPort): use httpPort for metrics, as they are reachable over 9200 if prom-exporter is used Signed-off-by: Toni Tauro <[email protected]> * fix(values): trailing spaces Signed-off-by: Toni Tauro <[email protected]> * Update version changelog Signed-off-by: Peter Zhu <[email protected]> --------- Signed-off-by: Toni Tauro <[email protected]> Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Peter Zhu <[email protected]>
opensearch-project · Dec 17, 2024 · 61d7961 · 61d7961
1 parent 8d802b8
commit 61d7961
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 3 deletions.
diff --git a/charts/opensearch/CHANGELOG.md b/charts/opensearch/CHANGELOG.md
@@ -14,6 +14,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 ---
+## [2.28.0]
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+- Fix metricsPort and plugins usage info in values.yaml
+### Security
+---
 ## [2.27.1]
 ### Added
 ### Changed
@@ -530,7 +539,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.27.1...HEAD
+[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.28.0...HEAD
+[2.28.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.27.1...opensearch-2.28.0
 [2.27.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.27.0...opensearch-2.27.1
 [2.27.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.26.1...opensearch-2.27.0
 [2.26.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.26.0...opensearch-2.26.1

diff --git a/charts/opensearch/Chart.yaml b/charts/opensearch/Chart.yaml
@@ -15,7 +15,7 @@ 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: 2.27.1
+version: 2.28.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

diff --git a/charts/opensearch/templates/serviceMonitor.yaml b/charts/opensearch/templates/serviceMonitor.yaml
@@ -14,7 +14,7 @@ spec:
     matchLabels:
       {{- include "opensearch.selectorLabels" . | nindent 6 }}
   endpoints:
-  - port: {{ .Values.service.metricsPortName | default "metrics" }}
+  - port: {{ .Values.service.httpPortName | default "http" }}
     interval: {{ .Values.serviceMonitor.interval }}
     path: {{ .Values.serviceMonitor.path }}
 {{- end }}
diff --git a/charts/opensearch/values.yaml b/charts/opensearch/values.yaml
@@ -534,6 +534,12 @@ extraObjects: []
 
 # ServiceMonitor Configuration for Prometheus
 # Enabling this option will create a ServiceMonitor resource that allows Prometheus to scrape metrics from the OpenSearch service.
+# This only creates the serviceMonitor, to actually have metrics Make sure to install the prometheus-exporter plugin needed for
+# serving metrics over the `.Values.plugins` value:
+# plugins:
+#   enabled: true
+#   installList:
+#     - https://github.com/aiven/prometheus-exporter-plugin-for-opensearch/releases/download/x.x.x.x/prometheus-exporter-x.x.x.x.zip
 serviceMonitor:
   # Set to true to enable the ServiceMonitor resource
   enabled: false