Rundeck 技术文档

本文档将详细介绍如何安装、使用和操作 Rundeck，这是一个由 PagerDuty 提供的开源运行手册自动化服务。

1. 安装指南

Rundeck 提供了多种安装方式，包括 Deb、RPM 和 War 包。以下是安装 Rundeck 的基本步骤：

Deb 包安装

wget https://www.rundeck.com/downloads/rundeck-<version>.deb
dpkg -i rundeck-<version>.deb

RPM 包安装

wget https://www.rundeck.com/downloads/rundeck-<version>.rpm
rpm -i rundeck-<version>.rpm

War 包安装

wget https://www.rundeck.com/downloads/rundeck-<version>.war
# 部署到你的 Web 服务器中

确保在安装之前，你的系统已经安装了 Java 11 和 NodeJs 18。

2. 项目使用说明

Rundeck 提供了一个 Web 控制台、命令行工具和一个 WebAPI，以帮助你轻松标准化任务，提高操作质量。

Web 控制台

通过访问 http://<your_rundeck_server>/，你可以使用 Web 控制台来执行和管理自动化任务。

命令行工具

安装后，你可以使用命令行工具来执行任务和查询状态。

rundeck --help

WebAPI

Rundeck 提供了一个 WebAPI，允许你通过编程方式访问和操作 Rundeck 功能。

3. 项目API使用文档

Rundeck 的 WebAPI 允许你执行各种操作，包括启动任务、查询任务状态、获取节点信息等。以下是使用 WebAPI 的基本步骤：

1. 获取 API 令牌：在 Rundeck Web 控制台中生成一个 API 令牌。
2. 使用 API 令牌进行身份验证：在 HTTP 请求的 Authorization 头中包含 API 令牌。

以下是一个使用 cURL 调用 WebAPI 的示例：

curl -H "Authorization: Bearer <your_api_token>" -X GET http://<your_rundeck_server>/api/1.0/jobs

更多 API 文档和示例，请参考 Rundeck API 文档。

4. 项目安装方式

除了上述的 Deb、RPM 和 War 包安装方式，Rundeck 还支持以下安装方法：

使用 Gradle 构建

./gradlew build

构建完成后，你会在 rundeckapp/build/libs/ 目录下找到 rundeck-X.Y.war 文件。

使用 Docker

./gradlew :docker:officialBuild

这将创建一个名为 rundeck/rundeck:SNAPSHOT 的 Docker 镜像。

请确保在安装和配置过程中遵循 Rundeck 的官方文档，以获得最佳体验。

---

本文档旨在帮助用户更好地理解和操作 Rundeck，从而提高自动化任务的管理和执行效率。