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/administer.
When you first log in to the Wayfinder UI and click Get started, 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.
See the workspace Overview page for shortcuts to some of the most common activities you'll want to do.
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:
|Create a new workspace|
|List workspaces you have access to|
|Delete a workspace|
|Set a default (active) workspace|
|List your default workspace|
|Run a command on non-default workspace|
|Add a member to a workspace|
|Create another workspace role|
Note the following:
Every workspace has a 3 - 5 character
KEYthat 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-KEYflag to apply the command to a different workspace, provided you have the right permissions.
If your default workspace is
abc, and you want to create a cluster called on workspace
wf create cluster qa -w xyz
For more information, see Using the CLI.
Create or delete a workspace
Create a workspace
Generally, a workspace owner/administrator creates a workspace and invites or adds other workspace members to it. But anyone can create a workspace to provision infrastructure for testing or other purposes.
To create a new workspace:
In the Wayfinder UI, click the down arrow on the workspace selector at the top of the page, and then click Add new workspace.
Enter the following information:
- Workspace name - A user friendly name of your choice
- Workspace Key - This identifier for the workspace must begin with a letter and contain 3-5 lowercase alphanumeric characters. You must use this key when specifying the workspace in CLI commands.
- Workspace description
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.
Delete a workspace
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 UI, ensure the workspace you're deleting is selected at the top.
- Navigate to your workspace's overview page, click Settings, and then click Delete workspace.
wf delete workspace WORKSPACE-KEY
Switch to another workspace after login
You can select or specify a workspace in either the Wayfinder UI or CLI. By doing so, your actions in the UI or CLI apply to that workspace.
You may be part of more than one workspace in Wayfinder. The currently selected workspace is shown in the UI at the top. For example, ggq is the currently selected workspace below:
To switch to another workspace:
- Click the arrow in the current workspace, and then either scroll to select the workspace you want, or start typing the workspace name in the search box to select it, as shown above.
wf use workspace WORKSPACE-KEY
Invite or add workspace members
Workspaces have two default workspace roles: member and admin. Workspace admins 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.
You can use a workspace invite link from the Wayfinder UI 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:
In the Wayfinder UI, select your workspace, and then navigate to User access > Members.
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:
- In the Wayfinder UI, select your workspace, and then navigate to User access > Members.
- In Add Wayfinder users now start typing the member's user ID, and select the user.
- If you're a workspace admin, you must also Select user type for this user.
- Click Add to workspace.
Create more workspace roles
The default workspace roles are member and admin. As a Workspace admin, you can create more roles as needed to help constrain your access policies.
To create a workspace role:
Run the CLI command: wf create workspace-role
wf create workspace-role tester
Set an email address for certificate notifications
You must specify an email address in order for your workspace clusters to be configured with TLS certificates. This email address is used by certificate issuers to send notifications to your workspace.
To specify the workspace email address:
- In the Wayfinder UI, select your workspace, and then click Settings.
- Enter the Email address, and then click Save.
Once you're in a workspace
Here are some of the things you can do once you're in a workspace.
- Configure a profile for your workspace to access an environment with the CLI—see
wf profile configure.
- Create a cluster and namespace—see Clusters and Namespaces.
- Wayfinder creates domains for you automatically when you create a cluster, but if desired, you can create a custom cluster DNS zone for your app—see DNS .
- Set up ingress and network policies for workspace apps—see Exposing your Applicatins via Ingress.
- Create robots for builds or deployments with your CI system—see Robots.
- View costs for your workspace's cloud infrastructure—see Costs.
- Share clusters in your workspace with one or more other workspaces—see Multi-Tenancy.
Workspace admins are owners of a workspace. They are workspace members with the additional privileges below. As a workspace admin, you can:
- Promote workspace members to be workspace admins in the Wayfinder UI: Navigate to your workspace, and then navigate to User access > Members > USERNAME > Add workspace role.
- Administer your workspace's role-based access (RBAC) by creating policies for how members can assume roles, or assign them to robots—see the RBAC section.
- Create more workspace roles as needed, in addition to
admin. You can then use these roles when defining RBAC policies.