Skip to content

Commit

Permalink
refactor platform console concepts
Browse files Browse the repository at this point in the history
  • Loading branch information
nikolasburk committed May 3, 2024
1 parent e601f2e commit 89b3d0d
Show file tree
Hide file tree
Showing 9 changed files with 116 additions and 107 deletions.
107 changes: 100 additions & 7 deletions content/500-platform/10-about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,108 @@ Platform Console enables you to integrate the latest Prisma Data Platform (PDP)

Open the [Platform Console](https://console.prisma.io).

## Workflows
## Concepts

The Platform Console workflows are based on three main concets:
The Platform Console workflows are based on four main concepts:

- **Account**: In order to use PDP products, you need to have a PDP account. An _organization_ will typically create one account to manage all their workspaces, projects and environments.
- [**Workspaces**](/platform/about/workspace): An account can have multiple workspaces. A workspace typically represents a _team_ within an _organization_. Billing happens on a per-workspace basis, i.e. an _organization_ receives an invoice at the end of the month that captures all cost associated with the projects in a given workspace.
- [**Project**](/platform/about/project): A workspace can have multiple projects. A project typically represents the _application_ of a _product_ or _service_ a team is working on.
- [**Environments**](/platform/about/environment): A project can have multiple environments. An environment typically maps to a _development stage_, like `dev`, `staging` or `prod`.
- [**Account**](#account): In order to use PDP products, you need to have a PDP account. An _organization_ will typically create one account to manage all their workspaces, projects and environments.
- [**Workspaces**](#workspace): An account can have multiple workspaces. A workspace typically represents a _team_ within an _organization_. **Billing happens on a per-workspace basis**, i.e. an _organization_ receives an invoice at the end of the month that captures all cost associated with the projects in a given workspace.
- [**Project**](#project): A workspace can have multiple projects. A project typically represents the _application_ of a _product_ or _service_ a team is working on.
- [**Environments**](#environment): A project can have multiple environments. An environment typically maps to a _development stage_, like `dev`, `staging` or `prod`. **API keys are provisioned on the environment-level**.

Here is a visual illustration of how these concepts relate to each other:

![](/img/platform/pdp-concepts.png)
![](/img/platform/pdp-concepts.png)

### Account

Your account is the basis for all interactions with PDP products. You can use it to manage your workspaces (and their projects).

If you need to delete your account, go [here](/platform/support#deleting-your-pdp-account).

### Workspace

In your PDP account, you can create several workspaces. A workspace is an isolated space to host projects in which you use PDP products.

In each workspace, you can:

- view and manage all projects (and their environments) in that workspace.
- manage billing, i.e. select a [pricing plan](https://pris.ly/pricing?utm_source=prisma-docs&utm_medium=docs-site), configure payment methods, or view the invoice history.
- view the usage of your enabled PDP products across all projects in that workspace.
- manage team members and change their roles / permissions in the workspace.

### Project

In each workspace, you can create several projects. A project typically represents an application (a product or service) your organization is offering. You typically have one [Prisma schema](/orm/prisma-schema/) per project.

In each project, you can:

- view and manage all environments in that project.

### Environment

An environment is an isolated space to provision PDP products for a given project. Environments typically map to development stages, like `dev`, `staging` or `prod`.

In each environment, you can:

- enable, disable and manage PDP products (Pulse, Accelerate, ...).
- for **Accelerate**:
- set your database connection string.
- generate API keys.
- change the connection pool size.
- enable static IPs.
- for **Pulse**:
- set your database connection string (of a [Pulse-compatible database](/pulse/database-setup)).
- configure the _region_ where Pulse is running.
- configure database replication.
- generate API keys.

The number of environments you can create depends on the [pricing plan](https://pris.ly/pricing?utm_source=prisma-docs&utm_medium=docs-site) configured in your workspace:

| | **Starter** | **Pro** | **Business** | **Enterprise** |
| ---------------- | ----------- | ----------- | ------------ | -------------- |
| **Projects** | 5 | 10 | 15 | Custom |
| **Environments** | 2 / project | 6 / project | 12 / project | Custom |

## Billing

### Per-workspace billing

Billing in PDP is done on a per-workspace basis:

- A [pricing plan](https://pris.ly/pricing?utm_source=prisma-docs&utm_medium=docs-site) is selected per workspace. That means, your PDP account can have multiple workspaces where each workspace uses a different pricing plan.
- A payment method is select per workspace. That means, your PDP account can have multiple workspaces where each workspace has a different payment method.

At the end of the billing period, **your selected payment method will be charged with the usage costs of the PDP products across _all_ the projects (and their environments) in that workspace**.

You can configure all billing details in the **Billing** section of your project.

### Prorated billing

All our paid plans are prorated, which means **you're only billed for the duration you use a specific plan**.

For example:

- if you subscribe to our **Pro** plan for only 15 days in a 30-day month, you'll only be charged for half of the plan's price.
- if you want to try out a particular plan for only 2 days, you can do so and you'll only be charged for the respective fraction of the plan's price (2 days out of the entire month).
- if you downgrade your pricing plan (e.g. from **Business** to **Pro**) after 10 days of a 30-day month, you'll be charged 1/3 (i.e. 10 days) for the **Business** plan and 2/3 (i.e. 20 days) for the **Pro** plan.

Visit our [pricing page](https://pris.ly/pricing?utm_source=prisma-docs&utm_medium=docs-site) for more details.

### Downgrading a pricing plan

If you downgrade a pricing plan, you may need to delete some of your projects and/or their environments in order to adhere to the [limits](#environment) of the newly selected plan.

For example, if your workspace is on a **Business** plan and current has 14 (out of 15) projects, you will need to delete at least 4 projects to adhere to the project limit of the **Pro** plan. Additionally, you need to make sure that the remaining projects don't have more than 6 environments per project to adhere to the environment limit of the **Pro** plan.

## Programmatic access via the Platform CLI

In addition to the GUI of the Platform Console, thge Prisma CLI provides another way to interact with your PDP account and manage PDP products in your projects.

This is if you need programmatic access to your account, e.g. for integrating it into CI workflows.

Read more about the Prisma CLI [here](/platform/platform-cli).

## API keys

An API key is required to authenticate requests from your Prisma Client to products such as Prisma Accelerate and Prisma Pulse. You may generate multiple API keys per environment and manage those via the **API Keys** section in a project.
16 changes: 0 additions & 16 deletions content/500-platform/20-concepts/10-workspaces.mdx

This file was deleted.

10 changes: 0 additions & 10 deletions content/500-platform/20-concepts/20-projects.mdx

This file was deleted.

40 changes: 0 additions & 40 deletions content/500-platform/20-concepts/30-environments.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions content/500-platform/20-concepts/_category_.json

This file was deleted.

15 changes: 0 additions & 15 deletions content/500-platform/20-concepts/index.mdx

This file was deleted.

4 changes: 1 addition & 3 deletions content/500-platform/30-maturity-levels.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,11 @@ metaDescription: 'Understand the maturity levels for features in Prisma Data Pla
displayed_sidebar: platformSidebar
---

<TopBlock>

Prisma releases updates to Prisma Data Platform multiple times per week, as opposed to the Prisma ORM that we release on a set schedule every few weeks. This is why we consider the lifecycle and process for maturing features in Prisma Data Platform differently.

You can [check out the releases and maturity process for the Prisma ORM](/orm/more/releases) for further details.

</TopBlock>
You can find information about releases across _all_ Prisma tools and products in the [changelog](https://www.prisma.io/changelog).

### Early Access

Expand Down
3 changes: 0 additions & 3 deletions content/500-platform/40-limits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,5 @@ hide_table_of_contents: true
displayed_sidebar: platformSidebar
---

<TopBlock>

More details on limits will be available soon.

</TopBlock>
24 changes: 15 additions & 9 deletions content/500-platform/50-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,32 @@ toc: true
displayed_sidebar: platformSidebar
---

<TopBlock>

Your feedback is invaluable, and we encourage you to share your experiences with us on [Discord](https://pris.ly/discord).

</TopBlock>

### Community Support
## Support

### Community support

Reach out to us in our [Discord](https://pris.ly/discord).

### Standard Support
### Standard support

- Email support, [email protected]
- Email support, <a href="mailto:[email protected]">[email protected]</a>
- Mon-Fri, 9am-5pm CET

### Premium Support
### Premium support

- Email support, [email protected]
- Email support, <a href="mailto:[email protected]">[email protected]</a>
- 24/7

### Dedicated Support
### Dedicated support

Dedicated contact person.

## Deleting your PDP account


If you want to delete your PDP account, **email us at <a href="mailto:[email protected]">[email protected]</a>**.

To ensure that you're not accidentally disabling any infrastructure powering onbe of your applications, we require that you **disable Accelerate and Pulse in _all_ environments of _all_ your projects** that live in the account to be deleted,

0 comments on commit 89b3d0d

Please sign in to comment.