Bellhop

Bellhop是一个用于预订不同资产的网络应用，如机器或IP地址

简介

目的

你是十个成员中的一个，共享三个测试环境吗？你是否保存了一个谁在使用什么IP地址的电子表格？你需要一种方式来跟踪谁借用了哪个虚拟机吗？

如果你对以上任何问题回答是，Bellhop可能能够帮助。Bellhop是一个超级简单的资产预订工具，它记录了谁在使用什么，直到什么时候。

有关更多信息，包括实时演示，请访问bellhop.rs。

项目结构

• bellhop/ - 实现Bellhop大多数功能的核心库。
• bellhop-demo/ - 一个可运行的示例，演示添加钩子和启动服务器。
• bellhop-hook-email/ - 当你的租赁即将到期时发送电子邮件的钩子。
• bellhop-hook-jenkins/ - 为每个事件启动Jenkins作业的钩子。
• bellhop-auth-dummy/ - 只需要电子邮件地址的认证插件。
• bellhop-auth-header/ - 基于头创建用户的认证插件。

设计

Bellhop设计为高度可定制和内部安装。可以通过编写钩子（如bellhop-hook-jenkins）添加附加功能。认证也是可定制的，具有如bellhop-auth-header之类的可插拔模块。

使用方法

到目前为止，Bellhop更像是您自己组装成网络应用的一系列crate，而不是一个网络应用本身。

一个好的起点是运行bellhop-demo，然后将其作为示例来构建自己的部署。

首次设置

以下说明大致针对Ubuntu，但应该与平台无关。Bellhop定期为Ubuntu和OS X编译，应该也能在Windows上编译。

安装Rust

项目需要最新的Rust夜间版本。您可以使用rustup安装它

$ curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain nightly

安装PostgreSQL

Bellhop使用PostgreSQL作为其数据库。任何大于或等于9.5的版本都应该工作。

Ubuntu/Debian

# Install the server and client libraries.
$ sudo apt install postgresql-9.5 postgresql-client libpq-dev

# Create a user, identified with a password.
$ sudo -u postgres createuser -P bellhop

# Create a new database owned by the same user.
$ sudo -u postgres createdb -O bellhop bellhop

OS X (Homebrew)

在https://brew.sh.cn/安装Homebrew

# Install the server and client libraries.
brew install postgres
brew services start postgresql

# Create a user, identified with a password.
createuser -P bellhop

# Create a new database owned by the same user.
createdb -O bellhop bellhop

安装Diesel

要执行数据库迁移，您需要安装 diesel_cli

$ cargo install diesel_cli --no-default-features --features postgres

获取Bellhop

获取所有组件的最简单方法是将Bellhop仓库克隆下来

$ git clone https://github.com/bellhop-rs/bellhop

执行迁移

核心应用程序以及一些钩子都需要应用数据库迁移，以便应用程序能够正常运行。

# Make sure to update this line with the password supplied earlier.
$ export DATABASE_URL=postgres://bellhop:<password>@localhost/bellhop

# Apply the core application's migrations. Note: `bellhop` refers to this repo's `bellhop` subdirectory.
$ cd bellhop
$ diesel migration run

# Apply any hook's migrations.
$ cd ../bellhop-hook-jenkins
$ diesel migration run

最后运行Bellhop

要以“演示”模式运行Bellhop

$ cargo run --bin bellhop-demo

请注意，bellhop-demo 登录不需要任何密码。它实际上不适合未经定制的生产使用。

开发

生成 bellhop-client

bellhop-client 是使用 openapi-generator 生成的。

要重新生成API客户端库

$ openapi-generator generate \
   -i bellhop/openapi/bellhop.yaml \
   -g rust \
   -o bellhop-client \
   --skip-validate-spec \
   --library reqwest \
   --additional-properties packageName=bellhop-client

许可

Bellhop遵循以下许可协议

• Apache License, Version 2.0, (LICENSE-APACHE 或 http://www.apache.org/licenses/LICENSE-2.0)

贡献

除非您明确说明，否则您提交给Bellhop的任何贡献，根据Apache-2.0许可证定义，都应按照上述方式许可，不附加任何额外的条款或条件。