Skip to main content
Version: 1.0

Prerequisites

This page details the prerequisites you need in place before and after install in order for Wayfinder to run successfully.

Summary of prerequisites

Tools on your workstation:

Pre-install:

Post-install:

Cloud access for install

Wayfinder is installed into a cloud account that you have access to. See the instructions below for the cloud you want to install Wayfinder in.

AWS

Follow these steps to configure your console for access to an AWS Account using the aws tool:

  1. Install the AWS CLI
  2. Configure AWS Profile

Azure

Set up access to an Azure Subscription in your console using the az tool:

  1. Install the Azure CLI.
  2. Sign in with Azure CLI.

GCP

The gcloud tool is part of the GCP SDK and is required for console access to a GCP project:

  1. Install gcloud CLI (SDK)
  2. Authorizing gcloud CLI (SDK)

Access to create public DNS records

Wayfinder is required to be installed securely with valid DNS records that can be trusted for secure web access (HTTPS).

Two DNS names in the same DNS zone are required for a Wayfinder install, for example:

  • api.wayfinder.myorg.com (Wayfinder API)
  • portal.wayfinder.myorg.com (Web UI)

You can use any public-facing DNS zone for these records.

The Wayfinder install reserves public IP addresses with your cloud provider during install and waits for these names to resolve before continuing.

Identity provider

Wayfinder uses your existing identity provider to grant access to the UI, CLI, and the infrastructure provisioned for team workspaces.

Wayfinder uses Open ID Connect (OIDC) for integrating with identity providers, and you must provide the following details when installing Wayfinder:

  • Issuer URL
  • Client ID
  • Client Secret

The installer:

  • Requests all these values during install.
  • Provides you the call-back URL to complete OIDC setup during install.
  • Validates the issuer URL only during install.

See User authentication providers for more information and help setting up specific providers.

Cloud accounts

After successfully installing Wayfinder, but before using it, you must provide it with one or more cloud accounts that you want it to use. For more information, see Cloud Accounts.