conduktor/conduktor-ctl

Conduktor ctl

!Release !License ![Roadmap]([] ![]([***]

镜像概述和主要用途

Conduktor ctl Docker镜像包含Conduktor CLI工具，这是一个命令行工具，用于与Conduktor Console交互。其设计灵感源自Kubernetes kubectl CLI工具，并复用了其部分核心概念，支持用户通过命令行高效管理Conduktor资源。

核心功能和特性

• 与Conduktor Console直接交互，执行资源管理操作
• 支持资源的更新（apply）、删除（delete）、查询（get）等核心命令
• 提供命令自动补全脚本生成功能（completion命令）
• 支持环境变量配置，无需手动输入认证信息
• 兼容命令行操作和CI/CD管道集成，支持自动化工作流
• 提供详细的命令帮助和调试信息（--verbose标志）

使用场景和适用范围

• 开发人员通过命令行快速管理Conduktor Console资源
• CI/CD管道中集成，实现Conduktor资源的自动化部署和更新
• 自动化脚本中调用，实现Conduktor Console的批量操作和管理
• 需要通过命令行监控或调试Conduktor资源的场景

使用方法和配置说明

安装Docker镜像

获取最新版Docker镜像：

bash
docker pull conduktor/conduktor-ctl:latest

配置说明

使用Conduktor CLI需配置以下2个环境变量：

• CDK_BASE_URL: Conduktor Console的URL地址
• CDK_API_KEY: API访问令牌（用户令牌或应用令牌），可在Console实例的/settings/public-api-keys页面生成

环境变量配置示例（YAML格式）：

yaml
CDK_BASE_URL=http://localhost:8080
CDK_API_KEY=<admin-token>

命令用法

基本命令格式：

conduktor [command]

可用命令

• apply: 更新Conduktor上的资源
• completion: 为指定shell生成自动补全脚本
• delete: 删除指定类型和名称的资源
• get: 获取指定类型的资源
• help: 查看命令帮助信息
• version: 显示conduktor版本信息

标志

• -h, --help: 显示命令帮助
• -v, --verbose: 显示更多调试信息

更多使用细节请参见官方文档

贡献

请阅读https://github.com/conduktor/ctl/blob/main/CONTRIBUTING.md%E4%BA%86%E8%A7%A3%E6%88%91%E4%BB%AC%E7%9A%84%E8%A1%8C%E4%B8%BA%E5%87%86%E5%88%99%E4%BB%A5%E5%8F%8A%E6%8F%90%E4%BA%A4%E6%8B%89%E5%8F%96%E8%AF%B7%E6%B1%82%E7%9A%84%E6%B5%81%E7%A8%8B%E3%80%82

许可

本项目采用Apache 2.0许可证授权 - 详见https://github.com/conduktor/ctl/blob/main/LICENSE%E6%96%87%E4%BB%B6%E3%80%82