node-control 技术文档

本文档将详细介绍如何安装、使用以及API调用 node-control 项目，该项目能够帮助系统管理员或代码部署者在多个远程机器上同时执行任务。

1. 安装指南

node-control 依赖于 OpenSSH 和本地控制机上的 Node。远程机器仅需运行标准的 sshd 守护进程。

如果您使用 npm：

npm install control

如果不使用 npm，可以使用 git 克隆此仓库或使用 GitHub 仓库的下载链接获取最新版本。然后将其作为标准 Node 模块通过 require 引入。

2. 项目使用说明

项目使用示例如下：

首先，定义一个配置任务和个工作任务：

var control = require('control'),
    task = control.task;

task('mycluster', '我的集群配置', function () {
    var config = {
        'a.domain.com': {
            user: 'alogin'
        },
        'b.domain.com': {
            user: 'blogin',
            sshOptions: ['-p 44'] // 非标准端口上的 sshd 守护进程
        }
    };

    return control.controllers(config);
});

task('date', '获取日期', function (controller) {
    controller.ssh('date');
});

control.begin();

将以上代码保存为 controls.js 文件，并使用以下命令运行：

node controls.js mycluster date

每个机器将并行联系，执行 date 命令，并将远程机器的输出打印到控制台。

3. 项目API使用文档

node-control 提供了一个基础控制器原型 control.controller，所有控制器都必须扩展此原型。

以下是一些基本API的示例：

controllers()

创建控制器的数组：

var controllers = control.controllers(config);

ssh()

在远程机器上执行命令：

controller.ssh('date');

scp()

将文件从本地复制到远程：

controller.scp(localPath, remotePath);

这些方法都是异步的，并且可以接收一个回调函数，在操作完成时执行。

stdout 和 stderr 监听器

可以为 stdout 和 stderr 流附加自定义监听器：

controller.stdout.on('data', function (chunk) {
    // 处理数据
});

4. 项目安装方式

如上所述，您可以使用 npm 安装 node-control：

npm install control

或者直接从 GitHub 下载代码，然后作为 Node 模块使用。