Everything you can do in Wayfinder is related to a specific workspace and your permissions within it. There are three different 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.
Manage workspaces in the CLI
The sections below show how to manage workspaces in the UI. Here are the CLI equivalents:
|Create a new workspace|
|List workspaces you have access to|
|List your default workspace|
|Set a default (active) workspace|
|Run a command on non-default workspace|
|Add a member to a workspace|
|Create another workspace role|
CLI commands apply to your default workspace unless you use the
-w flag to apply the command to a different workspace, provided you have the right permissions.
Suppose you have access to two workspaces. Your default workspace is
abc, and you want to create a cluster called
qa on workspace
wf create cluster qa -w xyz
For more information, see Using the CLI.
Create a new 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 Add or invite workspace members.
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-NAME
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, navigate to your workspace overview page, and then click the Members tab.
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 tab.
Add members to a workspace
You can add existing Wayfinder users to a workspace.
To add members to a workspace:
- In the Wayfinder UI, navigate to your workspace overview page, then click the Members tab.
- 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.
wf create member
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, navigate to your workspace's overview page, and then click Settings.
- Enter the Email address, and then click Save.
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.
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.
- Optionally, create a cloud environment without creating a cluster from the workspace Overview page.
- 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.
Workspace admins are owners of a workspace. They are workspace members with additional privileges. As a workspace admin, you can:
- Promote workspace members to be workspace admins in the Wayfinder UI: Navigate to your workspace Overview page, click 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.