-
Notifications
You must be signed in to change notification settings - Fork 118
doc: Add "Managing Workspaces" Guide #614
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 3 commits
ee37606
f33aab9
33c5469
a14914b
99e6a2d
d24ea7c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,167 @@ | ||
--- | ||
title: Managing Workspaces | ||
description: "Learn how to create, edit, delete, and configure your Workspaces." | ||
weight: 7 | ||
categories: [Spaces] | ||
--- | ||
|
||
This guide walks you through the practical steps of managing your Workspaces. Here, you'll learn how to create, edit, and delete Workspaces, as well as how to manage access by assigning teams and resources like Environments, Designs, and Views to them. | ||
|
||
If you're new to the concept of Workspaces, we recommend starting with the [Workspaces Overview](https://docs.layer5.io/cloud/spaces/workspaces/) to understand what a Workspace is and how it relates to key components like Environments, Designs, and Teams. | ||
|
||
{{< alert type="info" title="A Note on Permissions" >}} | ||
Every action described in this guide is governed by roles and permissions. To see a detailed breakdown of what your assigned role allows you to do, please refer to the [Default Permissions](https://docs.layer5.io/cloud/reference/default-permissions/) documentation. | ||
{{< /alert >}} | ||
|
||
### View Workspaces | ||
|
||
The [Workspaces page](https://cloud.layer5.io/spaces/workspaces) is where you can see all of the workspaces within the currently selected organization. | ||
|
||
To suit different workflows, you can switch between two distinct layouts: a visual grid view and a detailed table view. | ||
|
||
#### Grid View | ||
The grid view offers a card-based layout, perfect for quickly identifying workspaces at a glance. Each card displays essential information, and you can flip it to reveal management options like editing or deleting and get audit history. | ||
 | ||
|
||
#### Table View | ||
The table view provides a dense, list-based format that is ideal for managing a large number of workspaces. This view allows for sorting and gives you more control over the specific details you see. | ||
|
||
To customize the information displayed, click the **View Columns** icon and select the attributes you want to see, such as Owner ID or Created Date. | ||
|
||
 | ||
|
||
{{< alert type="info" title="Consistent Actions Across Views" >}} | ||
Both the grid and table views provide the same set of management capabilities. You can choose the layout that best fits your needs without losing any functionality. | ||
{{< /alert >}} | ||
|
||
### Create a Workspace | ||
|
||
Creating a new workspace allows you to manage resources, and define team access. | ||
|
||
{{< alert type="info" title="Permissions Required" >}} | ||
Only users with the Workspace Admin or Organization Admin role can create new workspaces. | ||
{{< /alert >}} | ||
|
||
To create a workspace: | ||
|
||
1. Click the **+ Create** button to open the creation modal. | ||
2. From the dropdown menu, select the **Organization** that will own the new workspace. The chosen Organization **cannot be** changed after the workspace is created. Please select carefully. | ||
3. Enter a descriptive **Name** and an optional **Description**, then click **Save**. | ||
4. Your new workspace will now appear on the page. | ||
|
||
 | ||
|
||
### Edit a Workspace | ||
|
||
You can modify a workspace's name and description at any time after it has been created. | ||
|
||
- **From the Grid View:** Flip the workspace card, then click the **pencil icon**. | ||
- **From the Table View:** Click the **pencil icon** in the row of the workspace you wish to modify. | ||
|
||
 | ||
|
||
### Delete a Workspace | ||
|
||
You can delete a single workspace or multiple workspaces at once. | ||
|
||
- **To delete a single workspace:** | ||
|
||
- From the **Grid View**, flip the workspace card, then click the **trash can icon**. | ||
- From the **Table View**, click the **trash can icon** in the row of the workspace you wish to delete. | ||
|
||
- **To delete multiple workspaces (Grid View only):** | ||
|
||
1. Select the checkboxes on the cards of the workspaces you want to delete. | ||
2. Click the **Delete** button that appears at the top of the page. | ||
|
||
 | ||
|
||
{{< alert type="info" title="Deletion Restrictions" >}} | ||
Meshery requires at least one workspace to exist within an organization at all times, so you cannot delete the last remaining workspace. | ||
{{< /alert >}} | ||
|
||
#### Workspace Deletion Behavior | ||
When a Workspace is deleted: | ||
|
||
- Deletion is **permanent and irreversible**. Proceed with caution. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It is implied, but not directly stated that all designs and views within the workspace will be deleted along with the workspace itself. It might be good to explicitly state this upfront. |
||
- Before deletion, users have the option to transfer associated Designs and Views to another Workspace. | ||
- If no transfer is made, all associated Designs and Views will be permanently deleted along with the Workspace[^1]. | ||
- Any associated Teams or Environments will be detached from the Workspace but will remain available for reassignment. | ||
|
||
{{< alert type="warning" title="What Happens When a Workspace is Deleted?" >}} | ||
Deleting a Workspace will permanently remove the Workspace itself and its associated Designs and Views, unless they are transferred beforehand. Teams and Environments will remain intact but will no longer be associated with the deleted Workspace. | ||
{{< /alert >}} | ||
|
||
### Assign Teams to a Workspace | ||
Assigning teams is the way you grant users access to a workspace. Once a team is assigned, its members can access all of the Designs, Views, and Environments linked to that workspace. | ||
|
||
 | ||
|
||
You can open the team management modal from either the grid or table view. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I wonder if we should be using the term "modal" in our user-facing docs. |
||
|
||
- **From the Grid View:** Click the **Teams** tile. | ||
- **From the Table View:** Click the **Teams icon** in the workspace row. A list of currently assigned teams will appear. From there, click the **Assign Team** button to open the assignment modal. | ||
|
||
Inside the assignment modal, you will see two lists: **Available Teams** on the left and **Assigned Teams** on the right. | ||
|
||
1. Select one or more teams from either list. | ||
2. Use the arrow buttons to move the selected teams between the lists: | ||
- **>** Assigns a selected team. | ||
- **<** Unassigns a selected team. | ||
- **>>** Assigns all available teams. | ||
- **<<** Unassigns all assigned teams. | ||
3. Click **Save** to apply your changes. | ||
|
||
{{< alert type="info" title="Team and Workspace Relationships" >}} | ||
You can assign multiple teams to a single workspace, and a single team can also be a member of multiple workspaces. This provides flexible access control across your projects. For more restrictions, see [Workspaces documentation](https://docs.layer5.io/cloud/spaces/workspaces/). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Perhaps, the relative path? |
||
{{< /alert >}} | ||
|
||
### Link Environments to a Workspace | ||
When you link an [Environment](https://docs.layer5.io/cloud/spaces/environments/) to a Workspace, you make all the connections (like those to Kubernetes clusters or databases) grouped within that Environment available. This means any team members with access to that Workspace can then deploy their applications or configurations to the resources. | ||
|
||
The process of linking environments is almost the same as assigning teams. | ||
 | ||
|
||
{{< alert type="info" title="Many-to-Many Relationship" >}} | ||
An Environment can be linked to multiple Workspaces, and a Workspace can have multiple Environments. This allows you to share common environments across different projects. | ||
{{< /alert >}} | ||
|
||
### Move Designs and Views Between Workspaces | ||
|
||
Unlike Environments, every Design and View **must belong to exactly one Workspace at all times.** | ||
|
||
When you create a new Design, it is automatically added to your current Workspace. Therefore, you don't "link" them in the same way you link an Environment; instead, you **move** them from one Workspace to another. | ||
|
||
#### How to Move a Design or View | ||
|
||
1. Click the **Designs/Views** tile on the Workspace card (or the equivalent icon in the table view) to open the management modal. | ||
2. Inside the modal, select the Design(s) or View(s). | ||
3. Use the arrow buttons to move the selected Design(s) or View(s) to the target workspace. | ||
4. Click **Save**. | ||
|
||
 | ||
|
||
{{< alert type="info" title="Exclusive Ownership" >}} | ||
A Design or View can only exist in one Workspace at a time. Moving it to a new Workspace will automatically remove it from its original location. For more detailed information, see [Workspaces documentation](https://docs.layer5.io/cloud/spaces/workspaces/). | ||
{{< /alert >}} | ||
|
||
### View Recent Activity | ||
|
||
Meshery keeps a detailed audit log for each workspace, allowing you to track all significant events. This is useful for maintaining security and troubleshooting issues. | ||
|
||
 | ||
|
||
The activity log captures a variety of events, including: | ||
- The creation or deletion of the workspace. | ||
- Updates to the workspace's name or description. | ||
- The assignment or unassignment of Teams. | ||
- The linking or unlinking of Environments. | ||
- The movement of Designs or Views between workspaces. | ||
|
||
At the bottom of the log, you will also find timestamps for when the workspace was initially created and when it was last updated. | ||
|
||
{{< alert type="info" title="Putting It All Together: A Hands-on Guide" >}} | ||
To see how managing a Workspace fits into a complete, end-to-end workflow, follow the [Using Workspaces Effectively](https://cloud.layer5.io/academy/learning-paths/mastering-meshery/introduction-to-meshery?chapter=using-workspaces-effectively) learning path. | ||
{{< /alert >}} | ||
|
||
[^1]: This functionality is not fully implemented yet. Users might occasionally observe that designs and views are preserved after Workspace deletion. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,11 @@ | ||
--- | ||
title: Workspaces | ||
description: > | ||
Meshery Workspaces serve as a virtual space for your team-based work. | ||
Understand the core concepts of Meshery Workspaces. | ||
weight: 6 | ||
categories: [Spaces] | ||
--- | ||
|
||
|
||
Meshery Workspaces provide a virtual space for you and your teams to collaborate, organize project-based work, manage access to environments and resources, and track team activities. | ||
|
||
You can create Workspaces to group related Designs and Environments, define domains of responsibility for your teams, and streamline resource management. | ||
|
@@ -30,19 +29,6 @@ After creating a Workspace, one of your next steps is to assign team access, cre | |
|
||
Like a shared drive (or shared collection of files), Workspaces are your Google Drive, while Meshery Designs are your Google Docs. | ||
|
||
### Workspace Deletion Behavior | ||
|
||
When a Workspace is deleted: | ||
|
||
- Deletion is **permanent and irreversible**. Proceed with caution. | ||
- Before deletion, users have the option to transfer associated Designs and Views to another Workspace. | ||
- If no transfer is made, all associated Designs and Views will be permanently deleted along with the Workspace[^1]. | ||
- Any associated Teams or Environments will be detached from the Workspace but will remain available for reassignment. | ||
|
||
{{< alert type="info" title="What Happens When a Workspace is Deleted?" >}} | ||
Deleting a Workspace will permanently remove the Workspace itself and its associated Designs and Views, unless they are transferred beforehand. Teams and Environments will remain intact but will no longer be associated with the deleted Workspace. | ||
{{< /alert >}} | ||
|
||
## Key Workspace Components | ||
|
||
### Environments | ||
|
@@ -92,6 +78,4 @@ To make the most of Meshery Workspaces, here are some best practices: | |
- Use Infrastructure Designs to standardize resource deployments. | ||
- Regularly review and update your Workspace's resources and configurations. | ||
|
||
Meshery Workspaces enhance collaboration within your teams, providing a structured environment for sharing and managing resources. By following best practices and understanding the core components of Workspaces, you can maximize the benefits of this feature in Meshery. | ||
|
||
[^1]: This functionality is not fully implemented yet. Users might occasionally observe that designs and views are preserved after Workspace deletion. | ||
Meshery Workspaces enhance collaboration within your teams, providing a structured environment for sharing and managing resources. By following best practices and understanding the core components of Workspaces, you can maximize the benefits of this feature in Meshery. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Does this page have a link to the "Managing Workspaces" page? Should it or are the Previous and Next page buttons sufficient in this case? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if this might be presented as a tip-style alert. Maybe so or maybe it would be unnecessarily distracting. Hmm.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, I wonder if the "grid view" and "table view" words should be hyperlinked to their respective sections.