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.

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

isolation doc and dedicated configuration guide #173

Merged
merged 12 commits into from
Nov 17, 2023
4 changes: 2 additions & 2 deletions docs/spicedb-dedicated/audit-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Audit Logging allows you to capture a log of all API calls made to SpiceDB, and

When enabled and properly configured, SpiceDB Enterprise will asynchronously log every API call made to it and emit a stream to your preferred log sink. The logs contain full details related to a request, including a hash of the API token, RPC, payload, request IP, response and any possible errors.

For assistance in configuring Audit Logging please [contact us](/contact-us) or reach out to your dedicated account team.
For assistance in configuring Audit Logging please [contact us](https://authzed.com/contact-us) or reach out to your dedicated account team.

## Supported Log Sink Types

Expand All @@ -20,4 +20,4 @@ Currently supported log sink types:
- Kinesis
- Firehose

If you'd like to see additional log sinks please [contact us](/contact-us).
If you'd like to see additional log sinks please [contact us](https://authzed.com/contact-us).
54 changes: 54 additions & 0 deletions docs/spicedb-dedicated/dedicated-configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# SpiceDB Dedicated Configuration

The guide provides information about the configuration options available to you when deploying a SpiceDB Dedicated Permission System.
corkrean marked this conversation as resolved.
Show resolved Hide resolved

## Configuration Options

### Permission System Type
corkrean marked this conversation as resolved.
Show resolved Hide resolved

<img src={require("/img/ps-type.png").default} alt="permission system type" />

Please select the choice (Production or Development) that is appropriate for the Permission System you are deploying. This choice will not effect the performance or security of your Permission System, but may have impact your Permission System in the future, so please choose appropriately.
corkrean marked this conversation as resolved.
Show resolved Hide resolved

### Datastore
corkrean marked this conversation as resolved.
Show resolved Hide resolved

<img src={require("/img/datastore-config.png").default} alt="datastore configuration" />

Your SpiceDB Dedicated environment can be provisioned with multiple isolated databases. If you have more than one, choose the database that is appropriate for the Permission System you are deploying.
corkrean marked this conversation as resolved.
Show resolved Hide resolved

### Update Channel

<img src={require("/img/channels-config.png").default} alt="channels config" />

SpiceDB Dedicated has two update channels: `rapid` and `regular` . You can select the update channel either when you launch the Permission System or in the settings page after you’ve launched it.

`rapid` - gets every release that is not a release candidate.

`regular` - trails behind `rapid` by at least one release.

After you’ve deployed your Permission System, you can choose to keep up to date with a channel automatically, or you can “pin” to a version by un-checking the automatic updates box. If you uncheck the automatic release box, you’ll still be able to update, but will have to pick the next version manually.
corkrean marked this conversation as resolved.
Show resolved Hide resolved

### Rollout Strategy

<img src={require("/img/rollout-strategy.png").default} alt="rollout strategy" />

There are two rollout strategies: `rolling update` and `immediate`.

- `rolling update` is a zero downtime strategy for upgrading to a new version. This is recommended for prod permission systems.
- `immediate` involves downtime, but is faster than `rolling update`.

### Define Cluster(s)

<img src={require("/img/define-clusters.png").default} alt="define clusters" />

#### Single region deployment

If you are deploying a single region Permission System, define a single cluster.

#### Multi-region deployment

Define a cluster for every region you want to deploy into.

#### Cluster Class

For production clusters, we recommend selecting the Cluster Class with the largest number of replicas and processing units. For non-production clusters, you can select whatever Cluster Class is appropriate for your workload. If you have questions about your overall utilization or would like to provision a custom Cluster Class, please reach out to your Authzed account team.
corkrean marked this conversation as resolved.
Show resolved Hide resolved
11 changes: 11 additions & 0 deletions docs/spicedb-dedicated/dedicated-isolation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# SpiceDB Dedicated Isolation

SpiceDB Dedicated isolates your workloads from other customers. Cloud accounts, compute resources, databases, and networking are all dedicated to you.

Additionally, SpiceDB allows you to deploy multiple isolated Permissions Systems into a single SpiceDB Dedicated environment. Each Permissions Systems has it’s own schema and set of relationships. Also, these Permissions Systems impose memory and CPU limits so one Permissions System can’t crowd out another Permissions System.
corkrean marked this conversation as resolved.
Show resolved Hide resolved

By default, API tokens are scoped to a particular Permissions System. [Fine Grained Access Management (FGAM)](/spicedb-dedicated/fgam.md) can take this farther by restricting API tokens to specified APIs, object types, or object IDs.
corkrean marked this conversation as resolved.
Show resolved Hide resolved

The below diagram gives an overview of the SpiceDB Dedicated isolation model.

<img src={require("/img/dedicated-isolation.png").default} alt="dedicated isolation model" />
corkrean marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion docs/spicedb-dedicated/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Please [schedule a call](https://authzed.com/call) to learn more.

## How is SpiceDB Dedicated deployed?

AuthZed provisions and manages an environment for you in a private account within our cloud provider organization. It comes with everything needed to run single and multi-region SpiceDB Permissions Systems in a cloud of your choice. We support AWS and GCP today, with Azure support coming. All resources are fully isolated and dedicated to you.
AuthZed provisions and manages an environment for you in a private account within our cloud provider organization. It comes with everything needed to run single and multi-region SpiceDB Permissions Systems in a cloud of your choice. We support AWS and GCP today, with Azure support coming. [All resources are fully isolated and dedicated to you.](/spicedb-dedicated/dedicated-isolation.md)

## Pricing

Expand Down
2 changes: 2 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ module.exports = {
'spicedb-dedicated/overview',
'spicedb-dedicated/fgam',
'spicedb-dedicated/audit-logging',
'spicedb-dedicated/dedicated-configuration',
'spicedb-dedicated/dedicated-isolation',
{
type: 'category',
label: 'Networking',
Expand Down
Binary file added static/img/channels-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/datastore-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/dedicated-isolation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/define-clusters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/ps-type.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/rollout-strategy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading