Skip to content

chore: update spanner instructions #542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tstirrat15 wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −8
Open

chore: update spanner instructions #542

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions app/spicedb/concepts/datastores/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,10 @@ Place the generated key contents (which must support an HMAC key) in `some.key`.

[spanner-docs]: https://cloud.google.com/spanner

#### Authentication

To enable SpiceDB to communicate with your spanner instance, you should set up [Application Default Credentials](https://docs.cloud.google.com/docs/authentication/client-libraries#adc) for your SpiceDB pods.

#### Required Parameters

| Parameter | Description | Example |
Expand All @@ -205,14 +209,14 @@ Place the generated key contents (which must support an HMAC key) in `some.key`.

#### Optional Parameters

| Parameter | Description | Example |
| ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| `datastore-spanner-credentials` | JSON service account token (omit to use [application default credentials](https://cloud.google.com/docs/authentication/production)) | `--datastore-spanner-credentials=./spanner.json` |
| `datastore-gc-interval` | Amount of time to wait between garbage collection passes | `--datastore-gc-interval=3m` |
| `datastore-gc-window` | Sets the window outside of which overwritten relationships are no longer accessible | `--datastore-gc-window=1s` |
| `datastore-revision-fuzzing-duration` | Sets a fuzzing window on all zookies/zedtokens | `--datastore-revision-fuzzing-duration=50ms` |
| `datastore-readonly` | Places the datastore into readonly mode | `--datastore-readonly=true` |
| `datastore-follower-read-delay-duration` | Amount of time to subtract from non-sync revision timestamps to ensure stale reads | `--datastore-follower-read-delay-duration=4.8s` |
| Parameter | Description | Example |
| ---------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------ |
| `datastore-spanner-credentials` | JSON service account token | `--datastore-spanner-credentials=./spanner.json` |
| `datastore-gc-interval` | Amount of time to wait between garbage collection passes | `--datastore-gc-interval=3m` |
| `datastore-gc-window` | Sets the window outside of which overwritten relationships are no longer accessible | `--datastore-gc-window=1s` |
| `datastore-revision-fuzzing-duration` | Sets a fuzzing window on all zookies/zedtokens | `--datastore-revision-fuzzing-duration=50ms` |
| `datastore-readonly` | Places the datastore into readonly mode | `--datastore-readonly=true` |
| `datastore-follower-read-delay-duration` | Amount of time to subtract from non-sync revision timestamps to ensure stale reads | `--datastore-follower-read-delay-duration=4.8s` |

## PostgreSQL

Expand Down
Loading