cancan-microstack 0.0.1__py3-none-any.whl

cancan_microstack/public/schemas/infra/operation.py

@@ -0,0 +1,90 @@
+"""
+异步操作相关的 Pydantic 模型
+
+供 opsbffsrv 和 infrasrv 之间通信使用
+"""
+from typing import (
+    Optional,
+    Dict,
+    Any,
+)
+from datetime import datetime
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+)
+
+from cancan_microstack.public.const.operation_consts import (
+    OperationType,
+    OperationStatus,
+    InitiatedBy,
+    InitiatedFrom,
+)
+
+
+class OperationCreateRequest(BaseModel):
+    """创建操作记录请求"""
+    operation_id: str = Field(..., description="操作ID")
+    operation_type: OperationType = Field(..., description="操作类型")
+    service_name: str = Field(..., description="服务名称（带 .service 后缀）")
+    operation_params: Dict[str, Any] = Field(default_factory=dict, description="操作参数")
+    status: OperationStatus = Field(default=OperationStatus.PENDING, description="操作状态")
+    initiated_by: InitiatedBy = Field(default=InitiatedBy.OPSBFFSRV, description="操作发起者")
+    initiated_from: InitiatedFrom = Field(default=InitiatedFrom.FRONTEND, description="发起来源")
+
+
+class OperationUpdateRequest(BaseModel):
+    """更新操作记录请求"""
+    operation_id: str = Field(..., description="操作ID")
+    status: Optional[OperationStatus] = Field(default=None, description="操作状态")
+    started_at: Optional[datetime] = Field(default=None, description="开始时间")
+    completed_at: Optional[datetime] = Field(default=None, description="完成时间")
+    result: Optional[Dict[str, Any]] = Field(default=None, description="操作结果")
+    error_message: Optional[str] = Field(default=None, description="错误信息")
+
+
+class OperationQueryRequest(BaseModel):
+    """查询操作记录请求"""
+    operation_id: Optional[str] = Field(default=None, description="操作ID")
+    service_name: Optional[str] = Field(default=None, description="服务名称")
+    status: Optional[OperationStatus] = Field(default=None, description="操作状态")
+    limit: int = Field(default=50, ge=1, le=1000, description="返回记录数")
+    offset: int = Field(default=0, ge=0, description="偏移量")
+
+
+class Operation(BaseModel):
+    """操作记录"""
+
+    model_config = ConfigDict(from_attributes=True)
+
+    id: Optional[int] = None
+    operation_id: str
+    operation_type: str  # 保持字符串以兼容数据库
+    service_name: str
+    operation_params: Dict[str, Any] = Field(default_factory=dict)
+    status: str = "pending"  # 保持字符串以兼容数据库
+    started_at: Optional[datetime] = None
+    completed_at: Optional[datetime] = None
+    result: Dict[str, Any] = Field(default_factory=dict)
+    error_message: Optional[str] = None
+    retry_count: int = 0
+    max_retries: int = 3
+    last_retry_at: Optional[datetime] = None
+    initiated_by: str = "system"  # 保持字符串以兼容数据库
+    initiated_from: str = "unknown"  # 保持字符串以兼容数据库
+    flag: int = 0
+    created_time: Optional[datetime] = None
+    update_time: Optional[datetime] = None
+
+
+
+class OperationResponse(BaseModel):
+    """操作响应"""
+    operation: Optional[Operation] = None
+
+
+class OperationListResponse(BaseModel):
+    """操作列表响应"""
+    operations: list[Operation] = Field(default_factory=list)
+    count: int = 0

cancan_microstack/public/schemas/infra/overview.py

@@ -0,0 +1,25 @@
+"""
+Service overview related Pydantic models.
+"""
+from pydantic import BaseModel
+
+from cancan_microstack.public.const.health_consts import (
+    HealthOverallStatus,
+    ServiceRuntimeStatus,
+)
+
+
+class ServiceOverview(BaseModel):
+    """Service overview data model."""
+    service_name: str
+    description: str = ""
+    service_type: str = "business"
+    expected_status: ServiceRuntimeStatus = ServiceRuntimeStatus.RUNNING
+    actual_status: ServiceRuntimeStatus = ServiceRuntimeStatus.STOPPED
+    status_matches_expected: bool = False
+    desired_replicas: int = 1
+    actual_replicas: int = 0
+    total_instances: int = 0
+    healthy_instances: int = 0
+    unhealthy_instances: int = 0
+    overall_status: HealthOverallStatus = HealthOverallStatus.DOWN

cancan_microstack/public/schemas/infra/push.py

@@ -0,0 +1,33 @@
+from typing import (
+    List,
+    Optional,
+)
+
+from pydantic import (
+    BaseModel,
+    Field,
+)
+
+
+class PushDetail(BaseModel):
+    """
+    配置推送单实例结果模型
+    Result model for a single push-to-service attempt
+    """
+    instance_id: str = Field(..., description="Instance ID")
+    host: str = Field(..., description="Host")
+    port: int = Field(..., description="Port")
+    status: str = Field(..., description="Result status, see OperationStatus")
+    error: Optional[str] = Field(default=None, description="Error message if failed")
+
+
+class PushResult(BaseModel):
+    """
+    配置推送汇总结果模型
+    Summary model for push-to-service operations
+    """
+    service_name: str = Field(..., description="Service name")
+    total_instances: int = Field(..., description="Total target instances")
+    success: int = Field(default=0, description="Successful pushes")
+    failed: int = Field(default=0, description="Failed pushes")
+    details: List[PushDetail] = Field(default_factory=list, description="Per-instance push details")

cancan_microstack/public/schemas/infra/service_action_log.py

@@ -0,0 +1,47 @@
+"""
+服务行为日志相关的 Pydantic 类型定义
+"""
+from typing import (
+    Optional,
+    Dict,
+    Any,
+)
+from datetime import datetime
+
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+)
+
+
+class ServiceActionLog(BaseModel):
+    """服务行为日志数据模型"""
+
+    model_config = ConfigDict(from_attributes=True)
+
+    id: Optional[int] = None
+    service_name: str = Field(..., description="服务名称")
+    instance_id: Optional[str] = Field(default=None, description="实例ID")
+    action_type: str = Field(..., description="行为类型")
+    action_status: str = Field(..., description="行为状态")
+    action_detail: Optional[Dict[str, Any]] = Field(default=None, description="行为详情")
+    error_message: Optional[str] = Field(default=None, description="错误信息")
+    triggered_by: str = Field(default="system", description="触发者")
+    action_metadata: Optional[Dict[str, Any]] = Field(default=None, description="行为附加元数据")
+    flag: int = Field(default=0, description="标志位")
+    created_time: Optional[datetime] = None
+    update_time: Optional[datetime] = None
+
+
+
+class ServiceActionLogCreate(BaseModel):
+    """创建服务行为日志的请求模型"""
+    service_name: str = Field(..., description="服务名称")
+    instance_id: Optional[str] = Field(default=None, description="实例ID")
+    action_type: str = Field(..., description="行为类型：register, deregister, heartbeat, health_check_fail, restart, scale, rebuild")
+    action_status: str = Field(..., description="行为状态：success, failed, in_progress")
+    action_detail: Optional[Dict[str, Any]] = Field(default=None, description="行为详情")
+    error_message: Optional[str] = Field(default=None, description="错误信息")
+    triggered_by: str = Field(default="system", description="触发者：system, user, auto")
+    action_metadata: Optional[Dict[str, Any]] = Field(default=None, description="行为附加元数据")

cancan_microstack/public/schemas/infra/service_config.py

@@ -0,0 +1,10 @@
+from pydantic import (
+    BaseModel,
+    Field,
+)
+
+
+class ServiceConfig(BaseModel):
+    service_name: str = Field(..., description="The name of the service")
+    conf_key: str = Field(..., description="The configuration key")
+    conf_value: str = Field(..., description="The configuration value")

cancan_microstack/public/schemas/infra/service_info.py

@@ -0,0 +1,69 @@
+"""
+服务信息相关的 Pydantic 类型定义
+"""
+from typing import (
+    Optional,
+    Dict,
+    Any,
+)
+from datetime import datetime
+
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+)
+
+
+class ServiceInfo(BaseModel):
+    """服务信息数据模型"""
+
+    model_config = ConfigDict(from_attributes=True)
+
+    id: Optional[int] = None
+    service_name: str = Field(..., description="服务名称")
+    description: Optional[str] = Field(default=None, description="服务描述")
+    service_type: str = Field(default="business", description="服务类型")
+    health_check_path: str = Field(default="/internal/health", description="默认健康检查路径")
+    service_metadata: Dict[str, Any] = Field(
+        default_factory=dict,
+        description="服务附加元数据（聚合 owner/deploy_region/config_version/labels 等信息）",
+    )
+    expected_status: str = Field(default="running", description="期望状态: running|stopped")
+    # 注意：以下副本数/扩缩容相关字段仅作"记录期望状态"用途，系统不会据此真正增减容器（扩缩容执行未实现）。
+    desired_replicas: int = Field(default=1, description="期望副本数（仅记录，不触发扩缩容）")
+    actual_replicas: int = Field(default=0, description="实际副本数（由上游上报回填）")
+    last_scale_at: Optional[datetime] = Field(default=None, description="最后记录副本数变更的时间（非真实扩缩容动作）")
+    scale_policy: Dict[str, Any] = Field(default_factory=dict, description="扩缩容策略（占位，未实现自动扩缩容）")
+    registered_time: Optional[datetime] = Field(default=None, description="首次注册时间")
+    last_registered_time: Optional[datetime] = Field(default=None, description="最近注册时间")
+    flag: int = Field(default=0, description="标志位")
+    created_time: Optional[datetime] = None
+    update_time: Optional[datetime] = None
+
+
+
+class ServiceInfoCreate(BaseModel):
+    """创建服务信息的请求模型"""
+
+    service_name: str = Field(..., description="服务名称", min_length=1, max_length=100)
+    description: Optional[str] = Field(default=None, description="服务描述")
+    service_type: str = Field(default="business", description="服务类型：infrastructure, business, ops")
+    health_check_path: str = Field(default="/internal/health", description="健康检查路径")
+    service_metadata: Dict[str, Any] = Field(default_factory=dict, description="服务附加元数据")
+    desired_replicas: int = Field(default=1, ge=1, description="期望副本数")
+    actual_replicas: int = Field(default=0, ge=0, description="当前副本数")
+    expected_status: str = Field(default="running", description="期望状态")
+    scale_policy: Dict[str, Any] = Field(default_factory=dict, description="扩缩容策略")
+
+
+class ServiceInfoUpdate(BaseModel):
+    """更新服务信息的请求模型"""
+    description: Optional[str] = Field(default=None, description="服务描述")
+    service_type: Optional[str] = Field(default=None, description="服务类型")
+    health_check_path: Optional[str] = Field(default=None, description="健康检查路径")
+    service_metadata: Optional[Dict[str, Any]] = Field(default=None, description="服务附加元数据")
+    expected_status: Optional[str] = Field(default=None, description="期望状态")
+    desired_replicas: Optional[int] = Field(default=None, ge=1, description="期望副本数")
+    actual_replicas: Optional[int] = Field(default=None, ge=0, description="当前副本数")
+    scale_policy: Optional[Dict[str, Any]] = Field(default=None, description="扩缩容策略")

cancan_microstack/public/schemas/infra/service_instance.py

@@ -0,0 +1,93 @@
+"""
+服务实例相关的 Pydantic 类型定义
+"""
+from typing import (
+    Optional,
+    Dict,
+    Any,
+)
+from datetime import datetime
+
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+)
+
+
+class ServiceInstance(BaseModel):
+    """
+    服务实例
+    
+    表示一个服务实例的完整信息，包括网络配置、健康状态、生命周期等。
+    """
+    id: Optional[int] = None
+    service_name: str = Field(..., description="服务名称")
+    instance_id: str = Field(..., description="实例ID")
+    container_name: Optional[str] = Field(default=None, description="Docker容器名 / Docker container name")
+    compose_service_name: Optional[str] = Field(default=None, description="Docker Compose服务名 / Compose service name")
+    host: str = Field(..., description="宿主机地址")
+    port: int = Field(..., description="服务端口")
+    internal_port: int = Field(default=8080, description="容器内部端口")
+    status: str = Field(..., description="实例状态 (UP|DOWN|UNHEALTHY) / Instance status")
+    expected_status: str = Field(default="UP", description="期望状态 (UP|DOWN) / Desired status")
+    health_check_url: Optional[str] = Field(default=None, description="健康检查URL / Health check URL")
+    health_status: Optional[str] = Field(None, description="健康状态: healthy|unhealthy|unknown")
+    last_health_check: Optional[datetime] = Field(None, description="最后健康检查时间")
+    last_heartbeat: Optional[datetime] = Field(None, description="最后心跳时间")
+    consecutive_failures: int = Field(default=0, description="连续失败次数")
+    last_health_error: Optional[str] = Field(None, description="最后健康检查错误")
+    started_at: Optional[datetime] = Field(None, description="启动时间")
+    stopped_at: Optional[datetime] = Field(None, description="停止时间")
+    restart_count: int = Field(default=0, description="重启次数")
+    cpu_limit: Optional[str] = Field(None, description="CPU限制")
+    memory_limit: Optional[str] = Field(None, description="内存限制")
+    instance_metadata: Dict[str, Any] = Field(default_factory=dict, description="实例元数据 / Instance metadata")
+    flag: int = Field(default=0)
+    created_time: Optional[datetime] = None
+    update_time: Optional[datetime] = None
+
+    model_config = ConfigDict(from_attributes=True)
+
+
+class ServiceInstanceCreate(BaseModel):
+    """创建服务实例的请求模型"""
+    service_name: str
+    instance_id: str
+    container_name: Optional[str] = None
+    compose_service_name: Optional[str] = None
+    host: str
+    port: int
+    internal_port: int = 8080
+    status: str = "UP"
+    expected_status: str = "UP"
+    health_check_url: Optional[str] = None
+    health_status: str = "unknown"
+    instance_metadata: Dict[str, Any] = Field(default_factory=dict, description="实例元数据")
+
+
+class ServiceInstanceUpdate(BaseModel):
+    """更新服务实例的请求模型"""
+    status: Optional[str] = None
+    expected_status: Optional[str] = None
+    health_status: Optional[str] = None
+    health_check_url: Optional[str] = None
+    last_health_check: Optional[datetime] = None
+    last_heartbeat: Optional[datetime] = None
+    consecutive_failures: Optional[int] = None
+    last_health_error: Optional[str] = None
+    started_at: Optional[datetime] = None
+    stopped_at: Optional[datetime] = None
+    restart_count: Optional[int] = None
+    instance_metadata: Optional[Dict[str, Any]] = None
+
+
+class ServiceInstanceQuery(BaseModel):
+    """查询服务实例的请求模型"""
+    service_name: Optional[str] = None
+    instance_id: Optional[str] = None
+    status: Optional[str] = None
+    expected_status: Optional[str] = None
+    health_status: Optional[str] = None
+    limit: int = Field(default=100, le=1000, description="返回结果数量限制")
+    offset: int = Field(default=0, description="分页偏移量")

cancan_microstack/public/schemas/infra/service_management.py

@@ -0,0 +1,152 @@
+"""
+服务管理相关的 Pydantic 模型 / Service Management Related Pydantic Models
+
+供 infrasrv 和 opsbffsrv 之间通信使用 / Used for communication between infrasrv and opsbffsrv
+"""
+from typing import (
+    Dict,
+    Any,
+    Optional,
+)
+from datetime import datetime
+from pydantic import (
+    BaseModel,
+    Field,
+)
+
+from cancan_microstack.public.const.operation_consts import (
+    OperationType,
+    OperationStatus,
+    InitiatedBy,
+    InitiatedFrom,
+)
+
+
+class ServiceManagementRequest(BaseModel):
+    """
+    服务管理请求模型 / Service Management Request Model
+    
+    统一的服务管理请求格式，适用于所有操作类型（start/stop/restart）
+    Unified service management request format for supported operation types
+    """
+    operation_id: str = Field(..., description="操作ID，用于跟踪操作生命周期 / Operation ID for tracking lifecycle")
+    service_name: str = Field(..., description="服务名称（带 .service 后缀）/ Service name (with .service suffix)")
+    operation_type: OperationType = Field(..., description="操作类型 / Operation type")
+    operation_params: Dict[str, Any] = Field(
+        default_factory=dict,
+        description="操作参数（按需使用）/ Operation parameters (optional)"
+    )
+    initiated_by: InitiatedBy = Field(
+        default=InitiatedBy.OPSBFFSRV,
+        description="操作发起者 / Operation initiator"
+    )
+    initiated_from: InitiatedFrom = Field(
+        default=InitiatedFrom.FRONTEND,
+        description="发起来源 / Initiation source"
+    )
+
+
+class ServiceManagementResponse(BaseModel):
+    """
+    服务管理响应模型 / Service Management Response Model
+    
+    包含操作执行结果和当前状态 / Contains operation execution result and current status
+    """
+    operation_id: str = Field(..., description="操作ID / Operation ID")
+    status: OperationStatus = Field(..., description="操作状态 / Operation status")
+    service_name: str = Field(..., description="服务名称 / Service name")
+    message: str = Field(default="", description="响应消息 / Response message")
+    result: Optional[Dict[str, Any]] = Field(
+        default=None,
+        description="操作结果详情（可选）/ Operation result details (optional)"
+    )
+    error_message: Optional[str] = Field(
+        default=None,
+        description="错误信息（如果操作失败）/ Error message (if operation failed)"
+    )
+    started_at: Optional[datetime] = Field(
+        default=None,
+        description="操作开始时间 / Operation start time"
+    )
+    completed_at: Optional[datetime] = Field(
+        default=None,
+        description="操作完成时间 / Operation completion time"
+    )
+
+
+class ServiceOperationResult(BaseModel):
+    """
+    服务操作结果模型（用于 controllersrv 返回）/ Service Operation Result Model (for controllersrv response)
+    
+    解析 controllersrv 返回的详细操作结果 / Parse detailed operation results from controllersrv
+    """
+    success: bool = Field(..., description="操作是否成功 / Whether operation succeeded")
+    message: str = Field(default="", description="结果消息 / Result message")
+    service_names: list[str] = Field(default_factory=list, description="涉及的服务列表 / List of involved services")
+    details: Dict[str, Any] = Field(
+        default_factory=dict,
+        description="详细信息（容器状态、日志等）/ Detailed info (container status, logs, etc.)"
+    )
+
+
+class ServiceManagementStats(BaseModel):
+    """
+    服务管理统计信息 / Service Management Statistics
+    
+    用于监控和分析服务管理操作的性能和结果 / Used for monitoring and analyzing service management performance
+    """
+    total_operations: int = Field(default=0, description="总操作数 / Total operations")
+    success_count: int = Field(default=0, description="成功次数 / Success count")
+    failed_count: int = Field(default=0, description="失败次数 / Failed count")
+
+
+class HookResult(BaseModel):
+    """
+    钩子执行结果模型 / Hook Execution Result Model
+    
+    用于预操作钩子返回结果 / Used for pre-operation hook return results
+    """
+    allow: bool = Field(default=True, description="是否允许操作继续 / Whether to allow operation to continue")
+    reason: str = Field(default="", description="拒绝原因（如果 allow=False）/ Rejection reason (if allow=False)")
+
+
+class ControllerSrvResult(BaseModel):
+    """
+    ControllerSrv 调用结果模型 / ControllerSrv Call Result Model
+    
+    统一 controllersrv 返回的结果格式 / Unified result format from controllersrv
+    """
+    success: bool = Field(..., description="操作是否成功 / Whether operation succeeded")
+    message: str = Field(default="", description="结果消息 / Result message")
+    error: Optional[str] = Field(default=None, description="错误信息 / Error message")
+    retry_count: Optional[int] = Field(default=None, description="重试次数 / Retry count")
+    pending_count: int = Field(default=0, description="待处理次数 / Pending count")
+    avg_duration_seconds: float = Field(default=0.0, description="平均耗时（秒）/ Average duration (seconds)")
+
+
+class ServiceManagementAPIResponse(BaseModel):
+    """
+    服务管理 API 响应 DTO / Service Management API Response DTO
+    
+    用于 API 层返回给客户端的响应格式 / Used for API layer to return response to client
+    """
+    operation_id: str = Field(..., description="操作ID / Operation ID")
+    status: str = Field(..., description="操作状态 / Operation status")
+    service_name: str = Field(..., description="服务名称 / Service name")
+    message: str = Field(default="", description="响应消息 / Response message")
+    result: Optional[Dict[str, Any]] = Field(
+        default=None,
+        description="操作结果详情（可选）/ Operation result details (optional)"
+    )
+    error_message: Optional[str] = Field(
+        default=None,
+        description="错误信息（如果操作失败）/ Error message (if operation failed)"
+    )
+    started_at: Optional[str] = Field(
+        default=None,
+        description="操作开始时间（ISO格式）/ Operation start time (ISO format)"
+    )
+    completed_at: Optional[str] = Field(
+        default=None,
+        description="操作完成时间（ISO格式）/ Operation completion time (ISO format)"
+    )

cancan_microstack/public/schemas/infra/service_operation.py

@@ -0,0 +1,79 @@
+"""
+服务操作相关的 Pydantic 类型定义
+"""
+from typing import (
+    Optional,
+    Dict,
+    Any,
+)
+from datetime import datetime
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+)
+
+from cancan_microstack.public.const.operation_consts import (
+    OperationStatus,
+)
+
+
+class ServiceOperation(BaseModel):
+    """
+    服务操作记录
+    
+    表示一个服务操作的完整信息，包括操作状态、执行时间、结果等。
+    """
+    id: Optional[int] = None
+    operation_id: str = Field(..., description="唯一操作ID")
+    operation_type: str = Field(..., description="操作类型: start|stop|restart|scale")
+    service_name: str = Field(..., description="服务名称")
+    operation_params: Dict[str, Any] = Field(default_factory=dict, description="操作参数")
+    status: str = Field(..., description="操作状态: pending|running|success|failed|timeout")
+    started_at: Optional[datetime] = Field(None, description="开始执行时间")
+    completed_at: Optional[datetime] = Field(None, description="完成时间")
+    result: Dict[str, Any] = Field(default_factory=dict, description="执行结果详情")
+    error_message: Optional[str] = Field(None, description="错误信息")
+    retry_count: int = Field(default=0, description="已重试次数")
+    max_retries: int = Field(default=3, description="最大重试次数")
+    last_retry_at: Optional[datetime] = Field(None, description="最后重试时间")
+    initiated_by: Optional[str] = Field(None, description="操作发起者")
+    initiated_from: Optional[str] = Field(None, description="发起来源")
+    flag: int = Field(default=0)
+    created_time: Optional[datetime] = None
+    update_time: Optional[datetime] = None
+
+    model_config = ConfigDict(from_attributes=True)
+
+
+class ServiceOperationCreate(BaseModel):
+    """创建服务操作的请求模型"""
+    operation_id: str
+    operation_type: str
+    service_name: str
+    operation_params: Dict[str, Any] = Field(default_factory=dict)
+    status: str = OperationStatus.PENDING
+    initiated_by: Optional[str] = None
+    initiated_from: Optional[str] = None
+    max_retries: int = 3
+
+
+class ServiceOperationUpdate(BaseModel):
+    """更新服务操作的请求模型"""
+    status: Optional[str] = None
+    started_at: Optional[datetime] = None
+    completed_at: Optional[datetime] = None
+    result: Optional[Dict[str, Any]] = None
+    error_message: Optional[str] = None
+    retry_count: Optional[int] = None
+    last_retry_at: Optional[datetime] = None
+
+
+class ServiceOperationQuery(BaseModel):
+    """查询服务操作的请求模型"""
+    operation_id: Optional[str] = None
+    service_name: Optional[str] = None
+    operation_type: Optional[str] = None
+    status: Optional[str] = None
+    limit: int = Field(default=10, le=100, description="返回结果数量限制")
+    offset: int = Field(default=0, description="分页偏移量")