Workspaces

A workspace is a way to group users and cloud infrastructure so that only members of a workspace have access to the infrastructure associated with that workspace. Within a workspace, members may have different access permissions to that infrastructure depending on the policies in place.

The Wayfinder administrator can assign cluster plans, cloud accounts, and cloud infrastructure like DNS zones and network peering rules to specific workspaces or to all of them. This lets workspace members easily self-serve infrastructure as needed.

Everything you can do in Wayfinder is related to a specific workspace and your permissions within it. There are three ways to become a member of a workspace:

• You're added by another workspace member.
• You're sent an invite link.
• You create a workspace, which you own and maintain.

When you first log in to the Wayfinder's web interface you're directed to the workspaces page. This displays all the workspaces you have access to, and lets you create a new workspace if needed.

CLI quick reference for workspaces

This page shows how to manage workspaces, generally using the UI. Here is a quick reference to the equivalent CLI commands:

Task	Command
Create a new workspace	wf create workspace WORKSPACE-KEY
List workspaces you have access to	wf get workspaces
Delete a workspace	wf delete workspace WORKSPACE-KEY
Set a default (active) workspace	wf use workspace WORKSPACE-KEY
List your default workspace	wf profiles list
Run a command on non-default workspace	wf COMMAND -w WORKSPACE-KEY
Add a member to a workspace	wf create member -u USERNAME
Create a workspace user group	wf create workspace-role ROLE-NAME

Note the following:

• Every workspace has a 3 - 5 character KEY that is its unique identifier. Use this key in the related CLI commmands above. To list workspaces and their keys, run wf get workspaces.
• CLI commands apply to your default workspace unless you use the -w WORKSPACE-KEY flag to apply the command to a different workspace, provided you have the right permissions.

Example:

If your default workspace is abc, and you want to create a cluster called qa on workspace xyz:

wf create cluster qa -w xyz

For more information, see Using the CLI.

Create or delete a workspace

Create a workspace

A workspace owner creates a workspace and invites or adds other workspace members to it.

To create a new workspace:

1. In the Wayfinder's web interface, click on Settings, and then navigate to Isolation & Boundaries > Workspaces. Click the Create workspace button and enter the details.

Your workspace is created. You can optionally add or invite users to the workspace at this point, or do so separately. See Invite or add workspace members.

CLI:

wf create workspace WORKSPACE-KEY --summary=WORKSPACE-NAME

Delete a workspace

caution

This operation cannot be undone.

Before deleting a workspace, be sure that you have deleted everything created for that workspace in Wayfinder.

To delete a workspace:

In the Wayfinder's web interface, click on Settings, and then navigate to Isolation & Boundaries > Workspaces. Select More options(represented as three horizontal dots) and select Delete Workspace.

CLI:

wf delete workspace WORKSPACE-KEY

Switch to another workspace after login

You can select or specify a workspace in either Wayfinder's web interface or CLI. By doing so, your actions apply to that workspace.

You may be part of more than one workspace in Wayfinder.

To switch to another workspace:

• Wayfinder's web interface: Use the drop-dow menu located below Workspaces in the left-hand navigation.

• CLI: wf use workspace WORKSPACE-KEY

Invite or add workspace members

Workspaces have two default workspace roles: member and owner. Workspace owners can create more workspace roles as needed to set access permissions for various Wayfinder resources. For information on what the default workspace roles can do, see Users and privileges.

Invite members

You can use a workspace invite link from the Wayfinder's web interface for users who haven't logged into Wayfinder before. This link invites them to use Wayfinder and makes them a member of a specific workspace. You can also invite existing Wayfinder users to a workspace.

To invite members to a workspace:

1. In the Wayfinder web interface, select Workspaces > Your workspace name, then navigate to Workspace Settings > Users

2. Copy and share the Invite link.

   The member you're inviting can use the link to automatically select that workspace upon login to the UI, and then the member's user ID is added to the Members page.

Add members to a workspace

You can add existing Wayfinder users to a workspace.

To add members to a workspace:

1. In the Wayfinder web interface, select Workspaces > Your workspace name, then navigate to Workspace Settings > Users
2. Under Add existing Wayfinder users, select the user and their group privileges.

CLI: wf create member -u USERNAME

Create a workspace user group

A user group is a convenient way to associate a set of users to roles and access policies. You can create groups specific to your workspace and associate them to the access policies you require.

Wayfinder comes with two default user groups that appear in all workspaces:

• owner
• member

Each default group is associated with an access policy, so that users in each group have a set of permissions and access controls associated with that group. For example, users in the owner group in a workspace have more access than users in the member group. Your Wayfinder administrator may also add more default user groups that appear in your workspace.

Workspaces can add users to default groups as needed, but cannot change the group's default access policy. However, you can create a new access policy, and apply it to a default group in your workspace.

To create a workspace group:

1. In the Wayfinder web interface, select Workspaces > Your workspace name, then navigate to Workspace Settings > Groups
2. Click on the Create Group button and fill in the details.

Edit or delete a group

To edit or delete a group:

1. In the Wayfinder web interface, select Workspaces > Your workspace name, then navigate to Workspace Settings > Groups
2. Expand the group you want.
3. Click the Actions tab, and then click either the Edit or Delete buttons.

Once you're in a workspace

Here are some of the things you can do once you're in a workspace.

Workspace Members

• Create applications and deploy them to your chosen environment

Workspace Owners

Workspace owners are workspace members with the additional privileges below. As a workspace owner, you can:

• Add or invite users to your workspace and assign then to the appropriate groups along with the privileges that the group entails.
• Administer your workspace's role-based access (RBAC) by creating policies for how members can assume roles—see the RBAC section.
• Create more roles as needed, in addition to member and owner. You can then use these roles when defining RBAC policies.
• View live sessions
• View and create workspace access tokens.