关键词

KubernetesAI助手自动化部署文档测试策略治理

项目简介

DevOps AI Toolkit 是一个功能强大的AI驱动平台，旨在通过智能自动化和AI协助，全面提升软件开发工作流的效率。它能够以标准化的方式向大型语言模型（LLM）客户端提供丰富的上下文信息和功能，包括Kubernetes资源管理、智能部署推荐、文档自动化测试、组织部署模式和治理策略管理，以及共享Prompt模板库。它通过Model Context Protocol (MCP) 与AI客户端通信，提供安全、可扩展的上下文服务框架。

主要功能点

  • Kubernetes智能部署: 自动发现集群资源、语义化管理资源能力、提供AI驱动的部署建议、支持自定义操作符和CRD，简化Kubernetes应用部署。
  • 文档测试与验证: 自动执行文档中的命令和示例、验证内容的功能与语义准确性、提供交互式修复建议和会话管理，确保文档的时效性与准确性。
  • 组织模式管理: 定义和共享企业内部的部署最佳实践和机构知识，通过向量数据库实现语义搜索，显著增强AI推荐的准确性。
  • 策略管理与治理: 定义合规性治理策略，指导用户创建符合规范的配置，并能自动生成Kyverno策略进行集群内的强制执行，预防配置漂移。
  • 共享Prompt库: 团队可以共享和访问精选的Prompt模板，通过AI开发工具中的原生斜杠命令直接使用，实现工作流标准化与团队协作一致性。
  • MCP集成: 无缝集成Claude Code、Cursor、VS Code等支持Model Context Protocol的AI开发工具，实现自然语言交互的对话式工作流，提升开发体验。

安装步骤

DevOps AI Toolkit 设计为通过MCP（Model Context Protocol）与AI开发工具配合使用，因此它是一个后端服务，无需直接在您的开发环境中手动安装。您需要配置您的AI工具来连接到此MCP服务器。

Docker Compose 快速启动 (推荐): 这是获取所有功能并以最少配置启动DevOps AI Toolkit的推荐方式：

  1. 下载 Docker Compose 配置文件: 打开您的终端，执行以下命令下载所需的 'docker-compose-dot-ai.yaml' 文件：

    curl -o docker-compose-dot-ai.yaml https://raw.githubusercontent.com/vfarcic/dot-ai/main/docker-compose-dot-ai.yaml

  2. 设置API密钥并创建MCP客户端配置: MCP服务器需要访问Anthropic和OpenAI的API才能提供AI驱动的功能。请确保您拥有以下API密钥：

    • 'ANTHROPIC_API_KEY': Anthropic（Claude）API密钥，用于大部分AI分析和推荐功能。
    • 'OPENAI_API_KEY': OpenAI API密钥，用于语义模式匹配、向量嵌入生成以及某些策略管理功能。
    • 'DOT_AI_SESSION_DIR': (可选) 设置MCP服务器用于存储会话数据的本地目录路径，默认为 '/app/sessions'。

    您可以在当前目录下创建一个 '.env' 文件来存储这些环境变量（例如：'ANTHROPIC_API_KEY="sk-ant-..."'，'OPENAI_API_KEY="sk-proj-..."'），或者在命令行中将它们导出为环境变量。

    然后，创建一个名为 '.mcp.json' 的文件。这个文件是您AI客户端（例如Claude Code）用于配置其连接到 'dot-ai' MCP服务器的指令。

    {
  "mcpServers": {
    "dot-ai": {
      "command": "docker",
      "args": [
        "compose",
        "-f",
        "docker-compose-dot-ai.yaml",
        "--env-file",
        ".env",
        "run",
        "--rm",
        "--remove-orphans",
        "dot-ai"
      ]
    }
  }
}

  3. 启动您的MCP客户端: 保存 '.mcp.json' 文件后，启动您的MCP客户端应用程序（例如，在终端中输入 'claude' 命令，或启动您集成了MCP的VS Code）。 您可以通过在AI客户端中询问 "Show dot-ai status" 来验证MCP服务器是否已成功启动并连接。

服务器配置 (供MCP客户端连接使用，非直接修改)

您的MCP客户端需要知道如何启动并与 'dot-ai' MCP服务器通信。您在上述安装步骤中创建的 '.mcp.json' 文件包含了以下关键配置信息，这些信息由您的MCP客户端在后台自动使用，您无需手动运行这些命令或更改其内部逻辑：

  • 服务器名称 ('dot-ai'): 这是您的MCP客户端用于识别和引用此MCP服务器的唯一标识符。例如，在客户端命令中，您可能会看到 '/dot-ai:tool-name' 这样的用法。
  • 启动命令 ('command'): 这是一个字符串，指示MCP客户端在需要启动服务器时执行的Shell命令。对于此配置，它是 'docker'，意味着客户端将通过Docker来管理服务器的生命周期。
  • 命令参数 ('args'): 这是一个字符串数组，包含了传递给启动命令 'docker' 的具体参数。这些参数指示Docker如何使用 'docker-compose-dot-ai.yaml' 文件来启动 'dot-ai' 服务，包括通过 '.env' 文件注入环境变量，并在容器停止时自动清理资源。 MCP客户端会根据这些信息，在后台按需启动和管理 'dot-ai' MCP服务器实例，确保您无需直接与服务器的底层启动细节交互。

基本使用方法

一旦MCP客户端成功连接到DevOps AI Toolkit MCP服务器，您便可以通过自然语言或特定的斜杠命令与AI进行对话式交互，利用其提供的各项功能：

  • Kubernetes部署: 当您想在集群中部署应用时，可以对AI说：“I want to deploy a web application to my cluster” (我希望在我的集群中部署一个Web应用程序)。AI会引导您完成部署流程。
  • 能力管理: 为了改进AI的推荐准确性，您可以指示AI扫描集群资源并理解其语义能力：“I want to scan my cluster for resource capabilities to improve recommendations” (我希望扫描我的集群以获取资源能力来改进推荐)。
  • 策略管理: 若要创建一项新的治理策略，例如为所有部署强制执行资源限制，可以说：“I want to create a policy requiring resource limits on all deployments” (我希望创建一项要求所有部署都具备资源限制的策略)。
  • 文档测试: 如果您想验证项目文档的准确性，可以命令AI：“I want to test my README.md file to make sure all the examples work” (我希望测试我的README.md文件以确保所有示例都有效)。
  • 共享Prompt: 若要直接使用共享的Prompt模板，您可以通过类似 '/dot-ai:prd-create' 的斜杠命令在AI客户端中调用它。

信息

分类

开发者工具

访问项目