[Feature] allow to config the terminationGracePeriodSeconds

Signed-off-by: yandongxiao <[email protected]>
StarRocks · Oct 14, 2023 · 1add3ba · 1add3ba
1 parent d36d9c4
commit 1add3ba
Show file tree

Hide file tree

Showing 7 changed files with 102 additions and 2 deletions.
diff --git a/config/crd/bases/starrocks.com_starrocksclusters.yaml b/config/crd/bases/starrocks.com_starrocksclusters.yaml
@@ -1273,6 +1273,19 @@ spec:
                       - storageSize
                       type: object
                     type: array
+                  terminationGracePeriodSeconds:
+                    description: TerminationGracePeriodSeconds defines duration in
+                      seconds the pod needs to terminate gracefully. May be decreased
+                      in delete request. Value must be non-negative integer. The value
+                      zero indicates stop immediately via the kill signal (no opportunity
+                      to shut down). If this value is nil, the default grace period
+                      will be used instead. The grace period is the duration in seconds
+                      after the processes running in the pod are sent a termination
+                      signal and the time when the processes are forcibly halted with
+                      a kill signal. Set this value longer than the expected cleanup
+                      time for your process. Defaults to 120 seconds.
+                    format: int64
+                    type: integer
                   tolerations:
                     description: (Optional) Tolerations for scheduling pods onto some
                       dedicated nodes
@@ -3218,6 +3231,19 @@ spec:
                       - storageSize
                       type: object
                     type: array
+                  terminationGracePeriodSeconds:
+                    description: TerminationGracePeriodSeconds defines duration in
+                      seconds the pod needs to terminate gracefully. May be decreased
+                      in delete request. Value must be non-negative integer. The value
+                      zero indicates stop immediately via the kill signal (no opportunity
+                      to shut down). If this value is nil, the default grace period
+                      will be used instead. The grace period is the duration in seconds
+                      after the processes running in the pod are sent a termination
+                      signal and the time when the processes are forcibly halted with
+                      a kill signal. Set this value longer than the expected cleanup
+                      time for your process. Defaults to 120 seconds.
+                    format: int64
+                    type: integer
                   tolerations:
                     description: (Optional) Tolerations for scheduling pods onto some
                       dedicated nodes
@@ -4310,6 +4336,19 @@ spec:
                       - storageSize
                       type: object
                     type: array
+                  terminationGracePeriodSeconds:
+                    description: TerminationGracePeriodSeconds defines duration in
+                      seconds the pod needs to terminate gracefully. May be decreased
+                      in delete request. Value must be non-negative integer. The value
+                      zero indicates stop immediately via the kill signal (no opportunity
+                      to shut down). If this value is nil, the default grace period
+                      will be used instead. The grace period is the duration in seconds
+                      after the processes running in the pod are sent a termination
+                      signal and the time when the processes are forcibly halted with
+                      a kill signal. Set this value longer than the expected cleanup
+                      time for your process. Defaults to 120 seconds.
+                    format: int64
+                    type: integer
                   tolerations:
                     description: (Optional) Tolerations for scheduling pods onto some
                       dedicated nodes
@@ -5575,6 +5614,19 @@ spec:
                       - storageSize
                       type: object
                     type: array
+                  terminationGracePeriodSeconds:
+                    description: TerminationGracePeriodSeconds defines duration in
+                      seconds the pod needs to terminate gracefully. May be decreased
+                      in delete request. Value must be non-negative integer. The value
+                      zero indicates stop immediately via the kill signal (no opportunity
+                      to shut down). If this value is nil, the default grace period
+                      will be used instead. The grace period is the duration in seconds
+                      after the processes running in the pod are sent a termination
+                      signal and the time when the processes are forcibly halted with
+                      a kill signal. Set this value longer than the expected cleanup
+                      time for your process. Defaults to 120 seconds.
+                    format: int64
+                    type: integer
                   tolerations:
                     description: (Optional) Tolerations for scheduling pods onto some
                       dedicated nodes

diff --git a/deploy/starrocks.com_starrocksclusters.yaml b/deploy/starrocks.com_starrocksclusters.yaml
@@ -596,6 +596,9 @@ spec:
                       - storageSize
                       type: object
                     type: array
+                  terminationGracePeriodSeconds:
+                    format: int64
+                    type: integer
                   tolerations:
                     items:
                       properties:
@@ -1496,6 +1499,9 @@ spec:
                       - storageSize
                       type: object
                     type: array
+                  terminationGracePeriodSeconds:
+                    format: int64
+                    type: integer
                   tolerations:
                     items:
                       properties:
@@ -1975,6 +1981,9 @@ spec:
                       - storageSize
                       type: object
                     type: array
+                  terminationGracePeriodSeconds:
+                    format: int64
+                    type: integer
                   tolerations:
                     items:
                       properties:
@@ -2547,6 +2556,9 @@ spec:
                       - storageSize
                       type: object
                     type: array
+                  terminationGracePeriodSeconds:
+                    format: int64
+                    type: integer
                   tolerations:
                     items:
                       properties:

diff --git a/helm-charts/charts/kube-starrocks/charts/starrocks/templates/starrockscluster.yaml b/helm-charts/charts/kube-starrocks/charts/starrocks/templates/starrockscluster.yaml
@@ -105,6 +105,7 @@ spec:
     tolerations:
 {{toYaml .Values.starrocksFESpec.tolerations | indent 4 }}
 {{- end }}
+    terminationGracePeriodSeconds: {{ .Values.starrocksFESpec.terminationGracePeriodSeconds }}
 {{- if .Values.starrocksFESpec.secrets }}
     secrets:
     {{- range .Values.starrocksFESpec.secrets }}
@@ -241,6 +242,7 @@ spec:
     tolerations:
 {{toYaml .Values.starrocksBeSpec.tolerations | indent 4 }}
 {{- end }}
+    terminationGracePeriodSeconds: {{ .Values.starrocksBeSpec.terminationGracePeriodSeconds }}
 {{- if .Values.starrocksBeSpec.secrets }}
     secrets:
     {{- range .Values.starrocksBeSpec.secrets }}
@@ -333,6 +335,7 @@ spec:
     tolerations:
 {{toYaml .Values.starrocksCnSpec.tolerations | indent 4 }}
 {{- end }}
+    terminationGracePeriodSeconds: {{ .Values.starrocksCnSpec.terminationGracePeriodSeconds }}
 {{- if and .Values.starrocksCluster.enabledCn .Values.starrocksCnSpec.autoScalingPolicy }}
     autoScalingPolicy:
 {{ toYaml .Values.starrocksCnSpec.autoScalingPolicy | indent 6 }}

diff --git a/helm-charts/charts/kube-starrocks/charts/starrocks/values.yaml b/helm-charts/charts/kube-starrocks/charts/starrocks/values.yaml
@@ -177,6 +177,8 @@ starrocksFESpec:
     # - name: my-configmap
     #   mountPath: /etc/my-configmap
     #   subPath: ""
+  # terminationGracePeriodSeconds defines duration in seconds the FE pod needs to terminate gracefully.
+  terminationGracePeriodSeconds: 120
 
 # spec for compute node, compute node provide compute function.
 starrocksCnSpec:
@@ -325,6 +327,8 @@ starrocksCnSpec:
     # - name: my-configmap
     #   mountPath: /etc/my-configmap
     #   subPath: ""
+  # terminationGracePeriodSeconds defines duration in seconds the CN pod needs to terminate gracefully.
+  terminationGracePeriodSeconds: 120
 
 # spec for component be, provide storage and compute function.
 starrocksBeSpec:
@@ -448,6 +452,8 @@ starrocksBeSpec:
     # - name: my-configmap
     #   mountPath: /etc/my-configmap
     #   subPath: ""
+  # terminationGracePeriodSeconds defines duration in seconds the BE pod needs to terminate gracefully.
+  terminationGracePeriodSeconds: 120
 
 # create secrets if necessary.
 secrets: []

diff --git a/pkg/apis/starrocks/v1/load_type.go b/pkg/apis/starrocks/v1/load_type.go
@@ -1,6 +1,8 @@
 package v1
 
-import corev1 "k8s.io/api/core/v1"
+import (
+	corev1 "k8s.io/api/core/v1"
+)
 
 type loadInterface interface {
 	GetAnnotations() map[string]string
@@ -12,6 +14,7 @@ type loadInterface interface {
 	GetAffinity() *corev1.Affinity
 	GetTolerations() []corev1.Toleration
 	GetStartupProbeFailureSeconds() *int32
+	GetTerminationGracePeriodSeconds() *int64
 
 	GetStorageVolumes() []StorageVolume
 	GetServiceAccount() string
@@ -90,6 +93,17 @@ type StarRocksLoadSpec struct {
 	// will be rounded up
 	// +optional
 	StartupProbeFailureSeconds *int32 `json:"startupProbeFailureSeconds,omitempty"`
+
+	// TerminationGracePeriodSeconds defines duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.
+	// Value must be non-negative integer. The value zero indicates stop immediately via
+	// the kill signal (no opportunity to shut down).
+	// If this value is nil, the default grace period will be used instead.
+	// The grace period is the duration in seconds after the processes running in the pod are sent
+	// a termination signal and the time when the processes are forcibly halted with a kill signal.
+	// Set this value longer than the expected cleanup time for your process.
+	// Defaults to 120 seconds.
+	// +optional
+	TerminationGracePeriodSeconds *int64 `json:"terminationGracePeriodSeconds,omitempty"`
 }
 
 // StarRocksService defines external service for starrocks component.
@@ -198,3 +212,11 @@ func (spec *StarRocksLoadSpec) GetSchedulerName() string {
 func (spec *StarRocksLoadSpec) GetStartupProbeFailureSeconds() *int32 {
 	return spec.StartupProbeFailureSeconds
 }
+
+func (spec *StarRocksLoadSpec) GetTerminationGracePeriodSeconds() *int64 {
+	if spec.TerminationGracePeriodSeconds == nil {
+		v := int64(120)
+		return &v
+	}
+	return spec.TerminationGracePeriodSeconds
+}
diff --git a/pkg/apis/starrocks/v1/zz_generated.deepcopy.go b/pkg/apis/starrocks/v1/zz_generated.deepcopy.go
diff --git a/pkg/k8sutils/templates/pod/spec.go b/pkg/k8sutils/templates/pod/spec.go
@@ -384,7 +384,7 @@ func Spec(spec v1.SpecInterface, defaultServiceAccount string, container corev1.
 		Containers:                    []corev1.Container{container},
 		Volumes:                       volumes,
 		ServiceAccountName:            spec.GetServiceAccount(),
-		TerminationGracePeriodSeconds: rutils.GetInt64ptr(int64(120)),
+		TerminationGracePeriodSeconds: spec.GetTerminationGracePeriodSeconds(),
 		Affinity:                      spec.GetAffinity(),
 		Tolerations:                   spec.GetTolerations(),
 		ImagePullSecrets:              spec.GetImagePullSecrets(),