From 0bb79ab034323dfc78373421f65af63670745275 Mon Sep 17 00:00:00 2001 From: Zihan Kuang Date: Sun, 27 Apr 2025 18:44:49 +0200 Subject: [PATCH 1/9] add-workspace-delete Signed-off-by: Zihan Kuang --- content/en/cloud/spaces/workspaces.md | 32 ++++++++++++++++++--------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/content/en/cloud/spaces/workspaces.md b/content/en/cloud/spaces/workspaces.md index a7bc3ca8..054e2a22 100644 --- a/content/en/cloud/spaces/workspaces.md +++ b/content/en/cloud/spaces/workspaces.md @@ -6,13 +6,10 @@ weight: 6 categories: [Spaces] --- -Meshery Workspaces serve as a virtual space for your team-based work. Create a Workspace to organize your work and to serve as the central point of collaboration for you and your teams and a central point of access control to Environments and their resources. -You may create Workspaces to organize project-based work or to create domains of responsibility for your teams or segregate Designs and Environments and track team activity. +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. -## Summary - -Workspaces facilitate collaboration between you and your teams, allow you to control access to resources, and track activity and report on related events. +You can create Workspaces to group related Designs and Environments, define domains of responsibility for your teams, and streamline resource management. ## Key Features @@ -33,6 +30,19 @@ Workspaces facilitate collaboration between you and your teams, allow you to con After creating a Workspace, of your next steps is to resource that Workspace. Like a shared drive (or 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, Meshery follows a non-destructive deletion strategy to preserve important data: + +- The Workspace itself is **soft-deleted** by setting a `deleted_at` timestamp. It is no longer active but still exists in the database for auditing purposes. +- **Associated mappings** between the Workspace and its Environments, Designs, Teams, and Views are also soft-deleted. +- **Environments, Designs, Teams, and Views themselves are not deleted**. They remain available and can be reassigned to other Workspaces if needed. +- Users will see the previously associated resources listed as available again, ready for new associations. + +{{< alert type="info" title="What Happens When a Workspace is Deleted?" >}} +Deleting a Workspace only removes the relationships between the Workspace and its associated resources. It does not delete the resources themselves. +{{< /alert >}} + ## Key Workspace Components ### Environments @@ -41,7 +51,7 @@ After creating a Workspace, of your next steps is to resource that Workspace. Li - One or more environments can be assigned to a workspace. - Same environment can be assigned to multiple workspaces. -{{< alert type="info" >}} +{{< alert type="info" title="Assigning Environments to Workspaces" >}} Assign any number of Environments to one or more Workspaces. See [Environments](https://docs.meshery.io/concepts/environments) section for more information. {{< /alert >}} @@ -52,7 +62,7 @@ Assign any number of Environments to one or more Workspaces. See [Environments]( - One ore more designs can be assigned to a workspace. - Same design can be assigned to multiple workspaces. -{{< alert type="info" >}} +{{< alert type="info" title="Design Ownership in Workspaces" >}} Designs belong to only one Workspace at any given time. See [Meshery Designs](https://docs.meshery.io/concepts/designs) section for more information. {{< /alert >}} @@ -61,8 +71,8 @@ Designs belong to only one Workspace at any given time. See [Meshery Designs](ht - One ore more teams can be assigned to a workspace. - Same team can be assigned to multiple workspaces. -{{< alert type="info" >}} -Teams offer control access to workspaces and to workspace resources such as environments and managed and unmanaged connections, See [Teams](/cloud/identity/teams). +{{< alert type="info" title="Team Access Control in Workspaces" >}} +Teams offer control access to workspaces and to workspace resources such as environments and managed and unmanaged connections. See [Teams](/cloud/identity/teams). {{< /alert >}} ### Connections @@ -71,7 +81,7 @@ Teams offer control access to workspaces and to workspace resources such as envi - Connections can be assigned to one or more environments. - Same connection can be assigned to multiple environments. -{{< alert type="info" >}} +{{< alert type="info" title="Learn More About Connections" >}} See [Connections](https://docs.meshery.io/concepts/logical/connections) section for more information. {{< /alert >}} @@ -83,4 +93,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. +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. \ No newline at end of file From ee808ee7ed0c78f6a9655be85a3126355ce84138 Mon Sep 17 00:00:00 2001 From: Zihan Kuang Date: Sun, 27 Apr 2025 19:37:53 +0200 Subject: [PATCH 2/9] add-workspace-delete Signed-off-by: Zihan Kuang --- content/en/cloud/spaces/workspaces.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/cloud/spaces/workspaces.md b/content/en/cloud/spaces/workspaces.md index 054e2a22..e6bdd268 100644 --- a/content/en/cloud/spaces/workspaces.md +++ b/content/en/cloud/spaces/workspaces.md @@ -24,11 +24,11 @@ You can create Workspaces to group related Designs and Environments, define doma - Access to Workspaces may be granted to one or more teams. - As a point of collaboration to facilitate work, Workspaces may have zero or more Environments associated. - A Workspace is closely associated with Teams in Meshery. Teams are groups of users with varying permissions, and they are at the center of resource access and management within a Workspace. -- One ore more teams can be assigned to a workspace. +- One or more teams can be assigned to a workspace. - Same team can be assigned to multiple workspaces. - A team can be assigned to a workspace only if the team is not already assigned to another workspace. -After creating a Workspace, of your next steps is to resource that Workspace. Like a shared drive (or or shared collection of files). Workspaces are your Google Drive, while Meshery Designs are your Google Docs. +After creating a Workspace, one of your next steps is to resource that Workspace. Like a shared drive (or shared collection of files). Workspaces are your Google Drive, while Meshery Designs are your Google Docs. ### Workspace Deletion Behavior @@ -58,8 +58,8 @@ Assign any number of Environments to one or more Workspaces. See [Environments]( ### Designs - Infrastructure Designs are essential for creating reusable deployment templates. Users belonging to teams with access to a workspace can utilize these designs to deploy resources in the Kubernetes clusters associated with that workspace. -- Like a shared drive (or or shared collection of files), Workspaces are your Google Drive, while Meshery Designs are your Google Docs. -- One ore more designs can be assigned to a workspace. +- Like a shared drive (or shared collection of files), Workspaces are your Google Drive, while Meshery Designs are your Google Docs. +- One or more designs can be assigned to a workspace. - Same design can be assigned to multiple workspaces. {{< alert type="info" title="Design Ownership in Workspaces" >}} @@ -68,7 +68,7 @@ Designs belong to only one Workspace at any given time. See [Meshery Designs](ht ### Teams - A Workspace is closely associated with Teams in Meshery. Teams are groups of users with varying permissions, and they are at the center of resource access and management within a Workspace. -- One ore more teams can be assigned to a workspace. +- One or more teams can be assigned to a workspace. - Same team can be assigned to multiple workspaces. {{< alert type="info" title="Team Access Control in Workspaces" >}} From db1da44cce13f7d8f5817fc943bc937aff0bc8a3 Mon Sep 17 00:00:00 2001 From: Zihan Kuang Date: Mon, 28 Apr 2025 20:03:29 +0200 Subject: [PATCH 3/9] Update Signed-off-by: Zihan Kuang --- content/en/cloud/spaces/workspaces.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/content/en/cloud/spaces/workspaces.md b/content/en/cloud/spaces/workspaces.md index e6bdd268..d48b1b84 100644 --- a/content/en/cloud/spaces/workspaces.md +++ b/content/en/cloud/spaces/workspaces.md @@ -13,11 +13,11 @@ You can create Workspaces to group related Designs and Environments, define doma ## Key Features -- **Resource Sharing** Workspaces allow for seamless resource sharing among team members, fostering collaboration. -- **Logical Grouping** Within Workspaces, you can group related components such as environments and infrastructure designs. -- **Flexibility**: Workspaces support various resources like Kubernetes, Prometheus, Jaeger, Nginx, and more. -- **Simplified Management** Managing and deploying resources is made easy within Workspaces. -- **Access Control** Workspaces allow you to control access to resources by granting permissions to users and teams. +- **Resource Sharing:** Workspaces allow for seamless resource sharing among team members, fostering collaboration. +- **Logical Grouping:** Within Workspaces, you can group related components such as environments and infrastructure designs. +- **Flexibility:** Workspaces support various resources like Kubernetes, Prometheus, Jaeger, Nginx, and more. +- **Simplified Management:** Managing and deploying resources is made easy within Workspaces. +- **Access Control:** Workspaces allow you to control access to resources by granting permissions to users and teams. ### Workspace Relationships and Restrictions @@ -32,12 +32,11 @@ After creating a Workspace, one of your next steps is to resource that Workspace ### Workspace Deletion Behavior -When a Workspace is deleted, Meshery follows a non-destructive deletion strategy to preserve important data: +When a Workspace is deleted: -- The Workspace itself is **soft-deleted** by setting a `deleted_at` timestamp. It is no longer active but still exists in the database for auditing purposes. -- **Associated mappings** between the Workspace and its Environments, Designs, Teams, and Views are also soft-deleted. -- **Environments, Designs, Teams, and Views themselves are not deleted**. They remain available and can be reassigned to other Workspaces if needed. -- Users will see the previously associated resources listed as available again, ready for new associations. +- Deletion is **permanent and irreversible**. Proceed with caution. +- Associated mappings between the Workspace and its Environments, Designs, Teams, and Views are detached. +- **Environments, Designs, Teams, and Views themselves are not deleted**; they remain available for reassignment to other Workspaces if needed[^1]. {{< alert type="info" title="What Happens When a Workspace is Deleted?" >}} Deleting a Workspace only removes the relationships between the Workspace and its associated resources. It does not delete the resources themselves. @@ -93,4 +92,6 @@ 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. \ No newline at end of file +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]: In future releases, workspace deletion will cascade to associated designs, views, and filters. Users will be notified and offered an option to transfer these resources to another workspace prior to deletion. \ No newline at end of file From e1b0e183c35f9bd56910b84d4713c0c5ddf7bee7 Mon Sep 17 00:00:00 2001 From: Zihan Kuang <127078886+zihanKuang@users.noreply.github.com> Date: Mon, 28 Apr 2025 20:11:18 +0200 Subject: [PATCH 4/9] Update content/en/cloud/spaces/workspaces.md Co-authored-by: Lee Calcote Signed-off-by: Zihan Kuang <127078886+zihanKuang@users.noreply.github.com> --- content/en/cloud/spaces/workspaces.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/cloud/spaces/workspaces.md b/content/en/cloud/spaces/workspaces.md index d48b1b84..8ad391a7 100644 --- a/content/en/cloud/spaces/workspaces.md +++ b/content/en/cloud/spaces/workspaces.md @@ -24,7 +24,7 @@ You can create Workspaces to group related Designs and Environments, define doma - Access to Workspaces may be granted to one or more teams. - As a point of collaboration to facilitate work, Workspaces may have zero or more Environments associated. - A Workspace is closely associated with Teams in Meshery. Teams are groups of users with varying permissions, and they are at the center of resource access and management within a Workspace. -- One or more teams can be assigned to a workspace. +- One or more teams can be assigned access to a workspace. - Same team can be assigned to multiple workspaces. - A team can be assigned to a workspace only if the team is not already assigned to another workspace. From 704600fe56258b4ca0ac203dd2bb36ff7c5ce34a Mon Sep 17 00:00:00 2001 From: Zihan Kuang <127078886+zihanKuang@users.noreply.github.com> Date: Mon, 28 Apr 2025 20:14:07 +0200 Subject: [PATCH 5/9] Update content/en/cloud/spaces/workspaces.md Co-authored-by: Lee Calcote Signed-off-by: Zihan Kuang <127078886+zihanKuang@users.noreply.github.com> --- content/en/cloud/spaces/workspaces.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/content/en/cloud/spaces/workspaces.md b/content/en/cloud/spaces/workspaces.md index 8ad391a7..859c49fa 100644 --- a/content/en/cloud/spaces/workspaces.md +++ b/content/en/cloud/spaces/workspaces.md @@ -25,8 +25,6 @@ You can create Workspaces to group related Designs and Environments, define doma - As a point of collaboration to facilitate work, Workspaces may have zero or more Environments associated. - A Workspace is closely associated with Teams in Meshery. Teams are groups of users with varying permissions, and they are at the center of resource access and management within a Workspace. - One or more teams can be assigned access to a workspace. -- Same team can be assigned to multiple workspaces. -- A team can be assigned to a workspace only if the team is not already assigned to another workspace. After creating a Workspace, one of your next steps is to resource that Workspace. Like a shared drive (or shared collection of files). Workspaces are your Google Drive, while Meshery Designs are your Google Docs. From e5b0dcbfa36a55b37383365021c5920e2ae4a6f5 Mon Sep 17 00:00:00 2001 From: Zihan Kuang <127078886+zihanKuang@users.noreply.github.com> Date: Mon, 28 Apr 2025 20:19:39 +0200 Subject: [PATCH 6/9] Update content/en/cloud/spaces/workspaces.md Co-authored-by: Lee Calcote Signed-off-by: Zihan Kuang <127078886+zihanKuang@users.noreply.github.com> --- content/en/cloud/spaces/workspaces.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/cloud/spaces/workspaces.md b/content/en/cloud/spaces/workspaces.md index 859c49fa..abe991c3 100644 --- a/content/en/cloud/spaces/workspaces.md +++ b/content/en/cloud/spaces/workspaces.md @@ -33,7 +33,7 @@ After creating a Workspace, one of your next steps is to resource that Workspace When a Workspace is deleted: - Deletion is **permanent and irreversible**. Proceed with caution. -- Associated mappings between the Workspace and its Environments, Designs, Teams, and Views are detached. +- Any associated Teams or Environments with the Workspace are detached. - **Environments, Designs, Teams, and Views themselves are not deleted**; they remain available for reassignment to other Workspaces if needed[^1]. {{< alert type="info" title="What Happens When a Workspace is Deleted?" >}} From 6d2fe7f08e1ef06fd1bae89322eb1337f971bb42 Mon Sep 17 00:00:00 2001 From: Zihan Kuang <127078886+zihanKuang@users.noreply.github.com> Date: Mon, 28 Apr 2025 20:19:45 +0200 Subject: [PATCH 7/9] Update content/en/cloud/spaces/workspaces.md Co-authored-by: Lee Calcote Signed-off-by: Zihan Kuang <127078886+zihanKuang@users.noreply.github.com> --- content/en/cloud/spaces/workspaces.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/en/cloud/spaces/workspaces.md b/content/en/cloud/spaces/workspaces.md index abe991c3..7fb5f0ba 100644 --- a/content/en/cloud/spaces/workspaces.md +++ b/content/en/cloud/spaces/workspaces.md @@ -26,7 +26,9 @@ You can create Workspaces to group related Designs and Environments, define doma - A Workspace is closely associated with Teams in Meshery. Teams are groups of users with varying permissions, and they are at the center of resource access and management within a Workspace. - One or more teams can be assigned access to a workspace. -After creating a Workspace, one of your next steps is to resource that Workspace. Like a shared drive (or shared collection of files). Workspaces are your Google Drive, while Meshery Designs are your Google Docs. +After creating a Workspace, one of your next steps is to assign team access, create or transfer designs into the Workspace, and allocate resources that to Workspace by associating it with one or more Environments, therein making the Environment's connections available to users of the Workspace. + +Like a shared drive (or shared collection of files), Workspaces are your Google Drive, while Meshery Designs are your Google Docs. ### Workspace Deletion Behavior From cd03032710197adf770cea8f16d40d688a25698a Mon Sep 17 00:00:00 2001 From: Zihan Kuang Date: Mon, 28 Apr 2025 20:53:15 +0200 Subject: [PATCH 8/9] Update Signed-off-by: Zihan Kuang --- content/en/cloud/spaces/workspaces.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/en/cloud/spaces/workspaces.md b/content/en/cloud/spaces/workspaces.md index 7fb5f0ba..49a6884f 100644 --- a/content/en/cloud/spaces/workspaces.md +++ b/content/en/cloud/spaces/workspaces.md @@ -36,10 +36,10 @@ When a Workspace is deleted: - Deletion is **permanent and irreversible**. Proceed with caution. - Any associated Teams or Environments with the Workspace are detached. -- **Environments, Designs, Teams, and Views themselves are not deleted**; they remain available for reassignment to other Workspaces if needed[^1]. +- All associated Designs will be permanently deleted along with the Workspace[^1]. {{< alert type="info" title="What Happens When a Workspace is Deleted?" >}} -Deleting a Workspace only removes the relationships between the Workspace and its associated resources. It does not delete the resources themselves. +Deleting a Workspace will permanently remove the Workspace itself and its associated Designs. Teams and Environments will remain intact but will no longer be associated with the deleted Workspace. {{< /alert >}} ## Key Workspace Components @@ -94,4 +94,4 @@ To make the most of Meshery Workspaces, here are some best practices: 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]: In future releases, workspace deletion will cascade to associated designs, views, and filters. Users will be notified and offered an option to transfer these resources to another workspace prior to deletion. \ No newline at end of file +[^1]: This functionality is not fully implemented yet. Users might occasionally observe that Designs are preserved after Workspace deletion. \ No newline at end of file From c31470bdbf42b959b8ea9412a0c4b5189f33c6bb Mon Sep 17 00:00:00 2001 From: Zihan Kuang Date: Mon, 28 Apr 2025 20:57:30 +0200 Subject: [PATCH 9/9] Update Signed-off-by: Zihan Kuang --- content/en/cloud/spaces/workspaces.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/content/en/cloud/spaces/workspaces.md b/content/en/cloud/spaces/workspaces.md index 49a6884f..adba705b 100644 --- a/content/en/cloud/spaces/workspaces.md +++ b/content/en/cloud/spaces/workspaces.md @@ -35,11 +35,12 @@ Like a shared drive (or shared collection of files), Workspaces are your Google When a Workspace is deleted: - Deletion is **permanent and irreversible**. Proceed with caution. -- Any associated Teams or Environments with the Workspace are detached. -- All associated Designs will be permanently deleted along with the Workspace[^1]. +- 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. Teams and Environments will remain intact but will no longer be associated with the deleted Workspace. +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 @@ -59,7 +60,7 @@ Assign any number of Environments to one or more Workspaces. See [Environments]( - Infrastructure Designs are essential for creating reusable deployment templates. Users belonging to teams with access to a workspace can utilize these designs to deploy resources in the Kubernetes clusters associated with that workspace. - Like a shared drive (or shared collection of files), Workspaces are your Google Drive, while Meshery Designs are your Google Docs. - One or more designs can be assigned to a workspace. -- Same design can be assigned to multiple workspaces. +- The Same design can be assigned to multiple workspaces. {{< alert type="info" title="Design Ownership in Workspaces" >}} Designs belong to only one Workspace at any given time. See [Meshery Designs](https://docs.meshery.io/concepts/designs) section for more information. @@ -94,4 +95,4 @@ To make the most of Meshery Workspaces, here are some best practices: 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 are preserved after Workspace deletion. \ No newline at end of file +[^1]: This functionality is not fully implemented yet. Users might occasionally observe that designs and views are preserved after Workspace deletion. \ No newline at end of file