Skip to main content
Version: 1.0

Workspaces

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.

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

Create a new workspace​

To create a new workspace:

  1. In the Wayfinder UI, click the down arrow on the workspace selector at the top of the page, and then click Add new workspace.

    Add new workspace

  2. Enter the following required 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
  3. Click Next.

    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.

CLI:

wf create workspace

Select 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.

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.

Select a workspace in the UI​

On first login​

When you first log into the Wayfinder UI, click Get started.

You'll be guided to select a workspace that you already belong to, or create a new one. If you don't see the workspace you're looking for, you can ask a member of that workspace to add you or send you an invite link. If you're creating a new workspace, you'll also be guided to (optionally) create a cluster for that workspace at the same time.

When using the Wayfinder UI, once you select a workspace, it will be your default workspace until you select another workspace in the UI.

Switch to another workspace after login​

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:

Workspaces tab

To switch to another workspace:

  1. 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.

Specify a workspace in the CLI​

When using the CLI, you can:

  • Set a default workspace—all your commands apply to this workspace. See Setting a default workspace.
  • Use the -t flag in commands to specify a workspace other than your default workspace, provided you have the right permission for the other workspace.

To specify a workspace other than your default workspace in the CLI:

  1. Use the -w flag to run a command for a workspace that is not your default workspace.

    For example, if your default workspace is rel, you can apply the command below to the qa-tm workspace:

    wf create cluster qa -w qa-tm

Invite or add workspace members​

Invite members​

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:

  1. In the Wayfinder UI, navigate to the Members page, and then 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 UI, navigate to Members > Add Wayfinder users now.
  2. Start typing the member's user ID in the Add field, and select the user.
  3. If you're a workspace admin, you must also select a workspace role for this user.
  4. Click Add to workspace.

CLI: wf create member

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:

  1. In the Wayfinder UI, navigate to the Workspace settings page.
  2. Enter the Email address, and then click Save.

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:

  1. In the Wayfinder UI, ensure the workspace you're deleting is selected at the top.
  2. Navigate to the Workspace settings page, 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.
  • 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 administrators​

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 Members > Add user type.
  • 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 member and admin. You can then use these roles when defining RBAC policies—see the CLI command wf create workspace-role.