about summary refs log tree commit diff
path: root/tvix/docs/src/castore/blobstore-protocol.md
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2024-11-09T14·23+0000
committerflokli <flokli@flokli.de>2024-11-12T14·05+0000
commit0b8ec03797bc8ace0e1db979ae87a00be2c98733 (patch)
treeaadedc9de018369d4b5b10598571d09c74e039ff /tvix/docs/src/castore/blobstore-protocol.md
parent1428ea4e191aa897a0a23e2c90f997f0b65aae6d (diff)
docs(tvix): document Store configuration r/8914
This describes the current composition system used for BlobService /
DirectoryService / PathInfoService, why it's hidden, how to expose it,
and adds some common examples to explain it.

Change-Id: I2ce7da40992cc988947c3e924499f8157c5e4937
Reviewed-on: https://cl.tvl.fyi/c/depot/+/12749
Tested-by: BuildkiteCI
Reviewed-by: yuka <yuka@yuka.dev>
Diffstat (limited to 'tvix/docs/src/castore/blobstore-protocol.md')
-rw-r--r--tvix/docs/src/castore/blobstore-protocol.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/tvix/docs/src/castore/blobstore-protocol.md b/tvix/docs/src/castore/blobstore-protocol.md
index 0dff787ccb00..215a8316803d 100644
--- a/tvix/docs/src/castore/blobstore-protocol.md
+++ b/tvix/docs/src/castore/blobstore-protocol.md
@@ -57,6 +57,8 @@ The flexibility of this doesn't need to be exposed to the user in the default
 case; in most cases we should be fine with some form of on-disk storage and a
 bunch of substituters with different priorities.
 
+Check [Store Configuration](./store-configuration.md) for more details.
+
 ### gRPC Clients
 Clients are encouraged to always read blobs in a chunked fashion (asking for a
 list of chunks for a blob via `BlobService.Stat()`, then fetching chunks via