|
|
1
|
+.. _faq:
|
|
|
2
|
+
|
|
|
3
|
+FAQ
|
|
|
4
|
+===
|
|
|
5
|
+
|
|
|
6
|
+Q. Which clients are currently supported?
|
|
|
7
|
+R. Currently we support `BuildStream`_, `Bazel`_ and `RECC`_. Though any client which implements v2 of the `Remote Execution API`_ should be supported.
|
|
|
8
|
+
|
|
|
9
|
+Q. Where can I get the most up to date information?
|
|
|
10
|
+R. We have a `mailing list`_ you can sign up to and a `slack channel`_ you can join.
|
|
|
11
|
+
|
|
|
12
|
+Q. Help! This feature isn't working!?!
|
|
|
13
|
+R. Please `raise`_ an issue or ask us on the `slack channel`_ for some help.
|
|
|
14
|
+
|
|
|
15
|
+Q. Can I have feature XYZ? I've made a cool thing, can I have it in BuildGrid?
|
|
|
16
|
+R. 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.
|
|
|
17
|
+
|
|
|
18
|
+Q. How do I install BuildGrid?
|
|
|
19
|
+R. Check out this `installation page`_.
|
|
|
20
|
+
|
|
|
21
|
+Q. How do I check on the status of a job?
|
|
|
22
|
+R. Using the command line tool you can simply list all the current jobs and select one for the status
|
|
|
23
|
+
|
|
|
24
|
+ .. code-block:: sh
|
|
|
25
|
+
|
|
|
26
|
+ bgd operation list
|
|
|
27
|
+ bgd operatation status <insert-operation-id>
|
|
|
28
|
+
|
|
|
29
|
+Q. How does CAS expiry work?
|
|
|
30
|
+R. We are working hard on automatic CAS expiry but until we have that, we recommend you regularly clean the CAS folder yourself.
|
|
|
31
|
+
|
|
|
32
|
+Q. What's the difference between a bot and a worker?
|
|
|
33
|
+R. 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`.
|
|
|
34
|
+
|
|
|
35
|
+Q. Where can I find more information about the API?
|
|
|
36
|
+R. 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`_.
|
|
|
37
|
+
|
|
|
38
|
+Q. What's going on in the _proto folder?
|
|
|
39
|
+A. 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.
|
|
|
40
|
+
|
|
|
41
|
+Q. How do I set up a BuildGrid?
|
|
|
42
|
+A. You can follow the `using`_ guide and there is also additional information on `server configuration`_.
|
|
|
43
|
+
|
|
|
44
|
+.. _BuildStream: https://buildstream.build
|
|
|
45
|
+.. _Bazel: https://bazel.build/
|
|
|
46
|
+.. _RECC: https://gitlab.com/bloomberg/recc
|
|
|
47
|
+.. _Remote Execution API: https://gitlab.com/BuildGrid/buildgrid/blob/master/buildgrid/_protos/build/bazel/remote/execution/v2/remote_execution.proto
|
|
|
48
|
+.. _Remote Workers API: https://gitlab.com/BuildGrid/buildgrid/tree/master/buildgrid/_protos/google/devtools/remoteworkers/v1test2
|
|
|
49
|
+.. _mailing list: https://lists.buildgrid.build/cgi-bin/mailman/listinfo/buildgrid
|
|
|
50
|
+.. _slack channel: https://join.slack.com/t/buildteamworld/shared_invite/enQtMzkxNzE0MDMyMDY1LTRmZmM1OWE0OTFkMGE1YjU5Njc4ODEzYjc0MGMyOTM5ZTQ5MmE2YTQ1MzQwZDc5MWNhODY1ZmRkZTE4YjFhNjU
|
|
|
51
|
+.. _merge request: https://gitlab.com/BuildGrid/buildgrid/merge_requests
|
|
|
52
|
+.. _contributing: https://gitlab.com/BuildGrid/buildgrid/blob/master/CONTRIBUTING.rst
|
|
|
53
|
+.. _raise: https://gitlab.com/BuildGrid/buildgrid/issues
|
|
|
54
|
+.. _installation page: https://buildgrid.gitlab.io/buildgrid/installation.html
|
|
|
55
|
+.. _detailed document for the Remote Execution API: https://docs.google.com/document/d/1AaGk7fOPByEvpAbqeXIyE8HX_A3_axxNnvroblTZ_6s/
|
|
|
56
|
+.. _detailed document for the Remote Workers API: https://docs.google.com/document/d/1s_AzRRD2mdyktKUj2HWBn99rMg_3tcPvdjx3MPbFidU/
|
|
|
57
|
+.. _grpc guide: https://grpc.io/docs/guides/
|
|
|
58
|
+.. _using: https://buildgrid.gitlab.io/buildgrid/using.html
|
|
|
59
|
+.. _server configuration: https://buildgrid.gitlab.io/buildgrid/reference_server_config.html
|
