The Remote Execution API is an API that, at its most general, allows clients to request execution of binaries on a remote system. It is intended primarily for use by build systems, such as Bazel, to distribute build and test actions through a worker pool, and also provide a central cache of build results. This allows builds to execute faster, both by reusing results already built by other clients and by allowing many actions to be executed in parallel, in excess of the resource limits of the machine running the build.
There are a number of clients and services using these APIs, they are listed below.
These tools use the Remote Execution API to distribute builds to workers.
These applications implement the Remote Execution API to server build requests from the clients above. These are then distributed to workers; some of these workers implement the Remote Worker API.
- Buildbarn (open source)
- Buildfarm (open source)
- BuildGrid (open source)
- EngFlow (commercial)
- Flare Build Execution (commercial)
- Remote Build Execution (Alpha) (commercial)
- Scoot (open source)
The Remote Execution APIs group hosts discussions related to the APIs in this repository.
Interested parties meet monthly via VC to discuss issues related to the APIs, and several contributors have organized occasional meetups, hack-a-thons, and summits. Joining the email discussion group will automatically add you to the Google Calendar invite for the monthly meeting.
The APIs in this repository refer to several general-purpose APIs published by
Google in the Google APIs
repository. You will need to refer to
packages from that repository in order to generate code using this API. If you
build the repository using the included BUILD files, Bazel will fetch the
protobuf compiler and googleapis automatically.
The repository provides a rule that you can use in your WORKSPACE file to
select which languages you are using. This allows you to depend on this
repository without pulling in Go rules, for instance, if you aren't using Go
rules.
For instance, if you only use Java in your project, add the following to your
WORKSPACE file:
load("@bazel_remote_apis//:repository_rules.bzl", "switched_rules_by_language")
switched_rules_by_language(
name = "bazel_remote_apis_imports",
java = True,
)You can find the complete list of supported languages in repository_rules.bzl.
The repository contains BUILD files to build the protobuf library with
Bazel. If you wish to use them with your own project in
Bazel, you will possibly want to declare cc_proto_library,
java_proto_library, etc. rules that depend on them.
Other build systems will have to run protoc on the protobuf files, and link in the googleapis and well-known proto types, manually.
This repository contains the generated Go code for interacting with the API via gRPC. Get it with:
go get github.com/bazelbuild/remote-apis
Import it with, for example:
repb "github.com/bazelbuild/remote-apis/build/bazel/remote/execution/v2"
Enable the git hooks to automatically generate Go proto code on commit:
git config core.hooksPath hooks/
This is a local setting, so applies only to this repository.