docs(spicedb): Add best practises #352
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅ |
tstirrat15
force-pushed
the
best-practises-spicedb
branch
from
32d47cf to
7579839
Compare
Signed-off-by: adinhodovic <hodovicadin@gmail.com>
Contributor
Author
|
I have read the CLA Document and I hereby sign the CLA |
authzedbot
added a commit
to authzed/cla
that referenced
this pull request
May 15, 2025
miparnisari
reviewed
May 16, 2025
Contributor
miparnisari
left a comment
miparnisari
left a comment
There was a problem hiding this comment.
Loved all these tips :)
| Some examples: | ||
|
|
||
| - A banlist - this could be expressed as a list in caveat context, but it can also be expressed as a relation with negation. | ||
| - A notion of public vs internal - boolean flags seem like an obvious caveat use case, but they can also be expressed using self relations. |
Contributor
There was a problem hiding this comment.
can we add a link for "self relations"?
Contributor
There was a problem hiding this comment.
We don't have that documentation yet 😓
Comment on lines
62
to
63
| This is because caveats come with a performance penalty. | ||
| A caveated relationship is both harder to cache and also slows down computation of the graph walk required to compute a permission. |
Contributor
There was a problem hiding this comment.
Move this to the top, before the examples. The fact that caveats affect performance should be front and center
|
|
||
| While designing your authorization, it’s important to plan ahead for how quickly an update is guaranteed, while trading off performance via cache effectiveness. | ||
| By default, SpiceDB sets the Quanitzation Interval to 5s; check operations are cached within this window. | ||
| To change this value, set `--datastore-revision-quantization-interval` longer or shorter. |
Contributor
There was a problem hiding this comment.
I feel that this sentence doesn't help me decide what value to use. A concrete example may help
Co-authored-by: Maria Ines Parnisari <maineparnisari@gmail.com>
Co-authored-by: Maria Ines Parnisari <maineparnisari@gmail.com>
Co-authored-by: Maria Ines Parnisari <maineparnisari@gmail.com>
tstirrat15
force-pushed
the
best-practises-spicedb
branch
from
5205e47 to
014c30b
Compare
miparnisari
reviewed
May 20, 2025
miparnisari
approved these changes
May 20, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.