rename balance-key-range to balance-range

Signed-off-by: 童剑 <[email protected]>
bufferflies · Jan 15, 2025 · d86148f · d86148f
1 parent d0cfc2d
commit d86148f
Show file tree

Hide file tree

Showing 10 changed files with 28 additions and 35 deletions.
diff --git a/pkg/mcs/scheduling/server/cluster.go b/pkg/mcs/scheduling/server/cluster.go
@@ -316,7 +316,7 @@ func (c *Cluster) updateScheduler() {
 		for _, scheduler := range latestSchedulersConfig {
 			schedulerType, ok := types.ConvertOldStrToType[scheduler.Type]
 			if !ok {
-				log.Error("scheduler not found  ", zap.String("type", scheduler.Type))
+				log.Error("scheduler not found", zap.String("type", scheduler.Type))
 				continue
 			}
 			s, err := schedulers.CreateScheduler(

diff --git a/pkg/schedule/operator/kind.go b/pkg/schedule/operator/kind.go
@@ -35,8 +35,6 @@ const (
 	OpMerge
 	// Initiated by range scheduler.
 	OpRange
-	// Initiated by key range scheduler.
-	OpKeyRange
 	// Initiated by replica checker.
 	OpReplica
 	// Include region split. Initiated by rule checker if `kind & OpAdmin == 0`.
@@ -62,7 +60,6 @@ var flagToName = map[OpKind]string{
 	OpHotRegion:     "hot-region",
 	OpReplica:       "replica",
 	OpMerge:         "merge",
-	OpKeyRange:      "key-range",
 	OpRange:         "range",
 	OpWitness:       "witness",
 	OpWitnessLeader: "witness-leader",
@@ -77,7 +74,6 @@ var nameToFlag = map[string]OpKind{
 	"replica":        OpReplica,
 	"merge":          OpMerge,
 	"range":          OpRange,
-	"key-range":      OpKeyRange,
 	"witness-leader": OpWitnessLeader,
 }
 

diff --git a/pkg/schedule/operator/operator_test.go b/pkg/schedule/operator/operator_test.go
@@ -476,9 +476,6 @@ func (suite *operatorTestSuite) TestSchedulerKind() {
 		}, {
 			op:     NewTestOperator(1, &metapb.RegionEpoch{}, OpLeader),
 			expect: OpLeader,
-		}, {
-			op:     NewTestOperator(1, &metapb.RegionEpoch{}, OpKeyRange|OpLeader),
-			expect: OpKeyRange,
 		},
 	}
 	for _, v := range testData {

diff --git a/pkg/schedule/schedulers/balance_key_range.go b/pkg/schedule/schedulers/balance_key_range.go
@@ -121,9 +121,9 @@ func (*balanceKeyRangeScheduler) Schedule(_cluster sche.SchedulerCluster, _dryRu
 
 // IsScheduleAllowed checks if the scheduler is allowed to schedule new operators.
 func (s *balanceKeyRangeScheduler) IsScheduleAllowed(cluster sche.SchedulerCluster) bool {
-	allowed := s.OpController.OperatorCount(operator.OpKeyRange) < cluster.GetSchedulerConfig().GetRegionScheduleLimit()
+	allowed := s.OpController.OperatorCount(operator.OpRange) < cluster.GetSchedulerConfig().GetRegionScheduleLimit()
 	if !allowed {
-		operator.IncOperatorLimitCounter(s.GetType(), operator.OpKeyRange)
+		operator.IncOperatorLimitCounter(s.GetType(), operator.OpRange)
 	}
 	return allowed
 }
@@ -135,7 +135,7 @@ type BalanceKeyRangeCreateOption func(s *balanceKeyRangeScheduler)
 // special store balanced.
 func newBalanceKeyRangeScheduler(opController *operator.Controller, conf *balanceKeyRangeSchedulerConfig, options ...BalanceKeyRangeCreateOption) Scheduler {
 	s := &balanceKeyRangeScheduler{
-		BaseScheduler: NewBaseScheduler(opController, types.BalanceKeyRangeScheduler, conf),
+		BaseScheduler: NewBaseScheduler(opController, types.BalanceRangeScheduler, conf),
 		conf:          conf,
 		handler:       newBalanceKeyRangeHandler(conf),
 	}

diff --git a/pkg/schedule/schedulers/init.go b/pkg/schedule/schedulers/init.go
@@ -550,7 +550,7 @@ func schedulersRegister() {
 
 	// balance key range scheduler
 	// args: [role, engine, timeout, range1, range2, ...]
-	RegisterSliceDecoderBuilder(types.BalanceKeyRangeScheduler, func(args []string) ConfigDecoder {
+	RegisterSliceDecoderBuilder(types.BalanceRangeScheduler, func(args []string) ConfigDecoder {
 		return func(v any) error {
 			conf, ok := v.(*balanceKeyRangeSchedulerConfig)
 			if !ok {
@@ -587,7 +587,7 @@ func schedulersRegister() {
 		}
 	})
 
-	RegisterScheduler(types.BalanceKeyRangeScheduler, func(opController *operator.Controller,
+	RegisterScheduler(types.BalanceRangeScheduler, func(opController *operator.Controller,
 		storage endpoint.ConfigStorage, decoder ConfigDecoder, _ ...func(string) error) (Scheduler, error) {
 		conf := &balanceKeyRangeSchedulerConfig{
 			schedulerConfig: newBaseDefaultSchedulerConfig(),

diff --git a/pkg/schedule/types/type.go b/pkg/schedule/types/type.go
@@ -70,8 +70,8 @@ const (
 	TransferWitnessLeaderScheduler CheckerSchedulerType = "transfer-witness-leader-scheduler"
 	// LabelScheduler is label scheduler name.
 	LabelScheduler CheckerSchedulerType = "label-scheduler"
-	// BalanceKeyRangeScheduler is balance key range scheduler name.
-	BalanceKeyRangeScheduler CheckerSchedulerType = "balance-key-range-scheduler"
+	// BalanceRangeScheduler is balance key range scheduler name.
+	BalanceRangeScheduler CheckerSchedulerType = "balance-range-scheduler"
 )
 
 // TODO: SchedulerTypeCompatibleMap and ConvertOldStrToType should be removed after
@@ -99,7 +99,7 @@ var (
 		SplitBucketScheduler:           "split-bucket",
 		TransferWitnessLeaderScheduler: "transfer-witness-leader",
 		LabelScheduler:                 "label",
-		BalanceKeyRangeScheduler:       "balance-key-range",
+		BalanceRangeScheduler:          "balance-range",
 	}
 
 	// ConvertOldStrToType exists for compatibility.
@@ -123,7 +123,7 @@ var (
 		"split-bucket":            SplitBucketScheduler,
 		"transfer-witness-leader": TransferWitnessLeaderScheduler,
 		"label":                   LabelScheduler,
-		"balance-key-range":       BalanceKeyRangeScheduler,
+		"balance-range":           BalanceRangeScheduler,
 	}
 
 	// StringToSchedulerType is a map to convert the scheduler string to the CheckerSchedulerType.
@@ -147,7 +147,7 @@ var (
 		"split-bucket-scheduler":            SplitBucketScheduler,
 		"transfer-witness-leader-scheduler": TransferWitnessLeaderScheduler,
 		"label-scheduler":                   LabelScheduler,
-		"balance-key-range-scheduler":       BalanceKeyRangeScheduler,
+		"balance-range-scheduler":           BalanceRangeScheduler,
 	}
 
 	// DefaultSchedulers is the default scheduler types.

diff --git a/server/api/scheduler.go b/server/api/scheduler.go
@@ -99,7 +99,7 @@ func (h *schedulerHandler) CreateScheduler(w http.ResponseWriter, r *http.Reques
 	}
 
 	switch tp {
-	case types.BalanceKeyRangeScheduler:
+	case types.BalanceRangeScheduler:
 		exist, _ := h.IsSchedulerExisted(name)
 		if exist {
 			h.r.JSON(w, http.StatusBadRequest, "The scheduler already exists, pls remove the exist scheduler first.")

diff --git a/server/cluster/cluster_test.go b/server/cluster/cluster_test.go
@@ -3209,10 +3209,10 @@ func TestAddScheduler(t *testing.T) {
 	re.NoError(err)
 	re.NoError(controller.AddScheduler(gls))
 
-	_, err = schedulers.CreateScheduler(types.BalanceKeyRangeScheduler, oc, storage.NewStorageWithMemoryBackend(), schedulers.ConfigSliceDecoder(types.BalanceKeyRangeScheduler, []string{}), controller.RemoveScheduler)
+	_, err = schedulers.CreateScheduler(types.BalanceRangeScheduler, oc, storage.NewStorageWithMemoryBackend(), schedulers.ConfigSliceDecoder(types.BalanceRangeScheduler, []string{}), controller.RemoveScheduler)
 	re.Error(err)
 
-	gls, err = schedulers.CreateScheduler(types.BalanceKeyRangeScheduler, oc, storage.NewStorageWithMemoryBackend(), schedulers.ConfigSliceDecoder(types.BalanceKeyRangeScheduler, []string{"learner", "tiflash", "1h", "100", "200"}), controller.RemoveScheduler)
+	gls, err = schedulers.CreateScheduler(types.BalanceRangeScheduler, oc, storage.NewStorageWithMemoryBackend(), schedulers.ConfigSliceDecoder(types.BalanceRangeScheduler, []string{"learner", "tiflash", "1h", "100", "200"}), controller.RemoveScheduler)
 	re.NoError(err)
 	re.NoError(controller.AddScheduler(gls))
 	conf, err = gls.EncodeConfig()

diff --git a/tools/pd-ctl/pdctl/command/scheduler.go b/tools/pd-ctl/pdctl/command/scheduler.go
@@ -162,7 +162,7 @@ func NewAddSchedulerCommand() *cobra.Command {
 	c.AddCommand(NewSlowTrendEvictLeaderSchedulerCommand())
 	c.AddCommand(NewBalanceWitnessSchedulerCommand())
 	c.AddCommand(NewTransferWitnessLeaderSchedulerCommand())
-	c.AddCommand(NewBalanceKeyRangeSchedulerCommand())
+	c.AddCommand(NewBalanceRangeSchedulerCommand())
 	return c
 }
 
@@ -375,12 +375,12 @@ func NewBalanceWitnessSchedulerCommand() *cobra.Command {
 	return c
 }
 
-// NewBalanceKeyRangeSchedulerCommand returns a command to add a balance-key-range-scheduler.
-func NewBalanceKeyRangeSchedulerCommand() *cobra.Command {
+// NewBalanceRangeSchedulerCommand returns a command to add a balance-key-range-scheduler.
+func NewBalanceRangeSchedulerCommand() *cobra.Command {
 	c := &cobra.Command{
-		Use:   "balance-key-range-scheduler [--format=raw|encode|hex] <engine> <role> <start_key> <end_key>",
-		Short: "add a scheduler to balance region for given key range",
-		Run:   addSchedulerForBalanceKeyRangeCommandFunc,
+		Use:   "balance-range-scheduler [--format=raw|encode|hex] <engine> <role> <start_key> <end_key>",
+		Short: "add a scheduler to balance region for given range",
+		Run:   addSchedulerForBalanceRangeCommandFunc,
 	}
 	c.Flags().String("format", "hex", "the key format")
 	return c
@@ -424,7 +424,7 @@ func addSchedulerForGrantHotRegionCommandFunc(cmd *cobra.Command, args []string)
 	postJSON(cmd, schedulersPrefix, input)
 }
 
-func addSchedulerForBalanceKeyRangeCommandFunc(cmd *cobra.Command, args []string) {
+func addSchedulerForBalanceRangeCommandFunc(cmd *cobra.Command, args []string) {
 	if len(args) != 4 {
 		cmd.Println(cmd.UsageString())
 		return
@@ -588,8 +588,8 @@ func newConfigBalanceLeaderCommand() *cobra.Command {
 
 func newConfigBalanceKeyRangeCommand() *cobra.Command {
 	c := &cobra.Command{
-		Use:   "balance-key-range-scheduler",
-		Short: "balance-key-range-scheduler config",
+		Use:   "balance-range-scheduler",
+		Short: "balance-range-scheduler config",
 		Run:   listSchedulerConfigCommandFunc,
 	}
 

diff --git a/tools/pd-ctl/tests/scheduler/scheduler_test.go b/tools/pd-ctl/tests/scheduler/scheduler_test.go
@@ -543,24 +543,24 @@ func (suite *schedulerTestSuite) checkSchedulerConfig(cluster *pdTests.TestClust
 	})
 
 	// test balance key range scheduler
-	echo = mustExec(re, cmd, []string{"-u", pdAddr, "scheduler", "add", "balance-key-range-scheduler"}, nil)
+	echo = mustExec(re, cmd, []string{"-u", pdAddr, "scheduler", "add", "balance-range-scheduler"}, nil)
 	re.NotContains(echo, "Success!")
-	echo = mustExec(re, cmd, []string{"-u", pdAddr, "scheduler", "add", "balance-key-range-scheduler", "--format=raw", "tiflash", "learner", "a", "b"}, nil)
+	echo = mustExec(re, cmd, []string{"-u", pdAddr, "scheduler", "add", "balance-range-scheduler", "--format=raw", "tiflash", "learner", "a", "b"}, nil)
 	re.Contains(echo, "Success!")
 	conf = make(map[string]any)
 	testutil.Eventually(re, func() bool {
-		mightExec(re, cmd, []string{"-u", pdAddr, "scheduler", "config", "balance-key-range-scheduler"}, &conf)
+		mightExec(re, cmd, []string{"-u", pdAddr, "scheduler", "config", "balance-range-scheduler"}, &conf)
 		return conf["role"] == "learner" && conf["engine"] == "tiflash"
 	})
 	re.Equal(float64(time.Hour.Nanoseconds()), conf["timeout"])
 	ranges := conf["ranges"].([]any)[0].(map[string]any)
 	re.Equal(base64.StdEncoding.EncodeToString([]byte("a")), ranges["start-key"])
 	re.Equal(base64.StdEncoding.EncodeToString([]byte("b")), ranges["end-key"])
 
-	echo = mustExec(re, cmd, []string{"-u", pdAddr, "scheduler", "add", "balance-key-range-scheduler", "--format=raw", "tiflash", "learner", "a", "b"}, nil)
+	echo = mustExec(re, cmd, []string{"-u", pdAddr, "scheduler", "add", "balance-range-scheduler", "--format=raw", "tiflash", "learner", "a", "b"}, nil)
 	re.Contains(echo, "400")
 	re.Contains(echo, "scheduler already exists")
-	echo = mustExec(re, cmd, []string{"-u", pdAddr, "scheduler", "remove", "balance-key-range-scheduler"}, nil)
+	echo = mustExec(re, cmd, []string{"-u", pdAddr, "scheduler", "remove", "balance-range-scheduler"}, nil)
 	re.Contains(echo, "Success!")
 
 	// test balance leader config