Add support for customizing terminationGracePeriodSeconds of the VTTa…

…blet pods Signed-off-by: Yohei Yoshimuta <[email protected]>
planetscale · Nov 6, 2023 · 8bb2c00 · 8bb2c00
1 parent f583949
commit 8bb2c00
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 1 deletion.
diff --git a/deploy/crds/planetscale.com_vitessclusters.yaml b/deploy/crds/planetscale.com_vitessclusters.yaml
@@ -1561,6 +1561,9 @@ spec:
                                                       x-kubernetes-int-or-string: true
                                                     type: object
                                                 type: object
+                                              terminationGracePeriodSeconds:
+                                                format: int64
+                                                type: integer
                                             required:
                                             - resources
                                             type: object
@@ -1960,6 +1963,9 @@ spec:
                                                     x-kubernetes-int-or-string: true
                                                   type: object
                                               type: object
+                                            terminationGracePeriodSeconds:
+                                              format: int64
+                                              type: integer
                                           required:
                                           - resources
                                           type: object

diff --git a/deploy/crds/planetscale.com_vitesskeyspaces.yaml b/deploy/crds/planetscale.com_vitesskeyspaces.yaml
@@ -609,6 +609,9 @@ spec:
                                                 x-kubernetes-int-or-string: true
                                               type: object
                                           type: object
+                                        terminationGracePeriodSeconds:
+                                          format: int64
+                                          type: integer
                                       required:
                                       - resources
                                       type: object
@@ -1008,6 +1011,9 @@ spec:
                                               x-kubernetes-int-or-string: true
                                             type: object
                                         type: object
+                                      terminationGracePeriodSeconds:
+                                        format: int64
+                                        type: integer
                                     required:
                                     - resources
                                     type: object

diff --git a/deploy/crds/planetscale.com_vitessshards.yaml b/deploy/crds/planetscale.com_vitessshards.yaml
@@ -592,6 +592,9 @@ spec:
                                 x-kubernetes-int-or-string: true
                               type: object
                           type: object
+                        terminationGracePeriodSeconds:
+                          format: int64
+                          type: integer
                       required:
                       - resources
                       type: object

diff --git a/docs/api/index.html b/docs/api/index.html
@@ -7892,6 +7892,18 @@ <h3 id="planetscale.com/v2.VttabletSpec">VttabletSpec
 to vttablet container</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>terminationGracePeriodSeconds</code></br>
+<em>
+int64
+</em>
+</td>
+<td>
+<p>TerminationGracePeriodSeconds can optionally be used to customize
+terminationGracePeriodSeconds of the vttablet pod.</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="planetscale.com/v2.WorkflowState">WorkflowState

diff --git a/pkg/apis/planetscale/v2/vitessshard_types.go b/pkg/apis/planetscale/v2/vitessshard_types.go
@@ -292,6 +292,10 @@ type VttabletSpec struct {
 	// +kubebuilder:validation:Schemaless
 	// +kubebuilder:pruning:PreserveUnknownFields
 	Lifecycle corev1.Lifecycle `json:"lifecycle,omitempty"`
+
+	// TerminationGracePeriodSeconds can optionally be used to customize
+	// terminationGracePeriodSeconds of the vttablet pod.
+	TerminationGracePeriodSeconds *int64 `json:"terminationGracePeriodSeconds,omitempty"`
 }
 
 // MysqldSpec configures the local MySQL server within a tablet.

diff --git a/pkg/apis/planetscale/v2/zz_generated.deepcopy.go b/pkg/apis/planetscale/v2/zz_generated.deepcopy.go
diff --git a/pkg/operator/vttablet/pod.go b/pkg/operator/vttablet/pod.go
@@ -313,7 +313,11 @@ func UpdatePod(obj *corev1.Pod, spec *Spec) {
 		obj.Spec.SecurityContext.FSGroup = pointer.Int64Ptr(planetscalev2.DefaultVitessFSGroup)
 	}
 
-	obj.Spec.TerminationGracePeriodSeconds = pointer.Int64Ptr(terminationGracePeriodSeconds)
+	if spec.Vttablet.TerminationGracePeriodSeconds != nil {
+		obj.Spec.TerminationGracePeriodSeconds = spec.Vttablet.TerminationGracePeriodSeconds
+	} else {
+		obj.Spec.TerminationGracePeriodSeconds = pointer.Int64Ptr(terminationGracePeriodSeconds)
+	}
 
 	// In both the case of the user injecting their own affinity and the default, we
 	// simply override the pod's existing affinity configuration.

diff --git a/test/integration/vitesscluster/vitesscluster_test.go b/test/integration/vitesscluster/vitesscluster_test.go
@@ -51,6 +51,8 @@ spec:
           - cell: cell1
             type: replica
             replicas: 3
+            vttablet:
+              terminationGracePeriodSeconds: 60
             mysqld: {}
             dataVolumeClaimTemplate:
               accessModes: [ReadWriteOnce]
@@ -219,9 +221,15 @@ func verifyBasicVitessShard(f *framework.Fixture, ns, cluster, keyspace, shard s
 	// Each vttablet Pod should have a PVC.
 	for i := range cell1Pods.Items {
 		f.MustGet(ns, cell1Pods.Items[i].Name, &corev1.PersistentVolumeClaim{})
+		if *cell1Pods.Items[i].Spec.TerminationGracePeriodSeconds != 60 {
+			f.Fatalf("TerminationGracePeriodSeconds should be 60, but got %d", *cell1Pods.Items[i].Spec.TerminationGracePeriodSeconds)
+		}
 	}
 	for i := range cell2Pods.Items {
 		f.MustGet(ns, cell2Pods.Items[i].Name, &corev1.PersistentVolumeClaim{})
+		if *cell2Pods.Items[i].Spec.TerminationGracePeriodSeconds != 1800 {
+			f.Fatalf("TerminationGracePeriodSeconds should be 1800, but got %d", *cell2Pods.Items[i].Spec.TerminationGracePeriodSeconds)
+		}
 	}
 
 	// VitessShard creates vtbackup-init Pod/PVC.