fix

Signed-off-by: Ryan Leung <[email protected]>

client/servicediscovery/service_discovery.go

@@ -74,7 +74,7 @@ const (
 type serviceType int
 
 const (
-	apiService serviceType = iota
+	pdService serviceType = iota
 	tsoService
 )
 
@@ -678,7 +678,7 @@ func (*serviceDiscovery) GetKeyspaceGroupID() uint32 {
 // DiscoverMicroservice discovers the microservice with the specified type and returns the server urls.
 func (c *serviceDiscovery) discoverMicroservice(svcType serviceType) (urls []string, err error) {
 	switch svcType {
-	case apiService:
+	case pdService:
 		urls = c.GetServiceURLs()
 	case tsoService:
 		leaderURL := c.getLeaderURL()

pkg/mcs/registry/registry.go

@@ -85,18 +85,18 @@ func (r *ServiceRegistry) InstallAllRESTHandler(srv bs.Server, h map[string]http
 		serviceName := createServiceName(prefix, name)
 		if l, ok := r.services[serviceName]; ok {
 			if err := l.RegisterRESTHandler(h); err != nil {
-				log.Error("register restful PD service failed", zap.String("prefix", prefix), zap.String("service-name", name), zap.Error(err))
+				log.Error("register restful service failed", zap.String("prefix", prefix), zap.String("service-name", name), zap.Error(err))
 			} else {
-				log.Info("restful PD service already registered", zap.String("prefix", prefix), zap.String("service-name", name))
+				log.Info("restful service already registered", zap.String("prefix", prefix), zap.String("service-name", name))
 			}
 			continue
 		}
 		l := builder(srv)
 		r.services[serviceName] = l
 		if err := l.RegisterRESTHandler(h); err != nil {
-			log.Error("register restful PD service failed", zap.String("prefix", prefix), zap.String("service-name", name), zap.Error(err))
+			log.Error("register restful service failed", zap.String("prefix", prefix), zap.String("service-name", name), zap.Error(err))
 		} else {
-			log.Info("restful PD service registered successfully", zap.String("prefix", prefix), zap.String("service-name", name))
+			log.Info("restful service registered successfully", zap.String("prefix", prefix), zap.String("service-name", name))
 		}
 	}
 }

pkg/mcs/scheduling/server/cluster.go

@@ -257,8 +257,8 @@ func (c *Cluster) triggerMembershipCheck() {
 	}
 }
 
-// SwitchPDServiceLeader switches the PD service leader.
-func (c *Cluster) SwitchPDServiceLeader(new pdpb.PDClient) bool {
+// SwitchPDLeader switches the PD leader.
+func (c *Cluster) SwitchPDLeader(new pdpb.PDClient) bool {
 	old := c.pdLeader.Load()
 	return c.pdLeader.CompareAndSwap(old, new)
 }

pkg/mcs/scheduling/server/config/config.go

@@ -243,7 +243,7 @@ func NewPersistConfig(cfg *Config, ttl *cache.TTLString) *PersistConfig {
 	o.SetClusterVersion(&cfg.ClusterVersion)
 	o.schedule.Store(&cfg.Schedule)
 	o.replication.Store(&cfg.Replication)
-	// storeConfig will be fetched from TiKV by PD service,
+	// storeConfig will be fetched from TiKV by PD,
 	// so we just set an empty value here first.
 	o.storeConfig.Store(&sc.StoreConfig{})
 	o.ttl = ttl
@@ -748,11 +748,11 @@ func (o *PersistConfig) IsRaftKV2() bool {
 // TODO: implement the following methods
 
 // AddSchedulerCfg adds the scheduler configurations.
-// This method is a no-op since we only use configurations derived from one-way synchronization from PD service now.
+// This method is a no-op since we only use configurations derived from one-way synchronization from PD now.
 func (*PersistConfig) AddSchedulerCfg(types.CheckerSchedulerType, []string) {}
 
 // RemoveSchedulerCfg removes the scheduler configurations.
-// This method is a no-op since we only use configurations derived from one-way synchronization from PD service now.
+// This method is a no-op since we only use configurations derived from one-way synchronization from PD now.
 func (*PersistConfig) RemoveSchedulerCfg(types.CheckerSchedulerType) {}
 
 // CheckLabelProperty checks if the label property is satisfied.

pkg/mcs/scheduling/server/config/watcher.go

@@ -36,7 +36,7 @@ import (
 	"github.com/tikv/pd/pkg/utils/keypath"
 )
 
-// Watcher is used to watch the PD service for any configuration changes.
+// Watcher is used to watch the PD for any configuration changes.
 type Watcher struct {
 	wg     sync.WaitGroup
 	ctx    context.Context
@@ -76,7 +76,7 @@ type persistedConfig struct {
 	Store          sc.StoreConfig       `json:"store"`
 }
 
-// NewWatcher creates a new watcher to watch the config meta change from PD service.
+// NewWatcher creates a new watcher to watch the config meta change from PD.
 func NewWatcher(
 	ctx context.Context,
 	etcdClient *clientv3.Client,

pkg/mcs/scheduling/server/grpc_service.go

@@ -159,7 +159,7 @@ func (s *Service) RegionHeartbeat(stream schedulingpb.Scheduling_RegionHeartbeat
 		region := core.RegionFromHeartbeat(request, 0)
 		err = c.HandleRegionHeartbeat(region)
 		if err != nil {
-			// TODO: if we need to send the error back to PD service.
+			// TODO: if we need to send the error back to PD.
 			log.Error("failed handle region heartbeat", zap.Error(err))
 			continue
 		}

pkg/mcs/scheduling/server/meta/watcher.go

@@ -33,7 +33,7 @@ import (
 	"github.com/tikv/pd/pkg/utils/keypath"
 )
 
-// Watcher is used to watch the PD service for any meta changes.
+// Watcher is used to watch the PD for any meta changes.
 type Watcher struct {
 	wg     sync.WaitGroup
 	ctx    context.Context
@@ -48,7 +48,7 @@ type Watcher struct {
 	storeWatcher *etcdutil.LoopWatcher
 }
 
-// NewWatcher creates a new watcher to watch the meta change from PD service.
+// NewWatcher creates a new watcher to watch the meta change from PD.
 func NewWatcher(
 	ctx context.Context,
 	etcdClient *clientv3.Client,

pkg/mcs/scheduling/server/rule/watcher.go

@@ -34,7 +34,7 @@ import (
 	"github.com/tikv/pd/pkg/utils/keypath"
 )
 
-// Watcher is used to watch the PD service for any Placement Rule changes.
+// Watcher is used to watch the PD for any Placement Rule changes.
 type Watcher struct {
 	ctx    context.Context
 	cancel context.CancelFunc
@@ -74,7 +74,7 @@ type Watcher struct {
 	patch *placement.RuleConfigPatch
 }
 
-// NewWatcher creates a new watcher to watch the Placement Rule change from PD service.
+// NewWatcher creates a new watcher to watch the Placement Rule change from PD.
 func NewWatcher(
 	ctx context.Context,
 	etcdClient *clientv3.Client,

pkg/mcs/scheduling/server/server.go

@@ -110,7 +110,7 @@ type Server struct {
 	hbStreams *hbstream.HeartbeatStreams
 	storage   *endpoint.StorageEndpoint
 
-	// for watching the PD service meta info updates that are related to the scheduling.
+	// for watching the PD meta info updates that are related to the scheduling.
 	configWatcher *config.Watcher
 	ruleWatcher   *rule.Watcher
 	metaWatcher   *meta.Watcher
@@ -169,10 +169,10 @@ func (s *Server) startServerLoop() {
 	s.serverLoopCtx, s.serverLoopCancel = context.WithCancel(s.Context())
 	s.serverLoopWg.Add(2)
 	go s.primaryElectionLoop()
-	go s.updatePDServiceMemberLoop()
+	go s.updatePDMemberLoop()
 }
 
-func (s *Server) updatePDServiceMemberLoop() {
+func (s *Server) updatePDMemberLoop() {
 	defer logutil.LogPanic()
 	defer s.serverLoopWg.Done()
 
@@ -220,7 +220,7 @@ func (s *Server) updatePDServiceMemberLoop() {
 					// double check
 					break
 				}
-				if s.cluster.SwitchPDServiceLeader(pdpb.NewPDClient(cc)) {
+				if s.cluster.SwitchPDLeader(pdpb.NewPDClient(cc)) {
 					if status.Leader != curLeader {
 						log.Info("switch leader", zap.String("leader-id", fmt.Sprintf("%x", ep.ID)), zap.String("endpoint", ep.ClientURLs[0]))
 					}

pkg/member/election_leader.go

@@ -21,7 +21,7 @@ import (
 )
 
 // ElectionLeader defines the common interface of the leader, which is the pdpb.Member
-// for in PD/PD service or the tsopb.Participant in the microservices.
+// for in PD or the tsopb.Participant in the microservices.
 type ElectionLeader interface {
 	// GetListenUrls returns the listen urls
 	GetListenUrls() []string

pkg/schedule/coordinator.go

@@ -389,7 +389,7 @@ func (c *Coordinator) LoadPlugin(pluginPath string, ch chan string) {
 		return
 	}
 	log.Info("create scheduler", zap.String("scheduler-name", s.GetName()))
-	// TODO: handle the plugin in PD service mode.
+	// TODO: handle the plugin in microservice env.
 	if err = c.schedulers.AddScheduler(s); err != nil {
 		log.Error("can't add scheduler", zap.String("scheduler-name", s.GetName()), errs.ZapError(err))
 		return

pkg/schedule/schedulers/scheduler_controller.go

@@ -52,10 +52,10 @@ type Controller struct {
 	cluster sche.SchedulerCluster
 	storage endpoint.ConfigStorage
 	// schedulers are used to manage all schedulers, which will only be initialized
-	// and used in the PD leader service mode now.
+	// and used in the non-microservice env now.
 	schedulers map[string]*ScheduleController
 	// schedulerHandlers is used to manage the HTTP handlers of schedulers,
-	// which will only be initialized and used in the PD service mode now.
+	// which will only be initialized and used in the microservice env now.
 	schedulerHandlers map[string]http.Handler
 	opController      *operator.Controller
 }

pkg/storage/endpoint/cluster_id.go

@@ -129,7 +129,7 @@ func InitClusterIDForMs(ctx context.Context, client *clientv3.Client) (err error
 	defer ticker.Stop()
 	retryTimes := 0
 	for {
-		// Microservice should not generate cluster ID by itself.
+		// Micro service should not generate cluster ID by itself.
 		if clusterID, err := getClusterIDFromEtcd(client); err == nil && clusterID != 0 {
 			keypath.SetClusterID(clusterID)
 			log.Info("init cluster id", zap.Uint64("cluster-id", clusterID))

pkg/tso/keyspace_group_manager.go

@@ -334,7 +334,7 @@ type KeyspaceGroupManager struct {
 	// Value: discover.ServiceRegistryEntry
 	tsoServiceKey string
 	// legacySvcRootPath defines the legacy root path for all etcd paths which derives from
-	// the PD/PD service. It's in the format of "/pd/{cluster_id}".
+	// the PD. It's in the format of "/pd/{cluster_id}".
 	// The main paths for different usages include:
 	// 1. The path, used by the default keyspace group, for LoadTimestamp/SaveTimestamp in the
 	//    storage endpoint.

pkg/utils/apiutil/serverapi/middleware.go

@@ -224,7 +224,7 @@ func (h *redirector) ServeHTTP(w http.ResponseWriter, r *http.Request, next http
 		clientUrls = leader.GetClientUrls()
 		r.Header.Set(apiutil.PDRedirectorHeader, h.s.Name())
 	} else {
-		// Prevent more than one redirection among PD/PD service.
+		// Prevent more than one redirection among PD.
 		log.Error("redirect but server is not leader", zap.String("from", name), zap.String("server", h.s.Name()), errs.ZapError(errs.ErrRedirectToNotLeader))
 		http.Error(w, errs.ErrRedirectToNotLeader.FastGenByArgs().Error(), http.StatusInternalServerError)
 		return

pkg/utils/keypath/key_path.go

@@ -321,7 +321,7 @@ func svcRootPath(svcName string) string {
 	return path.Join(constant.MicroserviceRootPath, c, svcName)
 }
 
-// LegacyRootPath returns the root path of legacy pd service.
+// LegacyRootPath returns the root path of legacy PD.
 // Path: /pd/{cluster_id}
 func LegacyRootPath() string {
 	return path.Join(pdRootPath, strconv.FormatUint(ClusterID(), 10))

server/api/admin.go

@@ -254,5 +254,5 @@ func (h *adminHandler) deleteRegionCacheInSchedulingServer(id ...uint64) error {
 }
 
 func buildMsg(err error) string {
-	return fmt.Sprintf("This operation was executed in PD service but needs to be re-executed on scheduling server due to the following error: %s", err.Error())
+	return fmt.Sprintf("This operation was executed in PD but needs to be re-executed on scheduling server due to the following error: %s", err.Error())
 }

server/api/server.go

@@ -63,7 +63,7 @@ func NewHandler(_ context.Context, svr *server.Server) (http.Handler, apiutil.AP
 	// Following requests are **not** redirected:
 	//	"/schedulers", http.MethodPost
 	//	"/schedulers/{name}", http.MethodDelete
-	//  Because the writing of all the config of the scheduling service is in the PD service,
+	//  Because the writing of all the config of the scheduling service is in the PD,
 	// 	we should not post and delete the scheduler directly in the scheduling service.
 	router.PathPrefix(apiPrefix).Handler(negroni.New(
 		serverapi.NewRuntimeServiceValidator(svr, group),
@@ -153,7 +153,7 @@ func NewHandler(_ context.Context, svr *server.Server) (http.Handler, apiutil.AP
 				scheapi.APIPathPrefix+"/config/placement-rule",
 				constant.SchedulingServiceName,
 				[]string{http.MethodGet}),
-			// because the writing of all the meta information of the scheduling service is in the PD service,
+			// because the writing of all the meta information of the scheduling service is in the PD,
 			// we should not post and delete the scheduler directly in the scheduling service.
 			serverapi.MicroserviceRedirectRule(
 				prefix+"/schedulers",

server/config/config.go

@@ -860,7 +860,7 @@ func (c *MicroserviceConfig) Clone() *MicroserviceConfig {
 	return &cfg
 }
 
-// IsSchedulingFallbackEnabled returns whether to enable scheduling service fallback to PD service.
+// IsSchedulingFallbackEnabled returns whether to enable scheduling service fallback to PD.
 func (c *MicroserviceConfig) IsSchedulingFallbackEnabled() bool {
 	return c.EnableSchedulingFallback
 }

server/config/service_middleware_config.go

@@ -22,7 +22,7 @@ const (
 	defaultEnableGRPCRateLimitMiddleware = true
 )
 
-// ServiceMiddlewareConfig is the configuration for PD Service middleware.
+// ServiceMiddlewareConfig is the configuration for PD middleware.
 type ServiceMiddlewareConfig struct {
 	AuditConfig         `json:"audit"`
 	RateLimitConfig     `json:"rate-limit"`

server/config/service_middleware_persist_options.go

@@ -40,12 +40,12 @@ func NewServiceMiddlewarePersistOptions(cfg *ServiceMiddlewareConfig) *ServiceMi
 	return o
 }
 
-// GetAuditConfig returns pd service middleware configurations.
+// GetAuditConfig returns PD middleware configurations.
 func (o *ServiceMiddlewarePersistOptions) GetAuditConfig() *AuditConfig {
 	return o.audit.Load().(*AuditConfig)
 }
 
-// SetAuditConfig sets the PD service middleware configuration.
+// SetAuditConfig sets the PD middleware configuration.
 func (o *ServiceMiddlewarePersistOptions) SetAuditConfig(cfg *AuditConfig) {
 	o.audit.Store(cfg)
 }
@@ -55,12 +55,12 @@ func (o *ServiceMiddlewarePersistOptions) IsAuditEnabled() bool {
 	return o.GetAuditConfig().EnableAudit
 }
 
-// GetRateLimitConfig returns pd service middleware configurations.
+// GetRateLimitConfig returns PD middleware configurations.
 func (o *ServiceMiddlewarePersistOptions) GetRateLimitConfig() *RateLimitConfig {
 	return o.rateLimit.Load().(*RateLimitConfig)
 }
 
-// SetRateLimitConfig sets the PD service middleware configuration.
+// SetRateLimitConfig sets the PD middleware configuration.
 func (o *ServiceMiddlewarePersistOptions) SetRateLimitConfig(cfg *RateLimitConfig) {
 	o.rateLimit.Store(cfg)
 }
@@ -70,12 +70,12 @@ func (o *ServiceMiddlewarePersistOptions) IsRateLimitEnabled() bool {
 	return o.GetRateLimitConfig().EnableRateLimit
 }
 
-// GetGRPCRateLimitConfig returns pd service middleware configurations.
+// GetGRPCRateLimitConfig returns PD middleware configurations.
 func (o *ServiceMiddlewarePersistOptions) GetGRPCRateLimitConfig() *GRPCRateLimitConfig {
 	return o.grpcRateLimit.Load().(*GRPCRateLimitConfig)
 }
 
-// SetGRPCRateLimitConfig sets the PD service middleware configuration.
+// SetGRPCRateLimitConfig sets the PD middleware configuration.
 func (o *ServiceMiddlewarePersistOptions) SetGRPCRateLimitConfig(cfg *GRPCRateLimitConfig) {
 	o.grpcRateLimit.Store(cfg)
 }

server/grpc_service.go

@@ -271,8 +271,8 @@ func (s *GrpcServer) GetClusterInfo(context.Context, *pdpb.GetClusterInfoRequest
 	}, nil
 }
 
-// GetMinTS implements gRPC PDServer. In PD mode, it simply returns a timestamp.
-// In PD service mode, it queries all tso servers and gets the minimum timestamp across
+// GetMinTS implements gRPC PDServer. In normal PD, it simply returns a timestamp.
+// If the tso server exist, it queries all tso servers and gets the minimum timestamp across
 // all keyspace groups.
 func (s *GrpcServer) GetMinTS(
 	ctx context.Context, request *pdpb.GetMinTSRequest,

server/util.go

@@ -119,7 +119,7 @@ func combineBuilderServerHTTPService(ctx context.Context, svr *Server, serviceBu
 		}
 	}
 
-	// Combine the pd service to the router. the extension service will be added to the userHandlers.
+	// Combine the pd to the router. the extension service will be added to the userHandlers.
 	for pathPrefix, handler := range registerMap {
 		if strings.Contains(pathPrefix, apiutil.CorePath) || strings.Contains(pathPrefix, apiutil.ExtensionsPath) {
 			router.PathPrefix(pathPrefix).Handler(handler)

tests/cluster.go

@@ -464,7 +464,7 @@ func createTestCluster(ctx context.Context, initialServerCount int, isKeyspaceEn
 	}, nil
 }
 
-// RestartTestPDCluster restarts the pd service cluster.
+// RestartTestPDCluster restarts the PD cluster.
 func RestartTestPDCluster(ctx context.Context, cluster *TestCluster) (*TestCluster, error) {
 	return restartTestCluster(ctx, cluster, true)
 }

tests/integrations/mcs/discovery/register_test.go

@@ -84,7 +84,7 @@ func (suite *serverRegisterTestSuite) checkServerRegister(serviceName string) {
 
 	addr := s.GetAddr()
 	client := suite.pdLeader.GetEtcdClient()
-	// test PD service discovery
+	// test PD discovery
 
 	endpoints, err := discovery.Discover(client, serviceName)
 	re.NoError(err)
@@ -98,7 +98,7 @@ func (suite *serverRegisterTestSuite) checkServerRegister(serviceName string) {
 	re.True(exist)
 	re.Equal(expectedPrimary, primary)
 
-	// test PD service discovery after unregister
+	// test PD discovery after unregister
 	cleanup()
 	endpoints, err = discovery.Discover(client, serviceName)
 	re.NoError(err)
@@ -140,7 +140,7 @@ func (suite *serverRegisterTestSuite) checkServerPrimaryChange(serviceName strin
 	delete(serverMap, primary)
 
 	expectedPrimary = tests.WaitForPrimaryServing(re, serverMap)
-	// test PD service discovery
+	// test PD discovery
 	client := suite.pdLeader.GetEtcdClient()
 	endpoints, err := discovery.Discover(client, serviceName)
 	re.NoError(err)