summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdam Coldrick <adam.coldrick@codethink.co.uk>2020-05-07 17:59:06 +0100
committerbst-marge-bot <marge-bot@buildstream.build>2020-07-17 14:31:35 +0000
commit38437cd9beedc6cbf2e6ef0fec4043d76898e2e4 (patch)
tree920c2f2de267a2316b16880d61a15fca609c517c
parent8536dea74cd067c355074c4878ec473caadd65a7 (diff)
downloadbuildstream-sotk/update-artifact-server-docs.tar.gz
Remove the suggestion that BuildGrid can be used as an artifact serversotk/update-artifact-server-docs
BuildGrid's CAS can be used as artifact storage, but BuildGrid no longer supports being used as an Artifact Cache, since it doesn't implement the new proto-based approach to artifacts. This commit makes this current situation clear in the docs, rather than incorrectly suggesting the use of BuildGrid for the `index` and `both` cache types.
-rw-r--r--doc/source/format_project.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst
index 93b7f7812..ffec5e176 100644
--- a/doc/source/format_project.rst
+++ b/doc/source/format_project.rst
@@ -242,12 +242,12 @@ format for that is as such:
server-cert: server.crt
# "storage" remotes store the artifact contents only - this can
# be a normal CAS implementation such as those provided by
- # Buildbarn or Bazel Buildfarm
+ # Buildbarn, BuildGrid, or Bazel Buildfarm
type: storage
- url: https://index.foo.com:11001
server-cert: server.crt
# "index" remotes store only artifact metadata. This is
- # currently only provided by the bst-artifact-server and BuildGrid
+ # currently only provided by the bst-artifact-server
type: index
# A remote cache from which to upload/download built/prebuilt artifacts
- url: https://foo.com:11002
@@ -256,7 +256,7 @@ format for that is as such:
client-cert: client.crt
client-key: client.key
# Caches that support both can omit the type, or set it to "both" -
- # currently, also only supported by bst-artifact-server and BuildGrid
+ # currently, also only supported by bst-artifact-server
type: both