From c0ef71064e9160d926960158edd90bc7f15075a1 Mon Sep 17 00:00:00 2001 From: Jim MacArthur Date: Tue, 21 Aug 2018 14:44:32 +0100 Subject: format_project.rst: Document remote-execution option https://gitlab.com/BuildStream/buildstream/issues/454 --- doc/source/format_project.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) 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: -- cgit v1.2.1