nailed 镜像文档

镜像概述

nailed 由后端CLI数据收集工具和基于Sinatra的Web前端组成，用于可视化产品的相关开发数据，这些产品的缺陷跟踪系统位于Bugzilla，代码库（可选）位于GitHub。请注意，Bugzilla布局（元数据）目前仍是SUSE特定的，可能并非对所有用户都适用（例如依赖标记为L3的缺陷），计划在未来使其成为可选项。

界面展示

!概览界面 !Bugzilla界面 !GitHub界面

安装（使用git，推荐）

您也可以直接从git检出使用nailed。确保获取依赖并从bin目录调用nailed。

SUSE系统

bash
zypper in ruby ruby-devel ruby2.5-rubygem-bundler gcc gcc-c++ libz1 zlib-devel sqlite3 sqlite3-devel

bundle install

• 对于SUSE BugZilla API，请确保在~目录下有包含您凭据的.oscrc文件。

使用方法

bash
$ nailed -h
选项:
          --new, -n:   创建新数据库 
      --migrate, -m:   迁移/升级数据库
     --bugzilla, -b:   刷新Bugzilla数据库记录
       --github, -g:   刷新GitHub数据库记录
     --list, -l <s>:   列出组织内的GitHub仓库
       --server, -s:   启动仪表板Web界面
         --help, -h:   显示此帮助信息

私有GitHub仓库

• 对于GitHub API，请确保在~目录下有包含有效GitHub OAuth令牌的.netrc文件。

bash
# .netrc示例

machine api.github.com
  login MaximilianMeister
  password <您的OAuth令牌>

配置

所有配置从config/config.yml读取。

• 配置您的config/config.yml
• 要设置数据库，请运行：

bash
nailed --migrate

生产环境变更

• 在生产环境中，添加产品/变更后，要使用新变更升级数据库，请运行：

bash
nailed --migrate

• 确保使用以下命令获取新数据：

bash
nailed --bugzilla
nailed --github

• 重启Web服务器

运行

• 创建cronjob以使用nailed自动收集数据

  例如：0 * * * * cd /path/to/bin/nailed; ./nailed -b && ./nailed -g

Docker容器运行

构建镜像

bash
git clone [***]
cd nailed
docker build -t nailed:latest .

创建数据目录

bash
mkdir -p /tmp/storage/config

配置文件挂载

将以下文件添加到/tmp/storage/config目录：

• 私有GitHub仓库需要的~/.netrc
• 配置文件config/config.yml（可参考示例）
• SUSE BugZilla API需要的~/.oscrc（如有）

运行容器

bash
docker run -ti -v /tmp/storage:/nailed/data -p 8000:4567 nailed:latest

致谢

• Duncan Mac-Vicar P. 提供了出色的Bicho gem。