使用 docker-compose 一键启停 Cromwell

本文主要介绍如何使用镜像市场中的免费镜像,通过docker-compose 快速启动一个 Cromwell server。

背景

Cromwell server 的启动需要以下组件配合:

  • 启动 MySQL 的 docker 容器作为 Crowmell 的持久化数据库,包括配置用户名,密码等;

  • 填写 Cromwell 配置文件,包括 BCS 后端配置及数据库等配置;

  • 使用 Cromwell 的 JAR 包,启动 server。

实际上 Cromwell 除了发布 jar 包,也会发布对应的 docker 镜像,我们可以考虑使用 docker-compose来简化以上步骤。docker-compose 是 Docker 官方的开源项目,其定位是定义和运行多个 Docker 容器的应用(Defining and running multi-container Docker applications)。

使用docker-compose 可以将容器化的 Cromwell 和 MySQL两个 service 拉起,作为一个应用来运行。再配合脚本来简化配置,可以将 Cromwell 的服务做成一键启停。

开通 ECS 作为 Crowmell server

首先使用 Cromwell server 镜像开通一台 ECS,ssh 登入机器后,可以运行目录下的cromwell-server.sh,进行Cromwell Server的管理:

# ./cromwell-server.sh
cromwell-server.sh - init cromwell config and start/stop service
Usage: cromwell-server.sh [options...] [init/start/stop/status]
Options:
  --id=STRING           Access id
  --key=STRING          Access key
  --root=STRING         Oss root for cromwell, e.g: oss://my-bucket/cromwell/
  --instance=STRING     default runtime: instance type [ecs.sn1.medium]
  --image=STRING        default runtime: image id [img-ubuntu-vpc]

第一次配置与启动服务

初次使用,需要做一些初始配置,可以使用下面的命令完成一键初始化与启动:

./cromwell-server.sh init --id=LTAI8xxxxx --key=vVGZVE8qUNjxxxxxxxx --root=oss://gtx-wgs-demo/cromwell/

上面的命令完成了以下配置:

  • --id: 批量计算的 Access Id;

  • --key: 批量计算的 Access Key;

  • --root: Crowmell 运行时在 OSS 上的工作根目录;

  • --instance: Cromwell 默认运行时参数,实例类型;

  • --image: Cromwell 默认运行时参数,镜像ID;执行完以上命令后,会根据 Crowmell 配置文件模板生成配置文件,并通过 docker-compose 启动 Cromwell server,并在后台运行。

服务启动后,就可以通过镜像中的命令行工具 widdler 执行工作流的提交:

cd /home/cromwell/cromwell/ 
widdler run echo.wdl inputs.json -o bcs_workflow_tag:test_echo

停止服务

使用下面的命令可以一键停止服务:

./cromwell-server.sh stop

再次启动服务

在已经完成配置的情况下,使用下面的命令,可以完成服务启动:

./cromwell-server.sh start

检查服务状态

启动服务后可以通过下面的命令检查服务状态:

./cromwell-server.sh status

如果server已经启动,则会看到下面的输出:

checking cromwell server status.....
{"cromwell":"48-613cea9-SNAP"} is running!

查看 Cromwell server 日志

./cromwell-server.sh logs

重新配置并启动服务

如果需要修改配置,在服务停止的情况下,再次使用 init 命令可以完成新配置重新启动:

./cromwell-server.sh init --id=LTAI8xxxxx --key=vVGZVE8qUNjxxxxxxxx --root=oss://gtx-wgs-demo/cromwell/

使用option文件设置默认运行时参数

在 Crowmell 的配置文件中,可以设置每个 backend 的默认运行时参数 default-runtime-attibutes,也可以在提交工作流时通过 option 覆盖原有设置。

所以如果您在提交工作流时用到了数据盘、NAS等,都可以在 option 文件中设置:

{
    "default_runtime_attributes": {
        "vpc": "192.168.0.0/24",
        "autoReleaseJob": true,
        "mounts": "nas://1f****04-xkv88.cn-beijing.nas.aliyuncs.com:/ /mnt/ true",
        "dataDisk": "cloud_ssd 250 /home/mount/"
    },
    "bcs_workflow_tag": "Tagxxx",
    "read_from_cache": true
}

使用 widdler 命令行的 -O (大写的O)参数提交 option 文件:

widdler run echo.wdl inputs.json -O options.json