Tugboat MCP

🚀 Tugboat Multi-Tenant Container Platform (MCP)

Tugboat-MCP is a multi-tenant containerized platform based on Docker and Kubernetes. It enables organizations to manage and orchestrate containerized workloads of multiple teams through a unified interface.

🚀 Quick Start

Installation and Deployment

# Clone the project repository
git clone git@github.com:tugboat-mcp/tugboat.git

# Enter the project directory
cd tugboat

# Initialize the environment
make init

# Start all components
make up

# Start only the API service
make start-api

# Stop all components
make down

# Run unit tests
make test

# Run integration tests
make e2e-test

Usage Guide

Create a New Tenant

# Create a tenant with default resource quotas
tugboatctl create-tenant --name dev-team --cpu 2 --memory 4G

# Optional: Specify GPU resources and storage quotas
tugboatctl create-tenant --name data-team --cpu 4 --memory 8G --gpu 1 --storage 50G

Deploy an Application

# Create a simple Node.js application
tugboatctl deploy app.yaml -n dev-team

View Resource Usage

# Query the resource usage of a specified tenant
tugboatctl get-usage --tenant dev-team

# Query the resource quotas of all tenants
tugboatctl describe tenants

✨ Features

• Multi-Tenant Support: Each tenant has independent resource quotas and isolated environments.
• Cluster Management: Supports multiple Kubernetes clusters for resource reuse and isolation.
• Image Building: Built-in Docker building capabilities, supporting CI/CD pipelines.
• Workload Orchestration: Define and manage containerized applications through YAML files.
• Monitoring and Logging: Integrates Prometheus and Grafana for real-time monitoring and log querying.

💻 Usage Examples

Basic Usage

# Clone the project and start the platform
git clone git@github.com:tugboat-mcp/tugboat.git
cd tugboat
make init
make up

Advanced Usage

# Create a tenant with specific GPU and storage resources and deploy an application
tugboatctl create-tenant --name data-team --cpu 4 --memory 8G --gpu 1 --storage 50G
tugboatctl deploy app.yaml -n data-team

📚 Documentation

Project Structure

tugboat-mcp/
├── api/                      # Platform API interface definitions
│   ├── v1/                  # First version API definitions
│   │   └── tenant/          # Tenant-related interfaces
│   │       ├── routes.ts    # Route definitions
│   │       └── controllers/ # Controller implementations
│   └── middleware/          # Global middleware configuration
│       └── auth.ts         # Authentication middleware
├── cli/                     # User command-line tool
│   ├── commands/            # Various CLI command implementations
│   │   ├── tenant.ts        # Tenant-related commands
│   │   └── deploy.ts        # Application deployment commands
│   └── utils/               # CLI utility functions
├── config/                  # Platform configuration files
│   └── default.yaml         # Default configuration
├── charts/                   # Kubernetes resource definitions
│   └── tugboat-operator/    # Platform operator
└── test/                    # Test cases
    ├── unit/                # Unit tests
    │   └── tenant.test.ts  # Tenant module tests
    └── e2e/                # Integration tests
        └── setup.ts        # Environment setup

Contribution Guide

How to Contribute Code

1. Fork the repository: git clone git@github.com:tugboat-mcp/tugboat.git
2. Create a feature branch: git checkout -b feature/<your-feature>
3. Commit your code: git add . && git commit -m 'Your commit message'
4. Push to the remote: git push origin feature/<your-feature>
5. Submit a pull request

Development Specifications

1. Follow the platform's code specifications and naming conventions.
2. Each feature branch must include corresponding unit tests.
3. Commit messages should be concise and follow the Type: Description format.
4. Ensure that the code passes the CI/CD pipeline verification.

Test Guide

Run Tests

# Run unit tests
npm run test:unit

# Run integration tests
npm run test:e2e

Add New Test Cases

1. Create new test files in the test/unit or test/e2e directory.
2. Ensure that each functional module has corresponding test coverage.
3. Submit the new test cases along with the code.

📄 License

This project is licensed under the Apache 2.0 license. For more information, please refer to the LICENSE file.