summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJim MacArthur <jim.macarthur@codethink.co.uk>2018-12-14 17:20:29 +0000
committerJim MacArthur <jim.macarthur@codethink.co.uk>2018-12-18 11:13:56 +0000
commit3dc209636b2ee09fb7e69a94af74f83ea6470524 (patch)
tree762c56da904f918f57c808d74d109cd317692987 /doc
parent89219f61ca11f6b5346832c27dcd8299907c965e (diff)
downloadbuildstream-3dc209636b2ee09fb7e69a94af74f83ea6470524.tar.gz
Documentation: Include instance-name in remote execution documentationraoul/627-RE-instance-config
Diffstat (limited to 'doc')
-rw-r--r--doc/source/format_project.rst11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst
index 4024cea19..bb66231cb 100644
--- a/doc/source/format_project.rst
+++ b/doc/source/format_project.rst
@@ -233,11 +233,13 @@ using the `remote-execution` option:
# A url defining a remote execution server
execution-service:
url: http://buildserver.example.com:50051
+ instance-name: development-emea-1
storage-service:
- - url: https://foo.com:11002/
+ url: https://foo.com:11002/
server-cert: server.crt
client-cert: client.crt
client-key: client.key
+ instance-name: development-emea-1
action-cache-service:
url: http://bar.action.com:50052
@@ -257,6 +259,13 @@ 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.
+Instance name is optional. Instance names separate different shards on
+the same endpoint (url). You can supply a different instance name for
+`execution-service` and `storage-service`, if needed. The instance
+name should be given to you by the service provider of each
+service. Not all remote execution and storage services support
+instance names.
+
The Remote Execution API can be found via https://github.com/bazelbuild/remote-apis.
.. _project_essentials_mirrors: