summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRaoul Hidalgo Charman <raoul.hidalgocharman@codethink.co.uk>2018-12-05 10:26:45 +0000
committerRaoul Hidalgo Charman <raoul.hidalgocharman@codethink.co.uk>2018-12-05 15:33:44 +0000
commit9d77351f0b05f6b37b4235742ac3a0ca2d6feb93 (patch)
treeeb5f8d46ac8cafe8b51744f151463bf01f23d18f
parent3641b6f6c24fc8d0965da5920a77413d36a32e17 (diff)
downloadbuildstream-9d77351f0b05f6b37b4235742ac3a0ca2d6feb93.tar.gz
format_project.rst: Add docs for action-cache-service
Part of #628
-rw-r--r--doc/source/format_project.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst
index 59ee05e85..a85bf6470 100644
--- a/doc/source/format_project.rst
+++ b/doc/source/format_project.rst
@@ -238,6 +238,8 @@ using the `remote-execution` option:
server-cert: server.crt
client-cert: client.crt
client-key: client.key
+ action-cache-service:
+ url: http://bar.action.com:50052
The execution-service part of remote execution does not support encrypted
connections yet, so the protocol must always be http.
@@ -245,6 +247,11 @@ 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 action-cache-service specifies where built actions are cached, allowing
+buildstream to check whether an action has already been executed and download it
+if so. This is similar to the artifact cache but REAPI specified, and is
+optional for remote execution to work.
+
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,