diff --git a/docs/docs/hasura-cloud/dedicated-vpc/index.mdx b/docs/docs/hasura-cloud/dedicated-vpc/index.mdx index b8bcdd863f5..559c88f41ab 100644 --- a/docs/docs/hasura-cloud/dedicated-vpc/index.mdx +++ b/docs/docs/hasura-cloud/dedicated-vpc/index.mdx @@ -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: @@ -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. - - - +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** + + - Clicking on the **New Project** button in VPC details screen + + All projects within a VPC are listed under **Projects**. 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). diff --git a/docs/docs/hasura-cloud/dedicated-vpc/vpc-collaborators.mdx b/docs/docs/hasura-cloud/dedicated-vpc/vpc-collaborators.mdx new file mode 100644 index 00000000000..9882be54634 --- /dev/null +++ b/docs/docs/hasura-cloud/dedicated-vpc/vpc-collaborators.mdx @@ -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 + + + +## 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. + + + +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. + + + +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. + + + +## 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. + + + +## Revoke collaborator invitation + +A `VPC Owner` or `VPC Manager` can click on the `Invited` button to revoke a VPC collaborator invitation. + + + +## 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. + + + +:::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. + +::: diff --git a/docs/static/img/deployment/dedicated-vpc/create-projects-under-vpc-01.png b/docs/static/img/deployment/dedicated-vpc/create-projects-under-vpc-01.png new file mode 100644 index 00000000000..c7c0a4714d6 Binary files /dev/null and b/docs/static/img/deployment/dedicated-vpc/create-projects-under-vpc-01.png differ diff --git a/docs/static/img/deployment/dedicated-vpc/create-projects-under-vpc-02.png b/docs/static/img/deployment/dedicated-vpc/create-projects-under-vpc-02.png new file mode 100644 index 00000000000..d686359036d Binary files /dev/null and b/docs/static/img/deployment/dedicated-vpc/create-projects-under-vpc-02.png differ diff --git a/docs/static/img/deployment/dedicated-vpc/create-vpc-projects.png b/docs/static/img/deployment/dedicated-vpc/create-vpc-projects.png deleted file mode 100644 index d8da1bdee10..00000000000 Binary files a/docs/static/img/deployment/dedicated-vpc/create-vpc-projects.png and /dev/null differ diff --git a/docs/static/img/deployment/dedicated-vpc/remove-vpc-collaborator.png b/docs/static/img/deployment/dedicated-vpc/remove-vpc-collaborator.png new file mode 100644 index 00000000000..e2fd9b16a1d Binary files /dev/null and b/docs/static/img/deployment/dedicated-vpc/remove-vpc-collaborator.png differ diff --git a/docs/static/img/deployment/dedicated-vpc/revoke-vpc-collaborator-invitation.png b/docs/static/img/deployment/dedicated-vpc/revoke-vpc-collaborator-invitation.png new file mode 100644 index 00000000000..460dd129a9a Binary files /dev/null and b/docs/static/img/deployment/dedicated-vpc/revoke-vpc-collaborator-invitation.png differ diff --git a/docs/static/img/deployment/dedicated-vpc/vpc-collaborator-invitation.png b/docs/static/img/deployment/dedicated-vpc/vpc-collaborator-invitation.png new file mode 100644 index 00000000000..1995c6a58f7 Binary files /dev/null and b/docs/static/img/deployment/dedicated-vpc/vpc-collaborator-invitation.png differ diff --git a/docs/static/img/deployment/dedicated-vpc/vpc-collaborator-send-invitation.png b/docs/static/img/deployment/dedicated-vpc/vpc-collaborator-send-invitation.png new file mode 100644 index 00000000000..ca4a74cbc74 Binary files /dev/null and b/docs/static/img/deployment/dedicated-vpc/vpc-collaborator-send-invitation.png differ diff --git a/docs/static/img/deployment/dedicated-vpc/vpc-collaborators-list.png b/docs/static/img/deployment/dedicated-vpc/vpc-collaborators-list.png new file mode 100644 index 00000000000..5337b6d66dd Binary files /dev/null and b/docs/static/img/deployment/dedicated-vpc/vpc-collaborators-list.png differ diff --git a/docs/static/img/deployment/dedicated-vpc/vpc-projects-list.png b/docs/static/img/deployment/dedicated-vpc/vpc-projects-list.png index 5a0d464392b..7dab251afdb 100644 Binary files a/docs/static/img/deployment/dedicated-vpc/vpc-projects-list.png and b/docs/static/img/deployment/dedicated-vpc/vpc-projects-list.png differ diff --git a/docs/static/img/deployment/dedicated-vpc/vpc-settings.png b/docs/static/img/deployment/dedicated-vpc/vpc-settings.png new file mode 100644 index 00000000000..4484d02d90e Binary files /dev/null and b/docs/static/img/deployment/dedicated-vpc/vpc-settings.png differ