Skip to main content

Installing Wayfinder

Note

If you have already installed and are upgrading Wayfinder see Upgrade.

The installation process#

caution

Wayfinder runs on Windows, however, the installer is currently supported only for Unix and Linux systems. Please contact us on Slack for help using the installer on windows.

The Wayfinder installer is built into the Wayfinder CLI, and configures the Wayfinder server and all its dependencies in a cluster in your cloud provider.

The installation procedure has two stages:

1. Interactive stage

  • Requests and validates all options
  • Creates ingress IPs required for valid DNS

This stage creates two files in your install directory, which contain the values you choose in response to prompts:

wf-install.yaml wf-install-secrets.yaml

If you want to automate installation, you can run the interactive stage alone, and use these generated files to do the automated installs. For details, see Prepare for an automated install and Use non-interactive install in your automation below.

2. Non-interactive stage

Installs Wayfinder and all dependencies, including:

  • Cloud Networking
  • Cloud Kubernetes
  • TLS Certificates
  • Ingress

Licensing#

During the interactive stage of the installer, there are three possibilities for licensing:

  • The installer detects an existing license key, and you confirm you want to use it.
  • The installer detects an existing license key, and you want to use a different one. You are prompted to paste in the license key.
  • There are no existing licenses, and you request a new one. The new license key unlocks a trial version. When it expires, you can contact Appvia to get a full license.

Install Wayfinder#

This procedure does a complete installation of Wayfinder. For detailed options see wf install.

Important

Review the Prerequisites before installing Wayfinder.

To install Wayfinder:

  1. Ensure you are logged in to the cloud provider in which you want to install Wayfinder.

  2. Create a directory, for example wf-install, for Wayfinder to create install files:

    mkdir wf-installcd wf-install
  3. Run the installer:

    wf install

    In the first stage, the installer prompts you for all configuration options, and then the second stage completes the installation. The second stage can take between 10 and 40 minutes depending on your cloud provider.

  4. Important: If this is a re-install, you must follow the procedure in Update Wayfinder's cloud access.

Prepare for an automated install#

This procedure runs the first, interactive, stage of the installer only. This generates two files needed to do an automated/non-interactive install using your automation script.

For detailed options, see wf install.

To prepare files for an automated install:

  1. Run the first stage of the installer only:

    wf install --init-only

    You are prompted for all configuration options. At the end of this stage, two files are created:

    • wf-install.yaml—you can commit this into a source control system.
    • wf-install-secrets.yaml—do NOT commit this to source control. Instead, ensure this file is encrypted or provided from a secrets management system.

    To automate your installs, you can use these files in your automation using the non-interactive install procedure below.

Use non-interactive install in your automation#

The non-interactive install is appropriate for use in your automated installs. The non-interactive install does a complete installation and takes between 10 and 40 minutes depending on cloud vendor.

For detailed options see wf install.

To run a non-interactive install:

  1. Ensure you have these files in your current directory:

    wf-install.yaml
    wf-install-secrets.yaml

    See Prepare for an automated install above.

  2. Use this command in your automation script to run the installer with no prompts:

    wf install --non-interactive

Set up cloud accounts for Wayfinder#

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.

Troubleshooting#

Issues with cert-manager#

Assuming you have not used the --api-tls-private-key-pem or --ui-tls-private-key-pem during the wf install installation, the Wayfinder install uses cert-manager which can encounter errors while requesting a certificate. You can check the status of the request by looking at the certificate object in the wayfinder namespace, i.e., kubectl -n wayfinder get certificate. Occasionally cert-manager can get into an exponential backoff; fixing this can be achieved quickly by deleting the certificate request with a False status and then re-running the wf install.

Last updated on Jan 19, 2022