summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRaoul Hidalgo Charman <raoul.hidalgocharman@codethink.co.uk>2019-03-12 18:26:36 +0000
committerbst-marge-bot <marge-bot@buildstream.build>2019-03-25 11:46:44 +0000
commit5b96fa6bfc8fd6fc897a3aafe889221db268bbcf (patch)
tree980c913f5d082d30632bcb95d108d30e17b9f9a3
parentb1dff84cd79b385932ee538acf02aae0fe8fc95b (diff)
downloadbuildstream-5b96fa6bfc8fd6fc897a3aafe889221db268bbcf.tar.gz
using_config.rst: Add source cache documentation
Part of #440
-rw-r--r--doc/source/using_config.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/source/using_config.rst b/doc/source/using_config.rst
index 40b763e78..58ef160c1 100644
--- a/doc/source/using_config.rst
+++ b/doc/source/using_config.rst
@@ -100,6 +100,52 @@ pull only access and push/pull access. For information regarding this and the
server/client certificates and keys, please see:
:ref:`Key pair for the server <server_authentication>`.
+Source cache server
+~~~~~~~~~~~~~~~~~~~
+Similarly global and project specific source caches servers can be specified in
+the user configuration.
+
+1. Global source caches
+
+.. code:: yaml
+
+ #
+ # Source caches
+ #
+ source-caches:
+ # Add a cache to pull from
+ - url: https://cache.com/sources:11001
+ server-cert: server.crt
+ # Add a cache to push/pull to/from
+ - url: https://cache.com/sources:11002
+ server-cert: server.crt
+ client-cert: client.crt
+ client-key: client.key
+ push: true
+ # Add another cache to pull from
+ - url: https://anothercache.com/sources:8080
+ server-cert: another_server.crt
+
+2. Project specific source caches
+
+.. code:: yaml
+
+ projects:
+ project-name:
+ artifacts:
+ # Add a cache to pull from
+ - url: https://cache.com/sources:11001
+ server-cert: server.crt
+ # Add a cache to push/pull to/from
+ - url: https://cache.com/sources:11002
+ server-cert: server.crt
+ client-cert: client.crt
+ client-key: client.key
+ push: true
+ # Add another cache to pull from
+ - url: https://ourprojectcache.com/sources:8080
+ server-cert: project_server.crt
+
.. _user_config_remote_execution:
Remote execution