add cluster version check

Signed-off-by: pingyu <[email protected]>
pingcap · Sep 14, 2022 · 5304c07 · 5304c07
1 parent 2a4f063
commit 5304c07
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 3 deletions.
diff --git a/pkg/cluster/spec/tikv_cdc.go b/pkg/cluster/spec/tikv_cdc.go
@@ -20,11 +20,13 @@ import (
 	"path/filepath"
 	"time"
 
+	"github.com/pingcap/errors"
 	"github.com/pingcap/tiup/pkg/cluster/api"
 	"github.com/pingcap/tiup/pkg/cluster/ctxt"
 	"github.com/pingcap/tiup/pkg/cluster/template/scripts"
 	logprinter "github.com/pingcap/tiup/pkg/logger/printer"
 	"github.com/pingcap/tiup/pkg/meta"
+	"github.com/pingcap/tiup/pkg/tidbver"
 )
 
 // TiKVCDCSpec represents the TiKVCDC topology specification in topology.yaml
@@ -121,7 +123,7 @@ func (c *TiKVCDCComponent) Instances() []Instance {
 	return ins
 }
 
-// TiKVCDCInstance represent the CDC instance.
+// TiKVCDCInstance represent the TiKV-CDC instance.
 type TiKVCDCInstance struct {
 	BaseInstance
 	topo Topology
@@ -155,6 +157,10 @@ func (i *TiKVCDCInstance) InitConfig(
 	deployUser string,
 	paths meta.DirPaths,
 ) error {
+	if !tidbver.TiKVCDCSupportDeploy(clusterVersion) {
+		return errors.New("tikv-cdc only supports cluster version v6.2.0 or later")
+	}
+
 	topo := i.topo.(*Specification)
 	if err := i.BaseInstance.InitConfig(ctx, e, topo.GlobalOptions, deployUser, paths); err != nil {
 		return err
@@ -203,7 +209,7 @@ func (i *TiKVCDCInstance) setTLSConfig(ctx context.Context, enableTLS bool, conf
 
 var _ RollingUpdateInstance = &TiKVCDCInstance{}
 
-// GetAddr return the address of this TiCDC instance
+// GetAddr return the address of this TiKV-CDC instance
 func (i *TiKVCDCInstance) GetAddr() string {
 	return fmt.Sprintf("%s:%d", i.GetHost(), i.GetPort())
 }
@@ -224,7 +230,7 @@ func (i *TiKVCDCInstance) PreRestart(ctx context.Context, topo Topology, apiTime
 	address := i.GetAddr()
 	// cdc rolling upgrade strategy only works if there are more than 2 captures
 	if len(tidbTopo.TiKVCDCServers) <= 1 {
-		logger.Debugf("TiKV-CDC pre-restart skipped, only one capture in the topology, addr: %s", address)
+		logger.Debugf("tikv-cdc pre-restart skipped, only one capture in the topology, addr: %s", address)
 		return nil
 	}
 

diff --git a/pkg/tidbver/tidbver.go b/pkg/tidbver/tidbver.go
@@ -98,3 +98,9 @@ func DMSupportDeploy(version string) bool {
 	// tiup-dm only support version not less than v2.0
 	return semver.Compare(version, "v2.0.0") >= 0 || strings.Contains(version, "nightly")
 }
+
+// TiKVCDCSupportDeploy return if given version of TiDB/TiKV cluster is supported
+func TiKVCDCSupportDeploy(version string) bool {
+	// TiKV-CDC only support TiKV version not less than v6.2.0
+	return semver.Compare(version, "v6.2.0") >= 0 || strings.Contains(version, "nightly")
+}
diff --git a/tests/tiup-cluster/script/tikv_cdc.sh b/tests/tiup-cluster/script/tikv_cdc.sh
@@ -46,6 +46,11 @@ function tikv_cdc_test() {
 	ssh-add /root/.ssh/id_rsa
 
 	tiup-cluster check $topo --apply
+
+	# Test check version. Cluster version >= v6.2.0 is required.
+	# Error message: "Error: init config failed: n3:8600: tikv-cdc only supports cluster version v6.2.0 or later"
+	! tiup-cluster --yes deploy $name 6.1.0 $topo
+
 	tiup-cluster --yes deploy $name $version $topo
 
 	# check the local config