Skip to content

Commit

Permalink
docs: upstream
Browse files Browse the repository at this point in the history 
planetscale/www@2ac65b9
  • Loading branch information
@planetscale-actions-bot
planetscale-actions-bot committed Sep 11, 2023
1 parent 06a87a9 commit 62100f0
Show file tree
Hide file tree
Showing 6 changed files with 64 additions and 60 deletions.
78 changes: 39 additions & 39 deletions docs/concepts/access-control.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,31 +42,31 @@ The following table describes permissions assigned at the organization level for

| Action | Description | Member | Administrator |
| -------------------------------------- | ------------------------------------------------------------------------------ | ------ | ------------- |
| View branches | View a database branch | ✔ | ✔ |
| Create branches | Create a database branch | ✔ | ✔ |
| Delete non-production branches | Delete a non-production database branch | ✔ | ✔ |
| View databases | View one or all databases | ✔ | ✔ |
| Create databases | Create a new database | ✔ | ✔ |
| Create deploy requests | Create a deploy request for a branch | ✔ | ✔ |
| Manage service tokens | Create, view, or delete service tokens | ✔ | ✔ |
| Manage service token grants | Create, view, update, or delete service token grants | ✔ | ✔ |
| View organization members | View one or all organization members | ✔ | ✔ |
| View database members | View one or all database members | ✔ | ✔ |
| View organization | View an organization | ✔ | ✔ |
| View query statistics | View query statistics for an organization's databases | ✔ | ✔ |
| Delete production branches | Delete a production database branch | | ✔ |
| Promote branches | Promote a branch to production | | ✔ |
| Manage databases | Delete, update settings, or import a database | | ✔ |
| Manage beta features | Opt-in or opt-out of a beta feature | | ✔ |
| Create production service token grants | Create a service token grant to connect or delete a production database branch | | ✔ |
| Update an integration | Update a third-party integration | | ✔ |
| Manage invitations | View, create, or cancel organization invitations | | ✔ |
| Manage invoices | View or download organization invoices | | ✔ |
| Manage billing | View or update billing plans and payment methods | | ✔ |
| View audit logs | View all audit logs | | ✔ |
| Manage organization members | Update member roles or delete organization members | | ✔ |
| Manage database members | Update member roles, add, or remove database members | | ✔ |
| Manage organization | Update organization settings, SSO, or delete organization | | ✔ |
| View branches | View a database branch | ✔ | ✔ |
| Create branches | Create a database branch | ✔ | ✔ |
| Delete non-production branches | Delete a non-production database branch | ✔ | ✔ |
| View databases | View one or all databases | ✔ | ✔ |
| Create databases | Create a new database | ✔ | ✔ |
| Create deploy requests | Create a deploy request for a branch | ✔ | ✔ |
| Manage service tokens | Create, view, or delete service tokens | ✔ | ✔ |
| Manage service token grants | Create, view, update, or delete service token grants | ✔ | ✔ |
| View organization members | View one or all organization members | ✔ | ✔ |
| View database members | View one or all database members | ✔ | ✔ |
| View organization | View an organization | ✔ | ✔ |
| View query statistics | View query statistics for an organization's databases | ✔ | ✔ |
| Delete production branches | Delete a production database branch | | ✔ |
| Promote branches | Promote a branch to production | | ✔ |
| Manage databases | Delete, update settings, or import a database | | ✔ |
| Manage beta features | Opt-in or opt-out of a beta feature | | ✔ |
| Create production service token grants | Create a service token grant to connect or delete a production database branch | | ✔ |
| Update an integration | Update a third-party integration | | ✔ |
| Manage invitations | View, create, or cancel organization invitations | | ✔ |
| Manage invoices | View or download organization invoices | | ✔ |
| Manage billing | View or update billing plans and payment methods | | ✔ |
| View audit logs | View all audit logs | | ✔ |
| Manage organization members | Update member roles or delete organization members | | ✔ |
| Manage database members | Update member roles, add, or remove database members | | ✔ |
| Manage organization | Update organization settings, SSO, or delete organization | | ✔ |

## Database-level permissions

Expand All @@ -76,20 +76,20 @@ For `Organization Administrators` and `Organization Members`, these permissions

| Action | Description | Member | Administrator |
| ------------------------------ | ------------------------------------------------------------- | ------ | ------------- |
| Create and view branches | Create or view a database branch | ✔ | ✔ |
| Delete non-production branches | Delete a non-production branch of a specific database | ✔ | ✔ |
| View database | View a database in an organization | ✔ | ✔ |
| Create deploy requests | Create a deploy request for a branch on a specific database | ✔ | ✔ |
| View database members | View one or all database members | ✔ | ✔ |
| View query statistics | View query statistics for an organization's databases | ✔ | ✔ |
| Restore non-production backups | Restore the backup of a development branch | ✔ | ✔ |
| Manage billing | Update the billing plan of a specific database | | ✔ |
| Delete production branches | Delete a production database branch of a specific database | | ✔ |
| Promote branches | Promote a branch of a specific database to production | | ✔ |
| Manage database | Delete, update settings, or import a database | | ✔ |
| Manage beta features | Opt-in or opt-out of a beta feature for a database | | ✔ |
| Manage database members | Update database member roles, add, or remove database members | | ✔ |
| Restore production backups | Restore the backup of a production branch | | ✔ |
| Create and view branches | Create or view a database branch | ✔ | ✔ |
| Delete non-production branches | Delete a non-production branch of a specific database | ✔ | ✔ |
| View database | View a database in an organization | ✔ | ✔ |
| Create deploy requests | Create a deploy request for a branch on a specific database | ✔ | ✔ |
| View database members | View one or all database members | ✔ | ✔ |
| View query statistics | View query statistics for an organization's databases | ✔ | ✔ |
| Restore non-production backups | Restore the backup of a development branch | ✔ | ✔ |
| Manage billing | Update the billing plan of a specific database | | ✔ |
| Delete production branches | Delete a production database branch of a specific database | | ✔ |
| Promote branches | Promote a branch of a specific database to production | | ✔ |
| Manage database | Delete, update settings, or import a database | | ✔ |
| Manage beta features | Opt-in or opt-out of a beta feature for a database | | ✔ |
| Manage database members | Update database member roles, add, or remove database members | | ✔ |
| Restore production backups | Restore the backup of a production branch | | ✔ |

An organization may have several databases, and an `Organization Member` may have different access to each database depending on whether or not they also have the `Database Administrator` role.

Expand Down
6 changes: 3 additions & 3 deletions docs/concepts/billing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The usage-based plans are summarized below:
| **Audit log retention** | 5 days | 15 days |
| **Automatic backups** | Daily | Every 12 hours |
| **Support** | Community | Standard |
| [**Data Branching®**](/docs/concepts/data-branching) | Not included | Not included |
| [**Data Branching®**](/docs/concepts/data-branching) | Not included | Not included |
| **Monthly cost** | $0 | $29 per database |
| [**PlanetScale Boost**](/docs/concepts/query-caching-with-planetscale-boost) | Not included | Available as an add-on |

Expand Down Expand Up @@ -207,7 +207,7 @@ All Scaler Pro plans, regardless of cluster size, share the following features:
| **Audit log retention** | 15 days |
| **Automatic backups** | Every 12 hours |
| **Support** | Standard, upgrade available\*\*\* |
| [**Data Branching®**](/docs/concepts/data-branching) | Included |
| [**Data Branching®**](/docs/concepts/data-branching) | Included |
| [**PlanetScale Boost**](/docs/concepts/query-caching-with-planetscale-boost) | Available as an add-on |

\* For the Scaler Pro plan, any storage over the included amount is billed at $1.50 per additional 1 GB.
Expand Down Expand Up @@ -244,7 +244,7 @@ The Enterprise plan is fully customizable to suit your businesses needs. For mor
| **Audit log retention** | Configurable |
| **Automated Backups** | Configurable |
| **Support** | Business, upgrade available\* |
| [**Data Branching®**](/docs/concepts/data-branching) | Included |
| [**Data Branching®**](/docs/concepts/data-branching) | Included |
| [**PlanetScale Boost**](/docs/concepts/query-caching-with-planetscale-boost) | Available as an add-on |
| **Monthly cost** | Custom |

Expand Down
1 change: 1 addition & 0 deletions docs/concepts/network-latency.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ This does not apply to PlanetScale Managed and single-tenant customers who have
PlanetScale's optimized hostname uses Route 53's [latency-based](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy-latency.html) routing to connect to the closest edge in PlanetScale's network. Using this hostname optimizes latency and improves reliability as it can route around regional network outages.

Examples of optimized hostnames:

- `aws.connect.psdb.cloud`
- `gcp.connect.psdb.cloud`

Expand Down
8 changes: 4 additions & 4 deletions docs/concepts/password-roles.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ The access level available to these roles is shown in the table below.

| Role name | Can create/edit schema | Can insert/update/delete rows | Can query rows |
| :--------- | :--------------------- | :---------------------------- | :------------- |
| Read-only | ❌ | ❌ | ✔ |
| Write-only | ❌ | ✔ | ❌ |
| Read/write | ❌ | ✔ | ✔ |
| Admin | ✔ | ✔ | ✔ |
| Read-only | ❌ | ❌ | ✔ |
| Write-only | ❌ | ✔ | ❌ |
| Read/write | ❌ | ✔ | ✔ |
| Admin | ✔ | ✔ | ✔ |

{% callout %}
The default role for all passwords created by the **Connect** button is `Administrator`. Passwords with custom roles
Expand Down
18 changes: 9 additions & 9 deletions docs/concepts/planetscale-plans.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Self-serve is comprised of three plans that you can sign up for from the PlanetS
| **Audit log retention** | 5 days | 15 days |
| **Automatic backups** | Daily | Every 12 hours |
| **Support** | Community | Standard |
| [**Data Branching®**](/docs/concepts/data-branching) | Not included | Not included |
| [**Data Branching®**](/docs/concepts/data-branching) | Not included | Not included |
| **Monthly cost** | $0 | $29 per database |
| [**PlanetScale Boost**](/docs/concepts/query-caching-with-planetscale-boost) | Not included | Available as an add-on |

Expand Down Expand Up @@ -76,7 +76,7 @@ On top of processing and memory, all **Scaler Pro** cluster sizes share the foll
| **Audit log retention** | 15 days |
| **Automatic backups** | Every 12 hours |
| **Support** | Standard, upgrade available\*\*\* |
| [**Data Branching®**](/docs/concepts/data-branching) | Included |
| [**Data Branching®**](/docs/concepts/data-branching) | Included |
| [**PlanetScale Boost**](/docs/concepts/query-caching-with-planetscale-boost) | Available as an add-on |

\* For the Scaler Pro plan, any storage over the included amount is billed at $1.50 per additional 1 GB.
Expand Down Expand Up @@ -137,13 +137,13 @@ PlanetScale's Enterprise Plan is great for users that want to scale farther, sha

| | **Multi-Tenant** | **Single-Tenant** | **Managed** |
| --------------------------- | ---------------- | ----------------- | ----------- |
| Resource-based pricing | ✔ | ✔ | ✔ |
| Horizontal sharding | ✔ | ✔ | ✔ |
| Unlimited connections | ✔ | ✔ | ✔ |
| Customizable feature limits | ✔ | ✔ | ✔ |
| BAAs available | ❌ | ✔ | ✔ |
| Dedicated AWS/GCP account | ❌ | ✔ | ✔ |
| Your own AWS/GCP account | ❌ | ❌ | ✔ |
| Resource-based pricing | ✔ | ✔ | ✔ |
| Horizontal sharding | ✔ | ✔ | ✔ |
| Unlimited connections | ✔ | ✔ | ✔ |
| Customizable feature limits | ✔ | ✔ | ✔ |
| BAAs available | ❌ | ✔ | ✔ |
| Dedicated AWS/GCP account | ❌ | ✔ | ✔ |
| Your own AWS/GCP account | ❌ | ❌ | ✔ |

## How do I know if I need an Enterprise plan?

Expand Down
Loading

0 comments on commit 62100f0

Please sign in to comment.