Skip to content

Commit

Permalink
feedback round 2
Browse files Browse the repository at this point in the history
  • Loading branch information
corkrean committed Nov 15, 2023
1 parent d56df08 commit 2d5d9d4
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 13 deletions.
24 changes: 13 additions & 11 deletions docs/spicedb-dedicated/dedicated-configuration.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,51 @@
# SpiceDB Dedicated Configuration

The guide provides information about the configuration options available to you when deploying a SpiceDB Dedicated Permission System.
This guide provides information about the configuration options available to you when deploying a SpiceDB Dedicated Permissions System.

## Configuration Options

### Permission System Type

<img src={require("/img/ps-type.png").default} alt="permission system type" />
<img src={require("/img/ps-type.png").default} alt="permissions 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.
Please select the choice (Production or Development) that is appropriate for the Permissions System you are deploying. This choice will not effect the performance or security of your Permissions System, but may impact your Permissions System in the future, so please choose appropriately.

### Datastore

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

Your SpiceDB Dedicated environment can be provisioned with multiple isolated datastores. If you have more than one, choose the datastore that is appropriate for the Permission System you are deploying.
Your SpiceDB Dedicated environment can be provisioned with multiple isolated [datastores](/spicedb/selecting-a-datastore.md). If you have more than one, choose the datastore that is appropriate for the Permissions System you are deploying.

### 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.
SpiceDB Dedicated has two update channels: `rapid` and `regular` . You can select the update channel either when you launch the Permissios 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.
After you’ve deployed your Permissions 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.

<img src={require("/img/update-box.png").default} alt="update box" />
<img src={require("/img/update_box_v2.png").default} alt="update box" />

### 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.
- `rolling update` is a zero downtime strategy for upgrading to a new version. This is recommended for prod permissions systems.
- `immediate` involves downtime, but is faster than `rolling update`.

### Define Cluster(s)

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

#### Single region deployment

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

#### Multi-region deployment

Expand All @@ -54,3 +54,5 @@ 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.

If you're ready to get started with SpiceDB Dedicated, [schedule a call](https://authzed.com/call).
4 changes: 2 additions & 2 deletions docs/spicedb-dedicated/dedicated-isolation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

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

Additionally, SpiceDB Dedicated 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.
Additionally, SpiceDB Dedicated allows you to deploy multiple isolated Permissions Systems into a single SpiceDB Dedicated environment. Each Permissions System 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.

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.
By default, API tokens are scoped to a particular Permissions System. [Fine Grained Access Management (FGAM)](/spicedb-dedicated/fgam.md) can take this further by restricting API tokens to specified APIs, object types, or object IDs.

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

Expand Down
Binary file added static/img/datastore-config-v2.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 removed static/img/datastore-config.png
Binary file not shown.
Binary file added static/img/define-clusters-v2.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 removed static/img/define-clusters.png
Binary file not shown.
Binary file removed static/img/update-box.png
Binary file not shown.
Binary file added static/img/update_box_v2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2d5d9d4

Please sign in to comment.