zgsm/zgsm-admin-system

配额管理仓库Docker镜像文档

1. 镜像概述

配额管理仓库Docker镜像是一个轻量级工具，旨在提供系统资源配额的定义、分配、监控和控制功能。通过容器化部署，简化配额管理流程，适用于需要对多用户、多服务或多租户环境进行资源分配与限制的场景，确保资源合理利用和系统稳定性。

2. 核心功能和特性

• 灵活配额定义：支持按用户、服务或租户自定义CPU、内存、磁盘空间等资源配额规则，支持动态调整
• 实时监控：实时跟踪资源使用状态，提供配额使用率统计和趋势分析，支持可视化展示
• 自动控制机制：当资源使用超限时，自动触发限制措施（如限制资源分配、发送告警通知）
• 多环境兼容：适配Docker、Kubernetes等容器化环境及传统物理机/虚拟机环境
• 数据持久化：支持配额配置和使用数据的持久化存储，确保容器重启后配置不丢失
• API支持：提供RESTful API接口，便于集成到现有管理系统或自动化流程

3. 使用场景和适用范围

• 共享服务器资源管理：在多用户共享物理服务器或虚拟机环境中，限制不同用户/部门的资源使用上限
• 容器化集群环境：为Kubernetes、Docker Swarm等容器编排平台中的Pod/容器设置资源配额，防止单个应用过度占用集群资源
• 多租户云服务平台：为云服务中的不同租户分配独立资源配额，实现租户间资源隔离，避免资源争抢
• 开发测试环境：在开发团队内部为不同项目或开发者分配测试资源配额，保障测试环境稳定性

4. 使用方法和配置说明

4.1 快速启动

使用以下命令快速启动配额管理服务：

bash
docker run -d --name quota-management \
  -p 8080:8080 \  # 映射服务端口
  -v /host/quota-data:/app/data \  # 挂载数据卷，持久化配额数据
  -e LOG_LEVEL=info \  # 设置日志级别
  -e DEFAULT_CPU_QUOTA=2 \  # 默认CPU配额（核数）
  -e DEFAULT_MEM_QUOTA=4G \  # 默认内存配额
  quota-management:latest

4.2 环境变量配置

4.3 配额规则配置

通过挂载配置文件自定义配额规则，配置文件（如quota-rules.yaml）示例：

yaml
# 按用户定义配额
user_quotas:
  - username: "dev_team1"
    cpu: 4          # CPU配额：4核
    memory: "8G"    # 内存配额：8GB
    disk: "100G"    # 磁盘配额：100GB
    priority: high  # 优先级：高（超限时延迟限制）

# 按服务定义配额
service_quotas:
  - service_name: "api-service"
    cpu: 2
    memory: "4G"
    disk: "50G"
    priority: normal

# 按租户定义配额（多租户场景）
tenant_quotas:
  - tenant_id: "tenant-001"
    cpu: 8
    memory: "32G"
    disk: "500G"
    priority: critical

启动时挂载配置文件：

bash
docker run -d --name quota-management \
  -p 8080:8080 \
  -v /host/quota-data:/app/data \
  -v /host/config/quota-rules.yaml:/app/config/quota-rules.yaml \  # 挂载自定义配额规则
  quota-management:latest

4.4 访问管理界面

服务启动后，通过http://<主机IP>:8080访问Web管理界面，可进行配额规则配置、资源使用监控和告警查看。

4.5 API接口调用

通过RESTful API管理配额（需先启动服务）：

• 获取当前配额规则：GET http://<主机IP>:8080/api/quotas
• 创建配额规则：POST http://<主机IP>:8080/api/quotas（请求体为JSON格式配额规则）
• 更新配额规则：PUT http://<主机IP>:8080/api/quotas/{quotaId}
• 获取资源使用统计：GET http://<主机IP>:8080/api/stats

5. 数据持久化

为避免容器重启导致配额配置和监控数据丢失，需挂载数据卷至容器内/app/data目录：

bash
-v /host/quota-data:/app/data

该目录包含配额数据库、使用统计日志和配置备份文件。