Skip to content
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

Update serverless references #315

Merged
merged 2 commits into from
Feb 24, 2025
Merged

Update serverless references #315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1faf20f
Update serverless references
samkim Feb 22, 2025
8d9313b
Fix broken links
samkim Feb 24, 2025
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
3 changes: 1 addition & 2 deletions pages/authzed/concepts/management-dashboard.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@
The Management Dashboard is a web-based application for organizations to manage SpiceDB deployments.
The dashboard is primarily targeting platform operators that want to configure and monitor the service.

The Management Dashboard is exclusive to AuthZed [Dedicated], [Cloud], and [Serverless].
The Management Dashboard is exclusive to AuthZed [Dedicated] and [Cloud].
In order to support a wider variety of environments, [Enterprise] customers configure [Extenders] directly instead of the Management Dashboard.

[Dedicated]: ../guides/picking-a-product#dedicated
[Cloud]: ../guides/picking-a-product#cloud
[Serverless]: ../guides/picking-a-product#serverless
[Enterprise]: ../guides/picking-a-product#enterprise
[Extenders]: ./extenders
2 changes: 1 addition & 1 deletion pages/authzed/concepts/restricted-api-access.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Here's what an example Restricted API Access Token looks like.
sdbst_h256_thisisnotaverysecuresecret
```

This is what you should forward in your API calls to your SpiceDB Dedicated cluster.
This is what you should forward in your API calls to your AuthZed Dedicated cluster.

If you are using [static configuration] in your own SpiceDB Enterprise deployment, you'd need to
generate a token hash to be included in your configuration YAML.
Expand Down
2 changes: 1 addition & 1 deletion pages/authzed/concepts/security-embargo.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ In the absense of a strict deadline, vulnerabilities are made public once every

## What actions must users under embargo take?

Dedicated and Serverless Deployments running the latest release in any [Update Channel] are automatically upgraded to include embargoed security patches.
Dedicated Deployments running the latest release in any [Update Channel] are automatically upgraded to include embargoed security patches.

Deployments with versions pinned to an older release and self-hosted users under embargo are given notice, but are ultimately responsible for updating their own software.

Expand Down
58 changes: 12 additions & 46 deletions pages/authzed/guides/picking-a-product.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,18 @@ This document is designed to give a high-level overview so that you can effectiv

The following table maps functional requirements to their respective products:

| Requirements | [Open Source] | [Serverless] | [Cloud] | [Dedicated] | [Enterprise] |
| ---------------------- | :-----------: | :----------: | :-----: | :---------: | :----------: |
| [Management Dashboard] | ❌ | ✅ | ✅ | ✅ | ❌ |
| No-commit pricing | ✅ | ✅ | ✅ | ❌ | ❌ |
| [Private Networking] | DIY | ❌ | ❌ | ✅ | DIY |
| [Workload Isolation] | DIY | ❌ | ✅ | ✅ | DIY |
| Self-Hosted | ✅ | ❌ | ❌ | ❌ | ✅ |
| [Automated Updates] | DIY | ✅ | ✅ | ✅ | DIY |
| [SOC2 Compliance] | DIY | ❌ | ❌ | ✅ | DIY |
| [Audit Logging] | ❌ | ❌ | ✅ | ✅ | ✅ |
| [Multi-Region] | DIY | ❌ | ❌ | ✅ | DIY |
| [Security Embargo] | ❌ | ✅ | ✅ | ✅ | ✅ |
| Requirements | [Open Source] | [Cloud] | [Dedicated] | [Enterprise] |
| ---------------------- | :-----------: | :-----: | :---------: | :----------: |
| [Management Dashboard] | ❌ | ✅ | ✅ | ❌ |
| No-commit pricing | ✅ | ✅ | ❌ | ❌ |
| [Private Networking] | DIY | ❌ | ✅ | DIY |
| [Workload Isolation] | DIY | ✅ | ✅ | DIY |
| Self-Hosted | ✅ | ❌ | ❌ | ✅ |
| [Automated Updates] | DIY | ✅ | ✅ | DIY |
| [SOC2 Compliance] | DIY | ❌ | ✅ | DIY |
| [Audit Logging] | ❌ | ✅ | ✅ | ✅ |
| [Multi-Region] | DIY | ❌ | ✅ | DIY |
| [Security Embargo] | ❌ | ✅ | ✅ | ✅ |

[Cloud]: #cloud
[Dedicated]: #dedicated
Expand Down Expand Up @@ -95,44 +95,10 @@ Upcoming functionality includes:
- Deployments in more regions, including Europe
- Full SpiceDB API access: Watch API, HTTP API
- Enterprise features like Audit Logs, Restricted API Access
- Removal of Serverless limitations: no rate-limits or prefixes required

AuthZed Cloud is built on the same foundation that's serving critical production workloads in AuthZed Dedicated.
During Early Access, the self-service control-plane functionality is considered experimental, but SpiceDB continues to operate with its existing level of reliability and performance.

### Serverless

[Serverless] is the Authzed product for self-service, shared-hardware SpiceDB clusters for evaluation purposes.

- This is a fully managed service run by the experts at Authzed.
- Clusters are autonomously configured and scaled without any configuration necessary.
- Provision and manage permission systems and view real time metrics all from one place: our dashboard.

<Callout type="warning">
**Warning:**
Serverless is not an accurate representation of Dedicated/Cloud performance.

Serverless lacks [Workload Isolation] and hardware configurations customized for your usage patterns.

[Workload Isolation]: ../concepts/workload-isolation
</Callout>

Serverless charges on a monthly billing period based on API usage.

API usage is measured in two dimensions: operations (dispatches) and storage (relationships stored).

The first 1 million of each are free.

| Dimension | Price per Million |
|-----------------------|-------------------|
| Dispatched Operations | $1 |
| Relationships Stored | $1 |

To understand and calculate your workloads' dispatches, you can refer to the documentation on [debugging requests][debug].

[Serverless]: https://app.authzed.com/?utm_source=docs&utm_content=spicedb+serverless
[debug]: /spicedb/modeling/validation-testing-debugging

### Open Source

We understand that AuthZed's product suite will not satisfy all use cases and, for that reason, we've built and continue to invest in an open-source community around SpiceDB.
Expand Down
2 changes: 1 addition & 1 deletion pages/authzed/links/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"newWindow": true
},
"status": {
"title": "Serverless Status Page",
"title": "Service Status Page",
"href": "https://status.authzed.com?utm_source=docs",
"newWindow": true
}
Expand Down
6 changes: 2 additions & 4 deletions pages/spicedb/concepts/datastore-migrations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,11 @@ More information on the use case/motivation is available in [this issue](https:/

## Recommendations

### Managed services
### Managed Service

Rather than handling updates yourself, SpiceDB is offered as a [managed service].
Depending on the service, the update strategy varies:

- SpiceDB Serverless upgrades seamlessly to track the latest release (and sometimes newer)
- SpiceDB Dedicated users can select the desired version of SpiceDB
- AuthZed Dedicated users can select the desired version of SpiceDB

No matter which service you select, zero-downtime migrations are always performed.

Expand Down
6 changes: 0 additions & 6 deletions pages/spicedb/concepts/schema.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,6 @@ caveat somecaveat(someparameter int) {
definition someobjecttype {}
```

<Callout type="info">
Note that the examples are unprefixed. You'll need to add the prefix from your
permissions system if calling `WriteSchema` for a permissions system hosted in
Serverless.
</Callout>

### Object Type Definitions

An Object Type definition is used to represent a new type of object.
Expand Down
2 changes: 1 addition & 1 deletion pages/spicedb/getting-started/discovering-spicedb.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Even if you aren't interested in paid products, you can still schedule a call or

<Cards>
<Card arrow={true} icon={<FontAwesomeIcon icon={faDocker} />} title="Deploy the Operator on Kubernetes" href="/spicedb/ops/deploying-spicedb-operator" />
<Card arrow={true} icon={<FontAwesomeIcon icon={faAws} />} title="Deploy a SpiceDB cluster on Amazon EKS" href="/spicedb/ops/deploying-spicedb-on-eks" />
<Card arrow={true} icon={<FontAwesomeIcon icon={faAws} />} title="Install a SpiceDB cluster on Amazon EKS" href="/spicedb/getting-started/install/eks" />
<Card arrow={true} icon={<FontAwesomeIcon icon={faPhone} />} title="Schedule a call with AuthZed" href="https://authzed.com/call?utm_source=docs_discovering_spicedb" />
</Cards>

Expand Down
2 changes: 1 addition & 1 deletion pages/spicedb/getting-started/install/eks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ SpiceDB [dispatches] work across instances in the same deployment via [gRPC].
We'll be securing this pod-to-pod communication with its own internal-only certificate:

[gRPC]: https://grpc.io
[dispatches]: ../concepts/dispatch
[dispatches]: ../../concepts/dispatch

```sh
kubectl apply --server-side -f - <<EOF
Expand Down
6 changes: 3 additions & 3 deletions pages/spicedb/ops/load-testing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ SpiceDB metrics can help you:
2. give you information on request latency
3. help you fine tune your load test

The easiest way to consume and view metrics is via the SpiceDB Dedicated Management Console.
The easiest way to consume and view metrics is via the AuthZed Dedicated Management Console.
There the metrics are preconfigured for you.
If you’re self hosting SpiceDB (not recommended for a load test) you can export metrics via the SpiceDB Prometheus endpoint.

Expand All @@ -363,9 +363,9 @@ Here's a few examples of how we can help:
- Review your schema to make sure it’s fully optimized
- Review or help you create scripts to seed your relationship data
- Review or help you create scripts to generate CheckPermission and Lookup traffic
- Provide you a trial of SpiceDB Dedicated, our private SaaS offering
- Provide you a trial of AuthZed Dedicated, our private SaaS offering
- During the trial, we can help you make adjustments and optimizations
- If you decide to move forward with SpiceDB Dedicated after the trial, you can keep using your trial cluster that we fine-tuned and right sized with you during the trial
- If you decide to move forward with AuthZed Dedicated after the trial, you can keep using your trial cluster that we fine-tuned and right sized with you during the trial
- If you decide to self host SpiceDB Enterprise after the trial, we’ll provide you a write up of all of the optimizations we made during the trial and the amount of hardware we used so you can deploy a SpiceDB cluster that has been optimized for your workload into your environment

If you’d like to schedule some time for a consultation from the Authzed team, please do so [here][call].
Expand Down
1 change: 0 additions & 1 deletion pages/spicedb/ops/secure-rag-pipelines.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,3 @@ If you want to replace the OpenAI LLM with the DeepSeek (or any other) LLM, [che
It follows similar steps as the above guide, but uses the DeepSeek LLM via [OpenRouter](https://openrouter.ai/)

To run through this workshop on a cloud notebook, [here's a branch](https://github.com/authzed/workshops/tree/google-colab) that uses Google Colab.
Note that this guide requires an instance of SpiceDB running on [AuthZed Serverless](https://app.authzed.com/) for which you can create a free account.