apache/cloudstack-cloudmonkey

CloudMonkey

CloudMonkey :cloud::monkey_face: 是 Apache CloudStack 的命令行界面(CLI)工具。它既可作为交互式 shell 使用，也可作为命令行工具运行，简化 Apache CloudStack 的配置与管理流程。

现代版 CloudMonkey 是用 Go 语言重写并简化的版本，兼容 Apache CloudStack 4.9 及以上版本。而用 Python 编写的遗留版 CloudMonkey 可用于 Apache CloudStack 4.0-incubating 及以上版本。

有关详细文档，请参见 https://github.com/apache/cloudstack-cloudmonkey/wiki%E3%80%82

核心功能与特性

• 双模式支持：同时提供交互式 shell 和命令行工具两种使用方式，适应不同管理场景需求
• 版本兼容性：Go 语言版本兼容 Apache CloudStack 4.9+；Python 遗留版本支持 4.0-incubating+
• 简化管理：提供便捷命令集，降低 CloudStack 配置与日常运维复杂度
• 跨平台支持：支持类 Unix 环境，可构建多平台发行版本

使用场景

CloudMonkey 适用于：

• Apache CloudStack 管理员通过命令行高效配置和管理云环境
• 开发人员在自动化脚本中集成 CloudStack 操作
• 需要通过 CLI 完成 CloudStack 日常管理任务的用户

开发指南

环境要求

开发 CloudMonkey 需要：

• Go 1.11 或更高版本
• 类 Unix 操作系统环境

构建目标

使用 make help 查看可用构建目标：

bash
$ make help

  all             构建程序二进制文件
  test-bench      运行基准测试
  test-short      仅运行简短测试
  test-verbose    以详细模式运行测试并生成覆盖率报告
  test-race       使用竞态检测器运行测试
  check tests     运行测试
  test-xml        运行测试并生成 xUnit 输出
  test-coverage   运行覆盖率测试
  debug           使用 dlv 运行可调试的二进制文件
  lint            运行 golint
  fmt             对所有源文件运行 gofmt

构建与运行

构建并直接运行：

bash
$ make run

手动构建并运行：

bash
$ make all
$ ./bin/cmk

构建多平台发行版本：

bash
$ make dist

社区与支持

可通过以下邮件列表参与 CloudMonkey 相关讨论：

• 开发邮件列表
• 用户邮件列表

贡献流程

1. 在 CloudStack 开发邮件列表 讨论问题和功能
2. 通过 user 邮件列表报告问题或在 Github 提交 https://github.com/apache/cloudstack-cloudmonkey/issues
3. Fork Github 仓库
4. 创建功能分支（如 add_component_x）
5. 提交更改并编写相关测试（如适用）
6. 运行测试确保全部通过
7. 通过 Github 提交 https://github.com/apache/cloudstack-cloudmonkey/pull/new/main

历史版本

• 原始版本：用 Python 编写，2012 年 10 月由 Rohit Yadav 贡献给 Apache CloudStack 项目
• 现代版本：从 v6.0.0 开始采用 Go 语言重写，提供精简功能集和跨平台支持，配置路径变更为 ~/.cmk/config（原路径 ~/.cloudmonkey/config），并引入默认 localcloud 配置文件

许可证

CloudMonkey 基于 Apache 许可证 2.0 版授权，详情参见：[***]