Tugboat MCP

🚀 Tugboat 多租户容器平台（MCP）

Tugboat-MCP 是一个基于 Docker 和 Kubernetes 的多租户容器化平台。它为组织提供了统一的界面，方便管理和编排多个团队的容器化工作负载，有效提升了管理效率和资源利用率。

🚀 快速开始

安装部署

# 克隆项目仓库
git clone git@github.com:tugboat-mcp/tugboat.git

# 进入项目目录
cd tugboat

# 初始化环境
make init

# 启动所有组件
make up

# 只启动 API 服务
make start-api

# 停止所有组件
make down

# 执行单元测试
make test

# 执行集成测试
make e2e-test

使用指南

创建新租户

# 创建一个拥有默认资源配额的租户
tugboatctl create-tenant --name dev-team --cpu 2 --memory 4G

# 可选：指定 GPU 资源和存储配额
tugboatctl create-tenant --name data-team --cpu 4 --memory 8G --gpu 1 --storage 50G

部署应用

# 创建一个简单的 Node.js 应用
tugboatctl deploy app.yaml -n dev-team

查看资源使用情况

# 查询指定租户的资源使用情况
tugboatctl get-usage --tenant dev-team

# 查询所有租户的资源配额
tugboatctl describe tenants

✨ 主要特性

• 多租户支持：每个租户拥有独立的资源配额和隔离环境，确保资源的合理分配和使用安全。
• 集群管理：支持多个 Kubernetes 集群，实现资源复用与隔离，提高资源利用率。
• 镜像构建：内置 Docker 构建能力，支持 CI/CD 流水线，加速应用开发和部署流程。
• 工作负载编排：通过 YAML 文件定义和管理容器化应用，方便快捷。
• 监控与日志：集成 Prometheus 和 Grafana，提供实时监控和日志查询，帮助用户及时发现和解决问题。

📚 详细文档

项目结构

tugboat-mcp/
├── api/                      # 平台 API 接口定义
│   ├── v1/                  # 第一版本 API 定义
│   │   └── tenant/          # 租户相关接口
│   │       ├── routes.ts    # 路由定义
│   │       └── controllers/ # 控制器实现
│   └── middleware/          # 全局中间件配置
│       └── auth.ts         # 认证中间件
├── cli/                     # 用户命令行工具
│   ├── commands/            # 各类 CLI 命令实现
│   │   ├── tenant.ts        # 租户相关命令
│   │   └── deploy.ts        # 应用部署命令
│   └── utils/               # CLI 工具集函数
├── config/                  # 平台配置文件
│   └── default.yaml         # 默认配置
├── charts/                   # Kubernetes 资源定义
│   └── tugboat-operator/    # 平台操作器
└── test/                    # 测试用例
    ├── unit/                # 单元测试
    │   └── tenant.test.ts  # 租户模块测试
    └── e2e/                # 集成测试
        └── setup.ts        # 环境搭建

贡献指南

如何贡献代码

1. 叉出仓库：git clone git@github.com:tugboat-mcp/tugboat.git
2. 创建功能分支：git checkout -b feature/<your-feature>
3. 提交代码：git add . && git commit -m '你的提交信息'
4. 推送到远程：git push origin feature/<your-feature>
5. 提出合并请求

开发规范

1. 遵循平台的代码规范和命名习惯。
2. 每个功能分支必须包含对应的单元测试。
3. 提交信息要简洁明了，遵循 类型：描述 格式。
4. 确保代码通过 CI/CD 流水线验证。

测试指南

执行测试

# 执行单元测试
npm run test:unit

# 执行集成测试
npm run test:e2e

添加新测试用例

1. 在 test/unit 或 test/e2e 目录下创建新的测试文件。
2. 确保每个功能模块都有对应的测试覆盖率。
3. 提交代码时一并提交新增的测试用例。

📄 许可证

本项目采用 Apache 2.0 协议。更多信息请参阅 LICENSE 文件。