summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Ennis <james.ennis@codethink.com>2018-11-06 16:14:10 +0000
committerJames Ennis <james.ennis@codethink.com>2018-11-06 16:34:43 +0000
commitcea8f49829db969c9cb943131f6c69da3ecdd8d4 (patch)
treebc645507ecd5b4d93470c812871889a6b1aa09e7
parentd010a55fc91ed8332b12e201d2f4d14c05c21230 (diff)
downloadbuildstream-cea8f49829db969c9cb943131f6c69da3ecdd8d4.tar.gz
format_project.rst: Update instructions regarding how we declare remote caches in project.conf
-rw-r--r--doc/source/format_project.rst25
1 files changed, 20 insertions, 5 deletions
diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst
index 469f99747..8701facb0 100644
--- a/doc/source/format_project.rst
+++ b/doc/source/format_project.rst
@@ -190,19 +190,34 @@ for more detail.
Artifact server
~~~~~~~~~~~~~~~
If you have setup an :ref:`artifact server <artifacts>` for your
-project then it is convenient to configure this in your ``project.conf``
+project then it is convenient to configure the following in your ``project.conf``
so that users need not have any additional configuration to communicate
with an artifact share.
.. code:: yaml
+ #
+ # Artifacts
+ #
artifacts:
+ # A remote cache from which to download prebuilt artifacts
+ - url: https://foo.com/artifacts:11001
+ server.cert: server.crt
+ # A remote cache from which to upload/download built/prebuilt artifacts
+ - url: https://foo.com/artifacts:11002
+ server-cert: server.crt
+ client-cert: client.crt
+ client-key: client.key
- # A url from which to download prebuilt artifacts
- url: https://foo.com/artifacts
+.. note::
+
+ You can also specify a list of different caches here; earlier entries in the
+ list will have higher priority than later ones.
+
+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>`.
-You can also specify a list of caches here; earlier entries in the list
-will have higher priority than later ones.
Remote execution
~~~~~~~~~~~~~~~~