Add comment about DNS and StatefulSet

charts/warpstream-agent/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.13.58] - 2024-11-29
+
+### Added
+
+- Add clarifying comment in values.yaml
+
 ## [0.13.57] - 2024-11-25
 
 ### Added

charts/warpstream-agent/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: warpstream-agent
 description: WarpStream Agent for Kubernetes.
 type: application
-version: 0.13.57
+version: 0.13.58
 appVersion: v602
 icon: https://avatars.githubusercontent.com/u/132156278
 home: https://docs.warpstream.com/warpstream/

charts/warpstream-agent/values.yaml

@@ -11,7 +11,17 @@ fullnameOverride: ""
 # Ignored if auto-scaling is enabled (which it is by default).
 replicas: 3
 
-# Only use StatefulSet when TLS is needed for an easier time managing certificates due to stable hostnames
+# Only use StatefulSet when TLS is needed for an easier time managing certificates due to stable hostnames.
+#
+# *Note* that if you switch to using StatefulSet you should stop using WarpStream's convenience bootstrap
+# URL in your Kafka clients, and switch to the Kubernetes service name instead. The reason for this is that
+# when you switch to StatefulSet, the Agents will begin advertising their stable pod names in the Kafka
+# protocol as their hostname, instead of their internal IP addresses. When this happens, WarpStream's DNS
+# server will start returning CNAME's for the convience bootstrap URL for each Agent, but your application
+# may not be able to resolve the CNAMEs due to limitations in things like CoreDNS.
+#
+# In general, we always recommend using the Kubernetes service name as the bootstrap URL for your clients
+# when the Agents are deployed in Kubernetes to avoid issues like this.
 deploymentKind: Deployment  # or StatefulSet
 
 # Only used in Deployments