From 2d0f31f69c7262a950ef1a570591ea1e4c75b6b6 Mon Sep 17 00:00:00 2001 From: Steven Sklar Date: Wed, 14 Oct 2026 16:46:36 -0400 Subject: [PATCH] docs(operator): document spec.podMetadata Co-Authored-By: Claude Opus 5.5 --- .../configuration.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/documentation/enterprise-kubernetes-operator/configuration.md b/documentation/enterprise-kubernetes-operator/configuration.md index 4778f9cc2..294ea2ac1 100644 --- a/documentation/enterprise-kubernetes-operator/configuration.md +++ b/documentation/enterprise-kubernetes-operator/configuration.md @@ -237,6 +237,22 @@ or disable the PDB after accepting the availability risk. Follow the Custom affinity or topology spread replaces the corresponding default rather than merging with it. +## Pod labels and annotations + +`spec.podMetadata` adds labels and annotations to every instance Pod, for +example so a metrics agent scrapes the `metrics` port (9003): + +```yaml +spec: + podMetadata: + annotations: + k8s.grafana.com/scrape: "true" + k8s.grafana.com/metrics.portName: metrics +``` + +If you set a key the operator also sets, the operator's value is used. Changing +`spec.podMetadata` rolls the Pods, including the primary. + ## Wire protocols `spec.protocols` configures optional wire-protocol behavior. Omit it and HTTP, @@ -422,7 +438,7 @@ operator-owned QWP keys as `spec.config`: both maps are merged into one ## Changes and immutable fields Changes to the image, image pull Secrets, resources, engine configuration, -protocol fields, or pod scheduling can roll affected Pods. Ordinary rollouts are +protocol fields, pod scheduling, or pod metadata can roll affected Pods. Ordinary rollouts are serialized: replicas roll in serial order before the primary, and at most one ordinary drift delete is attempted per instanceset reconcile. The controller may hold a rollout while topology, PVC usability, peer readiness, node health, or