feat: paas-service plan 支持多租户 (TencentBlueKing#211)

Author: SheepSheepChen

sdks/paas-service/CHANGES.md

@@ -1,4 +1,6 @@
 # 版本历史
+## 2.0.2
+- Support multi tenant 
 
 ## 2.0.1
 - Support querying service instance with parameter to_be_deleted 

sdks/paas-service/paas_service/__init__.py

@@ -16,6 +16,6 @@
 We undertake not to change the open source license (MIT license) applicable
 to the current version of the project delivered to anyone in the future.
 """
-__version__ = '2.0.1'
+__version__ = '2.0.2'
 
 default_app_config = 'paas_service.apps.PaaSServiceConfig'

sdks/paas-service/paas_service/constants.py

@@ -28,3 +28,8 @@ class Category(int, Enum):
 
 # Login 服务的重定向链接字段名
 REDIRECT_FIELD_NAME = "c_url"
+
+# The default tenant id exists only if the project does not enable multi-tenant mode,
+# it serves as a reserved value. When multi-tenant mode is enabled, no tenant id can
+# be "default".
+DEFAULT_TENANT_ID = "default"

sdks/paas-service/paas_service/fields.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+# TencentBlueKing is pleased to support the open source community by making
+# 蓝鲸智云 - PaaS 平台 (BlueKing - PaaS System) available.
+# Copyright (C) 2017 THL A29 Limited, a Tencent company. All rights reserved.
+# Licensed under the MIT License (the "License"); you may not use this file except
+# in compliance with the License. You may obtain a copy of the License at
+#
+#     http://opensource.org/licenses/MIT
+#
+# Unless required by applicable law or agreed to in writing, software distributed under
+# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+# either express or implied. See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# We undertake not to change the open source license (MIT license) applicable
+# to the current version of the project delivered to anyone in the future.
+from django.db import models
+
+from paas_service.constants import DEFAULT_TENANT_ID
+
+
+def tenant_id_field_factory(db_index: bool = True, unique: bool = False) -> models.CharField:
+    """Create a field that is configured to store tenant_id.
+
+    :param db_index: Whether to create an index for the field, defaults to True, turn
+        it off when the model already has a compound index on the tenant_id field.
+    :param unique: Whether to create a unique index for the field, defaults to False.
+
+    NOTE: https://github.com/TencentBlueKing/blueking-paas/pull/1877#discussion_r1912873811 中有相关的设计讨论
+    """
+    # If unique is True, db_index should be disabled to avoid creating a redundant index.
+    if unique:
+        db_index = False
+    return models.CharField(
+        verbose_name="租户 ID",
+        max_length=32,
+        default=DEFAULT_TENANT_ID,
+        help_text="本条数据的所属租户",
+        db_index=db_index,
+        unique=unique,
+    )

sdks/paas-service/paas_service/migrations/0009_alter_plan_unique_together_plan_tenant_id_and_more.py

@@ -0,0 +1,36 @@
+# Generated by Django 4.2.16 on 2025-02-17 13:19
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('paas_service', '0008_auto_20220426_0429'),
+    ]
+
+    operations = [
+        migrations.AlterUniqueTogether(
+            name='plan',
+            unique_together=set(),
+        ),
+        migrations.AddField(
+            model_name='plan',
+            name='tenant_id',
+            field=models.CharField(db_index=True, default='default', help_text='本条数据的所属租户', max_length=32, verbose_name='租户 ID'),
+        ),
+        migrations.AddField(
+            model_name='serviceinstance',
+            name='tenant_id',
+            field=models.CharField(db_index=True, default='default', help_text='本条数据的所属租户', max_length=32, verbose_name='租户 ID'),
+        ),
+        migrations.AddField(
+            model_name='serviceinstanceconfig',
+            name='tenant_id',
+            field=models.CharField(db_index=True, default='default', help_text='本条数据的所属租户', max_length=32, verbose_name='租户 ID'),
+        ),
+        migrations.AlterUniqueTogether(
+            name='plan',
+            unique_together={('tenant_id', 'service', 'name')},
+        ),
+    ]

sdks/paas-service/paas_service/models.py

@@ -28,9 +28,11 @@
 from django.utils.translation import gettext_lazy as _
 from jsonfield import JSONField
 from translated_fields import TranslatedField
-
 from blue_krill.models.fields import EncryptField
 
+from paas_service.fields import tenant_id_field_factory
+
+
 # Base Models start
 
 
@@ -59,7 +61,10 @@ class Meta(object):
 
 
 class SpecDefinition(UuidAuditedModel):
-    """Specification definition"""
+    """Specification definition
+
+    [multi-tenancy] This model is not tenant-aware.
+    """
 
     index = models.IntegerField(verbose_name=_('顺序'), default=0)
     name = models.CharField(verbose_name=_('名称'), unique=True, max_length=64, null=True)
@@ -81,7 +86,10 @@ def save(self, *args, **kwargs):
 
 
 class Specification(UuidAuditedModel):
-    """Specification value"""
+    """Specification value
+
+    [multi-tenancy] This model is not tenant-aware.
+    """
 
     definition = models.ForeignKey(SpecDefinition, verbose_name=_('定义'), on_delete=models.CASCADE)
     value = models.CharField(verbose_name=_('值'), max_length=64)
@@ -101,7 +109,10 @@ def save(self, *args, **kwargs):
 
 
 class Service(UuidAuditedModel):
-    """Service model for PaaS"""
+    """Service model for PaaS
+
+    [multi-tenancy] This model is not tenant-aware.
+    """
 
     name = models.CharField(verbose_name='服务名称', unique=True, max_length=64)
     category = models.IntegerField(verbose_name='服务分类')
@@ -134,11 +145,13 @@ class ServiceInstance(UuidAuditedModel):
 
     service = models.ForeignKey('Service', verbose_name='服务', null=True, on_delete=models.SET_NULL)
     plan = models.ForeignKey(
-        'Plan', verbose_name='方案', null=True, help_text="当前仅当迁移的增强服务实例, 会没有 plan", on_delete=models.SET_NULL
+        'Plan', verbose_name='方案', null=True, help_text="当前仅当迁移的增强服务实例, 会没有 plan",
+        on_delete=models.SET_NULL
     )
     config = JSONField(default=dict, blank=True)
     credentials = EncryptField(default="")
     to_be_deleted = models.BooleanField(default=False)
+    tenant_id = tenant_id_field_factory()
 
     class Meta:
         verbose_name_plural = verbose_name = '服务实例'
@@ -174,6 +187,7 @@ class ServiceInstanceConfig(UuidAuditedModel):
 
     instance = models.OneToOneField(ServiceInstance, verbose_name='服务实例', on_delete=models.CASCADE)
     paas_app_info = JSONField(default=dict, blank=True, verbose_name='平台应用信息')
+    tenant_id = tenant_id_field_factory()
 
     def was_initialized(self) -> bool:
         """Return if current config object was initialized"""
@@ -228,10 +242,11 @@ class Plan(UuidAuditedModel):
     service = models.ForeignKey('Service', related_name='plans', verbose_name='服务', on_delete=models.CASCADE)
 
     specifications = models.ManyToManyField(Specification, verbose_name='规格', blank=True)
+    tenant_id = tenant_id_field_factory()
 
     class Meta:
         verbose_name_plural = verbose_name = '方案'
-        unique_together = ("service", "name")
+        unique_together = ("tenant_id", "service", "name")
 
     def __str__(self):
         return f"{self.name}-{self.service.name}"
@@ -254,7 +269,10 @@ def full_specifications(self) -> Dict[str, Any]:
 
 
 class ResourceId(models.Model):
-    """utility model for avoiding name conflict"""
+    """utility model for avoiding name conflict
+
+    [multi-tenancy] This model is not tenant-aware.
+    """
 
     namespace = models.CharField(max_length=32)
     uid = models.CharField(max_length=64, null=False, unique=True, db_index=True)

sdks/paas-service/paas_service/serializers.py

@@ -96,6 +96,7 @@ class PaaSAppInfoSLZ(serializers.Serializer):
 
 class InstanceConfigSLZ(serializers.Serializer):
     paas_app_info = PaaSAppInfoSLZ(required=True)
+    tenant_id = serializers.CharField(max_length=64, read_only=True)
 
 
 ############################

sdks/paas-service/paas_service/utils.py

@@ -60,7 +60,7 @@ def gen_unique_id(
 
 def get_paas_app_info(instance: ServiceInstance) -> Optional[Dict]:
     """Get instance's related PaaS app infomations Dict"""
-    config, _ = ServiceInstanceConfig.objects.get_or_create(instance=instance)
+    config, _ = ServiceInstanceConfig.objects.get_or_create(instance=instance, tenant_id=instance.tenant_id)
     if not config.was_initialized():
         return None
 

sdks/paas-service/paas_service/views.py

@@ -36,7 +36,6 @@
 
 logger = logging.getLogger(__name__)
 
-
 m_verified_client_required = method_decorator(verified_client_required)
 
 
@@ -166,6 +165,7 @@ def provision(self, request, service_id, instance_id):
             plan=plan,
             config=instance_data.config,
             credentials=json.dumps(instance_data.credentials),
+            tenant_id=plan.tenant_id,
         )
         service_instance.prerender(request)
         return Response(serializers.ServiceInstanceSLZ(service_instance).data, status=201)
@@ -288,7 +288,7 @@ class SvcInstanceConfigViewSet(viewsets.ViewSet):
     def retrieve(self, request, instance_id):
         """Retrieve an instance's config"""
         instance = get_object_or_404(ServiceInstance, pk=instance_id)
-        config, _ = ServiceInstanceConfig.objects.get_or_create(instance=instance)
+        config, _ = ServiceInstanceConfig.objects.get_or_create(instance=instance, tenant_id=instance.tenant_id)
         if not config.was_initialized():
             return Response(data={'detail': 'config was not initialized yet'}, status=400)
 
@@ -304,7 +304,8 @@ def update(self, request, instance_id):
 
         # Update config
         config, _ = ServiceInstanceConfig.objects.update_or_create(
-            instance=instance, defaults={'paas_app_info': slz.validated_data['paas_app_info']}
+            instance=instance, tenant_id=instance.tenant_id,
+            defaults={'paas_app_info': slz.validated_data['paas_app_info']}
         )
         resp_slz = serializers.InstanceConfigSLZ(config)
         return Response(resp_slz.data)

sdks/paas-service/pyproject.toml

@@ -1,7 +1,7 @@
 [tool]
 [tool.poetry]
 name = "paas_service"
-version = "2.0.1"
+version = "2.0.2"
 description = "A Django application for developing BK-PaaS add-on services."
 readme = "README.md"
 authors = ["blueking <blueking@tencent.com>"]