diff options
author | Raoul Hidalgo Charman <raoul.hidalgocharman@codethink.co.uk> | 2019-03-12 18:16:55 +0000 |
---|---|---|
committer | bst-marge-bot <marge-bot@buildstream.build> | 2019-03-25 11:46:44 +0000 |
commit | b1dff84cd79b385932ee538acf02aae0fe8fc95b (patch) | |
tree | 5d70bbf73ccdf18eeec6dc9cdbc3d2c996718868 /doc | |
parent | d68fe0b070951df61f406d5da4a0f0ceba65c218 (diff) | |
download | buildstream-b1dff84cd79b385932ee538acf02aae0fe8fc95b.tar.gz |
format_project.rst: Add source cache documentation
Part of #440
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/format_project.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst index a2216100f..f9d999a19 100644 --- a/doc/source/format_project.rst +++ b/doc/source/format_project.rst @@ -218,6 +218,33 @@ The use of ports are required to distinguish between pull only access and push/pull access. For information regarding the server/client certificates and keys, please see: :ref:`Key pair for the server <server_authentication>`. +.. _project_source_cache: + +Source cache server +~~~~~~~~~~~~~~~~~~~ +Exactly the same as artifact servers, source cache servers can be specified. + +.. code:: yaml + + # + # Source caches + # + source-caches: + # A remote cache from which to download prestaged sources + - url: https://foo.com:11001 + server.cert: server.crt + # A remote cache from which to upload/download prestaged sources + - url: https://foo.com:11002 + server-cert: server.crt + client-cert: client.crt + client-key: client.key + +.. note:: + + As artifact caches work in exactly the same way, a configured artifact server + can also be used as a source cache server. If you want to use a server as + both you can put it under both artifacts and source caches configs. + .. _project_remote_execution: Remote execution |