快速开始

本文档将指导您完成 MCPCAN 平台的部署过程。我们提供两种部署路径，以适应不同的运行环境：

• 一键化部署脚本：适用于全新的、干净的服务器环境，脚本将自动为您安装所有依赖项并完成部署。推荐新用户和测试环境使用。
• 标准 Helm 部署：适用于您已经拥有可用 Kubernetes 集群的环境。

---

1. 环境依赖

在开始部署之前，请确保您的环境满足以下最低要求。如果您使用一键化部署脚本，脚本会自动检查并安装这些依赖。

• 系统要求:
  • Kubernetes: v1.20 或更高版本。
  • Helm: v3.0 或更高版本。
  • NGINX Ingress Controller: 如果需要通过域名访问平台，则必须安装。
  • 持久化存储 (Persistent Storage): 用于平台数据的持久化。
  • 硬件资源: 至少 4GB 内存和 2 核 CPU。

---

2. 克隆部署仓库

首先，克隆包含所有部署脚本和配置文件的 mcpcan-deploy 仓库。

# 克隆仓库
git clone https://github.com/kymo-mcp/mcpcan-deploy.git

# 进入仓库目录
cd mcpcan-deploy

3. 运行环境依赖安装

此方法通过执行一个脚本，在全新的环境中自动安装 K3s (一个轻量级的 Kubernetes 发行版)、Helm、Ingress 控制器，并最终部署 MCPCAN 平台。 如果您的环境中已经安装了 K3s、Helm 和 Ingress 控制器，您可以跳过此步骤。

执行环境安装脚本

仓库中的 install-run-environment.sh 脚本是部署核心，它会完成所有环境准备和应用安装工作。

# 执行安装脚本
./scripts/install-run-environment.sh

提示： 如果您在中国大陆地区执行此脚本，建议添加 --cn 参数。这将使用国内镜像源来加速依赖包的下载过程。

./scripts/install-run-environment.sh --cn

脚本执行成功后，基础环境就已经部署完成。

4. 标准 Helm 部署

我们通过 Helm 进行部署。为了方便管理和升级，最佳实践是将自定义配置与默认配置分离。

1. 复制配置文件： 将默认的 values.yaml 文件复制为 values-custom.yaml。我们所有的修改都将在这个新文件中进行。

   cp helm/values.yaml helm/values-custom.yaml

2. 修改自定义配置： 使用您偏好的编辑器打开 helm/values-custom.yaml 文件。最重要的配置是域名和 TLS 证书。

   # helm/values-custom.yaml
   
   # 全局配置
   global:
     # 是否使用国内镜像源, 默认为 false
     cn: false
     # 在这里设置您的域名, 例如: demo.mcpcan.com
     domain: "demo.mcpcan.com"
   
   # Ingress 配置
   ingress:
     tls:
       # 启用 TLS
       enabled: true
       # 配置证书内容 (用于自签名证书或已有证书)
       # -----BEGIN CERTIFICATE-----
       #  您的证书内容
       # -----END CERTIFICATE-----
       crt: |
         
       # -----BEGIN PRIVATE KEY-----
       #  您的私钥内容
       # -----END PRIVATE KEY-----
       key: |

完成自定义配置后，执行 helm install 命令来部署 MCPCAN。

helm install mcpcan ./helm -f helm/values-custom.yaml \
  --namespace mcpcan --create-namespace --timeout 600s --wait

• 命令解析:
  • helm install mcpcan ./helm: 安装一个名为 mcpcan 的 release，chart 路径为 ./helm。
  • -f helm/values-custom.yaml: 使用我们自定义的配置文件来覆盖默认值。
  • --namespace mcpcan: 指定在 mcpcan 这个命名空间中进行安装。
  • --create-namespace: 如果 mcpcan 命名空间不存在，则自动创建。
  • --timeout 600s: 将安装超时时间设置为 600 秒。
  • --wait: 等待所有资源都成功部署并进入 Ready 状态后再返回。

5. 验证部署

部署完成后，您可以通过以下命令检查所有 Pod 是否正常运行：

kubectl get pods -n mcpcan

如果所有 Pod 的 STATUS 都显示为 Running，则表示平台已成功启动。

接下来，您可以在浏览器中访问您配置的域名（例如 http://demo.mcpcan.com）来打开 MCPCAN 的登录界面。

6. 卸载平台

如果您需要卸载 MCPCAN 平台，只需执行以下 Helm 命令：

helm uninstall mcpcan -n mcpcan