feat(backend): 集群标签管理 #10165

# Reviewed, transaction id: 41685

Author: iSecloud

dbm-ui/backend/configuration/constants.py

@@ -134,6 +134,8 @@ class SystemSettingsEnum(str, StructuredEnum):
     MACHINE_PROPERTY = EnumField("MACHINE_PROPERTY", _("主机属性开关"))
     PADDING_PROXY_APPS = EnumField("PADDING_PROXY_APPS", _("补全proxy业务"))
     DISABLE_DBHA_APPS_CLUSTER_TYPE = EnumField("DISABLE_DBHA_APPS_CLUSTER_TYPE", _("禁用DBHA业务"))
+    # 内置标签列表
+    BUILTIN_LABELS = EnumField("BUILTIN_LABELS", _("内置标签列表"))
 
 
 class BizSettingsEnum(str, StructuredEnum):

dbm-ui/backend/configuration/views/system.py

@@ -50,6 +50,14 @@ class SystemSettingsViewSet(viewsets.SystemViewSet):
     }
     default_permission_class = [ResourceActionPermission([ActionEnum.GLOBAL_MANAGE])]
 
+    @common_swagger_auto_schema(
+        operation_summary=_("查询内置标签"),
+        tags=tags,
+    )
+    @action(methods=["GET"], detail=False)
+    def builtin_labels(self, request, *args, **kwargs):
+        return Response(SystemSettings.get_setting_value(SystemSettingsEnum.BUILTIN_LABELS.value, default=[]))
+
     @common_swagger_auto_schema(
         operation_summary=_("查询磁盘类型"),
         tags=tags,

dbm-ui/backend/db_meta/admin.py

@@ -213,3 +213,9 @@ class ClusterMonitorTopoAdmin(admin.ModelAdmin):
 class SyncFailedMachineAdmin(admin.ModelAdmin):
     list_display = ("bk_host_id", "error")
     search_fields = ("error",)
+
+
+@admin.register(models.tag.Tag)
+class TagAdmin(admin.ModelAdmin):
+    list_display = ("key", "value", "bk_biz_id", "is_builtin", "type")
+    search_fields = ("bk_biz_id", "key", "value")

dbm-ui/backend/db_meta/enums/comm.py

@@ -25,21 +25,21 @@ class DBCCModule(str, StructuredEnum):
     MONGODB = EnumField("mongodb", _("mongodb"))
 
 
+class RedisVerUpdateNodeType(str, StructuredEnum):
+    """redis版本升级节点类型"""
+
+    Proxy = EnumField("Proxy", _("Proxy"))
+    Backend = EnumField("Backend", _("Backend"))
+
+
 class TagType(str, StructuredEnum):
-    CUSTOM = EnumField("custom", _("自定义标签"))
-    SYSTEM = EnumField("system", _("系统标签"))
-    BUILTIN = EnumField("builtin", _("内置标签"))
+    """标签类型"""
+
+    RESOURCE = EnumField("resource", _("资源标签"))
+    CLUSTER = EnumField("cluster", _("集群标签"))
 
 
 class SystemTagEnum(str, StructuredEnum):
     """系统内置的tag名称"""
 
     TEMPORARY = EnumField("temporary", _("临时集群"))
-    RESOURCE_TAG = EnumField("resource", _("资源标签"))
-
-
-class RedisVerUpdateNodeType(str, StructuredEnum):
-    """redis版本升级节点类型"""
-
-    Proxy = EnumField("Proxy", _("Proxy"))
-    Backend = EnumField("Backend", _("Backend"))

dbm-ui/backend/db_meta/migrations/0050_auto_20250508_2142.py

@@ -0,0 +1,57 @@
+# Generated by Django 3.2.25 on 2025-05-08 13:42
+
+from django.db import migrations, models
+
+from backend.db_meta.enums.comm import TagType
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("db_meta", "0049_auto_20250507_1626"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="tag",
+            name="is_builtin",
+            field=models.BooleanField(default=False, help_text="是否内置"),
+        ),
+        migrations.AlterField(
+            model_name="clusterdbhaext",
+            name="begin_time",
+            field=models.DateTimeField(auto_now_add=True, db_index=True, help_text="屏蔽开始时间"),
+        ),
+        migrations.AlterField(
+            model_name="spec",
+            name="cpu",
+            field=models.JSONField(default=dict, help_text='cpu规格描述:{"min":1,"max":10}', null=True),
+        ),
+        migrations.AlterField(
+            model_name="spec",
+            name="device_class",
+            field=models.JSONField(default=dict, help_text='实际机器机型: ["class1","class2"]', null=True),
+        ),
+        migrations.AlterField(
+            model_name="spec",
+            name="mem",
+            field=models.JSONField(default=dict, help_text='mem规格描述:{"min":100,"max":1000}', null=True),
+        ),
+        migrations.AlterField(
+            model_name="spec",
+            name="qps",
+            field=models.JSONField(default=dict, help_text='qps规格描述:{"min": 1, "max": 100}', null=True),
+        ),
+        migrations.AlterField(
+            model_name="spec",
+            name="storage_spec",
+            field=models.JSONField(
+                default=dict, help_text='存储磁盘需求配置:[{"mount_point":"/data","size":500,"type":"ssd"}]', null=True
+            ),
+        ),
+        migrations.AlterField(
+            model_name="tag",
+            name="type",
+            field=models.CharField(choices=TagType.get_choices(), help_text="tag类型", max_length=64),
+        ),
+    ]

dbm-ui/backend/db_meta/models/spec.py

@@ -37,18 +37,18 @@ class Spec(AuditedModel):
     spec_name = models.CharField(max_length=128, help_text=_("虚拟规格名称"))
     spec_cluster_type = models.CharField(max_length=64, choices=SpecClusterType.get_choices(), help_text=_("组件类型"))
     spec_machine_type = models.CharField(max_length=64, choices=SpecMachineType.get_choices(), help_text=_("机器类型"))
-    cpu = models.JSONField(help_text=_('cpu规格描述:{"min":1,"max":10}'), default=dict)
-    mem = models.JSONField(help_text=_('mem规格描述:{"min":100,"max":1000}'), default=dict)
-    device_class = models.JSONField(help_text=_('实际机器机型: ["class1","class2"]'), default=dict)
+    cpu = models.JSONField(null=True, help_text=_('cpu规格描述:{"min":1,"max":10}'), default=dict)
+    mem = models.JSONField(null=True, help_text=_('mem规格描述:{"min":100,"max":1000}'), default=dict)
+    device_class = models.JSONField(null=True, help_text=_('实际机器机型: ["class1","class2"]'), default=dict)
     storage_spec = models.JSONField(
-        help_text=_('存储磁盘需求配置:[{"mount_point":"/data","size":500,"type":"ssd"}]'), default=dict
+        help_text=_('存储磁盘需求配置:[{"mount_point":"/data","size":500,"type":"ssd"}]'), default=dict, null=True
     )
     desc = models.TextField(help_text=_("资源规格描述"), null=True, blank=True)
     enable = models.BooleanField(help_text=_("是否启用"), default=True)
     # es专属
     instance_num = models.IntegerField(default=0, help_text=_("实例数(es专属)"))
     # spider，redis集群专属
-    qps = models.JSONField(default=dict, help_text=_('qps规格描述:{"min": 1, "max": 100}'))
+    qps = models.JSONField(default=dict, help_text=_('qps规格描述:{"min": 1, "max": 100}'), null=True)
 
     class Meta:
         verbose_name = verbose_name_plural = _("资源规格(Spec)")

dbm-ui/backend/db_meta/models/tag.py

@@ -20,21 +20,25 @@ class Tag(AuditedModel):
     bk_biz_id = models.IntegerField(help_text=_("业务 ID"), default=0)
     key = models.CharField(help_text=_("标签键"), default="", max_length=64)
     value = models.CharField(help_text=_("标签值"), default="", max_length=255)
-    type = models.CharField(
-        help_text=_("tag类型"), max_length=64, choices=TagType.get_choices(), default=TagType.CUSTOM.value
-    )
+
+    type = models.CharField(help_text=_("tag类型"), max_length=64, choices=TagType.get_choices())
+    is_builtin = models.BooleanField(help_text=_("是否内置"), default=False)
 
     class Meta:
         unique_together = ["bk_biz_id", "key", "value"]
 
     @property
-    def tag_desc(self):
-        """仅返回tag的信息"""
-        return {"bk_biz_id": self.bk_biz_id, "key": self.key, "type": self.type}
+    def desc(self):
+        return {"key": self.key, "value": self.value, "is_builtin": self.is_builtin, "id": self.id}
 
     @classmethod
-    def get_or_create_system_tag(cls, key: str, value: str):
+    def get_builtin_tag(cls, key, value, type):
+        """获取内置tag，如果不存在则创建"""
         tag, created = cls.objects.get_or_create(
-            bk_biz_id=PLAT_BIZ_ID, key=key, value=value, type=TagType.SYSTEM.value
+            key=key,
+            value=value,
+            type=type,
+            is_builtin=True,
+            defaults={"bk_biz_id": PLAT_BIZ_ID},
         )
-        return tag
+        return tag, created

dbm-ui/backend/db_proxy/migrations/0001_initial.py

@@ -3,8 +3,7 @@
 from django.db import migrations, models
 
 from backend.configuration.constants import DBType
-from backend.db_meta.enums import InstanceStatus
-from backend.db_proxy.constants import ExtensionType
+from backend.db_proxy.constants import ExtensionServiceStatus, ExtensionType
 
 
 class Migration(migrations.Migration):
@@ -50,7 +49,7 @@ class Migration(migrations.Migration):
                 (
                     "status",
                     models.CharField(
-                        choices=InstanceStatus.get_choices(),
+                        choices=ExtensionServiceStatus.get_choices(),
                         max_length=64,
                         verbose_name="服务状态",
                     ),

dbm-ui/backend/db_services/dbbase/resources/query.py

@@ -430,7 +430,9 @@ def _list_clusters(
             # 域名
             "domain": build_q_for_domain_by_cluster(domains=query_params.get("domain", "").split(",")),
             # 标签
-            "tags": Q(tags__in=query_params.get("tags", "").split(",")),
+            "tag_ids": Q(tags__in=query_params.get("tag_ids", "").split(",")),
+            # 标签key过滤
+            "tag_keys": Q(tags__key__in=query_params.get("tag_keys", "").split(",")),
         }
 
         filter_params_map.update(inner_filter_params_map)
@@ -590,21 +592,19 @@ def _to_cluster_representation(
         @param cluster_entry_map: key 是 cluster.id, value 是当前集群对应的 entry 映射
         @param cluster_operate_records_map: key 是 cluster.id, value 是当前集群对应的 操作记录 映射
         """
-        spec = None
+        cluster_spec = None
         cluster_entry_map_value = ClusterEntry.get_entries_map(entries=cluster.entries).get(cluster.id, {})
         bk_cloud_name = cloud_info.get(str(cluster.bk_cloud_id), {}).get("bk_cloud_name", "")
 
         # 补充集群规格信息
-        if cls.storage_spec_role is not None:
-            storage_spec = next(
-                (storage for storage in cluster.storages if storage.instance_role == cls.storage_spec_role), None
-            )
-            if storage_spec:
-                spec_id = storage_spec.machine.spec_id
-                spec = kwargs["remote_spec_map"].get(spec_id)
+        if cls.storage_spec_role:
+            storage = next((inst for inst in cluster.storages if inst.instance_role == cls.storage_spec_role), None)
+            cluster_spec_id = storage.machine.spec_id if storage else 0
+            cluster_spec = kwargs["remote_spec_map"].get(cluster_spec_id)
 
         return {
             "id": cluster.id,
+            "db_type": ClusterType.cluster_type_to_db_type(cluster.cluster_type),
             "phase": cluster.phase,
             "phase_name": cluster.get_phase_display(),
             "status": cluster.status,
@@ -633,7 +633,8 @@ def _to_cluster_representation(
             "updater": cluster.updater,
             "create_at": datetime2str(cluster.create_at),
             "update_at": datetime2str(cluster.update_at),
-            "cluster_spec": model_to_dict(spec) if spec else None,
+            "cluster_spec": model_to_dict(cluster_spec) if cluster_spec else None,
+            "tags": [tag.desc for tag in cluster.tags.all()],
         }
 
     @classmethod

dbm-ui/backend/db_services/dbbase/resources/serializers.py

@@ -42,6 +42,7 @@ class ListResourceSLZ(serializers.Serializer):
     cluster_type = serializers.CharField(required=False, help_text=_("集群类型"))
     ordering = serializers.CharField(required=False, help_text=_("排序字段,非必填"))
     tag_ids = serializers.CharField(required=False, help_text=_("标签"))
+    tag_keys = serializers.CharField(required=False, help_text=_("标签键"))
 
 
 class ListMySQLResourceSLZ(ListResourceSLZ):

dbm-ui/backend/db_services/dbbase/serializers.py

@@ -247,3 +247,21 @@ def validate(self, attrs):
             raise serializers.ValidationError(_("The new alias cannot be the same as the current alias."))
 
         return attrs
+
+
+class UpdateClusterTagsSerializer(serializers.Serializer):
+    bk_biz_id = serializers.IntegerField(help_text=_("业务ID"))
+    cluster_id = serializers.IntegerField(help_text=_("集群ID"))
+    tags = serializers.ListField(child=serializers.IntegerField(), help_text=_("标签列表"))
+
+
+class RemoveClusterTagKeysSerializer(serializers.Serializer):
+    bk_biz_id = serializers.IntegerField(help_text=_("业务ID"))
+    cluster_ids = serializers.ListField(child=serializers.IntegerField(), help_text=_("集群ID列表"))
+    keys = serializers.ListField(child=serializers.CharField(), help_text=_("标签键列表"))
+
+
+class AddClusterTagKeysSerializer(serializers.Serializer):
+    bk_biz_id = serializers.IntegerField(help_text=_("业务ID"))
+    cluster_ids = serializers.ListField(child=serializers.IntegerField(), help_text=_("集群ID列表"))
+    tags = serializers.ListField(child=serializers.IntegerField(), help_text=_("标签列表"))

dbm-ui/backend/db_services/dbbase/views.py

@@ -25,7 +25,7 @@
 from backend.components import BKBaseApi
 from backend.configuration.constants import DBType
 from backend.db_meta.enums import ClusterType, InstanceRole
-from backend.db_meta.models import Cluster, DBModule, ProxyInstance, StorageInstance
+from backend.db_meta.models import Cluster, DBModule, ProxyInstance, StorageInstance, Tag
 from backend.db_services.dbbase.cluster.handlers import ClusterServiceHandler
 from backend.db_services.dbbase.cluster.serializers import (
     BatchCheckClusterDbsSerializer,
@@ -38,6 +38,7 @@
 from backend.db_services.dbbase.resources.query import ListRetrieveResource, ResourceList
 from backend.db_services.dbbase.resources.serializers import ClusterSLZ
 from backend.db_services.dbbase.serializers import (
+    AddClusterTagKeysSerializer,
     ClusterDbTypeSerializer,
     ClusterEntryFilterSerializer,
     ClusterFilterSerializer,
@@ -53,8 +54,10 @@
     QueryClusterCapResponseSerializer,
     QueryClusterCapSerializer,
     QueryClusterInstanceCountSerializer,
+    RemoveClusterTagKeysSerializer,
     ResourceAdministrationSerializer,
     UpdateClusterAliasSerializer,
+    UpdateClusterTagsSerializer,
     WebConsoleResponseSerializer,
     WebConsoleSerializer,
 )
@@ -63,7 +66,11 @@
 from backend.db_services.mysql.remote_service.handlers import RemoteServiceHandler
 from backend.db_services.redis.toolbox.handlers import ToolboxHandler
 from backend.iam_app.handlers.drf_perm.base import DBManagePermission
-from backend.iam_app.handlers.drf_perm.cluster import ClusterDBConsolePermission, ClusterWebconsolePermission
+from backend.iam_app.handlers.drf_perm.cluster import (
+    ClusterDBConsolePermission,
+    ClusterEditPermission,
+    ClusterWebconsolePermission,
+)
 
 SWAGGER_TAG = _("集群通用接口")
 
@@ -83,9 +90,16 @@ class DBBaseViewSet(viewsets.SystemViewSet):
         (
             "simple_query_cluster",
             "common_query_cluster",
+            "filter_clusters",
         ): [DBManagePermission()],
         ("webconsole",): [ClusterWebconsolePermission()],
         ("dbconsole",): [ClusterDBConsolePermission()],
+        (
+            "update_cluster_alias",
+            "update_cluster_tag",
+            "remove_cluster_tag_keys",
+            "add_cluster_tag_keys",
+        ): [ClusterEditPermission()],
     }
     default_permission_class = [DBManagePermission()]
 
@@ -479,5 +493,54 @@ def update_cluster_alias(self, request):
         cluster = Cluster.objects.get(bk_biz_id=validated_data["bk_biz_id"], id=validated_data["cluster_id"])
         cluster.alias = validated_data["new_alias"]
         cluster.save(update_fields=["alias"])
-        serializer = ClusterSLZ(cluster)
-        return Response(serializer.data)
+        return Response(ClusterSLZ(cluster).data)
+
+    @common_swagger_auto_schema(
+        operation_summary=_("更新集群标签"),
+        request_body=UpdateClusterTagsSerializer(),
+        tags=[SWAGGER_TAG],
+    )
+    @action(methods=["POST"], detail=False, serializer_class=UpdateClusterTagsSerializer)
+    def update_cluster_tag(self, request):
+        """更新集群标签"""
+        data = self.params_validate(self.get_serializer_class())
+        cluster = Cluster.objects.get(bk_biz_id=data["bk_biz_id"], id=data["cluster_id"])
+        tags = Tag.objects.filter(id__in=data["tags"])
+        # 清空旧标签，添加新标签
+        cluster.tags.clear()
+        cluster.tags.add(*tags)
+        return Response(ClusterSLZ(cluster).data)
+
+    @common_swagger_auto_schema(
+        operation_summary=_("批量移除标签键"),
+        request_body=RemoveClusterTagKeysSerializer(),
+        tags=[SWAGGER_TAG],
+    )
+    @action(methods=["POST"], detail=False, serializer_class=RemoveClusterTagKeysSerializer)
+    def remove_cluster_tag_keys(self, request):
+        """批量移除标签键"""
+        data = self.params_validate(self.get_serializer_class())
+        tag_ids = list(Tag.objects.filter(key__in=data["keys"]).values_list("id", flat=True))
+        Cluster.tags.through.objects.filter(cluster_id__in=data["cluster_ids"], tag_id__in=tag_ids).delete()
+        return Response()
+
+    @common_swagger_auto_schema(
+        operation_summary=_("批量增加标签键"),
+        request_body=AddClusterTagKeysSerializer(),
+        tags=[SWAGGER_TAG],
+    )
+    @action(methods=["POST"], detail=False, serializer_class=AddClusterTagKeysSerializer)
+    def add_cluster_tag_keys(self, request):
+        """批量增加标签键"""
+        data = self.params_validate(self.get_serializer_class())
+
+        tags = Tag.objects.filter(id__in=data["tags"])
+        through = Cluster.tags.through
+
+        # 这里需要先获取到所有标签键，然后排除已经存在该key的集群，考虑到这里标签一次性不会太多，暂用for循环处理
+        for tag in tags:
+            add_clusters = Cluster.objects.filter(id__in=data["cluster_ids"]).exclude(tags__key=tag.key)
+            add_tags = [through(cluster_id=cluster.id, tag_id=tag.id) for cluster in add_clusters]
+            through.objects.bulk_create(add_tags)
+
+        return Response()