[Draft] CSPL-3354: Add Lifecycle Hooks and Configurable Termination Grace Period to Splunk Operator

api/v4/common_types.go

@@ -112,6 +112,8 @@ type Spec struct {
 
 	// TopologySpreadConstraint https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/
 	TopologySpreadConstraints []corev1.TopologySpreadConstraint `json:"topologySpreadConstraints,omitempty"`
+
+	TerminationGracePeriodSeconds int64 `json:"terminationGracePeriodSeconds"`
 }
 
 // Phase is used to represent the current phase of a custom resource

pkg/splunk/controller/util.go

@@ -165,6 +165,13 @@ func MergePodSpecUpdates(ctx context.Context, current *corev1.PodSpec, revised *
 			}
 		}
 	}
+	if current.TerminationGracePeriodSeconds != revised.TerminationGracePeriodSeconds {
+		scopedLog.Info("Pod TerminationGracePeriodSeconds differs",
+			"current", current.TerminationGracePeriodSeconds,
+			"revised", revised.TerminationGracePeriodSeconds)
+		current.TerminationGracePeriodSeconds = revised.TerminationGracePeriodSeconds
+		result = true
+	}
 
 	// check for changes in container images; assume that the ordering is same for pods with > 1 container
 	if len(current.Containers) != len(revised.Containers) {
@@ -244,12 +251,24 @@ func MergePodSpecUpdates(ctx context.Context, current *corev1.PodSpec, revised *
 				current.Containers[idx].StartupProbe = revised.Containers[idx].StartupProbe
 				result = true
 			}
+			setPreStopLifecycleHandler(current, idx)
 		}
 	}
 
 	return result
 }
 
+// set the PreStop lifecycle handler for the specified container index
+func setPreStopLifecycleHandler(podSpec *corev1.PodSpec, idx int) {
+	podSpec.Containers[idx].Lifecycle = &corev1.Lifecycle{
+		PreStop: &corev1.LifecycleHandler{
+			Exec: &corev1.ExecAction{
+				Command: []string{"/bin/sh", "-c", "/opt/splunk/bin/splunk offline && /opt/splunk/bin/splunk stop"},
+			},
+		},
+	}
+}
+
 // SortStatefulSetSlices sorts required slices in a statefulSet
 func SortStatefulSetSlices(ctx context.Context, current *corev1.PodSpec, name string) error {
 	reqLogger := log.FromContext(ctx)

pkg/splunk/controller/util_test.go

@@ -100,6 +100,14 @@ func TestMergePodUpdates(t *testing.T) {
 	matcher = func() bool { return reflect.DeepEqual(current.Spec.InitContainers, revised.Spec.InitContainers) }
 	podUpdateTester("InitContainer image changed")
 
+	// check Termination Grace Period updated
+	terminationGracePeriodSeconds := int64(60)
+	revised.Spec.TerminationGracePeriodSeconds = &terminationGracePeriodSeconds
+	matcher = func() bool {
+		return reflect.DeepEqual(current.Spec.TerminationGracePeriodSeconds, revised.Spec.TerminationGracePeriodSeconds)
+	}
+	podUpdateTester("TerminationGracePeriod updated")
+
 	// check new container added
 	revised.Spec.Containers = []corev1.Container{{Image: "splunk/splunk"}}
 	matcher = func() bool { return reflect.DeepEqual(current.Spec.Containers, revised.Spec.Containers) }
@@ -206,6 +214,12 @@ func TestMergePodUpdates(t *testing.T) {
 	}
 	podUpdateTester("Pod TopologySpreadConstraints changed")
 
+	// check Pre Stop Lifecycle Handler updated
+	idx := 0
+	setPreStopLifecycleHandler(&revised.Spec, idx)
+	matcher = func() bool { return reflect.DeepEqual(current.Spec.Containers, revised.Spec.Containers) }
+	podUpdateTester("PreStopLifecycleHandler updated")
+
 	// check container removed
 	revised.Spec.Containers = []corev1.Container{}
 	matcher = func() bool { return reflect.DeepEqual(current.Spec.Containers, revised.Spec.Containers) }

pkg/splunk/enterprise/configuration.go

@@ -736,6 +736,17 @@ func getSmartstoreConfigMap(ctx context.Context, client splcommon.ControllerClie
 	return configMap
 }
 
+// set the PreStop lifecycle handler for the specified container index
+func setPreStopLifecycleHandler(podTemplateSpec *corev1.PodTemplateSpec, idx int) {
+	podTemplateSpec.Spec.Containers[idx].Lifecycle = &corev1.Lifecycle{
+		PreStop: &corev1.LifecycleHandler{
+			Exec: &corev1.ExecAction{
+				Command: []string{"/bin/sh", "-c", "/opt/splunk/bin/splunk", "offline", "&&", "/opt/splunk/bin/splunk", "stop"},
+			},
+		},
+	}
+}
+
 // updateSplunkPodTemplateWithConfig modifies the podTemplateSpec object based on configuration of the Splunk Enterprise resource.
 func updateSplunkPodTemplateWithConfig(ctx context.Context, client splcommon.ControllerClient, podTemplateSpec *corev1.PodTemplateSpec, cr splcommon.MetaObject, spec *enterpriseApi.CommonSplunkSpec, instanceType InstanceType, extraEnv []corev1.EnvVar, secretToMount string) {
 
@@ -1036,7 +1047,12 @@ func updateSplunkPodTemplateWithConfig(ctx context.Context, client splcommon.Con
 				Type: corev1.SeccompProfileTypeRuntimeDefault,
 			},
 		}
+
+		// Use the helper function to set the lifecycle handler
+		setPreStopLifecycleHandler(podTemplateSpec, idx)
 	}
+
+	podTemplateSpec.Spec.TerminationGracePeriodSeconds = &spec.TerminationGracePeriodSeconds
 }
 
 func removeDuplicateEnvVars(sliceList []corev1.EnvVar) []corev1.EnvVar {

pkg/splunk/enterprise/configuration_test.go

@@ -23,6 +23,7 @@ import (
 	"os"
 	"strings"
 	"testing"
+	"reflect"
 
 	enterpriseApi "github.com/splunk/splunk-operator/api/v4"
 	"github.com/stretchr/testify/require"
@@ -1759,3 +1760,40 @@ func TestValidateLivenessProbe(t *testing.T) {
 		t.Errorf("Unexpected error when less than deault values passed for livenessProbe InitialDelaySeconds %d, TimeoutSeconds %d, PeriodSeconds %d. Error %s", livenessProbe.InitialDelaySeconds, livenessProbe.TimeoutSeconds, livenessProbe.PeriodSeconds, err)
 	}
 }
+
+func TestSetPreStopLifecycleHandler(t *testing.T) {
+    // Create a pod template spec with a single container
+    podTemplateSpec := corev1.PodTemplateSpec{
+        Spec: corev1.PodSpec{
+            Containers: []corev1.Container{
+                {Name: "splunk"},
+            },
+        },
+    }
+
+    // Index of the container to apply the lifecycle handler
+    idx := 0
+
+    // Set the lifecycle handler
+    setPreStopLifecycleHandler(&podTemplateSpec, idx)
+
+    t.Run("test lifecycle pre-stop handler", func(t *testing.T) {
+        // Verify that the lifecycle handler was set correctly
+        if podTemplateSpec.Spec.Containers[idx].Lifecycle == nil {
+            t.Error("Expected Lifecycle to be set, but it was nil")
+        }
+
+        if podTemplateSpec.Spec.Containers[idx].Lifecycle.PreStop == nil {
+            t.Error("Expected PreStop to be set, but it was nil")
+        }
+
+        if podTemplateSpec.Spec.Containers[idx].Lifecycle.PreStop.Exec == nil {
+            t.Error("Expected Exec to be set, but it was nil")
+        }
+
+        expectedCommand := []string{"/bin/sh", "-c", "/opt/splunk/bin/splunk offline &&  /opt/splunk/bin/splunk stop"}
+        if !reflect.DeepEqual(podTemplateSpec.Spec.Containers[idx].Lifecycle.PreStop.Exec.Command, expectedCommand) {
+            t.Errorf("Expected command to be %v, but got %v", expectedCommand, podTemplateSpec.Spec.Containers[idx].Lifecycle.PreStop.Exec.Command)
+        }
+    })
+}