Manage workspaces
As the creator of a workspace, you are automatically assigned the Owner role. See Manage collaborator role assignments for the access rights of the Owner role (for example, only you can delete the workspace).
As part of the normal workspace creation process, you will need to enter your payment details (unless you are creating your first free PAYG trial workspace). Your payment details are held and processed by Stripe. No payment details are held by Ververica.
You can:
- Create one Start-for-free workspace (you will be given the opportunity to convert this to a PAYG workspace at the end of the trial period).
- Create a PAYG workspace
note
You can only create up to 10 PAYG workspaces.
- Create a Reserved capacity workspace
Once you have created a workspace, you will become the owner of that workspace.
Once you have created a workspace, the following topics explain the other options available to you:
- Convert a Start-for-free workspace to a PAYG workspace.
- Change billing information
- Change payment method
- Invite and remove workspace collaborators
- Delete a workspace
- Delete your account
Create Start-for-free workspaceβ
When you first use Ververica Cloud, you can opt to create a free trial (Start-for-Free) workspace.
You are only allowed one free trial workspace; all other workspaces must have a valid payment method associated with them.
If you subsequently create other workspaces (PAYG or RC), the Start-for-Free workspace continues to run until you have consumed all its resources.
To create a free trial workspace:
-
Display your Dashboard.
-
Click New Workspace.
-
In the Create Workspace dialog, click Start for Free in the PAY AS YOU GO section of the Offering type panel.
-
In the Offering Details panel, enter a Workspace Name. (The Provider is set to AWS and cannot be changed.) See Workspace naming rules to ensure your naming conventions are correct.
-
Select the Region based on your location. Currently, Ververica Cloud supports the following regions:
- US West (N. California)
- US East (N. Virginia)
- Europe (Frankfurt)
-
In the Payment Details section, leave all the fields blank. Note: You can only create one free PAYG workspace. If you subsequently create more PAYG workspaces, you will need to add your credit card details.
-
Check the details in the Order Summary panel and click Create.
The new workspace will be listed on your Dashboard.
Create PAYG workspaceβ
To create a PAYG workspace in Ververica Cloud:
-
Display your Dashboard.
-
Click New Workspace.
-
In the Create Workspace dialog, click Start in the PAY AS YOU GO section of the Offering type panel.
-
In the Offering Details panel, enter a Workspace Name. (The Provider is set to AWS and cannot be changed.)
-
Select the Region based on your location. Currently, Ververica Cloud supports the following regions:
- US West (N. California)
- US East (N. Virginia)
- Europe (Frankfurt)
-
Fill in the Payment Details section:
- If you have not yet set up a payment method, enter your credit card details.
- If you already have a payment method set up, the credit card details will be filled in automatically.
- If you already have a payment method set up, but you want to change the card details or billing information, check the Update default payment option, fill in the new details and click Next. Then fill in or change the Billing Information details and click Next. Then review the information and click Confirm.
-
Check the details in the Order Summary panel and click Create.
The new workspace will be listed on your Dashboard.
Create RC workspaceβ
To create an RC workspace in Ververica Cloud:
-
Display your Dashboard.
-
Click New Workspace.
-
In the Create Workspace dialog, click Start from less than 2$ in the RESERVED CAPACITY section of the Offering type panel.
-
In the Offering details panel, enter a Workspace Name. (The Provider is set to AWS and cannot be changed.)
-
Select the Region based on your location. Currently, Ververica Cloud supports the following regions:
- US West (N. California)
- US East (N. Virginia)
- Europe (Frankfurt)
-
Select a Capacity.
-
Fill in the Payment Details section:
- If you have not yet set up a payment method, enter your credit card details.
- If you already have a payment method set up, the credit card details will be filled in automatically.
- If you already have a payment method set up, but you want to change the card details or billing information, check the Update default payment option, fill in the new details and click Next. Then fill in or change the Billing Information details and click Next. Then review the information and click Confirm.
-
Check the details in the Order Summary panel and click Create.
The new workspace will be listed on your Dashboard.
Open Console (existing workspace)β
To open the Console for an existing workspace:
-
Display your Dashboard.
-
Do one of the following in the workspace table:
- Click on the workspace name.
- Click the menu button (three vertical dots) to the right of the workspace entry and choose Open Console.
Delete workspaceβ
Any collaborators on this workspace will be notified of its deletion.
To delete a workspace:
-
Display your Dashboard.
-
Click the menu button (three vertical dots) to the right of the workspace entry.
-
Choose Delete.
Workspace naming rulesβ
- Maximum 128 characters
- Uppercase letters
- Lowercase letters
- Numbers 0β9
- Special characters: SPACE(β β), UNDERSCORE(β_β), DASH(β-β)
Invite and remove workspace collaboratorsβ
As the Owner or Admin of a workspace, you can add internal (existing Ververica Cloud) users and external users as collaborators into the workspace as Admin, Editor or Viewer roles.
Invite a user to collaborate in a workspaceβ
To invite a user to collaborate in one of your workspaces:
-
Display your Dashboard.
-
Click the Account menu button in the top right and choose Access Control.
-
In the Role Assignment tab, type the email address for the user you want to invite.
-
Use the Select workspace drop-down menu to specify workspace to which you want to invite the user.
-
Use the Select role drop-down menu to specify the role assignment for that user.
-
Click Assign.
Once you have done this:
- The user will receive an email informing them of the invitation.
- The user needs to respond to the invitation within a specified time limit.
- The status is visible in the Access Control > User Assignment tab. It can be one of the following:
- Good: The user has accepted the invitation.
- Pending: The user has not yet responded to the email.
- Expired: The period for the user to respond has expired. No change was made. As the owner of the workspace, you can reinvite the user.
- Rejected: The user rejected the invitation.
Remove a collaborator from a workspaceβ
To remove a user from the list of collaborators in one of your workspaces:
-
Display your Dashboard.
-
Click the Account menu button and choose Access Control.
-
In the Role Assignment tab, use the drop-down menu in the Assignment List panel to filter the list of your current workspaces.
-
Click the menu button next to the user who you want to remove and choose Delete.
-
Click Delete in the Delete User Assignment pop-up.
Once you have done this:
- The user will receive an email informing them of the change.
- The user will no longer be listed in the Access Control > User Assignment tab.
Manage workspace collaborator role assignmentsβ
The topics in this section explain how to assign roles and permissions to users in workspaces that you create.
Role definitions within a workspaceβ
Ververica Cloud supports the following predefined Roles:
- Owner: This role belongs to the original workspace creator, and provides the highest level of access. Owners have full access to resources within that workspace. They can also manage billing, access permissions, and granting or revoking access to other collaborators. Only the original creator can delete the workspace.
- Admin: The Admin role has the same permissions as the Owner, except for billing management and workspace deletion.
- Editor: Editors have permission to read, write, and edit resources, but they cannot manage access permissions or deployment templates.
- Viewer: Viewers have the lowest level of access. They can read resources but typically cannot write, edit, or delete them. They also can't manage access permissions or deployment templates.
Permission | Owner | Admin | Editor | Viewer |
---|---|---|---|---|
View deployments | Y | Y | Y | Y |
Start and cancel a deployment | Y | Y | Y | N |
Modify deployment configurations | Y | Y | Y | N |
View resources | Y | Y | Y | Y |
Upload resources | Y | Y | Y | N |
Write SQL statements | Y | Y | Y | N |
Create a user-defined function (UDF) | Y | Y | Y | N |
Register metadata | Y | Y | Y | N |
View a deployment template | Y | Y | Y | Y |
Add, delete, and modify a deployment template | Y | Y | N | N |
Manage members of a workspace | Y | Y | N | N |
Manage private connections | Y | Y | N | N |
Billing management | Y | N | N | N |
Delete workspace | Y | N | N | N |
Typical use caseβ
A business owner or financial team leverages the Owner role to manage billings, and assigns the Admin role of a workspace to the tech lead.
The tech lead manages the day-to-day technical tasks and assigns other Admins, Editors, and Viewers to the workspace.
Restrictionsβ
Since the Owner role involves the billing responsibility, each workspace can only have one owner (the workspace creator). The workspace owner cannot be changed. The workspace can, however, have multiple Admins, Editors, and Viewers.
View user role definitionsβ
To remind yourself of the permissions assigned to each type of user role:
-
Display your Dashboard.
-
Click the Account menu button in the top right of the screen and choose Access Control.
-
In the Access Control window, display the Role Permissions tab.
-
Click on the different user role types (Owner, Admin, Editor, and Viewer) to display a read-only list of permissions.
For background information on this subject, see Manage collaborator role assignments.
Edit workspace collaborator's role assignmentβ
You can edit an existing userβs role assignment in a workspace if you are the Owner or Admin of that workspace. You can also edit your own role assignment, as Owner or Admin of the workspace.
To edit a role assignment:
-
Display your Dashboard.
-
Click the Account menu button and choose Access Control.
-
In the Role Assignment tab, use the drop-down menu in the Assignment List panel to filter the list of your current workspaces.
-
Click the menu button next to the user whose role assignment you want to change and choose Edit.
-
Use the Select role drop-down menu to assign a different role the user.
-
Click Save.
Once you have done this:
- The user will receive an email informing them of the change.
- The user needs to respond to the change within a specified time limit.
- The status is visible in the Access Control > User Assignment tab. It can be one of the following:
- Good: The user has accepted the update.
- Pending: The user has not yet responded to the email.
- Expired: The period for the user to respond has expired. No change was made. As the owner of the workspace, you can reinvite the user.
- Rejected: The user rejected the proposed change.