ticdc: support graceful upgrade TiCDC pods (#4647)

Author: overvenus

docs/api-references/docs.md

@@ -14521,6 +14521,22 @@ string
 Defaults to Kubernetes default storage class.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>gracefulShutdownTimeout</code></br>
+<em>
+<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
+Kubernetes meta/v1.Duration
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>GracefulShutdownTimeout is the timeout of gracefully shutdown a TiCDC pod.
+Encoded in the format of Go Duration.
+Defaults to 10m</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="ticdcstatus">TiCDCStatus</h3>

manifests/crd.yaml

@@ -21443,6 +21443,8 @@ spec:
                           type: object
                       type: object
                     type: array
+                  gracefulShutdownTimeout:
+                    type: string
                   hostNetwork:
                     type: boolean
                   image:

manifests/crd/v1/pingcap.com_tidbclusters.yaml

@@ -9134,6 +9134,8 @@ spec:
                           type: object
                       type: object
                     type: array
+                  gracefulShutdownTimeout:
+                    type: string
                   hostNetwork:
                     type: boolean
                   image:

manifests/crd/v1beta1/pingcap.com_tidbclusters.yaml

@@ -9122,6 +9122,8 @@ spec:
                         type: object
                     type: object
                   type: array
+                gracefulShutdownTimeout:
+                  type: string
                 hostNetwork:
                   type: boolean
                 image:

manifests/crd_v1beta1.yaml

@@ -21429,6 +21429,8 @@ spec:
                         type: object
                     type: object
                   type: array
+                gracefulShutdownTimeout:
+                  type: string
                 hostNetwork:
                   type: boolean
                 image:

pkg/apis/pingcap/v1alpha1/openapi_generated.go

@@ -38,6 +38,9 @@ const (
 	defaultEnablePVReclaim    = false
 	// defaultEvictLeaderTimeout is the timeout limit of evict leader
 	defaultEvictLeaderTimeout = 1500 * time.Minute
+	// defaultTiCDCGracefulShutdownTimeout is the timeout limit of graceful
+	// shutdown a TiCDC pod.
+	defaultTiCDCGracefulShutdownTimeout = 10 * time.Minute
 )
 
 var (
@@ -194,6 +197,14 @@ func (tc *TidbCluster) TiFlashVersion() string {
 	return "latest"
 }
 
+func (tc *TidbCluster) TiFlashContainerPrivilege() *bool {
+	if tc.Spec.TiFlash == nil || tc.Spec.TiFlash.Privileged == nil {
+		pri := false
+		return &pri
+	}
+	return tc.Spec.TiFlash.Privileged
+}
+
 // TiCDCImage return the image used by TiCDC.
 //
 // If TiCDC isn't specified, return empty string.
@@ -219,12 +230,13 @@ func (tc *TidbCluster) TiCDCImage() string {
 	return image
 }
 
-func (tc *TidbCluster) TiFlashContainerPrivilege() *bool {
-	if tc.Spec.TiFlash == nil || tc.Spec.TiFlash.Privileged == nil {
-		pri := false
-		return &pri
+// TiCDCGracefulShutdownTimeout returns the timeout of gracefully shutdown
+// a TiCDC pod.
+func (tc *TidbCluster) TiCDCGracefulShutdownTimeout() time.Duration {
+	if tc.Spec.TiCDC != nil && tc.Spec.TiCDC.GracefulShutdownTimeout != nil {
+		return tc.Spec.TiCDC.GracefulShutdownTimeout.Duration
 	}
-	return tc.Spec.TiFlash.Privileged
+	return defaultTiCDCGracefulShutdownTimeout
 }
 
 // TiDBImage return the image used by TiDB.

pkg/apis/pingcap/v1alpha1/tidbcluster.go

@@ -15,6 +15,7 @@ package v1alpha1
 
 import (
 	"testing"
+	"time"
 
 	. "github.com/onsi/gomega"
 	apps "k8s.io/api/apps/v1"
@@ -672,6 +673,19 @@ func TestPDVersion(t *testing.T) {
 	}
 }
 
+func TestTiCDCGracefulShutdownTimeout(t *testing.T) {
+	g := NewGomegaWithT(t)
+
+	tc := newTidbCluster()
+	g.Expect(tc.TiCDCGracefulShutdownTimeout()).To(Equal(defaultTiCDCGracefulShutdownTimeout))
+
+	tc.Spec.TiCDC = &TiCDCSpec{GracefulShutdownTimeout: nil}
+	g.Expect(tc.TiCDCGracefulShutdownTimeout()).To(Equal(defaultTiCDCGracefulShutdownTimeout))
+
+	tc.Spec.TiCDC = &TiCDCSpec{GracefulShutdownTimeout: &metav1.Duration{Duration: time.Minute}}
+	g.Expect(tc.TiCDCGracefulShutdownTimeout()).To(Equal(time.Minute))
+}
+
 func TestComponentFunc(t *testing.T) {
 	t.Run("ComponentIsNormal", func(t *testing.T) {
 		g := NewGomegaWithT(t)

pkg/apis/pingcap/v1alpha1/tidbcluster_test.go

@@ -680,6 +680,12 @@ type TiCDCSpec struct {
 	// Defaults to Kubernetes default storage class.
 	// +optional
 	StorageClassName *string `json:"storageClassName,omitempty"`
+
+	// GracefulShutdownTimeout is the timeout of gracefully shutdown a TiCDC pod.
+	// Encoded in the format of Go Duration.
+	// Defaults to 10m
+	// +optional
+	GracefulShutdownTimeout *metav1.Duration `json:"gracefulShutdownTimeout,omitempty"`
 }
 
 // TiCDCConfig is the configuration of tidbcdc