建木DevOps工具技术文档

建木DevOps工具技术文档

【免费下载链接】建木 建木是一个面向DevOps领域的极易扩展的开源无代码(图形化)/低代码(GitOps)工具。可以帮助用户轻松编排各种DevOps流程并分发到不同平台执行。 项目地址: https://gitcode.com/jianmu-dev/jianmu

1. 安装指南

1.1 环境要求

• JDK: 11及以上版本
• MySQL: 8.0及以上版本
• 操作系统: 支持AMD64/ARM64架构
• 可选依赖: Docker、Kubernetes(如需容器化部署)

1.2 快速安装(使用Docker Compose)

wget https://gitee.com/jianmu-dev/jianmu-deploy/raw/master/docker-compose.yml
docker-compose up -d

1.3 源码编译安装

1. 克隆项目仓库
2. 执行编译命令:

mvn package

3. 编译完成后会在target目录生成可执行文件

2. 项目使用说明

2.1 首次配置

1. 创建application-dev.yml配置文件覆盖默认配置
2. 必须配置项包括:
   • 数据库连接(datasource.url)
   • 管理员密码(jianmu.api.adminPasswd)
   • Hub服务的AK/SK(registry.ak/sk)

2.2 核心功能

• 无代码图形化编排: 通过可视化界面设计DevOps流程
• 低代码GitOps支持: 支持通过代码仓库管理流程定义
• 多平台执行: 可分发到不同平台执行工作流

2.3 工作流管理

1. 通过图形化界面创建工作流
2. 定义任务节点及依赖关系
3. 配置触发器与执行条件
4. 监控执行状态与日志

3. 项目API使用文档

3.1 认证配置

所有API调用需使用管理员账号认证，初始密码在application-dev.yml中配置:

jianmu:
  api:
    adminPasswd: 123456

3.2 Worker连接配置(2.5.0+)

jianmu:
  worker:
    secret: worker-secret

可使用以下命令生成密钥:

openssl rand -hex 16

3.3 主要API端点

• 工作流管理API: 创建/查询/更新/删除工作流
• 任务执行API: 触发任务执行/查询执行状态
• 日志查询API: 获取任务执行日志
• 节点管理API: 管理执行节点资源

4. 项目安装方式

4.1 容器化部署(推荐)

1. 下载docker-compose.yml文件
2. 启动服务:

docker-compose up -d

4.2 传统部署方式

1. 编译项目生成可执行文件
2. 准备MySQL数据库
3. 配置application-dev.yml
4. 启动服务

4.3 配置建议

• 生产环境建议配置HTTPS
• 建议定期备份数据库
• 根据业务规模调整JVM参数

【免费下载链接】建木 建木是一个面向DevOps领域的极易扩展的开源无代码(图形化)/低代码(GitOps)工具。可以帮助用户轻松编排各种DevOps流程并分发到不同平台执行。 项目地址: https://gitcode.com/jianmu-dev/jianmu