coreroller/demo

!https://github.com/coreroller/coreroller/raw/master/docs/screenshots/coreroller.png

概述

CoreRoller是一套用于控制和监控更新 rollout 的工具，旨在作为CoreOS CoreUpdate的开源替代方案。

截图：

最新动态

2017年5月8日
CoreRoller 1.0版本发布！该项目从此采用语义化版本控制，自动构建的Docker镜像也会相应标记版本。如果您在此次发布前已使用CoreRoller，请查看下方的发布说明。

核心功能

• 用于控制和监控应用更新的仪表盘
• 开箱即可为CoreOS集群提供更新服务
• 支持管理自定义应用更新（不仅限于CoreOS）
• 可为CoreOS应用（预装）定义自定义分组和频道
• 为分组定义roll-out策略，控制更新如何应用到实例集
• 可在分组级别随时暂停/恢复更新
• 提供实例安装版本、更新进度状态等统计信息
• UI中的活动流可通知重要事件或错误
• 针对重要事件发送HipChat通知
• 基于Google开发的Omaha协议

状态

CoreRoller处于稳定状态，已在生产环境中使用超过一年，无重大问题。
如发现任何bug，请在仓库提交https://github.com/coreroller/coreroller/issues%E3%80%82

快速开始

体验CoreRoller的最佳方式是使用Docker Hub上的公共镜像启动容器：

bash
docker run -d -p 8000:8000 coreroller/demo

容器启动后，在浏览器访问：
http://localhost:8000/
默认用户名/密码为admin/admin。

此演示容器运行PostgreSQL（CoreRoller的数据存储）和CoreRoller服务器（rollerd）。

除coreroller/demo镜像外，Docker Hub还有其他实用镜像：

• **https://hub.docker.com/r/coreroller/rollerd**%EF%BC%9A%E8%BF%90%E8%A1%8C%E5%90%8E%E7%AB%AF%E6%9C%8D%E5%8A%A1%E5%99%A8%EF%BC%8C%E6%97%A0%E4%BE%9D%E8%B5%96%E7%9A%84Golang%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6%EF%BC%8C%E6%94%AF%E6%8C%81%E4%BB%AA%E8%A1%A8%E7%9B%98%E5%92%8COmaha%E6%9B%B4%E6%96%B0/%E4%BA%8B%E4%BB%B6%E8%AF%B7%E6%B1%82%E3%80%82
• **https://hub.docker.com/r/coreroller/postgres**%EF%BC%9A%E8%BF%90%E8%A1%8CPostgreSQL%E5%B9%B6%E5%88%9B%E5%BB%BACoreRoller%E6%89%80%E9%9C%80%E6%95%B0%E6%8D%AE%E5%BA%93%EF%BC%8C%E9%9C%80%E6%AD%A3%E7%A1%AE%E9%85%8D%E7%BD%AE%E5%8D%B7%E4%BB%A5%E9%81%BF%E5%85%8D%E6%95%B0%E6%8D%AE%E4%B8%A2%E5%A4%B1%E3%80%82

这些镜像会在每次提交后自动重建和标记版本，Dockerfile位于backend/docker目录。

此外，backend/systemd目录提供systemd单元文件，可用于在CoreOS集群中通过fleet部署CoreRoller；backend/kubernetes目录提供Kubernetes配置文件（使用kubectl create -f backend/kubernetes部署）。这些文件为示例，可根据需求调整。

管理CoreOS更新

CoreRoller启动后，可用于管理集群中的CoreOS更新。新机器和现有机器的配置方式略有不同，均需更新CoreOS更新器的服务器URL（默认指向CoreOS公共服务器）。

新机器

在新机器的cloud config中设置更新服务器：

yaml
coreos:
  update:
    group: stable
    server: http://your.coreroller.host:port/v1/update/

除默认stable、beta、alpha分组外，还可创建自定义分组（需使用仪表盘分组名称旁的分组ID）：

yaml
coreos:
  update:
    group: ab51a000-02dc-4fc7-a6b0-c42881c89856
    server: http://your.coreroller.host:port/v1/update/

注意：示例容器默认使用8000端口（HTTP，无SSL），需根据部署调整URL。

现有机器

编辑/etc/coreos/update.conf，更新SERVER（可选GROUP）：

bash
SERVER=https://your.coreroller.host/v1/update/
# 自定义分组需使用ID
GROUP=ab51a000-02dc-4fc7-a6b0-c42881c89856

应用更改：

bash
sudo systemctl restart update-engine

若需立即触发更新：

bash
update_engine_client -update

注：CoreUpdate文档详细解释了此过程，大部分信息适用于CoreRoller，详见此处。

CoreRoller中的CoreOS包

默认情况下，CoreRoller会定期轮询CoreOS公共更新服务器，创建包并更新频道（需联网）。可通过-enable-syncer=false禁用此功能。

默认仅存储CoreOS包元数据，实例需联网从CoreOS公共服务器下载包 payload。若需CoreRoller托管payload，需传递参数给rollerd：

bash
rollerd -host-coreos-packages=true -coreos-packages-path=/PATH/TO/STORE/PACKAGES -coreroller-url=http://your.coreroller.host:port

管理自定义应用更新

CoreRoller可用于管理自定义应用更新，发送Omaha更新和事件请求简单易行。

updaters/lib目录提供示例助手，可用于创建与CoreRoller交互的更新器；updaters/examples目录提供使用https://github.com/***go/grace%E6%9E%84%E5%BB%BA%E7%9A%84%E7%A4%BA%E4%BE%8B%E5%BA%94%E7%94%A8%EF%BC%8C%E5%8F%AF%E9%80%9A%E8%BF%87CoreRoller%E4%BC%98%E9%9B%85%E6%9B%B4%E6%96%B0%E8%87%AA%E8%BA%AB%E3%80%82

其他功能

HipChat通知

CoreRoller支持在特定事件发生时发送HipChat通知（如频道指向新包、rollout开始/失败/成功等）。需为rollerd设置环境变量：

bash
CR_HIPCHAT_ROOM=ROOM_ID
CR_HIPCHAT_TOKEN=TOKEN

贡献

CoreRoller是开源项目，欢迎贡献。提交新功能或重大变更前，请先打开https://github.com/coreroller/coreroller/issues%E8%AE%A8%E8%AE%BA%E3%80%82

后端

CoreRoller后端（rollerd）是Golang应用，使用gb管理构建和依赖。后端代码位于backend/src：

• api包：提供CRUD操作，抽象PostgreSQL数据存储，控制分组roll-out策略和实例/事件注册。
• omaha包：处理Omaha更新和事件请求，依赖api包获取包、存储事件等。
• syncer包：同步CoreOS官方频道包，存储元数据或下载payload。
• rollerd命令：主后端进程，暴露HTTP端点（仪表盘、Omaha请求）。
• initdb命令：重置数据库（仅用于清空数据，rollerd会自动应用迁移）。

代码需使用gofmt格式化，并通过https://github.com/alecthomas/gometalinter%E6%A3%80%E6%9F%A5%E3%80%82

后端数据存储（PostgreSQL）

CoreRoller使用PostgreSQL，需安装或使用coreroller/postgres镜像。手动创建数据库：

bash
psql -U postgres -c "create database coreroller;"
# 测试数据库
psql -U postgres -c "create database coreroller_tests;"

前端

前端（仪表盘）是基于react/flux的JavaScript应用。需Node.js安装依赖并构建：

bash
# 进入frontend目录
npm install
npm run build

构建文件位于frontend/built，可通过rollerd直接服务。开发时可使用watch命令：

bash
npm run watch # 监控js和css
npm run watch-js # 仅监控js
npm run watch-css # 仅监控css

发布说明

1.0

主要变更：移除PostgreSQL semver扩展，合并数据库迁移。升级步骤：

1. 备份数据：

bash
pg_dump -h COREROLLER_DB -U postgres -d coreroller --data-only --exclude-table=database_migrations > coreroller_backup.sql

2. 启动新PostgreSQL服务器并创建数据库：

bash
psql -h NEW_COREROLLER_DB -U postgres -c "create database coreroller;"

3. 启动1.0版本rollerd连接新数据库（自动应用新迁移）。
4. 删除新数据库中的示例数据：

bash
psql -h NEW_COREROLLER_DB -U postgres -d coreroller -c "delete from team; delete from event_type; delete from instance;"

5. 恢复备份数据：

bash
psql -h NEW_COREROLLER_DB -U postgres coreroller < coreroller_backup.sql

许可证

CoreRoller基于Apache 2.0许可证发布。
由Cintia Sánchez García、Mathieu Lohier和Sergio Castaño Arteaga创建。