feat(group): support scale subresource (#6213)

Author: liubog2008

.golangci.yml

@@ -123,6 +123,7 @@ issues:
         - dupl
         - mnd
         - lll
+        - goconst
   exclude-files:
     - ".*/br/.*/_test.go"
     - ".*/br/.*/testutils/.*"

api/core/v1alpha1/common_types.go

@@ -330,6 +330,9 @@ type GroupStatus struct {
 	// It will be same as the `spec.version` only when all instances are upgraded to the desired version.
 	Version string `json:"version,omitempty"`
 
+	// Selector is the label selector for scale subresource.
+	Selector string `json:"selector"`
+
 	// Replicas is the number of Instance created by the controller.
 	Replicas int32 `json:"replicas"`
 

api/core/v1alpha1/pd_types.go

@@ -55,6 +55,7 @@ type PDGroupList struct {
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas,selectorpath=.status.selector
 // +kubebuilder:resource:categories=tc;group,shortName=pdg
 // +kubebuilder:selectablefield:JSONPath=`.spec.cluster.name`
 // +kubebuilder:printcolumn:name="Cluster",type=string,JSONPath=`.spec.cluster.name`

api/core/v1alpha1/scheduler_types.go

@@ -35,6 +35,7 @@ type SchedulerGroupList struct {
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas,selectorpath=.status.selector
 // +kubebuilder:resource:categories=tc;group,shortName=sg
 // +kubebuilder:selectablefield:JSONPath=`.spec.cluster.name`
 // +kubebuilder:printcolumn:name="Cluster",type=string,JSONPath=`.spec.cluster.name`

api/core/v1alpha1/ticdc_types.go

@@ -42,6 +42,7 @@ type TiCDCGroupList struct {
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas,selectorpath=.status.selector
 // +kubebuilder:resource:categories=tc;group,shortName=cg
 // +kubebuilder:selectablefield:JSONPath=`.spec.cluster.name`
 // +kubebuilder:printcolumn:name="Cluster",type=string,JSONPath=`.spec.cluster.name`

api/core/v1alpha1/tidb_types.go

@@ -60,6 +60,7 @@ type TiDBGroupList struct {
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas,selectorpath=.status.selector
 // +kubebuilder:resource:categories=tc;group,shortName=dbg
 // +kubebuilder:selectablefield:JSONPath=`.spec.cluster.name`
 // +kubebuilder:printcolumn:name="Cluster",type=string,JSONPath=`.spec.cluster.name`

api/core/v1alpha1/tiflash_types.go

@@ -51,6 +51,7 @@ type TiFlashGroupList struct {
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas,selectorpath=.status.selector
 // +kubebuilder:resource:categories=tc;group,shortName=fg
 // +kubebuilder:selectablefield:JSONPath=`.spec.cluster.name`
 // +kubebuilder:printcolumn:name="Cluster",type=string,JSONPath=`.spec.cluster.name`

api/core/v1alpha1/tikv_types.go

@@ -64,6 +64,7 @@ type TiKVGroupList struct {
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas,selectorpath=.status.selector
 // +kubebuilder:resource:categories=tc;group,shortName=kvg
 // +kubebuilder:selectablefield:JSONPath=`.spec.cluster.name`
 // +kubebuilder:printcolumn:name="Cluster",type=string,JSONPath=`.spec.cluster.name`

api/core/v1alpha1/tiproxy_types.go

@@ -39,6 +39,7 @@ type TiProxyGroupList struct {
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas,selectorpath=.status.selector
 // +kubebuilder:resource:categories=tc;group,shortName=pg
 // +kubebuilder:selectablefield:JSONPath=`.spec.cluster.name`
 // +kubebuilder:printcolumn:name="Cluster",type=string,JSONPath=`.spec.cluster.name`

api/core/v1alpha1/tso_types.go

@@ -35,6 +35,7 @@ type TSOGroupList struct {
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas,selectorpath=.status.selector
 // +kubebuilder:resource:categories=tc;group,shortName=tg
 // +kubebuilder:selectablefield:JSONPath=`.spec.cluster.name`
 // +kubebuilder:printcolumn:name="Cluster",type=string,JSONPath=`.spec.cluster.name`

cmd/runtime-gen/generators/runtime.go

@@ -347,6 +347,14 @@ func (g *$.|pub$) StatusRevision() (update, current string, collisionCount *int3
 		g.Status.CollisionCount
 }
 
+func (g *$.|pub$) SetStatusSelector(l string) {
+	g.Status.Selector = l
+}
+
+func (g *$.|pub$) StatusSelector() string {
+	return g.Status.Selector
+}
+
 func (g *$.|pub$) TemplateLabels() map[string]string {
 	return g.Spec.Template.Labels
 }

manifests/crd/core.pingcap.com_pdgroups.yaml

@@ -8717,6 +8717,9 @@ spec:
                 description: Replicas is the number of Instance created by the controller.
                 format: int32
                 type: integer
+              selector:
+                description: Selector is the label selector for scale subresource.
+                type: string
               updateRevision:
                 description: UpdateRevision is the revision of the Controller that
                   should modify the resource.
@@ -8736,6 +8739,7 @@ spec:
             - currentReplicas
             - readyReplicas
             - replicas
+            - selector
             - updatedReplicas
             type: object
         type: object
@@ -8744,4 +8748,8 @@ spec:
     served: true
     storage: true
     subresources:
+      scale:
+        labelSelectorPath: .status.selector
+        specReplicasPath: .spec.replicas
+        statusReplicasPath: .status.replicas
       status: {}

manifests/crd/core.pingcap.com_schedulergroups.yaml

@@ -8861,6 +8861,9 @@ spec:
                 description: Replicas is the number of Instance created by the controller.
                 format: int32
                 type: integer
+              selector:
+                description: Selector is the label selector for scale subresource.
+                type: string
               updateRevision:
                 description: UpdateRevision is the revision of the Controller that
                   should modify the resource.
@@ -8880,6 +8883,7 @@ spec:
             - currentReplicas
             - readyReplicas
             - replicas
+            - selector
             - updatedReplicas
             type: object
         type: object
@@ -8888,4 +8892,8 @@ spec:
     served: true
     storage: true
     subresources:
+      scale:
+        labelSelectorPath: .status.selector
+        specReplicasPath: .spec.replicas
+        statusReplicasPath: .status.replicas
       status: {}

manifests/crd/core.pingcap.com_ticdcgroups.yaml

@@ -8694,6 +8694,9 @@ spec:
                 description: Replicas is the number of Instance created by the controller.
                 format: int32
                 type: integer
+              selector:
+                description: Selector is the label selector for scale subresource.
+                type: string
               updateRevision:
                 description: UpdateRevision is the revision of the Controller that
                   should modify the resource.
@@ -8713,6 +8716,7 @@ spec:
             - currentReplicas
             - readyReplicas
             - replicas
+            - selector
             - updatedReplicas
             type: object
         type: object
@@ -8721,4 +8725,8 @@ spec:
     served: true
     storage: true
     subresources:
+      scale:
+        labelSelectorPath: .status.selector
+        specReplicasPath: .spec.replicas
+        statusReplicasPath: .status.replicas
       status: {}

manifests/crd/core.pingcap.com_tidbgroups.yaml

@@ -8827,6 +8827,9 @@ spec:
                 description: Replicas is the number of Instance created by the controller.
                 format: int32
                 type: integer
+              selector:
+                description: Selector is the label selector for scale subresource.
+                type: string
               updateRevision:
                 description: UpdateRevision is the revision of the Controller that
                   should modify the resource.
@@ -8846,6 +8849,7 @@ spec:
             - currentReplicas
             - readyReplicas
             - replicas
+            - selector
             - updatedReplicas
             type: object
         type: object
@@ -8854,4 +8858,8 @@ spec:
     served: true
     storage: true
     subresources:
+      scale:
+        labelSelectorPath: .status.selector
+        specReplicasPath: .spec.replicas
+        statusReplicasPath: .status.replicas
       status: {}

manifests/crd/core.pingcap.com_tiflashgroups.yaml

@@ -8739,6 +8739,9 @@ spec:
                 description: Replicas is the number of Instance created by the controller.
                 format: int32
                 type: integer
+              selector:
+                description: Selector is the label selector for scale subresource.
+                type: string
               updateRevision:
                 description: UpdateRevision is the revision of the Controller that
                   should modify the resource.
@@ -8758,6 +8761,7 @@ spec:
             - currentReplicas
             - readyReplicas
             - replicas
+            - selector
             - updatedReplicas
             type: object
         type: object
@@ -8766,4 +8770,8 @@ spec:
     served: true
     storage: true
     subresources:
+      scale:
+        labelSelectorPath: .status.selector
+        specReplicasPath: .spec.replicas
+        statusReplicasPath: .status.replicas
       status: {}

manifests/crd/core.pingcap.com_tikvgroups.yaml

@@ -8701,6 +8701,9 @@ spec:
                 description: Replicas is the number of Instance created by the controller.
                 format: int32
                 type: integer
+              selector:
+                description: Selector is the label selector for scale subresource.
+                type: string
               updateRevision:
                 description: UpdateRevision is the revision of the Controller that
                   should modify the resource.
@@ -8720,6 +8723,7 @@ spec:
             - currentReplicas
             - readyReplicas
             - replicas
+            - selector
             - updatedReplicas
             type: object
         type: object
@@ -8728,4 +8732,8 @@ spec:
     served: true
     storage: true
     subresources:
+      scale:
+        labelSelectorPath: .status.selector
+        specReplicasPath: .spec.replicas
+        statusReplicasPath: .status.replicas
       status: {}

manifests/crd/core.pingcap.com_tiproxygroups.yaml

@@ -8932,6 +8932,9 @@ spec:
                 description: Replicas is the number of Instance created by the controller.
                 format: int32
                 type: integer
+              selector:
+                description: Selector is the label selector for scale subresource.
+                type: string
               updateRevision:
                 description: UpdateRevision is the revision of the Controller that
                   should modify the resource.
@@ -8951,6 +8954,7 @@ spec:
             - currentReplicas
             - readyReplicas
             - replicas
+            - selector
             - updatedReplicas
             type: object
         type: object
@@ -8959,4 +8963,8 @@ spec:
     served: true
     storage: true
     subresources:
+      scale:
+        labelSelectorPath: .status.selector
+        specReplicasPath: .spec.replicas
+        statusReplicasPath: .status.replicas
       status: {}

manifests/crd/core.pingcap.com_tsogroups.yaml

@@ -8860,6 +8860,9 @@ spec:
                 description: Replicas is the number of Instance created by the controller.
                 format: int32
                 type: integer
+              selector:
+                description: Selector is the label selector for scale subresource.
+                type: string
               updateRevision:
                 description: UpdateRevision is the revision of the Controller that
                   should modify the resource.
@@ -8879,6 +8882,7 @@ spec:
             - currentReplicas
             - readyReplicas
             - replicas
+            - selector
             - updatedReplicas
             type: object
         type: object
@@ -8887,4 +8891,8 @@ spec:
     served: true
     storage: true
     subresources:
+      scale:
+        labelSelectorPath: .status.selector
+        specReplicasPath: .spec.replicas
+        statusReplicasPath: .status.replicas
       status: {}

pkg/apiutil/core/v1alpha1/group.go

@@ -17,6 +17,8 @@ package coreutil
 import (
 	"maps"
 
+	"k8s.io/apimachinery/pkg/labels"
+
 	"github.com/pingcap/tidb-operator/api/v2/core/v1alpha1"
 	"github.com/pingcap/tidb-operator/pkg/client"
 	"github.com/pingcap/tidb-operator/pkg/runtime"
@@ -146,3 +148,26 @@ func InstanceAnnotations[
 
 	return maps.Clone(obj.TemplateAnnotations())
 }
+
+func SetStatusSelector[
+	S scope.Group[F, T],
+	F client.Object,
+	T runtime.Group,
+](f F) bool {
+	obj := scope.From[S](f)
+
+	l := obj.StatusSelector()
+
+	changed := compare.SetIfChanged(&l, labels.Set{
+		v1alpha1.LabelKeyManagedBy: v1alpha1.LabelValManagedByOperator,
+		v1alpha1.LabelKeyComponent: obj.Component(),
+		v1alpha1.LabelKeyCluster:   obj.Cluster(),
+		v1alpha1.LabelKeyGroup:     f.GetName(),
+	}.String())
+
+	if changed {
+		obj.SetStatusSelector(l)
+	}
+
+	return changed
+}