FAQ

  1. Which clients are currently supported?
  2. Currently we support BuildStream, Bazel and RECC. Though any client which implements v2 of the Remote Execution API should be supported.
  1. Where can I get the most up to date information?
  2. We have a mailing list you can sign up to and a slack channel you can join.
  1. Help! This feature isn’t working!?!
  2. Please raise an issue or ask us on the slack channel for some help.
  1. Can I have feature XYZ? I’ve made a cool thing, can I have it in BuildGrid?
  2. Check that a similar issue hasn’t been raised already and then raise one yourself if it hasn’t. From there we can discuss the feature. We would encourage you to contact the mailing list if you wish to implement a large feature so everyone aware of your idea. Then, create a merge request. The worst we can do is politely decline your work, otherwise you’re now officially a contributor! Have a quick read of the contributing guidelines before making your patch submission.
  1. How do I install BuildGrid?
  2. Check out this installation page.
  1. How do I check on the status of a job?

  2. Using the command line tool you can simply list all the current jobs and select one for the status

    bgd operation list
    bgd operatation status <insert-operation-id>
    
  1. How does CAS expiry work?
  2. We are working hard on automatic CAS expiry but until we have that, we recommend you regularly clean the CAS folder yourself.
  1. What’s the difference between a bot and a worker?
  2. A worker can be thought of but isn’t limited to a physical machine. For example, it can be a collection of physical devices, docker images or a selected number of CPUs. The worker runs what we call a bot. This is a program that controls the worker; giving it actions to do, returning results to the central server and monitoring the status of the worker. The central server can communicate with a collection of bots via the BotsInterface.
  1. Where can I find more information about the API?
  2. We recommend you read the proto files for the Remote Execution API and Remote Workers API. There is a more detailed document for the Remote Execution API and another detailed document for the Remote Workers API.
  1. What’s going on in the _proto folder?
  2. This project uses gRPC and protocol buffers for network messaging. The .proto files are used to generate python modules which are then used in the project. See the grpc guide for more details.
  1. How do I set up a BuildGrid?
  2. You can follow this guide to give you an understanding on basic usecases: Using. There is also additional information on how to configure your Grid here: parser.