diff options
| author | Jim MacArthur <jim.macarthur@codethink.co.uk> | 2018-08-21 14:44:32 +0100 |
|---|---|---|
| committer | Martin Blanchard <martin.blanchard@codethink.co.uk> | 2018-09-07 13:57:29 +0100 |
| commit | c0ef71064e9160d926960158edd90bc7f15075a1 (patch) | |
| tree | 9ea9e191d6d2f0c259e919cfd9ece147151e8f32 | |
| parent | 7306a9545c3800109ac8dfcf510d2b3f0224d280 (diff) | |
| download | buildstream-c0ef71064e9160d926960158edd90bc7f15075a1.tar.gz | |
format_project.rst: Document remote-execution option
https://gitlab.com/BuildStream/buildstream/issues/454
| -rw-r--r-- | doc/source/format_project.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst index b43e67005..31984145b 100644 --- a/doc/source/format_project.rst +++ b/doc/source/format_project.rst @@ -204,6 +204,24 @@ with an artifact share. You can also specify a list of caches here; earlier entries in the list will have higher priority than later ones. +Remote execution +~~~~~~~~~~~~~~~~ +BuildStream supports remote execution using the Google Remote Execution API +(REAPI). A description of how remote execution works is beyond the scope +of this document, but you can specify a remote server complying with the REAPI +using the `remote-execution` option: + +.. code:: yaml + + remote-execution: + + # A url defining a remote execution server + url: http://buildserver.example.com:50051 + +The url should contain a hostname and port separated by ':'. Only plain HTTP is +currently suported (no HTTPS). + +The Remote Execution API can be found via https://github.com/bazelbuild/remote-apis. .. _project_essentials_mirrors: |