Workspace
Workspace Management in Scoutflo
Last updated
Workspace Management in Scoutflo
Last updated
In Scoutflo, a Workspace serves as an isolated environment for managing clusters, applications, and resources. Workspaces allow organizations to logically separate teams, projects, or use cases within the platform, ensuring streamlined management of resources with proper role-based access control (RBAC).
A Workspace is a core concept in the Scoutflo platform, designed to:
Provide logical isolation for different teams or projects.
Allow management of clusters, applications, and infrastructure resources within a controlled environment.
Enable easy collaboration, with the ability to assign specific members and roles within each workspace.
Purpose of Workspaces:
They help organize projects or teams independently so that resources (like clusters and applications) don't mix.
Each workspace has its own set of permissions, members, and resources.
You can have multiple workspaces under one account, which allows teams to work on different projects in parallel while maintaining security and isolation of resources.
For example, a company may create workspaces for different departments like “Development,” “QA,” and “Production,” or for separate clients or projects, ensuring that resources are managed independently in each.
Navigate to Workspace Settings:
Go to Account Settings > Workspaces.
View Existing Workspaces:
You will see a list of all existing workspaces. By default, a “Default” Workspace is created by the Super Admin when the account is first set up. Other members will not receive a default workspace.
Create a New Workspace:
On the top-right corner, click “+ Create Workspace”. A modal window will open for workspace creation.
Enter Workspace Details:
Fill in the workspace name (required) and an optional description.
Optionally, you can invite team members directly during the workspace creation process.
Confirm Creation:
After filling in the details, click “Create”. You’ll receive a success notification, and the newly created workspace will appear in the list.
Edit a Workspace:
In the workspace list, click on the 'Three-Dot Action button > Edit Workspace' next to the workspace you want to edit.
Alternatively, if you are inside the workspace, you can find an “Edit Workspace” button.
Modify Workspace Details:
You can update the Name and Description in the modal that opens.
Save Changes:
Click “Save”, and the updated information will reflect in the workspace list.
Delete a Workspace:
Click the three-dot Action button next to the workspace you wish to delete.
Alternatively, you can find the “Delete Workspace” button inside the workspace.
Preconditions for Deletion:
Before a workspace can be deleted, all resources (clusters, applications) and members must either be removed or migrated to another workspace.
If there are still resources or members, a modal will prompt you to clear or migrate them.
Delete the Workspace:
Once the workspace is empty, you can proceed with deletion.
Deleting a workspace in Scoutflo requires that all resources (clusters, applications, etc.) and members are either migrated to another workspace or deleted to ensure data consistency and avoid accidental data loss. The deletion flow includes guided steps to help safely migrate or remove resources and members before deletion.
Delete a Workspace:
Navigate to the workspace list and click on the Three-Dot Action button > Delete Workspace next to the workspace you want to delete.
Preconditions for Deletion:
If there are resources (clusters, applications) or members associated with the workspace, a confirmation modal will prompt you to either clear or migrate them.
As the access to delete any workspace is with the Super Admin only, the' Migration' process can be executed only by the Super Admin in the organization.
The modal provides options to:
Migrate members and resources to another workspace.
Delete all members and resources associated with this workspace.
Migration Process:
Member Migration:
Select Members to Migrate: First, choose all members from the current workspace that you intend to delete.
Select Target Workspace: A dropdown will display a list of all workspaces except the current one. Select the target workspace where you wish to migrate the selected members.
Initiate Migration: Click Migrate to transfer the selected members to the target workspace.
Migration Confirmation: After migration, confirm that all required members are present in the target workspace.
Duplication Check: If a member already exists in the target workspace (based on user ID), they will not be duplicated. The system checks each user ID to ensure that only new members are moved.
Resource Migration or Deletion:
You can either migrate clusters and applications to the target workspace or choose to delete them entirely.
Ensure the target workspace has adequate permissions and capacity for any resources being migrated.
Complete the Workspace Deletion:
Empty the Workspace: If there are still members or resources left in the workspace, you must either migrate or remove them. Only an empty workspace can be deleted.
Finalize Deletion: Once all members and resources have been transferred or removed, proceed with the workspace deletion by confirming in the modal.
Click Discard to cancel the deletion or Migrate to finalize the process if all conditions are met.
This process ensures that no members or resources are left stranded in the workspace, providing a controlled and safe approach to workspace deletion.
Invite Members: After finalizing your workspace setup, you can invite colleagues or team members to the platform.
Collaborate: Your team can now collaborate on cluster management, application deployment, and more within the same workspace.
Navigate to the Members Section: Inside a workspace, go to the Members & Invitees section.
Click “Invite”: In the top-right corner, click “Invite” to open the invitation modal.
Fill in the Invitation Details: Enter the team member’s email and select their role (Super Admin, Workspace Owner, Workspace User, or View-Only).
Send Invitation: If the information is correct, you will see a confirmation message saying “Invitation Successful”, and the user will receive an invite to join the workspace.
Resources (like clusters and applications) are associated with the current workspace you are operating in. Here's how resource management works within a workspace:
Workspace Dropdown: On the top-left corner of the platform, there is a dropdown where you can select the workspace you are currently working in. The resources (clusters, applications) you create will be saved inside this selected workspace.
Switching Workspaces: You can easily switch between workspaces by selecting a different one from the dropdown. The resources created in one workspace are isolated from those in another.
The Default Workspace is a special workspace that is automatically created for the Super Admin when the organization’s account is set up. Here are some key points about the Default Workspace:
It cannot be deleted.
The Super Admin is automatically part of this workspace and can manage all resources within it.
Other users will not receive a Default Workspace and must be invited to a workspace.
Here are some important rules and behaviour guidelines for workspaces in Scoutflo:
Default Workspace Creation: When an account is created, a Default Workspace is automatically generated.
Deletion of Workspaces: Before deleting any workspace, you must remove or migrate all resources (clusters, applications) and members to another workspace.
Super Admin Permissions: The Super Admin is part of all workspaces by default and cannot leave any workspace. Only the Super Admin has permission to create new workspaces.
Unique Cluster IDs: Each time a cluster is created or connected in a workspace, a unique cluster ID is generated for that workspace.
If the same cluster is shared across multiple workspaces, there will be multiple unique cluster IDs, one for each workspace, maintaining isolation between resources.
Application Isolation: Any applications or connections deployed inside a workspace are isolated to that specific workspace, using the associated cluster IDs.
Super Admin's Role in Accepting User Requests:
If any user requests to join the organization’s Scoutflo account, it is the Super Admin who has the authority to accept or reject the request.
Before accepting the request, the Super Admin must assign the user to an existing workspace.
Once the request is accepted, the user is added to the specified workspace, and their profile is created.
Invitations to Workspaces:
When a Workspace Owner or Super Admin invites a new member, the invitation is tied to a specific workspace.
The invitee will be added to the workspace once they accept the invitation and complete the sign-up process.
The user's profile will be created only after they join the workspace.
User Must Always Belong to a Workspace:
A user in Scoutflo is always assigned to a workspace. They cannot exist independently at the account level unless they are the Super Admin.
This ensures that all operations, resources, and activities are scoped within a workspace.
Account-Level Super Admin:
Only the Super Admin operates at the account level and has visibility and access across all workspaces.
All other users must be within a workspace, as workspace isolation ensures that operations are limited to the workspace's resources and members.
Limitations on Leaving Workspaces:
If a user is only a part of one workspace, they cannot leave or be removed from that workspace.
This rule ensures that no user is left without a workspace, as all users must be associated with at least one workspace at all times.
If a user needs to leave, they must first be added to another workspace.
If you want a user not to be a part of any workspace, then you can delete the profile of the user which will permanently remove the user's data from the platform.
