tutum/boatyard

boatyard 镜像文档

镜像概述

boatyard是一个基于Go语言开发的Web服务，提供HTTP API和Web用户界面，用于构建、推送和删除Docker镜像。该项目已被弃用，建议使用Tutum的新Automated Build功能，其基于开源的https://github.com/tutumcloud/builder%E9%95%9C%E5%83%8F%E5%AE%9E%E7%8E%B0%E6%9E%84%E5%BB%BA%E5%8A%9F%E8%83%BD%E3%80%82

核心功能与特性

• 提供Web UI和HTTP API双重交互方式
• 支持多种输入源构建Docker镜像
• 可检查构建作业状态及获取详细日志
• 支持配置Docker主机连接和Redis缓存

使用场景

• 需要通过Web界面管理Docker镜像构建流程的用户
• 需通过API自动化Docker镜像构建和推送的CI/CD流程
• 开发人员快速构建、测试和推送Docker镜像

使用方法

运行要求

• 已安装Docker和fig
• Docker服务监听地址为tcp://localhost:4243

启动命令

使用fig启动服务：

bash
fig up -d

运行docker ps命令查看boatyard分配的端口，然后通过浏览器访问http://localhost:49XXX/打开Web UI（将49XXX替换为实际分配的端口）。

配置选项

可在fig.yml中通过以下环境变量配置服务：

• DOCKER_HOST（默认：tcp://localhost:4243）：Docker服务器监听端点
• CACHE_1_PORT_6379_TCP_ADDR（默认：无）：Redis缓存服务器主机名
• CACHE_1_PORT_6379_TCP_PORT（默认：6379）：Redis缓存服务器端口
• CACHE_PASSWORD（默认：无）：Redis缓存认证密码（可选）

镜像构建输入

主要输入参数

创建镜像时需提供以下基本信息：

• 镜像名称（如：user/myimage）
• 用户名（推送镜像时使用，如：user）
• 密码（推送镜像时使用，如：password）
• ***（推送镜像时使用，如：user@example.com）

可选输入方式

可通过以下任意方式向boatyard提供构建上下文：

• 直接提供Dockerfile内容
• 指向包含根目录Dockerfile及所需文件的tarball URL
• GitHub仓库（需提供GitHub用户名、仓库名和标签）
• 请求中附带的tarball文件

API规范

构建镜像

请求

从Dockerfile构建：

http
POST /api/v1/build

请求体：

json
{
    "image_name": "user/image",
    "username": "user",
    "password": "password",
    "email": "user@example.com",
    "dockerfile": "FROM ubuntu:saucy\nCMD echo \"Hello world\""
}

从tarball URL构建：

http
POST /api/v1/build

请求体：

json
{
    "image_name": "user/image",
    "username": "user",
    "password": "password",
    "email": "user@example.com",
    "tar_url": "https://github.com/tutumcloud/docker-hello-world/archive/v1.0.tar.gz"
}

从GitHub仓库构建：

http
POST /api/v1/build

请求体：

json
{
    "image_name": "user/image",
    "username": "user",
    "password": "password",
    "email": "user@example.com",
    "github_username": "tutumcloud",
    "github_reponame": "docker-hello-world",
    "github_tag": "v1.0"
}

从请求中的tarball构建：

http
POST /api/v1/build

请求体（multipart/form-data格式）：

----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="TarFile"; filename="dockertarexample.tar.gz"
Content-Type: application/x-gzip


----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="Json"; filename="manifest.json"
Content-Type: application/json


----WebKitFormBoundaryE19zNvXGzXaLvS5C

其中manifest.json格式如下：

json
{
    "image_name": "user/image",
    "username": "user",
    "password": "password",
    "email": "user@example.com"
}

响应

json
{
    "JobIdentifier": "ef0c7a10-31a5-4140-6087-df97c2bebcb2"
}

返回的JobIdentifier可用于查询作业状态和日志。

检查作业状态

请求

http
GET /api/v1/:jobid/status

其中:jobid为构建请求返回的作业ID（如：ef0c7a10-31a5-4140-6087-df97c2bebcb2）

响应

json
{
    "Status": "Pushing"
}

状态说明：作业状态包括"Building"（构建中）、"Pushing"（推送中）、"Finished"（完成），发生错误时会显示错误信息。

检查作业日志

请求

http
GET /api/v1/:jobid/logs

其中:jobid为构建请求返回的作业ID

响应

json
{
    "Logs": "Logs are returned as one string."
}

日志包含构建过程日志及Docker主机返回的任何错误信息。