This repository hosts the Bazel remote caching and execution system.
Background information on the status of caching and remote execution in bazel can be found in the bazel documentation.
File issues here for bugs or feature requests, and ask questions via build team slack in the #buildfarm channel.
All commandline options override corresponding config settings.
bazel run //src/main/java/build/buildfarm:buildfarm-server <configfile> [<-p|--port> PORT]
configfile has to be in Protocol Buffer text format, corresponding to a BuildFarmServerConfig definition.
For an example, see the examples directory, which contains the working example examples/server.config.example. For format details see here. Protocol Buffer structure at src/main/protobuf/build/buildfarm/v1test/buildfarm.proto
PORT to expose service endpoints on
bazel run //src/main/java/build/buildfarm:buildfarm-operationqueue-worker <configfile> [--root ROOT] [--cas_cache_directory CAS_CACHE_DIRECTORY]
configfile has to be in Protocol Buffer text format, corresponding to a WorkerConfig definition.
For an example, see the examples directory, which contains the working example examples/worker.config.example. For format details see here. Protocol Buffer structure at src/main/protobuf/build/buildfarm/v1test/buildfarm.proto
ROOT base directory path for all work being performed.
CAS_CACHE_DIRECTORY is (absolute or relative) directory path to cached files from CAS.
To use the example configured buildfarm with bazel (version 1.0 or higher), you can configure your
.bazelrc as follows:
$ cat .bazelrc build --remote_executor=grpc://localhost:8980
Then run your build as you would normally do.
You can use typical Java logging configuration to filter these results and observe the flow of executions through your running services.
logging.properties file has been provided at examples/debug.logging.properties for use as follows:
bazel run //src/main/java/build/buildfarm:buildfarm-server -- --jvm_flag=-Djava.util.logging.config.file=$PWD/examples/debug.logging.properties $PWD/examples/server.config.example
bazel run //src/main/java/build/buildfarm:buildfarm-operationqueue-worker -- --jvm_flag=-Djava.util.logging.config.file=$PWD/examples/debug.logging.properties $PWD/examples/worker.config.example
To attach a remote debugger, run the executable with the
--debug=<PORT> flag. For example:
bazel run //src/main/java/build/buildfarm:buildfarm-server -- --debug=5005 $PWD/examples/server.config.example
This is done using
Tested with Redis
6.0.10, other versions probably work fine as well.
First of all you need Redis installed:
brew install redis
sudo apt-get update && sudo apt-get install redis-server redis-tools
Then you need eight terminal panes for this. Six for a minimal Redis cluster, one for the Buildfarm server and one for a Buildfarm worker.
redis-cli --cluster create 127.0.0.1:6379 127.0.0.1:6380 127.0.0.1:6381 127.0.0.1:6382 127.0.0.1:6383 127.0.0.1:6384 --cluster-replicas 1
Your Redis cluster is now up, and you can now start your Buildfarm server talking to it:
bazel run //src/main/java/build/buildfarm:buildfarm-server $PWD/examples/shard-server.config.example
And your Buildfarm worker:
mkdir /tmp/worker bazel run //src/main/java/build/buildfarm:buildfarm-shard-worker $PWD/examples/shard-worker.config.example
Make sure you have a supported IntelliJ version, otherwise download one here
Once IntelliJ is done loading your project, open
and find the
main() method at the bottom
Press the green play button symbol in the gutter next to
main() to create a
Bazel build configuration for starting a server. Launching this configuration
should get you a help text from Buildfarm Server indicating missing a config
This indicates a successful launch!
To add a config file, edit your new run configuration and enter the absolute
the "Executable flags" text box.
Now, you should have something like this, and you can now run / debug Buildfarm Server from inside of IntelliJ, just like any other program:
Most third-party dependencies (e.g. protobuf, gRPC, ...) are managed automatically via
rules_jvm_external. These dependencies are enumerated in
the WORKSPACE with a
Things that aren't supported by
rules_jvm_external are being imported as manually managed remote repos via
Buildfarm can be used as an external repository for composition into a deployment of your choice.
Add the following to your WORKSPACE to get access to buildfarm targets, filling in the commit and sha256 values:
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") BUILDFARM_EXTERNAL_COMMIT = "<revision commit id>" BUILDFARM_EXTERNAL_SHA256 = "<sha256 digest of url below>" http_archive( name = "build_buildfarm", strip_prefix = "bazel-buildfarm-%s" % BUILDFARM_EXTERNAL_COMMIT, sha256 = BUILDFARM_EXTERNAL_SHA256, url = "https://github.com/bazelbuild/bazel-buildfarm/archive/%s.zip" % BUILDFARM_EXTERNAL_COMMIT, ) load("@build_buildfarm//:deps.bzl", "buildfarm_dependencies") buildfarm_dependencies() load("@build_buildfarm//:defs.bzl", "buildfarm_init") buildfarm_init()
Optionally, if you want to use the buildfarm docker container image targets, you can add this:
load("@build_buildfarm//:images.bzl", "buildfarm_images") buildfarm_images() load("@build_buildfarm//:pip.bzl", "buildfarm_pip") buildfarm_pip()