[Notes] [Git][BuildGrid/buildgrid][mablanch/000-update-buildstream-doc] docs: Update BuildStream usage example

[Martin Blanchard <gitlab mg gitlab com>]

Title: GitLab

Martin Blanchard pushed to branch mablanch/000-update-buildstream-doc at BuildGrid / buildgrid

Commits:

• 535e62a0
  by Martin Blanchard at 2018-11-30T11:10:42Z

  docs: Update BuildStream usage example
  
  BuildStream remote execution configuration section recently changed. Out
  documentation usage example needs and update to match the new format.
  
  https://gitlab.com/BuildStream/buildstream/merge_requests/946
  https://gitlab.com/BuildStream/buildstream/merge_requests/952
  

1 changed file:

• docs/source/using_buildstream.rst

Changes:

docs/source/using_buildstream.rst

---

...	...	@@ -4,9 +4,11 @@
4	4	BuildStream client
5	5	==================
6	6
7		-`BuildStream`_ is a free software tool for building and integrating software
	7	+`BuildStream`_ is a free software tool for building and integrating software
8	8	stacks. It supports remote build execution using the remote execution API
9		-(REAPI) v2.
	9	+(REAPI) v2. The project's documentation has a detailed section about its
	10	+`remote execution subsystem architecture`_ that you are very recommanded to
	11	+read first.
10	12
11	13	.. note::
12	14
...	...	@@ -15,6 +17,7 @@ stacks. It supports remote build execution using the remote execution API
15	17	remote execution.
16	18
17	19	.. _BuildStream: https://buildstream.build
	20	+.. _remote execution subsystem architecture: https://buildstream.gitlab.io/buildstream/arch_remote_execution.html
18	21	.. _install it from sources: https://buildstream.build/source_install.html
19	22
20	23
...	...	@@ -43,7 +46,7 @@ Project configuration
43	46	In order to activate remote build execution at project-level, the project's
44	47	``project.conf`` file must declare two specific configuration nodes:
45	48
46		-- ``artifacts`` for `remote CAS endpoint details`_.
	49	+- ``artifacts`` for `remote cache endpoint details`_.
47	50	- ``remote-execution`` for `remote execution endpoint details`_.
48	51
49	52	.. important::
...	...	@@ -55,11 +58,11 @@ In order to activate remote build execution at project-level, the project's
55	58
56	59	.. important::
57	60
58		- If you are using BuildGrid's artifact server, the server instance **must**
59		- accept pushes from your client for remote execution to be possible.
	61	+ If you are using BuildStream's artifact server, the server instance pointed
	62	+ by the ``storage-service`` key **must** accept pushes from your client for
	63	+ remote execution to be possible.
60	64
61		-
62		-.. _remote CAS endpoint details: https://buildstream.gitlab.io/buildstream/install_artifacts.html#user-configuration
	65	+.. _remote cache endpoint details: https://buildstream.gitlab.io/buildstream/format_project.html#artifact-server
63	66	.. _remote execution endpoint details: https://buildstream.gitlab.io/buildstream/format_project.html#remote-execution
64	67
65	68
...	...	@@ -167,7 +170,13 @@ append at the end of the ``project.conf`` file from the root directory:
167	170	push: true
168	171
169	172	remote-execution:
170		- url: http://localhost:50051
	173	+ execution-service:
	174	+ url: http://localhost:50051
	175	+ storage-service:
	176	+ url: http://localhost:50051
	177	+ client-key: ''
	178	+ client-cert: ''
	179	+ server-cert: ''
171	180
172	181	This activates BuildGrid's remote execution mode and points to the unnamed
173	182	remote execution server instance at ``localhost:50051``.

—
View it on GitLab.
You're receiving this email because of your account on gitlab.com. If you'd like to receive fewer emails, you can adjust your notification settings.