Dreadnot 技术文档

1. 安装指南

环境要求

• Node.js（建议使用最新稳定版本）
• npm（通常随Node.js一起安装）
• Vagrant（用于开发环境）
• Virtualbox（用于运行Vagrant虚拟机）

安装步骤

1. 安装Node.js和npm：

   • 访问Node.js官网下载并安装适合你操作系统的Node.js版本。
   • npm会随Node.js一起安装。

2. 安装Vagrant和Virtualbox：

   • 访问Vagrant官网下载并安装Vagrant。
   • 访问Virtualbox官网下载并安装Virtualbox。

3. 克隆项目仓库：

   git clone https://github.com/racker/dreadnot.git
   cd dreadnot
   

4. 安装依赖：

   npm install
   

5. 启动开发环境（可选）：

   vagrant up
   

   启动后，访问 http://localhost:8000 即可查看Dreadnot界面。

2. 项目的使用说明

配置文件

Dreadnot的配置文件是一个JavaScript文件，通常命名为 local_settings.js。配置文件中包含以下主要部分：

• name：Dreadnot实例的名称，用于显示。
• env：环境名称，如 dev、staging 或 production。
• data_root：Dreadnot使用的数据根目录。
• default_url：Dreadnot的访问URL。
• htpasswd_file：用于认证的htpasswd文件路径。
• stacks：定义需要部署的代码库及其相关配置。
• github：GitHub组织信息，用于构建URL。
• plugins：可选的插件配置，如IRC、邮件和Hipchat通知。

启动Dreadnot

在项目根目录下运行以下命令启动Dreadnot：

npm install dreadnot -g
dreadnot -c ./local_settings.js -s ./stacks -p 8000

这将使用指定的配置文件和堆栈目录启动Dreadnot，并监听端口8000。

3. 项目API使用文档

主要API接口

Dreadnot的API主要通过配置文件中的 stacks 和 plugins 进行定义。以下是一些关键的API接口：

1. get_deployedRevision

• 功能：获取已部署的代码版本。
• 参数：
  • environment：环境名称。
  • region：区域名称。
  • callback：回调函数，接收 (err, deployed_revision)。

2. targets

• 功能：定义部署目标及其任务列表。
• 示例：

  targets: {
    deploy: ['task_preDeploy', 'task_deploy', 'task_postDeploy'],
    finally: ['task_cleanup']
  }
  

3. 任务函数

• 功能：定义具体的部署任务。
• 参数：
  • stack：堆栈对象，包含 stackConfig 和 config。
  • baton：任务执行时的共享对象，包含日志方法。
  • args：任务参数，如 dryrun、environment、region、revision 和 user。
  • callback：任务完成后的回调函数。

4. 项目安装方式

全局安装

npm install dreadnot -g

本地安装

在项目目录下运行：

npm install

开发环境

使用Vagrant启动开发环境：

vagrant up

启动后，访问 http://localhost:8000 即可查看Dreadnot界面。

启动命令

dreadnot -c ./local_settings.js -s ./stacks -p 8000

这将使用指定的配置文件和堆栈目录启动Dreadnot，并监听端口8000。