Skip to main content

How to Manage A Workspace

What is this guide about?

Here are short guides on how to handle the most common tasks in a workspace.

Creating a Workspace​

Creating a Workspace as an Application Team​

Prerequisites:

  • Have a user account that can log into meshStack.
  • meshStack is configured to allow workspace creation for application teams via the UI.

Step by Step Guide:

  1. Start the wizard by selecting "Create Workspace" in the workspace drop-down in the top navigation bar.
  2. Fill in the required details such as name, identifier and tag information.
  3. Onboard the initial team members.
  4. Review the workspace details and confirm creation.

Creating a Workspace as an Administrator​

Prerequisites:

  • Have admin access to meshStack with organization admin permissions.

Step by Step Guide:

  1. Navigate to the admin area and select "Workspaces."
  2. Click on "Create Workspace."
  3. Fill in the required details such as name, ID, and tag information.
  4. Assign initial users and roles.
  5. Review the workspace details and confirm creation.

Deleting a Workspace​

A workspace can only be deleted once it's empty. If something is still in it, meshStack tells you what it is and you delete that first.

Emptying a workspace takes a while

Nothing in a workspace is gone the moment you delete it, so the workspace stays undeletable for as long as the clean-up runs:

  • A building block goes once its deletion run has succeeded. If the run failed, open the building block and retry or purge it.
  • A tenant or a project goes once your platform team has approved the deletion and the platforms have confirmed it. Ask your platform team about the status if it sits there.

Deleting a Workspace as an Application Team​

Prerequisites:

  • Have access to the workspace management area.
  • Have workspace owner permissions.
  • No remaining resources in the workspace: projects, tenants, building blocks and published service brokers.
  • No building block definitions owned by the workspace. Ask your platform team to delete them or to transfer their ownership to another workspace first.

Step by Step Guide:

  1. Navigate to the workspace management area.
  2. Under "Deletion", provide a reason for deletion and confirm.

Deleting a Workspace as an Administrator​

Prerequisites:

  • Have admin access to meshStack with organization admin permissions.
  • No remaining resources in the workspace: projects, tenants, building blocks and published service brokers.
  • No building block definitions owned by the workspace. Delete them or transfer their ownership to another workspace first; the deletion dialog lists the definitions the workspace still owns.

Step by Step Guide:

  1. Navigate to the admin area and select "Workspaces."
  2. In the drop-down for the workspace, select "Delete Workspace."
  3. Provide a reason for deletion and confirm.

Manage Workspace Tags​

Manage Workspace Tags as an Application Team​

Prerequisites:

  • Have access to the workspace management area.
  • Have workspace manager or owner permissions.

Step by Step Guide:

  1. Navigate to the workspace management area.
  2. Under "Settings," select "Tags."
  3. Add or edit tags as needed. Please be aware that some tags may be restricted to admin users only.
  4. Save changes to apply the tags to the workspace.

Manage Workspace Tags as an Administrator​

Prerequisites:

  • Have admin access to meshStack with organization admin permissions.

Step by Step Guide:

  1. Navigate to the admin area and select "Workspaces."
  2. In the drop-down for the workspace, select "Workspace Tags."
  3. Add or edit tags as needed.

Workspace User Management​

Info

Please be aware that one user can have multiple workspace role bindings. As the roles are hierarchical we recommend to only assign one role per user in a workspace to ease configuration of access.

User Management as an Application Team​

Prerequisites:

  • Have access to the workspace management area.
  • Have workspace manager or owner permissions.

Step by Step Guide:

You can find the workspace access management in the workspace management area under "Access Management." Select "Role Bindings."

  • To add users to a workspace, follow the guide How to Onboard Your Team.
  • To remove users, simply select their role binding and click "Remove."
  • To set an expiration date for a user, select a deprecation date on the user.
  • To change a user's role, choose a different role from the drop-down menu.
  • To add a workspace group, use the "meshWorkspaceUserGroup" resource in the API.

User Management as an Administrator​

Prerequisites:

  • Have admin access to meshStack with organization admin permissions.

Step by Step Guide:

  1. Navigate to the admin area and select "Workspaces."
  2. In the drop-down for the workspace, select "User & Groups."
  • To add users to a workspace, follow the guide How to Onboard Your Team.
  • To remove users, simply select their role binding and click "Remove."
  • To set an expiration date for a user, select a deprecation date on the user.
  • To change a user's role, choose a different role from the drop-down menu.
  • To add a workspace group, use the "meshWorkspaceUserGroup" resource in the API.