summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJim MacArthur <jim.macarthur@codethink.co.uk>2018-11-09 17:06:33 +0000
committerJim MacArthur <jim.macarthur@codethink.co.uk>2018-11-27 15:33:36 +0000
commitd7cdb03ef792feae5bbe1ae34594de69122cc941 (patch)
tree2d65f7686512049b7f195ec6b6f49cc8db5296d6 /doc
parent926c1446f57ed1a8b94d1497eb40336204f34173 (diff)
downloadbuildstream-d7cdb03ef792feae5bbe1ae34594de69122cc941.tar.gz
Documentation: Update to show new config options
Diffstat (limited to 'doc')
-rw-r--r--doc/source/format_project.rst20
1 files changed, 17 insertions, 3 deletions
diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst
index 8701facb0..e64f19988 100644
--- a/doc/source/format_project.rst
+++ b/doc/source/format_project.rst
@@ -231,10 +231,24 @@ using the `remote-execution` option:
remote-execution:
# A url defining a remote execution server
- url: http://buildserver.example.com:50051
+ execution-service:
+ url: http://buildserver.example.com:50051
+ storage-service:
+ - url: https://foo.com:11002/
+ server-cert: server.crt
+ client-cert: client.crt
+ client-key: client.key
+
+The execution-service part of remote execution does not support encrypted
+connections yet, so the protocol must always be http.
+
+storage-service specifies a remote CAS store and the parameters are the
+same as those used to specify an :ref:`artifact server <artifacts>`.
-The url should contain a hostname and port separated by ':'. Only plain HTTP is
-currently suported (no HTTPS).
+The storage service may be the same endpoint used for artifact
+caching. Remote execution cannot work without push access to the
+storage endpoint, so you must specify a client certificate and key,
+and a server certificate.
The Remote Execution API can be found via https://github.com/bazelbuild/remote-apis.