Support broker per-pod service and advertisedListeners (#1263)

labuladong · web-flow · commit 8885cf803a34 · 2026-01-22T13:27:12.000+08:00
## Summary

Add `networking.podService` and `advertisedListeners` configuration to
PulsarBroker CR for Istio Federation/Multi-cluster scenarios.

- Add `networking.podService` config (enabled, type, annotations,
labels, ports)
- Add `advertisedListeners` config for custom broker advertisement
- Update both sn-platform and sn-platform-slim charts

## Test Values

Use the following values file to test the feature:

```yaml
# Test Broker Pod Service functionality
# Simulates Istio Federation scenario

broker:
  pulsarBroker:
    networking:
      podService:
        enabled: true
        type: ClusterIP
        annotations:
          sidecar.istio.io/inject: "true"
          test.streamnative.io/feature: "broker-pod-service"
        labels:
          app.kubernetes.io/managed-by: "pulsar-operator"
          test.streamnative.io/scenario: "istio-federation"
    # Use non-default port (6660) to avoid conflict with brokerServicePort (6650)
    advertisedListeners:
      - name: pod
        hostTemplate: "$(POD_NAME).test-namespace.svc.cluster.local"
        protocols:
          pulsar:
            advertisedPort: 6660
            containerPort: 6660
```

## Verification

1. Deploy with the test values:
   ```bash
helm install test-pulsar ./sn-platform-slim -n test-namespace -f
test-values.yaml
   ```

2. Verify PulsarBroker CR contains correct config:
   ```bash
kubectl get pulsarbroker -n test-namespace -o yaml | grep -A 20
"networking:"
   ```

3. Verify per-pod Services are created:
   ```bash
   kubectl get svc -n test-namespace | grep broker
   ```

4. Expected per-pod Services:
   - `{cluster}-broker-0` with correct annotations/labels
   - `{cluster}-broker-1` with correct annotations/labels
   - Services should include port 6660

## Test plan

- [x] `helm template` renders correct YAML
- [x] Per-pod Services created with correct selector
(`statefulset.kubernetes.io/pod-name`)
- [x] Custom annotations and labels applied to Services
- [x] Broker starts on configured listener port (6660)
- [x] Both sn-platform and sn-platform-slim charts work correctly
diff --git a/charts/sn-platform-slim/templates/broker/broker-cluster.yaml b/charts/sn-platform-slim/templates/broker/broker-cluster.yaml
@@ -190,6 +190,32 @@ spec:
         mode: "passthrough"
       {{- end }}
   {{- end }}
+  {{- if and .Values.broker.pulsarBroker.networking .Values.broker.pulsarBroker.networking.podService .Values.broker.pulsarBroker.networking.podService.enabled }}
+  networking:
+    {{- with .Values.broker.pulsarBroker.networking.podService }}
+    podService:
+      enabled: {{ .enabled }}
+      {{- if .type }}
+      type: {{ .type }}
+      {{- end }}
+      {{- with .annotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .labels }}
+      labels:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .ports }}
+      ports:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+    {{- end }}
+  {{- end }}
+  {{- with .Values.broker.pulsarBroker.advertisedListeners }}
+  advertisedListeners:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
   {{- if .Values.broker.dnsNames }}
   dnsNames:
 {{ toYaml .Values.broker.dnsNames | indent 2}}
diff --git a/charts/sn-platform-slim/values.yaml b/charts/sn-platform-slim/values.yaml
@@ -1143,6 +1143,48 @@ broker:
     labels: {}
     # annotations that will be added on the PulsarBroker CR only.
     annotations: {}
+    # networking configures per-pod Service creation for broker pods
+    # When enabled, creates a dedicated Service for each broker pod
+    # Essential for Istio Federation/Multi-cluster scenarios
+    networking:
+      podService:
+        # enabled controls whether per-pod Services are created
+        enabled: false
+        # type specifies the Service type: ClusterIP, LoadBalancer, or NodePort
+        type: ClusterIP
+        # annotations to add to each pod Service
+        annotations: {}
+        # labels to add to each pod Service
+        labels: {}
+        # ports to expose on each pod Service
+        # If not specified, uses default broker ports (6650, 8080, etc.)
+        # Example:
+        # ports:
+        #   - name: pulsar
+        #     port: 6650
+        #     targetPort: 6650
+        #   - name: http
+        #     port: 8080
+        #     targetPort: 8080
+        ports: []
+    # advertisedListeners defines how brokers are advertised to clients
+    # Used with networking.podService for Istio Federation/Multi-cluster scenarios
+    #
+    # Available hostTemplate variables (interpolated by Kubernetes at runtime):
+    #   - $(POD_NAME): Full pod name, e.g., "pulsar-broker-0"
+    #   - $(POD_ID): Pod ordinal from StatefulSet, e.g., "0", "1", "2"
+    #
+    # IMPORTANT: Use a non-default port (e.g., 6660) to avoid conflict with brokerServicePort (6650)
+    #
+    # Example for Istio Federation:
+    # advertisedListeners:
+    #   - name: pod
+    #     hostTemplate: "$(POD_NAME).my-namespace.svc.cluster.local"
+    #     protocols:
+    #       pulsar:
+    #         advertisedPort: 6660
+    #         containerPort: 6660
+    advertisedListeners: []
 
   # The field autoScaling will track the average metrics usage of the Pulsar nodes and adjusts the nodes to keep at the target metrics usage level.
   # If the average metrics usage for nodes is over the target, scaling controller will scale out to bring more nodes and if the average metrics for the nodes is less than the target, scaling controller will downscale nodes to save resources.
diff --git a/charts/sn-platform/templates/broker/broker-cluster.yaml b/charts/sn-platform/templates/broker/broker-cluster.yaml
@@ -191,6 +191,32 @@ spec:
         mode: "passthrough"
       {{- end }}
   {{- end }}
+  {{- if and .Values.broker.pulsarBroker.networking .Values.broker.pulsarBroker.networking.podService .Values.broker.pulsarBroker.networking.podService.enabled }}
+  networking:
+    {{- with .Values.broker.pulsarBroker.networking.podService }}
+    podService:
+      enabled: {{ .enabled }}
+      {{- if .type }}
+      type: {{ .type }}
+      {{- end }}
+      {{- with .annotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .labels }}
+      labels:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .ports }}
+      ports:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+    {{- end }}
+  {{- end }}
+  {{- with .Values.broker.pulsarBroker.advertisedListeners }}
+  advertisedListeners:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
   {{- if .Values.broker.dnsNames }}
   dnsNames:
 {{ toYaml .Values.broker.dnsNames | indent 2}}
diff --git a/charts/sn-platform/values.yaml b/charts/sn-platform/values.yaml
@@ -1218,6 +1218,48 @@ broker:
     labels: {}
     # annotations that will be added on the PulsarBroker CR only.
     annotations: {}
+    # networking configures per-pod Service creation for broker pods
+    # When enabled, creates a dedicated Service for each broker pod
+    # Essential for Istio Federation/Multi-cluster scenarios
+    networking:
+      podService:
+        # enabled controls whether per-pod Services are created
+        enabled: false
+        # type specifies the Service type: ClusterIP, LoadBalancer, or NodePort
+        type: ClusterIP
+        # annotations to add to each pod Service
+        annotations: {}
+        # labels to add to each pod Service
+        labels: {}
+        # ports to expose on each pod Service
+        # If not specified, uses default broker ports (6650, 8080, etc.)
+        # Example:
+        # ports:
+        #   - name: pulsar
+        #     port: 6650
+        #     targetPort: 6650
+        #   - name: http
+        #     port: 8080
+        #     targetPort: 8080
+        ports: []
+    # advertisedListeners defines how brokers are advertised to clients
+    # Used with networking.podService for Istio Federation/Multi-cluster scenarios
+    #
+    # Available hostTemplate variables (interpolated by Kubernetes at runtime):
+    #   - $(POD_NAME): Full pod name, e.g., "pulsar-broker-0"
+    #   - $(POD_ID): Pod ordinal from StatefulSet, e.g., "0", "1", "2"
+    #
+    # IMPORTANT: Use a non-default port (e.g., 6660) to avoid conflict with brokerServicePort (6650)
+    #
+    # Example for Istio Federation:
+    # advertisedListeners:
+    #   - name: pod
+    #     hostTemplate: "$(POD_NAME).my-namespace.svc.cluster.local"
+    #     protocols:
+    #       pulsar:
+    #         advertisedPort: 6660
+    #         containerPort: 6660
+    advertisedListeners: []
 
   # The field autoScaling will track the average metrics usage of the Pulsar nodes and adjusts the nodes to keep at the target metrics usage level.
   # If the average metrics usage for nodes is over the target, scaling controller will scale out to bring more nodes and if the average metrics for the nodes is less than the target, scaling controller will downscale nodes to save resources.
