Skip to content

Commit f2cfa46

Browse files
committed
docs(helm): correct the metrics bindAddress override note
The earlier note suggested keeping `service.port` aligned with a runtime override of `METRICS_BIND_ADDRESS`, but `service.port` is the cluster-facing front-door port and has no effect on the Service backend. The Service `targetPort` and the pod `containerPort` are both derived from `bindAddress` at template time, so overriding the env var via `controller.env` cannot move the rendered Service at all — that operational consequence is what the comment now states, with `bindAddress` flagged as the only chart-side knob that moves the listener and the Service together. Addresses review feedback on kagent-dev#1803. Signed-off-by: Daniel Orbach <ddorbach@gmail.com>
1 parent 18826c4 commit f2cfa46

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

helm/kagent/values.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -228,14 +228,14 @@ controller:
228228
# - name: OPENSHELL_GRPC_ADDR
229229
# value: "openshell.my-namespace.svc.cluster.local:8080"
230230
# -- Prometheus-style /metrics endpoint for the controller manager.
231-
# When enabled, provisions a dedicated metrics Service plus the ClusterRoles
232-
# required for authenticated scrapes. Bind `<fullname>-metrics-reader` to
233-
# your Prometheus ServiceAccount to grant scrape access. The Service
234-
# targetPort and pod containerPort are derived from `bindAddress` so the
235-
# two cannot drift; only the cluster-facing `service.port` is independently
236-
# configurable. Overriding `METRICS_BIND_ADDRESS` via `controller.env`
237-
# changes the runtime bind but not the Service — keep `service.port`
238-
# aligned manually if you take that escape hatch.
231+
# When enabled, provisions a dedicated metrics Service plus the
232+
# ClusterRoles required for authenticated scrapes. Bind
233+
# `<fullname>-metrics-reader` to your Prometheus ServiceAccount to grant
234+
# scrape access. Use `bindAddress` for any port change: the Service
235+
# `targetPort` and the pod `containerPort` are derived from it at
236+
# template time, so overriding `METRICS_BIND_ADDRESS` via
237+
# `controller.env` shifts only the runtime listener and leaves the
238+
# rendered Service pointing at the chart-time port.
239239
# @default -- disabled
240240
metrics:
241241
enabled: false

0 commit comments

Comments
 (0)