[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:

• f978e30e
  by Martin Blanchard at 2018-11-30T10:55:52Z

  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

---

...	...	@@ -43,7 +43,7 @@ Project configuration
43	43	In order to activate remote build execution at project-level, the project's
44	44	``project.conf`` file must declare two specific configuration nodes:
45	45
46		-- ``artifacts`` for `remote CAS endpoint details`_.
	46	+- ``artifacts`` for `remote cache endpoint details`_.
47	47	- ``remote-execution`` for `remote execution endpoint details`_.
48	48
49	49	.. important::
...	...	@@ -55,11 +55,11 @@ In order to activate remote build execution at project-level, the project's
55	55
56	56	.. important::
57	57
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.
	58	+ If you are using BuildStream's artifact server, the server instance pointed
	59	+ by the ``storage-service`` key **must** accept pushes from your client for
	60	+ remote execution to be possible.
60	61
61		-
62		-.. _remote CAS endpoint details: https://buildstream.gitlab.io/buildstream/install_artifacts.html#user-configuration
	62	+.. _remote cache endpoint details: https://buildstream.gitlab.io/buildstream/format_project.html#artifact-server
63	63	.. _remote execution endpoint details: https://buildstream.gitlab.io/buildstream/format_project.html#remote-execution
64	64
65	65
...	...	@@ -167,7 +167,13 @@ append at the end of the ``project.conf`` file from the root directory:
167	167	push: true
168	168
169	169	remote-execution:
170		- url: http://localhost:50051
	170	+ execution-service:
	171	+ url: http://localhost:50051
	172	+ storage-service:
	173	+ url: http://localhost:50051
	174	+ client-key: ''
	175	+ client-cert: ''
	176	+ server-cert: ''
171	177
172	178	This activates BuildGrid's remote execution mode and points to the unnamed
173	179	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.