docs: vpc collaborators

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10846
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Rob Dominguez <24390149+robertjdominguez@users.noreply.github.com>
GitOrigin-RevId: 06a1212c0a923ad0d4bc88d9a6460ad4a4a123ad
This commit is contained in:
Krushan Bauva 2024-06-11 18:57:30 +05:30 committed by hasura-bot
parent 75ced29d11
commit 264ea9ff85
12 changed files with 110 additions and 7 deletions

View File

@ -42,8 +42,8 @@ more.
## Creating a VPC
Once the feature is enabled for your account, you'll see a new tab on the dashboard called **VPCs**. All existing VPCs
can be found under VPCs tab on cloud dashboard. You can also initiate a request to create a new VPC. To request a new VPC, click on the **Create New
VPC** button on top. This will open a form with the following fields:
can be found under VPCs tab on cloud dashboard. Only `VPC owner` can initiate a request to create a new VPC. To request a new VPC, click
on the **Create New VPC** button on top. This will open a form with the following fields:
<Thumbnail src="/img/deployment/dedicated-vpc/view-vpc-list.png" alt="VPC list" width="1146px" />
@ -73,17 +73,24 @@ resolve this.
## Create projects within the VPC
Once the VPC is provisioned, create a project by clicking on the **New Project** button in VPC details screen or
[get in touch with us](https://hasura.io/help/) to migrate your existing Hasura Project to the VPC.
<Thumbnail src="/img/deployment/dedicated-vpc/create-vpc-projects.png" alt="Create VPC Project" width="500px" />
Once the VPC is provisioned, `VPC owner` or `VPC manager` can create a project under the VPC by:
- Clicking on the **New Project** button from the Projects tab and select **Create VPC Project**
<Thumbnail src="/img/deployment/dedicated-vpc/create-projects-under-vpc-01.png" alt="Create VPC Project" width="900px" />
- Clicking on the **New Project** button in VPC details screen
<Thumbnail src="/img/deployment/dedicated-vpc/create-projects-under-vpc-02.png" alt="Create VPC Project" width="900px" />
All projects within a VPC are listed under **Projects**.
<Thumbnail src="/img/deployment/dedicated-vpc/vpc-projects-list.png" alt="VPC Projects List" width="900px" />
If peering is not enabled, the project resides in a dedicated VPC on the Hasura side, but the traffic **from the project to the database** will be routed over the public internet.
:::info Migrating existing projects to VPC
[Get in touch with us](https://hasura.io/help/) to migrate your existing Hasura Project to the VPC.
:::
## VPC Peering
VPC Peering is necessary to establish a private and secure one-to-one connection from Hasura to your infrastructure. This includes databases, Remote Schemas, or Event / Schedueld Trigger endpoints running under your VPC.
@ -92,3 +99,11 @@ Follow the Cloud provider-specific instruction to create VPC peering requests:
- [AWS](/hasura-cloud/dedicated-vpc/aws-network-peering.mdx)
- [Azure](/hasura-cloud/dedicated-vpc/azure-network-peering.mdx)
- [GCP](/hasura-cloud/dedicated-vpc/gcp-network-peering.mdx)
## VPC Collaborators
You can invite collaborators to your VPC and grant them either of the following roles:
- [VPC Manager](/hasura-cloud/dedicated-vpc/vpc-collaborators.mdx#vpc-manager)
- [VPC Viewer](/hasura-cloud/dedicated-vpc/vpc-collaborators.mdx#vpc-viewer)
Read more about [VPC Collaborators](/hasura-cloud/dedicated-vpc/vpc-collaborators.mdx).

View File

@ -0,0 +1,88 @@
---
sidebar_label: VPC Collaborators
title: 'VPC Collaborators'
description: Managing VPC collaborators on Hasura Cloud Enterprise
keywords:
- hasura
- docs
- cloud
- email
- VPC
- team
- collaborators
- invite
sidebar_position: 10
---
import Thumbnail from '@site/src/components/Thumbnail';
import HeadingIcon from '@site/src/components/HeadingIcon';
import ProductBadge from '@site/src/components/ProductBadge';
# VPC Collaborators
<ProductBadge ee />
## Introduction
You can invite collaborators to your VPC and grant them either of the following roles:
- [VPC Manager](/hasura-cloud/dedicated-vpc/vpc-collaborators.mdx#vpc-manager)
- [VPC Viewer](/hasura-cloud/dedicated-vpc/vpc-collaborators.mdx#vpc-viewer)
## Invite a collaborator
To invite a VPC collaborator, navigate to the `VPCs` tab on the dashboard and click on view VPC details.
<Thumbnail src="/img/deployment/dedicated-vpc/vpc-settings.png" alt="VPC Settings" width="900px" />
Click on the `Collaborators` tab to see a list of all the users who have access to the VPC and users who have been invited as
collaborators to the VPC.
<Thumbnail src="/img/deployment/dedicated-vpc/vpc-collaborators-list.png" alt="VPC Collaborators List" width="900px" />
Click on `Invite a Collaborator` to invite a new collaborator by providing the email of the user to be invited to the
VPC and select the appropriate role for this collaborator.
<Thumbnail src="/img/deployment/dedicated-vpc/vpc-collaborator-send-invitation.png" alt="VPC Collaborators List" width="900px" />
## Collaborator roles
Collaborators can have different levels of access in the VPC.
### VPC Manager
A VPC Manager has complete access to the VPC and can perform the following actions:
- View VPC settings
- Create VPC peering
- Create a new project under the VPC
- Admin access to all projects under the VPC
### **VPC Viewer**
A VPC Viewer has limited privileges and can perform the following actions:
- View VPC settings
- View VPC peering
- View metrics for all projects under the VPC
## Accept or Decline collaborator invitation
You can see all the VPCs you have been invited to collaborate on under the `VPCs` tab. Click on `Join` to accept the
invitation or click on `Dismiss` to decline the invitation.
<Thumbnail src="/img/deployment/dedicated-vpc/vpc-collaborator-invitation.png" alt="VPC Collaborator Invitation" width="900px" />
## Revoke collaborator invitation
A `VPC Owner` or `VPC Manager` can click on the `Invited` button to revoke a VPC collaborator invitation.
<Thumbnail src="/img/deployment/dedicated-vpc/revoke-vpc-collaborator-invitation.png" alt="Revoke VPC Collaborator Invitation" width="900px" />
## Remove a collaborator
A `VPC owner` or `VPC manager` can remove a collaborator from the VPC. To remove a VPC collaborator, click on the
collaborator and then select all the projects you want to remove the collaborator from.
<Thumbnail src="/img/deployment/dedicated-vpc/remove-vpc-collaborator.png" alt="Remove VPC Collaborator" width="900px" />
:::info
The user will be removed as a collaborator of the VPC and will also lose access to the projects that are selected.
However, the user will continue to have access to those projects that are not selected.
:::

Binary file not shown.

After

Width:  |  Height:  |  Size: 124 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB