RBE Setup
Getting started with Remote Build Execution (RBE) is less daunting than it may seem. We've put together a guide that not only helps you get started with BuildBuddy RBE, but also helps you understand what is going on under the hood.
This guide assumes you're using BuildBuddy Cloud or BuildBuddy Enterprise on-prem.
The basics
To execute a build remotely on BuildBuddy, pass the --remote_executor flag to your bazel build command:
bazel build //... --remote_executor=grpcs://remote.buildbuddy.io
This points Bazel at BuildBuddy Cloud as a remote executor. Projects that do not build native libraries or binaries will likely build correctly using the command above.
Projects that build native libraries or binaries or depend on platform-specific tools will need more configuration to take advantage of RBE. We do this with platforms and toolchains. Adding the BuildBuddy Toolchain to your project will let you build and test targets remotely.
Using the BuildBuddy Toolchain with Bazel modules
If your project uses Bazel modules, you can add the BuildBuddy Toolchain as a dependency for your module:
bazel_dep(name = "toolchains_buildbuddy", version = "0.0.4")
buildbuddy = use_extension("@toolchains_buildbuddy//:extensions.bzl", "buildbuddy")
register_toolchains(
"@toolchains_buildbuddy//toolchains/cc:ubuntu_gcc_x86_64",
)
Then, to build remotely on x86_64 Linux:
bazel build //... \
--bes_results_url=https://app.buildbuddy.io/invocation/ \
--bes_backend=grpcs://remote.buildbuddy.io \
--remote_executor=grpcs://remote.buildbuddy.io \
--platforms=@toolchains_buildbuddy//platforms:linux_x86_64 \
--extra_execution_platforms=@toolchains_buildbuddy//platforms:linux_x86_64
Using the BuildBuddy Toolchain with a WORKSPACE file
If your project still uses a WORKSPACE file, you can add the BuildBuddy Toolchain with this snippet:
http_archive(
name = "io_buildbuddy_buildbuddy_toolchain",
integrity = "sha256-4rtmioGI2dzQey1h0fw7z2exUCCelNv0Uff7uwrQihc=",
strip_prefix = "buildbuddy-toolchain-v0.0.4",
urls = ["https://github.com/buildbuddy-io/buildbuddy-toolchain/releases/download/v0.0.4/buildbuddy-toolchain-v0.0.4.tar.gz"],
)
load("@io_buildbuddy_buildbuddy_toolchain//:deps.bzl", "buildbuddy_deps")
buildbuddy_deps()
load("@io_buildbuddy_buildbuddy_toolchain//:rules.bzl", "buildbuddy")
buildbuddy(name = "buildbuddy_toolchain")
Platforms
The first thing you'll want to do is tell BuildBuddy RBE in what environment you'll want to run your build actions. This is tools can be found in different locations on different platforms. This is done with the --host_platform, --platforms, and --extra_execution_platforms flags.
BuildBuddy's default platform is Ubuntu 16.04 with Java 8 installed. We can specify this platform with the --host_platform, --platforms, and --extra_execution_platforms flags:
--host_platform=@buildbuddy_toolchain//:platform
--platforms=@buildbuddy_toolchain//:platform
--extra_execution_platforms=@buildbuddy_toolchain//:platform
If you want to use a different environment, you can specify a custom Docker container image to use. More information on how to do this can be found in our platforms documentation.
Toolchains
Toolchains sound complicated (and they can be) - but the concept is simple. We're telling our remote executors where to find tools that are needed to build our code.
C toolchain
The first toolchain you'll likely run into the need for is a C/C++ compiler. Even if your code isn't written in one of these languages, it's likely that one of your dependencies is - or calls some C code with something like cgo.
You'll know you need a C toolchain when you see an error for a missing gcc or clang that looks like:
exec: "/usr/bin/gcc": stat /usr/bin/gcc: no such file or directory
To use BuildBuddy's default C toolchain, we can use the --crosstool_top and --extra_toolchains flag:
--crosstool_top=@buildbuddy_toolchain//:toolchain
--extra_toolchains=@buildbuddy_toolchain//:cc_toolchain
If you're looking for an llvm based toolchain instead, take a look at this project.
Java toolchain
If your project depends on Java code, you'll need to set the following flags:
--java_language_version=11
--tool_java_language_version=11
--java_runtime_version=remotejdk_11
--tool_java_runtime_version=remotejdk_11
Available versions are listed in Bazel's User Manual.
If you need a custom Java toolchain, see Bazel's docs on Java toolchain configuration.
Java toolchain for older Bazel versions
If your project is using a Bazel version before 6.0.0, you will need the following 4 flags instead. They will tell the executors where to look for Java tools.
Setting both the old flags and the new flags will result in an error and may result in incorrect toolchain selection.
See https://github.com/bazelbuild/bazel/issues/7849 for more information.
Using BuildBuddy's default Java 8 config:
--javabase=@buildbuddy_toolchain//:javabase_jdk8
--host_javabase=@buildbuddy_toolchain//:javabase_jdk8
--java_toolchain=@buildbuddy_toolchain//:toolchain_jdk8
--host_java_toolchain=@buildbuddy_toolchain//:toolchain_jdk8
If you need a different version of Java, we recommend using bazel-toolchains for now.