about summary refs log tree commit diff
path: root/tvix/store/README.md
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2023-09-21T19·32+0300
committerclbot <clbot@tvl.fyi>2023-09-22T12·51+0000
commit32f41458c0a0f62bf906021ef096c465ccc45581 (patch)
tree3aaab8c453871f39c46fb43f8278aa933b24519d /tvix/store/README.md
parentd8ef0cfb4a859af7e33828b013356412d02532da (diff)
refactor(tvix): move castore into tvix-castore crate r/6629
This splits the pure content-addressed layers from tvix-store into a
`castore` crate, and only leaves PathInfo related things, as well as the
CLI entrypoint in the tvix-store crate.

Notable changes:
 - `fixtures` and `utils` had to be moved out of the `test` cfg, so they
   can be imported from tvix-store.
 - Some ad-hoc fixtures in the test were moved to proper fixtures in the
   same step.
 - The protos are now created by a (more static) recipe in the protos/
   directory.

The (now two) golang targets are commented out, as it's not possible to
update them properly in the same CL. This will be done by a followup CL
once this is merged (and whitby deployed)

Bug: https://b.tvl.fyi/issues/301

Change-Id: I8d675d4bf1fb697eb7d479747c1b1e3635718107
Reviewed-on: https://cl.tvl.fyi/c/depot/+/9370
Reviewed-by: tazjin <tazjin@tvl.su>
Reviewed-by: flokli <flokli@flokli.de>
Autosubmit: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Reviewed-by: Connor Brewster <cbrewster@hey.com>
Diffstat (limited to 'tvix/store/README.md')
-rw-r--r--tvix/store/README.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/tvix/store/README.md b/tvix/store/README.md
index ca64cd249c1e..8fa4cf5a67c5 100644
--- a/tvix/store/README.md
+++ b/tvix/store/README.md
@@ -14,9 +14,12 @@ However, enough information is preserved to still be able to render NAR and
 NARInfo when needed.
 
 ## More Information
-Check the `protos/` subfolder for the definition of the exact RPC methods and
-messages.
+The store consists out of two different gRPC services, `tvix.castore.v1` for
+the low-level content-addressed bits, and `tvix.store.v1` for the Nix and
+`StorePath`-specific bits.
 
+Check the `protos/` subfolder both here and in `castore` for the definition of
+the exact RPC methods and messages.
 
 ## Interacting with the GRPC service manually
 The shell environment in `//tvix` provides `evans`, which is an interactive
@@ -37,15 +40,16 @@ $ evans --host localhost --port 8000 -r repl
  more expressive universal gRPC client
 
 
-tvix.store.v1@localhost:8000> service BlobService
+localhost:8000> package tvix.castore.v1
+tvix.castore.v1@localhost:8000> service BlobService
 
-tvix.store.v1.BlobService@localhost:8000> call Put --bytes-from-file
+tvix.castore.v1.BlobService@localhost:8000> call Put --bytes-from-file
 data (TYPE_BYTES) => /run/current-system/system
 {
   "digest": "KOM3/IHEx7YfInAnlJpAElYezq0Sxn9fRz7xuClwNfA="
 }
 
-tvix.store.v1.BlobService@localhost:8000> call Get --bytes-as-base64
+tvix.castore.v1.BlobService@localhost:8000> call Get --bytes-as-base64
 digest (TYPE_BYTES) => KOM3/IHEx7YfInAnlJpAElYezq0Sxn9fRz7xuClwNfA=
 {
   "data": "eDg2XzY0LWxpbnV4"