outofcoffee/corebot

Corebot：用于Rundeck和Jenkins的Slack机器人

从Slack触发Rundeck或Jenkins作业。

示例：

@corebot deploy user-service 1.0 to staging

> corebot:
> OK, I'm deploying user-service version 1.0 to staging.
> Status of job is: running
> Details: [***]

为何需要此工具？了解ChatOps。

核心功能

触发部署作业

!https://github.com/outofcoffee/corebot/raw/master/docs/images/deploy.png

触发其他自定义作业

!https://github.com/outofcoffee/corebot/raw/master/docs/images/restart.png

锁定功能防止意外部署

!https://github.com/outofcoffee/corebot/raw/master/docs/images/lock_deploy_fail.png

解锁已锁定内容

!https://github.com/outofcoffee/corebot/raw/master/docs/images/unlock.png

获取帮助

!https://github.com/outofcoffee/corebot/raw/master/docs/images/unknown.png

使用说明

• 作为Slack管理员，创建Slack机器人用户并获取其认证令牌
• 作为Rundeck管理员，生成Rundeck API令牌
• 设置环境变量
• 运行！

快速启动

最快的启动方式是使用Docker镜像：

bash
docker run -d \
        --env SLACK_AUTH_TOKEN="CHANGEME" \
        --env SLACK_CHANNEL_NAME="corebot" \
        --env RUNDECK_API_TOKEN="CHANGEME" \
        --env RUNDECK_BASE_URL="http://rundeck:4440" \
        -v /path/to/actions.yml:/opt/corebot/actions.yml \
        outofcoffee/corebot

注意：容器不需要暴露任何入站端口。

动作与配置

机器人包含内置动作和自定义动作。内置动作如锁定/解锁功能，自定义动作是Rundeck作业的触发器，通过配置文件（通常名为actions.yml）进行配置。

动作配置文件

注意：BOT_CONFIG的默认路径为/opt/corebot/actions.yml

示例：

yaml
version: '1'
actions:
  services:
    jobId: 9374f1c8-7b3f-4145-8556-6b55551fb60f
    template: deploy services {version} to {environment}

文件结构：

• 所有文件必须指定版本为‘1’
• 所有动作必须位于顶级actions块下
• 每个动作必须有名称（本例中为services）
• 每个动作必须有Rundeck作业ID（从Rundeck获取）
• 每个动作必须有模板 - 详情见下文
• 每个动作可选择性指定默认选项映射
• 每个动作可选择性指定标签列表

动作模板

动作模板提供调用命令的语法。

示例：

deploy services

模板还允许将作业选项指定为占位符，例如：

deploy services {version} to {environment}

在此示例中，version和environment均从命令中捕获，如：

@corebot deploy services 1.0 to UAT

这将触发动作，并传递以下选项：

• version=1.0
• environment=UAT

默认选项

有时可能需要默认传递某个选项，而无需用户提供。可通过options动作块实现：

yaml
version: '1'
actions:
  services:
    jobId: 9374f1c8-7b3f-4145-8556-6b55551fb60f
    template: deploy services {version} to {environment}
    options:
	    myOption: someValue

这将触发动作，并传递以下选项：

• version=1.0
• environment=UAT
• myOption=someValue

标签与多作业动作

有时动作可在多个作业上运行。通过设置tags块实现：

yaml
version: '1'
actions:
  deploy-services:
    jobId: 9374f1c8-7b3f-4145-8556-6b55551fb60f
    template: deploy services {version} to {environment}
    tags:
	    - services
	    
  restart-services:
    jobId: e9d12eec-abff-4780-89cd-56a48b8c67be
    template: restart services in {environment}
    tags:
	    - services

此处定义了两个动作：deploy-services和restart-services，均标记为services。这意味着可以执行：

@corebot lock services

……两个动作都将被锁定。

提示：所有动作都有一个特殊标签all，因此可以执行@corebot lock all。

内置动作

内置动作包括：

• @corebot lock {动作名称或标签} - 锁定动作以防止意外触发。
• @corebot unlock {动作名称或标签} - 解锁已锁定的动作。
• @corebot status {动作名称或标签} - 显示动作状态。
• @corebot enable {动作名称或标签} - 设置作业的Rundeck执行状态 - 注意： 这要求Rundeck ACL允许API用户设置作业执行状态。
• @corebot disable {动作名称或标签} - 设置作业的Rundeck执行状态 - 注意： 这要求Rundeck ACL允许API用户设置作业执行状态。

贡献

接受拉取请求：https://github.com/outofcoffee/corebot

更多信息

Slack API：[***]

Rundeck API：[***]

Rundeck

任何支持API v14或更高版本的Rundeck实例均可使用。

例如，以下是非官方Rundeck Docker镜像：https://hub.docker.com/r/jordan/rundeck/

bash
docker run -it \
    -p 4440:4440 \
    -e SERVER_URL=http://localhost:4440 \
    jordan/rundeck