Velero MCP

🚀 Velero MCP 服務器

Velero MCP 服務器是一個開源的模型上下文協議（MCP）服務器，它為運行在任何 Kubernetes 集群內的 Velero 備份和調度資源提供只讀、安全、結構化的訪問。

該項目允許 AI 代理（如 ChatGPT、Claude、Cursor、GitHub Copilot 等）：

• 🔍 檢查 Velero 備份
• 🔄 檢查 Velero 調度
• 📄 生成 Velero 備份 YAML 清單
• 🧩 將 Velero 數據作為 MCP 資源進行訪問
• 🔐 以只讀模式安全地與集群進行交互

此項目幫助平臺工程師使用 AI 自動化工作流，同時確保對關鍵集群配置的零風險、低權限和只讀訪問。

🚀 快速開始

Velero MCP 服務器為 AI 代理提供了安全訪問 Velero 備份和調度資源的途徑，可幫助工程師自動化工作流。以下將詳細介紹其特性、安裝、配置和使用方法。

✨ 主要特性

🔧 MCP 工具

list_velero_backups(namespace?: str)

返回 Velero 備份自定義資源（CR）的列表。

get_velero_backup(name: str, namespace?: str)

返回詳細的結構化備份對象。

list_velero_schedules(namespace?: str)

列出 Velero 調度 CR，包括 cron 表達式、暫停狀態和上次備份信息。

generate_velero_backup_yaml(...)

為 Velero Backup 生成只讀 YAML。

📦 安裝指南

git clone https://github.com/YOUR-ORG/velero-mcp-server.git
cd velero-mcp-server

python -m venv .venv
source .venv/bin/activate    # Windows: .venv\Scripts\activate

pip install -r requirements.txt
pip install .

若用於開發：

pip install ".[dev]"

💻 使用示例

基礎用法

列出失敗的備份

“調用 list_velero_backups 並過濾出狀態為失敗的備份。”

檢查備份

“使用 get_velero_backup 獲取 prod-full 備份的信息，並告訴我包含的命名空間。”

生成清單

“生成一個包含 db 和 logging 命名空間、TTL 為 168 小時的 Velero 備份 YAML。”

生成的 YAML 如下：

apiVersion: velero.io/v1
kind: Backup
metadata:
  name: prod-backup
  namespace: velero
spec:
  includedNamespaces:
    - db
    - logging
  ttl: 168h

📚 詳細文檔

📦 MCP 資源端點

這些端點允許大語言模型（LLMs）在不調用工具的情況下探索 Velero 的狀態。

🏗 架構

• Python 3.10+
• MCP（官方模型上下文協議 SDK）
• Kubernetes Python 客戶端
• Pydantic 模型
• 安全、只讀設計
• 不使用 kubectl，不執行命令，無副作用

流程如下：

MCP 客戶端 → Velero MCP 服務器 → Kubernetes API → Velero CRDs

🔐 安全模型

設計為 100% 安全

服務器從不：

• 創建備份
• 執行恢復操作
• 刪除備份對象
• 向 Kubernetes 寫入任何內容

僅通過 Kubernetes API 讀取自定義資源定義（CRDs）。

需要的基於角色的訪問控制（RBAC）：

get, list on:
- backups.velero.io
- schedules.velero.io

⚙️ 配置

環境變量

K8s 認證順序：

1. 集群內的服務賬戶
2. $KUBECONFIG
3. ~/.kube/config

▶️ 運行服務器

以標準輸入輸出模式（MCP 要求）啟動服務器：

python -m velero_mcp_server.server

🧩 示例 MCP 客戶端配置

ChatGPT MCP 配置

{
  "mcpServers": {
    "velero-mcp": {
      "command": "python",
      "args": ["-m", "velero_mcp_server.server"],
      "env": {
        "KUBECONFIG": "/path/to/kubeconfig",
        "VELERO_NAMESPACE": "velero"
      }
    }
  }
}

Claude 桌面端

"mcpServers": {
  "velero-mcp": {
    "command": "python",
    "args": ["-m", "velero_mcp_server.server"],
    "env": {
      "KUBECONFIG": "/path/to/kubeconfig",
      "VELERO_NAMESPACE": "velero"
    }
  }
}

🛠 開發

運行代碼檢查工具：

ruff check velero_mcp_server

進行類型檢查：

mypy velero_mcp_server

運行測試：

pytest

🤝 貢獻

我們歡迎各種形式的貢獻：

• 添加 Velero 恢復 / 卷快照支持
• 改進錯誤處理
• 添加更多 MCP 資源
• 添加 Helm 圖表
• 添加日誌或指標
• 改進文檔

請閱讀完整的 CONTRIBUTING.md。

📜 許可證

本項目採用MIT 許可證，允許：

• 商業使用
• 個人使用
• 修改
• 分發

🗺 路線圖

計劃進行的改進：

• 添加對恢復 CRDs 的支持
• 支持快照對象
• 進行恢復影響分析
• 啟用寫入模式（需嚴格的標誌控制）
• 發佈到 PyPI
• 提供用於集群部署的 Helm 圖表

如果您想參與項目方向的規劃，請提交一個 issue！