Bellhop

Bellhop 是一个用于预订不同资产（如机器或 IP 地址）的 Web 应用程序

介绍

目的

你是十人团队中的一员，共享三个测试环境吗？你保存了一个谁在使用什么 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 更像是一组你自行组装成 Web 应用的 crate，而不是一个真正的 Web 应用程序。

一个好的起点是运行 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许可证版本2.0，（LICENSE-APACHE或http://www.apache.org/licenses/LICENSE-2.0）

贡献

除非您明确声明，否则您根据Apache-2.0许可证提交给Bellhop的任何有意贡献，都将按照上述方式许可，没有额外的条款或条件。

lib.rs:

一个实现bellhop::hooks::Hook的实例，当租约创建或释放，或者即将到期时启动Jenkins作业。

路由

不提供路由。

捕获器

不提供捕获器。

配置

目前还没有:(

示例

use bellhop::Bellhop;
use bellhop_hook_jenkins::Jenkins;

fn main() {
    Bellhop::default()
        .hook(Jenkins)
        .start()
}