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/                  # 第 1 版 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 パイプラインの検証に合格することを確認する。

📄 ライセンス

このプロジェクトは Apache 2.0 ライセンスを採用しています。詳細については、LICENSE ファイルを参照してください。

テストの実行

# 単体テストを実行する
npm run test:unit

# 統合テストを実行する
npm run test:e2e

新しいテストケースを追加する

1. test/unit または test/e2e ディレクトリに新しいテストファイルを作成する。
2. 各機能モジュールに対応するテストカバレッジがあることを確認する。
3. コードをコミットする際に、新しいテストケースも一緒にコミットする。