screwdrivercd/screwdriver

Screwdriver API

Screwdriver是一个自包含、可插拔的服务，帮助你使用最新的容器化技术构建、测试和持续交付软件。本镜像提供其API服务器组件，是Screwdriver持续交付服务的核心部分。

目录

• 背景
• 安装与使用
• 配置
• 测试
• 贡献
• 许可证

背景

Screwdriver起源于2012年雅虎内部一个简化Jenkins交互的临时项目。随着构建量增加，Jenkins在大规模运行时的稳定性和可行性不足逐渐显现。2016年，我们基于最佳编码实践和持续集成/持续部署目标，从零开始重写了这个项目并开源。Screwdriver与执行器和源代码管理系统无关，你可以选择适合自己需求的插件或构建自定义插件。它完全免费开源，团队正在积极维护代码。

更多关于Screwdriver的信息，请访问官方网站。

安装与使用

插件

此API预加载了16个资源插件：

• auth
• banners
• builds
• buildClusters
• collections
• commands
• coverage（可选）
• events
• jobs
• pipelines
• secrets
• templates
• tokens
• webhooks
• stats
• isAdmin

三种数据存储选项：

• Postgres、MySQL和Sqlite（sequelize）

三种执行器选项：

• Kubernetes（k8s）
• Docker（docker）
• Nomad（nomad）

三种源代码管理（SCM）选项：

• Github（github）
• Gitlab（gitlab）
• Bitbucket（bitbucket）

前提条件

使用Screwdriver需要以下前提条件：

• Node v8.0.0或更高版本
• Kubernetes或Docker

从源代码安装

bash
$ git clone git@github.com:screwdriver-cd/screwdriver.git ./
$ npm install
$ vim ./config/local.yaml # 配置说明见下文
$ npm start
info: Server running at http://localhost:8080

使用预构建Docker镜像

bash
$ vim ./local.yaml # 配置说明见下文
$ docker run --rm -it --volume=`pwd`/local.yaml:/config/local.yaml -p 8080 screwdrivercd/screwdriver:stable
info: Server running at http://localhost:8080

使用In-A-Box

我们的in-a-box脚本可在本地启动完整的Screwdriver实例（UI、API和日志存储）供你试用。请按照https://github.com/screwdriver-cd/in-a-box#screwdriver-in-a-box%E7%9A%84%E8%AF%B4%E6%98%8E%E6%93%8D%E4%BD%9C%E3%80%82

使用Helm

https://github.com/screwdriver-cd/screwdriver-chart%E5%8F%AF%E5%BC%95%E5%AF%BC%E6%95%B4%E4%B8%AAScrewdriver%E7%94%9F%E6%80%81%E7%B3%BB%E7%BB%9F%E4%BB%A5%E5%8F%8Anginx%E5%85%A5%E5%8F%A3%E6%8E%A7%E5%88%B6%E5%99%A8%E3%80%82

配置

Screwdriver已默认大多数配置，但你可以使用local.yaml或环境变量覆盖默认值。

要继续设置，请遵循https://github.com/screwdriver-cd/guide/blob/master/docs/cluster-management/configure-api.md#managing-the-api%E3%80%82

Yaml配置

local.yaml覆盖示例：

yaml
executor:
    plugin: k8s
    k8s:
        options:
            kubernetes:
                host: kubernetes.default
                token: this-is-a-real-token
            launchVersion: stable

scms:
    github:
        plugin: github
        config:
            oauthClientId: totally-real-client-id
            oauthClientSecret: another-real-client-secret
            secret: a-really-real-secret
            username: sd-buildbot
            email: dev-null@screwdriver.cd

环境变量配置

环境变量覆盖示例：

bash
$ export K8S_HOST=127.0.0.1
$ export K8S_TOKEN=this-is-a-real-token
$ export SECRET_OAUTH_CLIENT_ID=totally-real-client-id
$ export SECRET_OAUTH_CLIENT_SECRET=another-real-client-secret

所有可能的环境变量定义在此处。

测试

单元测试

bash
npm test

注意：运行所有单元测试时可能会遇到内存问题。你可以在~/.bashrc文件中添加以下行，确保有足够内存运行测试：

bash
export NODE_OPTIONS=--max_old_space_size=4096

功能测试

从https://github.com/screwdriver-cd-test%E5%B0%86%60functional-*%60%E4%BB%93%E5%BA%93 Fork 到你的组织。

使用.func_config

在Screwdriver API文件夹根目录添加.func_config，包含测试用的用户名、GitHub令牌、访问密钥、主机和组织：

GIT_TOKEN=你的GitHub令牌
SD_API_TOKEN=你的SD API令牌
SD_API_HOST=你的SD API主机
SD_API_PROTOCOL=SD API协议 // 例如PROTOCOL=http；默认是https
TEST_ORG=你的测试组织
TEST_USERNAME=你的GitHub用户名
TEST_SCM_HOSTNAME=你的测试SCM主机名 // 例如TEST_SCM_HOSTNAME=mygithub.com；默认是github.com
TEST_SCM_CONTEXT=你的测试SCM上下文 // 例如TEST_SCM_CONTEXT=bitbucket；默认是github

使用环境变量

设置环境变量：

bash
$ export GIT_TOKEN=你的GitHub令牌
$ export SD_API_TOKEN=你的SD API令牌
$ export SD_API_HOST=你的SD API主机
$ export SD_API_PROTOCOL=SD API协议
$ export TEST_ORG=你的测试组织
$ export TEST_USERNAME=你的GitHub用户名
$ export TEST_SCM_HOSTNAME=你的测试SCM主机名
$ export TEST_SCM_CONTEXT=你的测试SCM上下文

然后运行Cucumber测试：

bash
npm run functional

贡献

要开始为Screwdriver贡献代码，请查看我们的指南以及开始修改的建议，详见贡献指南。

许可证

代码采用BSD 3-Clause许可证授权。详见https://github.com/screwdriver-cd/screwdriver/blob/master/LICENSE%E3%80%82