使用Bonanza构建bb-storage项目的完整指南

前言

Bonanza是一个正在开发中的构建系统，目前主要专注于支持构建bb-storage项目。本文将详细介绍如何使用Bonanza构建bb-storage，通过这个过程，读者可以深入理解Bonanza的工作原理和独特设计。

准备工作

获取修改版的bb-storage

首先需要获取一个经过修改的bb-storage版本，这个版本包含了支持Bonanza构建的必要改动：

git clone [e-mail]:buildbarn/bb-storage.git
cd bb-storage
git checkout eschouten/bonanza

建议查看与主分支的差异，了解为支持Bonanza所做的修改类型。

配置.bazelrc文件

为了简化构建过程，我们需要在~/.bazelrc中添加Bonanza专用的配置。以下是对关键配置项的详细说明：

远程缓存和执行器配置

common:bonanza --remote_cache=unix:///path/to/bonanza_storage_frontend.sock
common:bonanza --remote_executor=unix:///path/to/bonanza_scheduler_clients.sock

这些配置指定了Bonanza的存储前端和调度器的Unix域套接字路径。与Bazel不同，Bonanza使用自己的存储和执行协议。

加密配置

common:bonanza --remote_encryption_key=U3YDUwfejfiRDeD4aqoR7A==

Bonanza支持使用AES加密CAS对象。这个密钥可以在客户端生成，并在构建时传递给集群。更改密钥将导致整个缓存失效。

构建器身份验证

common:bonanza --remote_executor_builder_pkix_public_key=MCowBQYDK2VuAyEAE+onXE9lGj+1ykKMdYJ7ORbbGvDg6mXwX9H90afmdDI=

Bonanza使用X25519密钥对来识别不同类型的worker。这个公钥对应于演示部署中使用的私钥。

客户端证书

common:bonanza --remote_executor_client_private_key=/path/to/bonanza_bazel.key.pem
common:bonanza --remote_executor_client_certificate_chain=/path/to/bonanza_bazel.cert.pem

构建请求需要附带受信任的X.509证书和对应的X25519私钥，用于加密构建请求。

模块覆盖

common:bonanza --override_module=bazel_tools=/path/to/bazel_tools
common:bonanza --override_module=builtins_bzl=/path/to/builtins_bzl
common:bonanza --override_module=builtins_core=/path/to/builtins_core

这些配置指定了需要上传的额外Starlark代码模块。

内置模块

common:bonanza --builtins_module=builtins_core
common:bonanza --builtins_module=builtins_bzl

这些配置使得DefaultInfo、filegroup()、platform()等基础功能以及cc_binary()等规则无需显式加载即可使用。

平台配置

common:bonanza --repo_platform=//platforms:repo

这个配置指定了用于运行仓库规则的平台。值得注意的是，bb-storage的platforms/BUILD.bazel中包含了一些Bonanza特有的平台属性：

• exec_pkix_public_key：替代Bazel的exec_properties和remote_execution_properties属性，包含识别worker类型的X25519公钥
• repository_os_*：包含运行仓库规则所需的平台额外信息

安装bonanza_bazel

要启动构建，需要安装Bonanza的命令行工具：

install -m 555 \
    $(bazel run --run_under echo //cmd/bonanza_bazel) \
    /usr/local/bin/bonanza_bazel

启动演示集群

可以在本地系统上启动一个演示集群：

bazel run //deployments/demo

这个命令会启动多个进程，包括：

• bonanza_builder：负责构建分析和编排
• bonanza_scheduler：调度器
• bonanza_storage_frontend：存储前端
• 多个bonanza_storage_shard实例：存储分片
• bonanza_worker：工作节点
• bb_runner：实际执行构建动作的进程

执行构建

一切准备就绪后，可以在bb-storage代码目录中执行构建：

bonanza_bazel build --config=bonanza //cmd/bb_storage

技术要点解析

1. 安全模型：Bonanza采用了基于X25519密钥对的身份验证机制，相比传统的属性键值对提供了更强的安全性。

2. 加密存储：支持客户端控制的AES加密，确保CAS对象在传输和存储过程中的安全性。

3. 模块化设计：将核心功能实现为Starlark模块，提高了系统的可扩展性和灵活性。

4. 平台抽象：通过repo_platform配置实现了构建环境与运行环境的解耦，支持跨平台构建。

5. 进程架构：保持了与Buildbarn类似的worker架构，使用单独的runner进程执行构建动作。

通过这个构建过程，开发者可以深入了解Bonanza的设计理念和技术实现，为未来支持更广泛的Bazel项目构建奠定基础。