Workspaces
End users can use workspaces to group and organize resources they create. For example, a data scientist may wish to create two workspaces called "Dev" and "QA". In the example below, you can see that there are different instances and notebooks operating in these two workspaces.
Workspaces are also a way to achieve multi tenancy and isolation. Users can invite collaborators to specific workspaces. In the example above, you can see that the data scientist user "John" has invited his colleague "Sally" to collaborate with him only in the "Dev" workspace. Although Sally can access all resources inside the Dev workspace, she cannot view/access any resources inside the "QA" workspace.
In summary, workspaces help end users achieve the following:
- Group and Organize Resources
- Collaboration with Isolation and Multi Tenancy for End User Resources
Create Workspace¶
Users can create and manage multiple workspaces. Although here is no limit to the number of workspaces they create, a practical number may be 3-5 workspaces. To create a new workspace
- Click on "Add Workspace"
- Provide a unique name
- Click on Save
Note that users can optionally also enter a user friendly Display Name and a Description. This can be extremely useful when additional collaborators are added to the workspace.
View Workspace¶
When the user selects the workspaces menu on the left, the list of all workspaces will be displayed. Users can view additional details (e.g. when was it created? when was it last modified) about a workspace by clicking on the name.
If the user has a large number of workspaces, they can "search" for the workspace by entering either a partial or full name in the search box. This will display a filtered list of all workspaces that matched the search criteria.
Edit Workspace¶
To modify the workspace, click on the ellipses on the far right of the workspace to bring up the actions menu. Select "edit configuration", make the necessary changes and save the workspace.
Add/Remove Collaborators¶
To add collaborators to a workspace, click on the workspace. This will display additional details about the workspace. In the collaborators section, you will see a list of users that have access to the workspace with their roles (i.e. privileges describing what they can/cannot do in the workspace).
New Users¶
To invite new collaborators to the workspace, click on "new user" and provide the following details:
- First Name
- Last Name
- Email Address
- Role
- User Type
Collaborators can be added to a workspace with different roles depending on the level of access they require. A subset of roles available in Rafay is listed below for the convenience of users.
| Role | Description |
|---|---|
| PaaS Workspace Administrator | Administrative privileges in the workspace |
| PaaS Workspace Collaborator | Can do everything in the workspace except administrative actions |
| PaaS Workspace Collaborator Read Only | Can only perform read only actions in the workspace |
For type of user, you can either select "Console" or "API Only". Select the latter if you want to limit the user to "programmatic access" to the workspace.
Note
New users will be sent an activation email with a temporary password. They will be required to reset and create a new password before they can access the workspace.
Existing Users¶
Users already in the Organization can be added to the workspace quickly as well.
- Click on "existing users"
- Select a role from the drop down
- Select one or more users from the drop down list and Save.
Delete Users¶
To remove a user from a workspace, click on the "ellipses" on the far right of the user row and click on "actions" and select "delete".
Delete Workspace¶
Users with the "PaaS Workspace Admin" role are authorized to delete a workspace. They are considered owners/co-owners of the workspace.
- Click on the workspace menu on the left to view the list of all workspaces
- Click on the ellipses menu on the right of the workspace
- From the list of available actions, select "delete" to delete the workspace
Note
Once a workspace is deleted, it cannot be recovered/restored.