Tugboat MCP

🚀 Tugboat 多租戶容器平臺（MCP）

Tugboat-MCP 是一個基於 Docker 和 Kubernetes 的多租戶容器化平臺，它為組織提供了統一界面，可對多個團隊的容器化工作負載進行管理與編排。

✨ 主要特性

• 多租戶支持：每個租戶擁有獨立的資源配額和隔離環境
• 集群管理：支持多個 Kubernetes 集群，實現資源複用與隔離
• 鏡像構建：內置 Docker 構建能力，支持 CI/CD 流水線
• 工作負載編排：通過 YAML 文件定義和管理容器化應用
• 監控與日誌：集成 Prometheus 和 Grafana，提供即時監控和日誌查詢

📦 安裝指南

# 克隆項目倉庫
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

📚 詳細文檔

項目結構

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 文件。