summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJürg Billeter <j@bitron.ch>2020-07-27 16:21:51 +0200
committerbst-marge-bot <marge-bot@buildstream.build>2020-08-13 09:24:43 +0000
commita637dc1d737d9d6ca24a1bb5938de37b7bcf440f (patch)
tree52f2a4fd879296e14129dca2e3aa42b64697eeb3
parent713e48cd62e2bc64822c5fa2b3d2439b04de96c8 (diff)
downloadbuildstream-a637dc1d737d9d6ca24a1bb5938de37b7bcf440f.tar.gz
doc: Update for Remote Asset API
-rw-r--r--doc/source/arch_caches.rst13
-rw-r--r--doc/source/arch_remote_execution.rst2
-rw-r--r--doc/source/using_configuring_cache_server.rst6
3 files changed, 10 insertions, 11 deletions
diff --git a/doc/source/arch_caches.rst b/doc/source/arch_caches.rst
index c415cfc47..448a0a389 100644
--- a/doc/source/arch_caches.rst
+++ b/doc/source/arch_caches.rst
@@ -34,10 +34,10 @@ files digests. The digests point to locations in the CAS of relavant files and
directories, allowing BuildStream to query remote CAS servers for this
information.
-:ref:`bst-artifact-server <artifact_command_reference>` uses grpc to implement a
-remote API for an artifact service, that BuildStream then uses to query,
-retrieve and update artifact files, before using this information to download
-the files and other data from the remote CAS.
+:ref:`bst-artifact-server <artifact_command_reference>` uses grpc to implement
+the Remote Asset API for an artifact service, that BuildStream then uses to
+query, retrieve and update artifact references, before using this information to
+download the files and other data from the remote CAS.
Source caches
-------------
@@ -53,9 +53,8 @@ artifacts, as they just need to map a source key to a directory digest, with no
additional metadata.
Similar to artifacts, :ref:`bst-artifact-server <artifact_command_reference>`
-uses grpc to implements a 'reference service' API that allows BuildStream to
-query for these source digests, which can then be used to retrieve sources from
-a CAS.
+uses grpc to implement the Remote Asset API that allows BuildStream to query for
+these source digests, which can then be used to retrieve sources from a CAS.
.. note::
diff --git a/doc/source/arch_remote_execution.rst b/doc/source/arch_remote_execution.rst
index efefc84b5..9c8e9d354 100644
--- a/doc/source/arch_remote_execution.rst
+++ b/doc/source/arch_remote_execution.rst
@@ -8,7 +8,7 @@ The previous section :ref:`sandboxing` describes the two forms of local sandbox:
Artifact caches and other storage
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-BuildStream can transmit the results of local builds to remote artifact caches and retrieve them later. The same mechanism is used for remote execution. The filesystem staged before building is stored in a local content-addressable store, which may be the same as the local artifact cache. The command to execute is also stored as an object in local CAS. Both the initial source filesystem and command are transmitted to remote storage specific to the remote execution service, and after the build is complete, the filesystem after build is retrieved from remote storage to the local CAS. The remote execution service uses the same communication protocol as artifact caches, and may use the same internal storage, but may not implement the extensions used by BuildStream to store full artifacts.
+BuildStream can transmit the results of local builds to remote artifact caches and retrieve them later. The same mechanism is used for remote execution. The filesystem staged before building is stored in a local content-addressable store, which may be the same as the local artifact cache. The command to execute is also stored as an object in local CAS. Both the initial source filesystem and command are transmitted to remote storage specific to the remote execution service, and after the build is complete, the filesystem after build is retrieved from remote storage to the local CAS. The remote execution service uses the same communication protocol as artifact caches, and may use the same internal storage, but may not implement the Remote Asset API used by BuildStream to store full artifacts.
.. image:: images/arch-remote-execution.svg
:align: center
diff --git a/doc/source/using_configuring_cache_server.rst b/doc/source/using_configuring_cache_server.rst
index d31a6661c..e5755a666 100644
--- a/doc/source/using_configuring_cache_server.rst
+++ b/doc/source/using_configuring_cache_server.rst
@@ -161,13 +161,13 @@ Instance with push and requiring client authentication:
.. note::
- BuildStream's artifact cache is an extension of `Google's Remote
- Execution CAS server
+ BuildStream's artifact cache uses `Bazel's Remote Execution CAS and Remote
+ Asset API
<https://github.com/bazelbuild/remote-apis/>`_.
Sometimes, when using Remote Execution, it is useful to run
BuildStream with just a basic CAS server, without using the
- artifact extensions, but BuildStream still needs to store these to
+ Remote Asset API, but BuildStream still needs to store these to
work correctly.
For this scenario, you can add the `--index-only` flag to the above