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

docs: update object hierarchy image #2181

Merged
merged 12 commits into from
Sep 19, 2024
2 changes: 1 addition & 1 deletion content/docs/guides/project-sharing-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To share your project:

The Neon account associated with the email address is granted full access to the project with the exception privileges required to delete the project. This account can also share the project with other Neon users. When the user logs in to Neon, the shared project is listed on their **Projects** page, under **Shared with me**.

![Project shared with me](/docs/guides/shared_with_me.png)
![Project shared with you](/docs/guides/shared_with_you.png)

An email is also sent to the email address informing the user that a project has been shared with them. The email includes an **Open project** link the user can click on to log in to Neon. After logging in, the user is directed to the **Dashboard** for the shared project in the Neon Console.

Expand Down
6 changes: 1 addition & 5 deletions content/docs/introduction/manage-billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,4 @@ If you are on any of Neon's paid plans, you need to downgrade to the Free plan t

## Delete your account

To delete your Neon account, please initiate an account deletion request through the Neon support team. If you're a Launch, Scale, or Business plan subscriber, you can generate a support ticket directly from the Neon Console. Navigate to the **Support** link located in the Neon Console sidebar to open the **Create support ticket** modal. Here, you can formally request the deletion of your account. For direct access to this modal, [click here](https://console.neon.tech/app/projects?modal=support). If you are a Free Plan user and do not have access to the **Create support ticket** modal in the Neon Console, please direct your request to `[email protected]`.

<Admonition type="important">
Before Neon can proceed with deleting your account, it is necessary to ensure all active projects have been deleted. To learn how to delete your projects, please refer to [Delete a project](/docs/manage/projects#delete-a-project) for instructions.
</Admonition>
If you would like to delete your Neon account entirely, please refer to the steps described here: [Deleting your account](/docs/manage/accounts#deleting-your-account).
4 changes: 2 additions & 2 deletions content/docs/manage/organizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Each organization is made up of three types of users:

- **Admin** &#8212; Administrators have access to all projects in the organization. Additionally, admins manage all permissions, invitations, and billing details.
- **Members** &#8212; Members have access to all the projects that belong to the organization. They need to be invited to the organization by an Admin.
- **Guests** &#8212; Guests are people given limited access to particular projects, using [project sharing](/docs/guides/project-sharing-guide). They do not have access to the Organization dashboard. Projects will appear under the **Shared with me** grouping in their personal account.
- **Guests** &#8212; Guests are people given limited access to particular projects, using [project sharing](/docs/guides/project-sharing-guide). They do not have access to the Organization dashboard. Projects will appear under the **Shared with you** grouping in their personal account.

Here's a breakdown of what actions each role can take:

Expand Down Expand Up @@ -55,7 +55,7 @@ After creating the organization, your next actions depend on your particular sce

### Scenario 1 &#8212; Moving an existing team to a new organization

If you’re currently on a paid plan, using project sharing to work with your team on your Personal account projects, and you intend to work intend to work primarily from your new Organization account:
If you’re currently on a paid plan, using project sharing to work with your team on your Personal account projects, and you intend to work primarily from your new Organization account:

- [Transfer your existing projects](/docs/manage/orgs-project-transfer#transfer-projects-in-bulk) from your personal account to the new organization. You can leave one project behind, since that's the Free Plan limit.
- Downgrade your personal account to the [Free Plan](/docs/introduction/manage-billing#change-your-plan) once all projects are transferred. This shifts all billing to the Organization.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/manage/orgs-manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Permissions within the organization are exclusively managed by Admins. As an Adm

## Invite Guests

All members can invite external Guests to collaborate on specific projects through [project sharing](/docs/guides/project-sharing-guide). Guests will not have access to the organization Dashboard but can access any projects shared with them from the **Projects** page of their personal account, under **Shared with Me**. Guests can invite additional Guests to the project and remove existing Guests from the project.
All members can invite external Guests to collaborate on specific projects through [project sharing](/docs/guides/project-sharing-guide). Guests will not have access to the organization Dashboard but can access any projects shared with them from the **Projects** page of their personal account, under **Shared with you**. Guests can invite additional Guests to the project and remove existing Guests from the project.

![organization guests](/docs/manage/org_guests.png)

Expand Down
18 changes: 11 additions & 7 deletions content/docs/manage/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Managing your Neon project requires an understanding of the Neon object hierarch

![Neon object hierarchy](/docs/manage/neon_object_hierarchy.jpg)

## Neon account
## Neon account or organization

This is the account you used to sign up with Neon. Neon supports signing up with an email, GitHub, Google, or partner account.
This is the Neon account or Neon organization you signed up with. Neon supports signing up with an email, GitHub, Google, or partner account.

## API keys
### API keys

API keys are global and belong to the Neon account. API keys are used with the [Neon API](https://api-docs.neon.tech/reference/getting-started-with-neon-api) to create and manage Neon projects or objects within a Neon project. While there is no strict limit on the number of API keys you can create, we recommend keeping it under 10,000 per Neon account. For more about API keys, see [Manage API keys](/docs/manage/api-keys).

Expand All @@ -25,14 +25,18 @@ A project is the top-level object in the Neon object hierarchy. It is a containe

Data resides in a branch. Each Neon project is created with a default branch called `main`. This initial branch is also your project's root branch, which cannot be deleted. After creating more branches, you can designate a different branch as your default branch, but your root branch cannot be deleted. You can create child branches from any branch in your project. Each branch can contain multiple databases and roles. Plan limits define the number of branches you can create in a project and the amount of data per branch. To learn more, see [Manage branches](/docs/manage/branches).

## Computes
## R/W and Read Replica computes

A compute is a virtualized computing resource that includes vCPU and memory for running applications. In the context of Neon, a compute runs Postgres. When you create a project in Neon, a primary read-write compute is created for a project's default branch. Neon supports both read-write and [read replica](/docs/introduction/read-replicas) computes. A branch can have a single primary read-write compute but supports multiple read replicas. To connect to a database that resides on a branch, you must connect via a compute associated with the branch. Your Neon plan defines the resources (vCPU and RAM) available to a compute. For more information, see [Manage computes](/docs/manage/endpoints). Compute size, autoscaling, and autosuspend (scale-to-zero) are all settings that are configured for a compute.
A compute is a virtualized computing resource that includes vCPU and memory for running applications. In the context of Neon, a compute runs Postgres. When you create a project in Neon, a primary R/W (read/write) compute is created for a project's default branch. Neon supports both R/W and [Read Replica](/docs/introduction/read-replicas) computes. A branch can have a single primary R/W compute but supports multiple Read Replica computes. To connect to a database that resides on a branch, you must connect via a R/W or Read Replica compute associated with the branch. Your Neon plan defines the resources (vCPU and RAM) available to your R/W and Read Replica computes. For more information, see [Manage computes](/docs/manage/endpoints). Compute size, autoscaling, and autosuspend (scale-to-zero) are all settings that are configured for R/W and Read Replica computes.

## Roles

In Neon, roles are Postgres roles. A role is required to create and access a database. A role belongs to a branch. While there is no strict limit on the number of roles you can create, we recommend keeping it under 500 per branch. The default branch of a Neon project is created with a role named for your database. For example, if your database is named `neondb`, the project is created with a role named `neondb_owner`. This role is the owner of the database. Any role created via the Neon Console, CLI, or API is created with [neon_superuser](/docs/manage/roles#the-neonsuperuser-role) privileges. For more information, see [Manage roles](/docs/manage/roles).
In Neon, roles are Postgres roles. A role is required to create and access a database. A role belongs to a branch. There is a limit of 500 roles per branch. The default branch of a Neon project is created with a role named for your database. For example, if your database is named `neondb`, the project is created with a role named `neondb_owner`. This role is the owner of the database. Any role created via the Neon Console, CLI, or API is created with [neon_superuser](/docs/manage/roles#the-neonsuperuser-role) privileges. For more information, see [Manage roles](/docs/manage/roles).

## Databases

As with any standalone instance of Postgres, a database is a container for SQL objects such as schemas, tables, views, functions, and indexes. In Neon, a database belongs to a branch. If you do not specify your own database name when creating a project, the default branch of your project is created with a ready-to-use database named `neondb`. While there is no strict limit on the number of databases you can create, we recommend keeping it under 500 per branch. For more information, see [Manage databases](/docs/manage/databases).
As with any standalone instance of Postgres, a database is a container for SQL objects such as schemas, tables, views, functions, and indexes. In Neon, a database belongs to a branch. If you do not specify your own database name when creating a project, the default branch of your project is created with a ready-to-use database named `neondb`. There is a limit of 500 databases per branch. For more information, see [Manage databases](/docs/manage/databases).

## Schemas

All databases in Neon are created with a `public` schema, which is the default behavior for any standard PostgreSQL instance. SQL objects are created in the `public` schema, by default. For more information about the `public` schema, refer to [The Public schema](https://www.postgresql.org/docs/current/ddl-schemas.html#DDL-SCHEMAS-PUBLIC), in the _PostgreSQL documentation_.
4 changes: 4 additions & 0 deletions content/docs/sidebar.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,10 @@
slug: guides/logical-replication-schema-changes
- title: Logical replication tips
slug: guides/logical-replication-tips
- title: Organizations
slug: manage/organizations
- title: Project sharing
slug: guides/project-sharing-guide
- title: Read replicas
slug: introduction/read-replicas
items:
Expand Down
Binary file removed public/docs/guides/shared_with_me.png
Binary file not shown.
Binary file added public/docs/guides/shared_with_you.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 modified public/docs/guides/sharing_grant_access.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 modified public/docs/guides/sharing_people_with_access.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 modified public/docs/manage/neon_object_hierarchy.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.