Skip to content
Snippets Groups Projects
Commit c246d3af authored by Martin Blanchard's avatar Martin Blanchard
Browse files

docs: Update BuildStream usage example

BuildStream remote execution configuration section recently changed. Our
documentation usage example needs an update to match the new format.

BuildStream/buildstream!946
BuildStream/buildstream!952
BuildStream/buildstream!982
parent 669e776b
No related branches found
No related tags found
Loading
Pipeline #40564956 passed
...@@ -6,7 +6,9 @@ BuildStream client ...@@ -6,7 +6,9 @@ BuildStream client
`BuildStream`_ is a free software tool for building and integrating software `BuildStream`_ is a free software tool for building and integrating software
stacks. It supports remote build execution using the remote execution API stacks. It supports remote build execution using the remote execution API
(REAPI) v2. (REAPI) v2. The project's documentation has a detailed section about its
`remote execution subsystem architecture`_ that you are very recommanded to
read first.
.. note:: .. note::
...@@ -15,6 +17,7 @@ stacks. It supports remote build execution using the remote execution API ...@@ -15,6 +17,7 @@ stacks. It supports remote build execution using the remote execution API
remote execution. remote execution.
.. _BuildStream: https://buildstream.build .. _BuildStream: https://buildstream.build
.. _remote execution subsystem architecture: https://buildstream.gitlab.io/buildstream/arch_remote_execution.html
.. _install it from sources: https://buildstream.build/source_install.html .. _install it from sources: https://buildstream.build/source_install.html
...@@ -43,23 +46,23 @@ Project configuration ...@@ -43,23 +46,23 @@ Project configuration
In order to activate remote build execution at project-level, the project's In order to activate remote build execution at project-level, the project's
``project.conf`` file must declare two specific configuration nodes: ``project.conf`` file must declare two specific configuration nodes:
- ``artifacts`` for `remote CAS endpoint details`_. - ``artifacts`` for `remote cache endpoint details`_.
- ``remote-execution`` for `remote execution endpoint details`_. - ``remote-execution`` for `remote execution endpoint details`_.
.. important:: .. important::
BuildStream does not support multi-instance remote execution servers and will BuildStream does not support multi-instance remote execution servers and will
always submit remote execution request omitting the instance name parameter. always submit remote execution request omitting the instance name parameter.
Thus, you must declare an unnamed `""` instance in your server configuration Thus, you must declare an unnamed `''` instance in your server configuration
to workaround this. to workaround this.
.. important:: .. important::
If you are using BuildGrid's artifact server, the server instance **must** If you are using BuildStream's artifact server, the server instance pointed
accept pushes from your client for remote execution to be possible. by the ``storage-service`` key **must** accept pushes from your client for
remote execution to be possible.
.. _remote cache endpoint details: https://buildstream.gitlab.io/buildstream/format_project.html#artifact-server
.. _remote CAS endpoint details: https://buildstream.gitlab.io/buildstream/install_artifacts.html#user-configuration
.. _remote execution endpoint details: https://buildstream.gitlab.io/buildstream/format_project.html#remote-execution .. _remote execution endpoint details: https://buildstream.gitlab.io/buildstream/format_project.html#remote-execution
...@@ -167,6 +170,14 @@ append at the end of the ``project.conf`` file from the root directory: ...@@ -167,6 +170,14 @@ append at the end of the ``project.conf`` file from the root directory:
push: true push: true
remote-execution: remote-execution:
execution-service:
url: http://localhost:50051
storage-service:
url: http://localhost:50051
client-key: ''
client-cert: ''
server-cert: ''
action-cache-service:
url: http://localhost:50051 url: http://localhost:50051
This activates BuildGrid's remote execution mode and points to the unnamed This activates BuildGrid's remote execution mode and points to the unnamed
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment