The Administration section explains the administrative features of Wayfinder that allow you to define what resources workspace members can use, which clouds they have access to, and more. If you are not a Wayfinder administrator, see the Developer Guide for information on how to use Wayfinder's developer features.
In order to administer Wayfinder, you must be in the
admin workspace. By default, the
first user added to Wayfinder is placed in this workspace, and that user can add administrative privileges to other users.
This topic lists some important activities you'll do as a Wayfinder administrator and points you to where you can find more information about them.
Log in to Wayfinder
You can log in using either the Wayfinder UI or CLI. To download the CLI, see Get the CLI for instructions.
For login instructions see:
Change your password
To change your password:
In the UI, click the user icon, and then select Change password.
Fill in the required fields, and then click Change password.
Quick start setup
When you log in as a Wayfinder admin, you're directed to the Quick start setup page. This gives you shortcuts to the most common tasks you'll do in Wayfinder, so you don't have to remember how to navigate to them.
See the sections below for more information.
Set up authentication
After installing Wayfinder, we recommend you set up an identity provider (IDP) for user authentication. See Authentication for instructions to configure three popular IDPs.
Connect your cloud accounts
You'll have to give Wayfinder access to one or more of your cloud accounts, and allocate the accounts to one or more workspaces in Wayfinder. Then workspace members will be able to self-serve to create environments for their applications.
For instructions, head to Cloud Accounts.
Define your environment stages
Stages are a way of grouping resources and expressing their environment or intent. For example, stages can specify whether a resource is associated to non-production or production. Internally, resources provisioned under these stages are labelled accordingly, and can be used when you apply a configuration such as policy, compliance, user permissions, costs, network peering, and more.
Stages are selectable by developers when they create a cluster.
For more information, see Stages.
Set guardrails with cluster plans
Wayfinder comes with default cluster plans for each cloud provider we support. The default cluster plans provide a set of preset Kubernetes cluster parameters based on whether the cluster will be used for development or production. With cluster plans, workspace members choose the plan they need, and create the cluster quickly without worrying about Kubernetes cluster settings. You can also create your own custom plans as needed.
For more information, see:
Create workspaces to isolate infrastructure
Wayfinder users can be added or invited to workspaces. Within a workspace, members can self-serve their infrastructure, for example create clusters.
For details on creating and managing workspaces, see Workspaces.
Set up networking/allocate network IP ranges
Wayfinder uses default IP ranges defined in cluster plans. However, you can control the IP address ranges used to build workspace clusters. For more information, see IP Management.
Manage self-service DNS zones
To make it convenient for developers to have available domains for their applications, you can create managed DNS zones. Then when a workspace member creates a cluster, DNS zones can be automatically created for that cluster, based on the managed DNS zones you created. Workspace members can also add their own custom domains for applications.
For more information and instructions, see DNS.
Set up cost reporting
Add and manage users
See User Management for details.
Configure single-sign-on (SSO)
If SSO with an identity provider (IDP) is not already set up, you can set it up. See User Authentication Providers. If you're not using SSO, want to add specific local users, or want to manage users via CI pipeline, see User Management.