Apache Cassandra 构建工具技术文档

1. 安装指南

1.1 环境准备

在开始安装之前，请确保您的系统满足以下要求：

• Docker 已安装并运行。
• 已安装 svn 工具。
• 已安装 createrepo 和 reprepro 工具（用于更新包仓库）。

1.2 安装步骤

1. 克隆项目仓库：

   git clone https://github.com/apache/cassandra-build-tools.git
   cd cassandra-build-tools
   

2. 构建 Docker 镜像：

   • 构建 Debian 包的 Docker 镜像：

     docker build -t cass-build-debs -f docker/bullseye-image.docker docker/
     

   • 构建 RPM 包的 Docker 镜像：

     docker build -t cass-build-rpms -f docker/almalinux-image.docker docker/
     

3. 设置环境变量：

   • 在 cassandra-release/finish_release.sh 中设置 ARTIFACTORY_API_KEY。
   • 在 cassandra-release/prepare_release.sh 中设置 gpg_key。

2. 项目的使用说明

2.1 构建包

1. 运行构建脚本：

   • 构建 Debian 包：

     docker run --rm -v `pwd`/dist:/dist `docker images -f label=org.cassandra.buildenv=bullseye -q` /home/build/build-debs.sh <branch/tag>
     

   • 构建 RPM 包：

     docker run --rm -v `pwd`/dist:/dist `docker images -f label=org.cassandra.buildenv=almalinux -q` /home/build/build-rpms.sh <branch/tag>
     

2. 选择 Java 版本（仅适用于 Debian 包）：

   • 默认使用 Java 8，若要使用 Java 11，请在命令末尾添加 11：

     docker run --rm -v `pwd`/dist:/dist `docker images -f label=org.cassandra.buildenv=bullseye -q` /home/build/build-debs.sh <branch/tag> 11
     

2.2 签名包

• RPM 包签名：

  rpmsign -D '%_gpg_name MyAlias' --addsign cassandra-3.0.13-1.noarch.rpm
  

• Debian 包签名： 参考 cassandra-release/prepare_release.sh 中的 debsign 使用方法。

2.3 更新包仓库

1. 克隆 SVN 仓库：

   svn co --config-option 'config:miscellany:use-commit-times=yes' https://dist.apache.org/repos/dist/release/cassandra
   

2. 更新 RPM 仓库：

   • 将 RPM 包复制到 $artifacts_svn_dir/redhat/<version>。
   • 重新生成元数据：

     createrepo -v .
     

   • 签名元数据文件：

     for i in `ls *.bz2 *.gz *.xml`; do gpg -sba --local-user MyAlias $i; done;
     

3. 更新 Debian 仓库： 参考 finish_release.sh 中的步骤。

3. 项目API使用文档

3.1 Jenkins Job DSL 脚本

• 目录：jenkins-dsl/
• 功能：用于创建 CI 作业的 Jenkins Job DSL 脚本。

3.2 构建/测试运行时脚本

• 目录：build-scripts/
• 功能：包含构建和测试 Cassandra 的运行时脚本。

3.3 Cassandra 打包工具

• 目录：cassandra-release/ 和 docker/
• 功能：包含用于打包 Cassandra 的工具和 Docker 镜像。

4. 项目安装方式

4.1 通过 Docker 构建

• 构建 Debian 包：

  docker build -t cass-build-debs -f docker/bullseye-image.docker docker/
  

• 构建 RPM 包：

  docker build -t cass-build-rpms -f docker/almalinux-image.docker docker/
  

4.2 运行构建脚本

• Debian 包：

  docker run --rm -v `pwd`/dist:/dist `docker images -f label=org.cassandra.buildenv=bullseye -q` /home/build/build-debs.sh <branch/tag>
  

• RPM 包：

  docker run --rm -v `pwd`/dist:/dist `docker images -f label=org.cassandra.buildenv=almalinux -q` /home/build/build-rpms.sh <branch/tag>
  

通过以上步骤，您可以成功构建、签名并更新 Apache Cassandra 的包仓库。