feat: Add publishNotReadyAddresses and podTerminationGracePeriodSeconds configuration

apis/mattermost/v1alpha1/clusterinstallation_types.go

@@ -99,6 +99,16 @@ type ClusterInstallationSpec struct {
 	// Specify deployment pull policy.
 	// +optional
 	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`
+	// PublishNotReadyAddresses controls whether pod endpoints are published before pods are ready.
+	// When false (recommended), only ready pods receive traffic. When true, pods receive traffic immediately upon creation.
+	// Defaults to false if not specified.
+	// +optional
+	PublishNotReadyAddresses *bool `json:"publishNotReadyAddresses,omitempty"`
+	// PodTerminationGracePeriodSeconds defines how long to wait before forcefully terminating the pod during shutdown.
+	// This gives time for the pod to finish processing in-flight requests.
+	// If not specified, Kubernetes default of 30 seconds is used.
+	// +optional
+	PodTerminationGracePeriodSeconds *int64 `json:"podTerminationGracePeriodSeconds,omitempty"`
 
 	// Migrate specifies that the ClusterInstallation CR should be migrated to the Mattermost CR.
 	// CAUTION: Some features like BlueGreen or Canary are not supported with a new Custom Resource

config/crd/bases/mattermost.com_clusterinstallations.yaml

@@ -1601,6 +1601,19 @@ spec:
                   Selector which must match a node's labels for the pod to be scheduled on that node.
                   More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
                 type: object
+              podTerminationGracePeriodSeconds:
+                description: |-
+                  PodTerminationGracePeriodSeconds defines how long to wait before forcefully terminating the pod during shutdown.
+                  This gives time for the pod to finish processing in-flight requests.
+                  If not specified, Kubernetes default of 30 seconds is used.
+                format: int64
+                type: integer
+              publishNotReadyAddresses:
+                description: |-
+                  PublishNotReadyAddresses controls whether pod endpoints are published before pods are ready.
+                  When false (recommended), only ready pods receive traffic. When true, pods receive traffic immediately upon creation.
+                  Defaults to false if not specified.
+                type: boolean
               readinessProbe:
                 description: Defines the probe to check if the application is ready
                   to accept traffic.

docs/examples/full.yaml

@@ -21,3 +21,5 @@ spec:
     password: "" # Password to log into Elasticsearch.
   nodeSelector: {} # See https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector.
   affinity: {} # See https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity.
+  publishNotReadyAddresses: false # Set to false (default) to only route traffic to ready pods. Prevents connection errors during rolling updates and maintenance.
+  podTerminationGracePeriodSeconds: 60 # How long (in seconds) to wait before forcefully terminating pods during shutdown. Increase this (e.g., 60-90) to allow in-flight requests to complete during rolling updates. Default is 30 seconds if not specified.

pkg/mattermost/mattermost.go

@@ -381,8 +381,9 @@ func GenerateDeployment(mattermost *mattermostv1alpha1.ClusterInstallation, dbIn
 					Annotations: podAnnotations,
 				},
 				Spec: corev1.PodSpec{
-					ServiceAccountName: serviceAccountName,
-					InitContainers:     initContainers,
+					ServiceAccountName:            serviceAccountName,
+					TerminationGracePeriodSeconds: mattermost.Spec.PodTerminationGracePeriodSeconds,
+					InitContainers:                initContainers,
 					Containers: []corev1.Container{
 						{
 							Name:                     mattermostv1alpha1.MattermostAppContainerName,
@@ -486,6 +487,12 @@ func ClusterInstallationOwnerReference(mattermost *mattermostv1alpha1.ClusterIns
 // newService returns semi-finished service with common parts filled.
 // Returned service is expected to be completed by the caller.
 func newService(mattermost *mattermostv1alpha1.ClusterInstallation, serviceName, selectorName string, annotations map[string]string) *corev1.Service {
+	// Default to false if not specified
+	publishNotReady := false
+	if mattermost.Spec.PublishNotReadyAddresses != nil {
+		publishNotReady = *mattermost.Spec.PublishNotReadyAddresses
+	}
+
 	return &corev1.Service{
 		ObjectMeta: metav1.ObjectMeta{
 			Labels:    mattermost.ClusterInstallationLabels(serviceName),
@@ -502,7 +509,7 @@ func newService(mattermost *mattermostv1alpha1.ClusterInstallation, serviceName,
 		},
 		Spec: corev1.ServiceSpec{
 			Selector:                 mattermostv1alpha1.ClusterInstallationSelectorLabels(selectorName),
-			PublishNotReadyAddresses: true,
+			PublishNotReadyAddresses: publishNotReady,
 		},
 	}
 }

pkg/mattermost/mattermost_test.go

@@ -67,7 +67,8 @@ func TestGenerateService(t *testing.T) {
 				expectPort(t, service, 8067)
 			}
 
-			assert.True(t, service.Spec.PublishNotReadyAddresses)
+			// Default behavior is now false unless explicitly set
+			assert.False(t, service.Spec.PublishNotReadyAddresses)
 		})
 	}
 }