ebr-board

Elastic Build Results的RESTful接口。

使用

要查看API文档，请启动服务器并转到 <url>/api/docs。

配置

ebr-board使用Vault-Anyconfig来读取其配置，允许它访问Hashicorp Vault实例以加载机密。有关更多详细信息，请参阅其文档。

为了部署一个简单的ebr-board实例，你需要两个文件：config.yaml和vault.yaml。留空vault.yaml，因为在本次实例中我们将不会使用Vault-Anyconfig的机密加载。

config.yaml应格式如下

elastic:
  host: <elastic_url>
  port: 9200
  timeout: 20
  use_ssl: true
  verify_certs: true
  ca_certs: /etc/ebr-board/elastic.crt
  index: testspipeline*
  user: <elastic_user>
  pwd: <elastic_password>

要更改默认url前缀（/api），在顶层添加新的键值对

url_prefix: "/new_prefix"

要不使用前缀，提供空字符串，即

url_prefix: ""`

开发模式

要以开发模式启动，请运行python ebr_board/ebr_board.py

生产模式

可以使用ebr_board:create_app(config_filename='/etc/ebr-board/config.yaml', vault_config_filename='/etc/ebr-board/vault.yaml', vault_creds_filename='/etc/ebr-board/vault.yaml', load_certs=True, reverse_proxy=True)调用，例如从Gunicorn。您应该将其配置在反向代理后面 - 有关更多详细信息，请参阅配置Flask服务器进行部署的任何指南。在存储库根目录中提供了一个预配置Gunicorn的Dockerfile。

AWS Lambda支持

应用程序可以通过使用aws_lambda模块中的handler函数在AWS Lambda中运行。在这种情况下，它应该与aws_lambda可选依赖项一起安装，即pip install ebr-board['aws_lambda']。它期望配置（主配置、保险库配置和保险库凭据）将完全以字符串形式存储在参数存储中。可以通过环境变量配置它处理这些参数的方式。

• config_name：默认为ebr_board_config
• vault_config_name：默认为ebr_board_vault_config
• vault_creds_name：默认为ebr_board_vault_creds
• config_format：默认为yaml

功能

• 提供获取抽象
  • 给定作业的构建列表
  • 给定作业的测试
  • 测试失败的聚合
• AWS Lambda支持

待办事项

• 提高测试覆盖率
• 填写资源覆盖率
• 扩展聚合/搜索功能

致谢

本软件包是用Cookiecutter和tomtom-international/cookiecutter-python项目模板创建的。

变更日志

0.2.0 (2019-08-26)

• 删除了对Python 3.5的支持

0.1.1 (2019-08-23)

• 为aws_lambda添加了extras_require

0.1.0 (2019-08-22)

• 添加aws lambda处理器
• 清理代码以更好地包含状态（适用于lambda兼容性）

0.0.1-dev (2019-07-05)

• 首次发布在PyPI上。