feat(store): support server labels for store

api/core/v1alpha1/tidb_types.go

@@ -242,8 +242,10 @@ type TiDBServer struct {
 	Ports TiDBPorts `json:"ports,omitempty"`
 
 	// Labels defines the server labels of the TiDB server.
-	// TiDB Operator will ignore `labels` in TiDB's config file and use this field instead.
-	// Note these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
+	// Operator will set these `labels` by API.
+	// If a label in this field is conflict with the config file, this field takes precedence.
+	// NOTE: Different from other components, TiDB will replace all labels but not only add/update.
+	// NOTE: these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
 	//  - host
 	//  - region
 	//  - zone

api/core/v1alpha1/tiflash_types.go

@@ -183,6 +183,17 @@ type TiFlashTemplateSpec struct {
 type TiFlashServer struct {
 	// Ports defines all ports listened by tiflash
 	Ports TiFlashPorts `json:"ports,omitempty"`
+
+	// Labels defines the server labels of the TiFlash server.
+	// Operator will set these `labels` by API.
+	// If a label in this field is conflict with the config file, this field takes precedence.
+	// NOTE: If a label is removed, operator will not delete it automatically.
+	// NOTE: these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
+	//  - host
+	//  - region
+	//  - zone
+	// +kubebuilder:validation:XValidation:rule="!('host' in self) && !('region' in self) && !('zone' in self)",message="labels cannot contain 'host', 'region', or 'zone' keys"
+	Labels map[string]string `json:"labels,omitempty"`
 }
 
 type TiFlashPorts struct {

api/core/v1alpha1/tikv_types.go

@@ -224,6 +224,17 @@ type TiKVRemoteWorkers struct {
 type TiKVServer struct {
 	// Ports defines all ports listened by tikv
 	Ports TiKVPorts `json:"ports,omitempty"`
+
+	// Labels defines the server labels of the TiKV server.
+	// Operator will set these `labels` by API dynamically.
+	// If a label in this field is conflict with the config file, this field takes precedence.
+	// NOTE: If a label is removed, operator will not delete it automatically.
+	// NOTE: these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
+	//  - host
+	//  - region
+	//  - zone
+	// +kubebuilder:validation:XValidation:rule="!('host' in self) && !('region' in self) && !('zone' in self)",message="labels cannot contain 'host', 'region', or 'zone' keys"
+	Labels map[string]string `json:"labels,omitempty"`
 }
 
 type TiKVPorts struct {
@@ -238,6 +249,7 @@ type TiKVGroupStatus struct {
 	GroupStatus  `json:",inline"`
 }
 
+// TiKVSpec defines the spec of tikv instance
 // +kubebuilder:validation:XValidation:rule="(!has(oldSelf.topology) && !has(self.topology)) || (has(oldSelf.topology) && has(self.topology))",fieldPath=".topology",message="topology can only be set when creating"
 type TiKVSpec struct {
 	// Cluster is a reference of tidb cluster

api/core/v1alpha1/tiproxy_types.go

@@ -184,9 +184,11 @@ type TiProxyServer struct {
 	// Port defines all ports listened by TiProxy.
 	Ports TiProxyPorts `json:"ports,omitempty"`
 
-	// Labels defines the server labels of the TiProxy.
-	// TiDB Operator will ignore `labels` in TiProxy's config file and use this field instead.
-	// Note these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
+	// Labels defines the server labels of the TiProxy server.
+	// Operator will set these `labels` by API.
+	// If a label in this field is conflict with the config file, this field takes precedence.
+	// NOTE: If a label is removed, operator will not delete it automatically.
+	// NOTE: these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
 	//  - host
 	//  - region
 	//  - zone

cmd/runtime-gen/generators/namer.go

@@ -20,6 +20,13 @@ import (
 	"k8s.io/gengo/v2/types"
 )
 
+const (
+	nameTiDB    = "TiDB"
+	nameTiProxy = "TiProxy"
+	nameTiKV    = "TiKV"
+	nameTiFlash = "TiFlash"
+)
+
 type NameFunc func(t *types.Type) string
 
 func (f NameFunc) Name(t *types.Type) string {
@@ -39,7 +46,7 @@ func GroupToInstanceName(t *types.Type) string {
 func GroupToSecurityTypeName(t *types.Type) string {
 	name := strings.TrimSuffix(t.Name.Name, "Group")
 	switch name {
-	case "TiDB", "TiProxy":
+	case nameTiDB, nameTiProxy:
 		return name + "Security"
 	}
 
@@ -53,7 +60,7 @@ func GroupToSecurityTypeName(t *types.Type) string {
 func GroupToTLSTypeName(t *types.Type) string {
 	name := strings.TrimSuffix(t.Name.Name, "Group")
 	switch name {
-	case "TiDB", "TiProxy":
+	case nameTiDB, nameTiProxy:
 		return name + "TLSConfig"
 	}
 
@@ -71,3 +78,12 @@ func GroupToInternalTLSTypeName(t *types.Type) string {
 
 	return "InternalTLS"
 }
+
+func InstanceToServerLabelsField(t *types.Type) string {
+	switch t.Name.Name {
+	case nameTiDB, nameTiKV, nameTiFlash, nameTiProxy:
+		return "in.Spec.Server.Labels"
+	}
+
+	return "nil"
+}

cmd/runtime-gen/generators/runtime.go

@@ -54,11 +54,12 @@ func (g *runtimeGenerator) Filter(_ *generator.Context, t *types.Type) bool {
 
 func (g *runtimeGenerator) Namers(*generator.Context) namer.NameSystems {
 	return namer.NameSystems{
-		"pub":         namer.NewPublicNamer(0),
-		"instance":    NameFunc(GroupToInstanceName),
-		"security":    NameFunc(GroupToSecurityTypeName),
-		"tls":         NameFunc(GroupToTLSTypeName),
-		"internaltls": NameFunc(GroupToInternalTLSTypeName),
+		"pub":          namer.NewPublicNamer(0),
+		"instance":     NameFunc(GroupToInstanceName),
+		"security":     NameFunc(GroupToSecurityTypeName),
+		"tls":          NameFunc(GroupToTLSTypeName),
+		"internaltls":  NameFunc(GroupToInternalTLSTypeName),
+		"serverlabels": NameFunc(InstanceToServerLabelsField),
 	}
 }
 
@@ -281,6 +282,10 @@ func (in *$.|pub$) Subdomain() string {
 	return in.Spec.Subdomain
 }
 
+func (in *$.|pub$) ServerLabels() map[string]string {
+	return $.|serverlabels$
+}
+
 func (in *$.|pub$) ClusterCertKeyPairSecretName() string {
 	sec := in.Spec.Security
 	if sec != nil && sec.TLS != nil && sec.TLS.Cluster != nil && sec.TLS.Cluster.CertKeyPair != nil {

manifests/crd/core.pingcap.com_tidbgroups.yaml

@@ -8800,8 +8800,10 @@ spec:
                               type: string
                             description: |-
                               Labels defines the server labels of the TiDB server.
-                              TiDB Operator will ignore `labels` in TiDB's config file and use this field instead.
-                              Note these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
+                              Operator will set these `labels` by API.
+                              If a label in this field is conflict with the config file, this field takes precedence.
+                              NOTE: Different from other components, TiDB will replace all labels but not only add/update.
+                              NOTE: these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
                                - host
                                - region
                                - zone

manifests/crd/core.pingcap.com_tidbs.yaml

@@ -8511,8 +8511,10 @@ spec:
                       type: string
                     description: |-
                       Labels defines the server labels of the TiDB server.
-                      TiDB Operator will ignore `labels` in TiDB's config file and use this field instead.
-                      Note these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
+                      Operator will set these `labels` by API.
+                      If a label in this field is conflict with the config file, this field takes precedence.
+                      NOTE: Different from other components, TiDB will replace all labels but not only add/update.
+                      NOTE: these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
                        - host
                        - region
                        - zone

manifests/crd/core.pingcap.com_tiflashes.yaml

@@ -8412,6 +8412,23 @@ spec:
               server:
                 description: Server defines the server config of TiFlash
                 properties:
+                  labels:
+                    additionalProperties:
+                      type: string
+                    description: |-
+                      Labels defines the server labels of the TiFlash server.
+                      Operator will set these `labels` by API.
+                      If a label in this field is conflict with the config file, this field takes precedence.
+                      NOTE: If a label is removed, operator will not delete it automatically.
+                      NOTE: these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
+                       - host
+                       - region
+                       - zone
+                    type: object
+                    x-kubernetes-validations:
+                    - message: labels cannot contain 'host', 'region', or 'zone' keys
+                      rule: '!(''host'' in self) && !(''region'' in self) && !(''zone''
+                        in self)'
                   ports:
                     description: Ports defines all ports listened by tiflash
                     properties:

manifests/crd/core.pingcap.com_tiflashgroups.yaml

@@ -8686,6 +8686,24 @@ spec:
                       server:
                         description: Server defines the server config of TiFlash
                         properties:
+                          labels:
+                            additionalProperties:
+                              type: string
+                            description: |-
+                              Labels defines the server labels of the TiFlash server.
+                              Operator will set these `labels` by API.
+                              If a label in this field is conflict with the config file, this field takes precedence.
+                              NOTE: If a label is removed, operator will not delete it automatically.
+                              NOTE: these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
+                               - host
+                               - region
+                               - zone
+                            type: object
+                            x-kubernetes-validations:
+                            - message: labels cannot contain 'host', 'region', or
+                                'zone' keys
+                              rule: '!(''host'' in self) && !(''region'' in self)
+                                && !(''zone'' in self)'
                           ports:
                             description: Ports defines all ports listened by tiflash
                             properties:

manifests/crd/core.pingcap.com_tikvgroups.yaml

@@ -8703,6 +8703,24 @@ spec:
                       server:
                         description: Server defines the server config of TiKV
                         properties:
+                          labels:
+                            additionalProperties:
+                              type: string
+                            description: |-
+                              Labels defines the server labels of the TiKV server.
+                              Operator will set these `labels` by API dynamically.
+                              If a label in this field is conflict with the config file, this field takes precedence.
+                              NOTE: If a label is removed, operator will not delete it automatically.
+                              NOTE: these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
+                               - host
+                               - region
+                               - zone
+                            type: object
+                            x-kubernetes-validations:
+                            - message: labels cannot contain 'host', 'region', or
+                                'zone' keys
+                              rule: '!(''host'' in self) && !(''region'' in self)
+                                && !(''zone'' in self)'
                           ports:
                             description: Ports defines all ports listened by tikv
                             properties:

manifests/crd/core.pingcap.com_tikvs.yaml

@@ -61,6 +61,7 @@ spec:
           metadata:
             type: object
           spec:
+            description: TiKVSpec defines the spec of tikv instance
             properties:
               cluster:
                 description: Cluster is a reference of tidb cluster
@@ -8428,6 +8429,23 @@ spec:
               server:
                 description: Server defines the server config of TiKV
                 properties:
+                  labels:
+                    additionalProperties:
+                      type: string
+                    description: |-
+                      Labels defines the server labels of the TiKV server.
+                      Operator will set these `labels` by API dynamically.
+                      If a label in this field is conflict with the config file, this field takes precedence.
+                      NOTE: If a label is removed, operator will not delete it automatically.
+                      NOTE: these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
+                       - host
+                       - region
+                       - zone
+                    type: object
+                    x-kubernetes-validations:
+                    - message: labels cannot contain 'host', 'region', or 'zone' keys
+                      rule: '!(''host'' in self) && !(''region'' in self) && !(''zone''
+                        in self)'
                   ports:
                     description: Ports defines all ports listened by tikv
                     properties:

manifests/crd/core.pingcap.com_tiproxies.yaml

@@ -8507,9 +8507,11 @@ spec:
                     additionalProperties:
                       type: string
                     description: |-
-                      Labels defines the server labels of the TiProxy.
-                      TiDB Operator will ignore `labels` in TiProxy's config file and use this field instead.
-                      Note these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
+                      Labels defines the server labels of the TiProxy server.
+                      Operator will set these `labels` by API.
+                      If a label in this field is conflict with the config file, this field takes precedence.
+                      NOTE: If a label is removed, operator will not delete it automatically.
+                      NOTE: these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
                        - host
                        - region
                        - zone

manifests/crd/core.pingcap.com_tiproxygroups.yaml

@@ -8795,9 +8795,11 @@ spec:
                             additionalProperties:
                               type: string
                             description: |-
-                              Labels defines the server labels of the TiProxy.
-                              TiDB Operator will ignore `labels` in TiProxy's config file and use this field instead.
-                              Note these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
+                              Labels defines the server labels of the TiProxy server.
+                              Operator will set these `labels` by API.
+                              If a label in this field is conflict with the config file, this field takes precedence.
+                              NOTE: If a label is removed, operator will not delete it automatically.
+                              NOTE: these label keys are managed by TiDB Operator, it will be set automatically and you can not modify them:
                                - host
                                - region
                                - zone

pkg/apiutil/core/v1alpha1/instance.go

@@ -407,3 +407,11 @@ func InstanceAdvertiseAddress[
 ](cluster *v1alpha1.Cluster, obj F, port P) string {
 	return InstanceHost[S](cluster, obj) + urlPort(port)
 }
+
+func ServerLabels[
+	S scope.Instance[F, T],
+	F client.Object,
+	T runtime.Instance,
+](obj F) map[string]string {
+	return scope.From[S](obj).ServerLabels()
+}

pkg/controllers/common/interfaces.go

@@ -264,7 +264,3 @@ type HealthyState interface {
 type HealthyStateUpdater interface {
 	SetHealthy()
 }
-
-type ServerLabelsState interface {
-	GetServerLabels() map[string]string
-}