mcpField
C
conduktor

conduktor

github.com/conduktor数据与数据库6333 次安装2 周前更新
代码仓库

关于 conduktor

conduktor 是用于通过状态发现、文档查询和受控操作来使用 Conduktor Platform 与 Apache Kafka 的 Agent 技能。内容涵盖 Console、Gateway 和 CLI 工作流,面向平台工程师和应用开发者。

主要功能

  1. 01指导 Console 和 Gateway 的部署与管理
  2. 02涵盖 Kafka 加密、数据屏蔽和数据质量策略
  3. 03提供 CLI 与 GitOps 自动化工作流
  4. 04包含 Terraform 和自助服务流程
  5. 05要求变更前先发现状态并执行 dry-run 检查

适用场景

  1. 01管理 Kafka 集群和 Gateway 资源
  2. 02应用数据屏蔽或数据质量规则
  3. 03使用 CLI 或 Terraform 自动化管理 Conduktor 资源
  4. 04为开发者提供接入指导并处理主题访问请求

MCP 相关

该技能引用 Conduktor 文档 MCP 服务来查询版本敏感信息;若没有 MCP 工具,也提供连接配置。

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/conduktor/skills --skill conduktor

安装后在 Claude Code 中输入/conduktor确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

LICENSE
README.md
references/
anti-patterns.md
guardrails.md
mental-model.md
resource-policy-examples.md
terminology.md
use-cases/app-developer/
create-topic.md
onboard-to-kafka.md
produce-consume.md
request-access.md
use-cases/platform/
bootstrap-self-service-cli.md
deploy-conduktor.md
encrypt-kafka-data.md
enforce-data-quality.md
gateway-community-edition.md
gitops-automation.md
multi-tenancy.md
self-service-github-cicd-cli.md
terraform.md
traffic-control.md

详细介绍

原文在翻译后有更新,译文可能不是最新。

Conduktor Platform

Conduktor 是围绕 Apache Kafka 协同工作的三款产品:

  • Console(conduktor/conduktor-console,端口 8080)用于观测和管理 Kafka 集群。它提供 RBAC、主题目录、监控、自助服务框架和数据质量策略。需要 PostgreSQL。未提供许可证时,它会以 Community Edition 运行:不支持自助服务或数据质量策略,且用户数、集群数、告警数和脱敏策略数均有上限。
  • Gateway(conduktor/conduktor-gateway,端口 6969)是一个透明的 Kafka 代理,可拦截并修改请求和响应。它提供拦截器、虚拟集群、字段级加密、数据脱敏和流量控制。客户端连接 Gateway,而非直接连接 Kafka。未设置 GATEWAY_LICENSE_KEY 时无法启动(3.18+)。
  • CLI(conduktor 二进制文件)是一款类似 kubectl 的工具,可通过 YAML apply/get/delete 以声明式方式管理 Console 和 Gateway 资源。

Console 和 Gateway 是独立服务。Console 可以管理 Gateway,但它们是独立部署的。

版本基准:此技能针对 Console 1.43–1.45、Gateway 3.17 和 CLI 0.7 编写。防护措施和命令形式已在 Console 1.47.2、Gateway 3.21.1、CLI 0.9.2 和 Terraform provider 1.5.1(2026-09)上重新验证。对于与版本相关的细节(环境变量、插件选项、新增功能等),请通过 docs MCP 确认。

务必先阅读

运行任何会改变状态的命令之前,请阅读 references/guardrails.md。其中涵盖预检、错误处理指南、CLI 状态和 Terraform 数据丢失陷阱、密钥处理,以及可用的命令形式。

对于任何 Conduktor 相关问题,请加载 references/mental-model.md,以了解产品边界、Gateway 资源模型、虚拟集群和自助服务框架。

有关 AI 助手常见的错误做法,请参阅 references/anti-patterns.md。

有关 Conduktor 到 Kafka 的术语映射,请参阅 references/terminology.md。

使用场景

平台工程师
我想要……阅读
部署 Console 和 Gateway(Docker、Helm、Kubernetes)use-cases/platform/deploy-conduktor.md
加密或脱敏 Kafka 数据(字段级、负载)use-cases/platform/encrypt-kafka-data.md
强制执行数据质量规则(CEL、JSON Schema)use-cases/platform/enforce-data-quality.md
设置多租户(虚拟集群、ACL、服务账号)use-cases/platform/multi-tenancy.md
应用流量控制和防护措施(速率限制、主题策略)use-cases/platform/traffic-control.md
使用 CLI 和 GitOps 实现自动化(apply、CI/CD、状态管理)use-cases/platform/gitops-automation.md
设置自助式 GitHub CI/CD(工作流、CODEOWNERS、令牌、策略)——基于官方的 conduktor/self-service-templateuse-cases/platform/self-service-github-cicd-cli.md
根据现有集群、主题和权限初始化自助服务(生成与官方模板匹配的仓库)use-cases/platform/bootstrap-self-service-cli.md
使用 Terraform 将基础设施作为代码进行管理use-cases/platform/terraform.md
应用开发者
我想要……阅读
通过 Conduktor 开始使用 Kafka(连接、发现主题)use-cases/app-developer/onboard-to-kafka.md
通过自助服务创建主题use-cases/app-developer/create-topic.md
通过 Gateway 生产和消费(客户端配置、架构)use-cases/app-developer/produce-consume.md
请求访问其他团队的主题use-cases/app-developer/request-access.md

Agent 行为

重要:先进行发现。技能文件和 CLI 发现结果能提供用户的实际状态。对于这些内容未涵盖的信息和对版本敏感的细节,请使用 docs MCP(第 5 步)。

当用户询问 Conduktor 时,不要只解释其工作原理。要主动提供帮助:

  1. 先通过 CLI 进行发现——运行预检(guardrails.md §1:conduktor run whoami、许可证方案),阅读匹配的用例文件,然后运行其中“Agent workflow”部分的 conduktor get 命令。CLI 提供实际状态;文档提供通用示例。
  2. 提供选项供用户选择——利用发现结果提供具体选项,而不是提出开放式问题。如果有 AskUserQuestion 工具,请使用预设选项(例如,主题名称建议、分区数量、保留策略预设)。一次只问一个问题,不要列出编号问题。优先采用合理的默认值——只有在选择确实重要时才提问。
  3. 生成可直接使用的输出——根据发现结果中的真实名称,生成完整的 YAML、HCL 或客户端配置。如果可以填入真实值,就不要提供带占位符的模板。
  4. 确认后执行——先运行 conduktor apply -f <file> --dry-run 并阅读输出:如果出现许可证 403,或本应保留的资源显示 Deleted (dry-run),就停止(参见 guardrails.md §2–3)。获得批准后,再运行 conduktor apply -f <file>。使用 Terraform 时,运行 terraform plan,如果现有资源将被替换或销毁,就停止,然后运行 terraform apply。
  5. 查找未知信息——检查技能文件并通过 CLI 发现信息后,或遇到对版本敏感的细节时,立即使用 search_conduktor_documentation 工具(Conduktor 的 MCP 文档服务),前提是该工具可用。切勿编造这些文件或文档中未提及的环境变量名称、配置字段或 API 端点。如果 MCP 工具不可用,请告知用户使用以下配置添加该工具:
    { "mcpServers": { "conduktor-docs": { "type": "url", "url": "https://docs.conduktor.io/mcp" } } }
    

CLI 需要身份验证。如果命令因 401/连接错误而失败,请帮助用户配置 CDK_BASE_URL + CDK_API_KEY(Console)或 CDK_GATEWAY_BASE_URL + CDK_GATEWAY_USER/CDK_GATEWAY_PASSWORD(Gateway)。如果出现 403,提示功能不适用于当前许可证,则表示这是方案限制,而非身份验证问题。

意图路由

当用户提及以下关键词时,加载对应的文件:

  • 错误、403、许可证、失败、已删除、数据丢失、状态、试运行 -> references/guardrails.md
  • 加密、脱敏、PII、GDPR、防护 -> use-cases/platform/encrypt-kafka-data.md
  • 数据质量、CEL、验证、强制执行架构 -> use-cases/platform/enforce-data-quality.md
  • 虚拟集群、租户、隔离、团队命名空间 -> use-cases/platform/multi-tenancy.md
  • 速率限制、限流、保护措施、配额、流量 -> use-cases/platform/traffic-control.md
  • 部署、Docker、Helm、Kubernetes、安装 -> use-cases/platform/deploy-conduktor.md
  • conduktor CLI、应用、GitOps、CI/CD、流水线、自动化 -> use-cases/platform/gitops-automation.md
  • GitHub Actions、CODEOWNERS、工作流、令牌范围、ResourcePolicy 示例、入门应用 -> use-cases/platform/self-service-github-cicd-cli.md
  • 引导、自助服务、采用、迁移、所有权、逆向工程 -> use-cases/platform/bootstrap-self-service-cli.md
  • Terraform、IaC、HCL、提供程序 -> use-cases/platform/terraform.md
  • 接入、连接、凭据、快速入门、引导 -> use-cases/app-developer/onboard-to-kafka.md
  • 创建主题、新主题、自助创建主题 -> use-cases/app-developer/create-topic.md
  • 生产、消费、架构注册表、消费者组 -> use-cases/app-developer/produce-consume.md
  • 访问、权限、请求、共享主题 -> use-cases/app-developer/request-access.md

评论

支持 Markdown