Setup Guide (Platform 2.0 Beta)

Overview

Welcome to the Setup Guide. This document walks you through installing Fugue Platform 2.0 beta and includes the following details:

  • Prerequisites for setup
  • Permissions
  • Installation instructions

If you’re new to Platform 2.0 and want to review more about the beta and what is included with this release, check out the Getting Started page for details.

For configuration details, including how to uninstall, see Configuration (Platform 2.0 Beta).

Prerequisites

Platform 2.0 beta includes a relatively simple setup. There are two main components to install: the Fugue Platform CLI and the Fugue Conductor. This guide assumes you have already downloaded the Fugue Client Tools containing the CLI.

As a prerequisite, you’ll need IAM roles with access to the U.S. government partitions in both AWS and Azure. If you want to confirm the required permissions for each role, you can review those details here.

You must also have the AWS CLI and the Azure CLI installed to complete the Platform 2.0 beta installation process.

Note

Fugue Platform 2.0 beta is available to existing Fugue customers. If you’re not an existing customer and you’re interested in access to Fugue, contact us at sales@fugue.co.

Permissions

AWS

For AWS we recommend the use of an AWS profile with the AdministratorAccess policy to configure Fugue Platform 2.0 beta. Read more here about creating an admin user in AWS.

Azure

For Azure we also recommend configuring an administrative role. You can read more about creating an Administrative role in Azure here.

Installation

Azure Configuration

Before you begin you will need to ensure that you are logged in to Azure. Run the following commands to configure the Azure CLI:

az cloud set -n AzureUSGovernment
az login --use-device-code

Follow the associated prompts to complete the login process, and the terminal should display something like this:

{
  "environmentName": "AzureUSGovernment",
  "id": "<your-subscription-id>",
  "isDefault": true,
  "name": "<Name>",
  "state": "Enabled",
  "tenantId": "<your-tenant-id>",
  "user": {
    "name": "<your-user-name>",
    "type": "user"
  }
}

Note: If you encounter an error, you may be required to manually set your subscription id using az account set –subscription <your-subscription-id>.

Note: If you’re already logged in, you can run az account show to confirm the active subscription.

AWS Configuration

Fugue supports the following methods of AWS configuration:

  • AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY environment variables
  • AWS_PROFILE environment variable
  • A profile created by aws configure

For more information, see the AWS documentation.

Installing the Fugue Platform 2.0 Beta CLI

Now that you’ve configured the AWS and Azure CLIs, you can install the Fugue Platform 2.0 beta CLI.

This step of the setup is platform-specific, so find your operating system below:

Windows

Double-click the installer fugue2-client-<version>.msi and follow the prompts. (e.g., fugue2-client-0.64.7.799.msi)

Note that for the initial beta, the installer will place files at both C:\Program Files\Fugue and C:\Fugue.

macOS

Double-click the installer fugue2-client-<version>.pkg and follow the prompts. (e.g., fugue2-client-0.64.7-885.pkg)

Linux

Run the installer appropriate for your OS. (e.g., fugue2-client-0.64.7-885.el6.x86_64.rpm, fugue2-client-desktop-0.64.7-885.x86_64.rpm, or fugue2-client_0.64.7-885_amd64.deb)

RPM:

sudo rpm -ivh fugue2-client*.rpm

DEB:

sudo dpkg -i fugue2-client-*.deb

Configuring Settings

In Fugue Platform 2.0 beta, configuration information may be stored in the following ways:

  • In an optional fugue2.yaml field in the user’s home directory
  • In environment variables

To continue setting up Fugue Platform, you may choose either method:

  • Configure with fugue2.yaml
  • Configure with environment variables

Creating the `fugue2.yaml` Configuration File

Fugue Platform 2.0 beta’s fugue2.yaml configuration file is similar to Fugue Platform’s fugue.yaml file but contains different fields and is saved in a different place. You’ll also need to create fugue2.yaml manually.

In your home directory, create a folder named .fugue and create a file called fugue2.yaml. This should be the path for your operating system:

  • ~/.fugue/fugue2.yaml on macOS and Linux
  • %USERPROFILE%\.fugue\fugue2.yaml or %HOMEDRIVE%\%HOMEPATH%\.fugue\fugue2.yaml on Windows

Configuring `fugue2.yaml`

The fugue2.yaml file contains AWS and Azure settings. Here’s an example:

# Fugue Platform 2.0 beta config

aws-region: us-gov-west-1
aws-profile: mygovprofile

azure-location: usgovvirginia
azure-cloud: AzureUSGovernment
azure-subscription: e142a3cb-bfab-444f-a154-7f3b9example

You can download this file and use it for your own installation – just be sure to substitute your own azure_subscription.

For a list of field definitions, including the equivalent environment variables, see Configuration Options.

The next step is installing the Conductor, so you can jump ahead to continue. Or, read the next section for details about environment variables.

Configuring Environment Variables

In Platform 2.0 beta, you may omit fugue2.yaml and configure settings via environment variables.

If you’ve configured the AWS and Azure CLIs already, you may not need to set any environment variables at all.

The CLI honors these settings:

  • FUGUE_AWS_REGION
  • FUGUE_AWS_PROFILE
  • FUGUE_AZURE_LOCATION
  • FUGUE_AZURE_CLOUD
  • FUGUE_AZURE_SUBSCRIPTION

For a table with definitions, examples, and fugue2.yaml equivalents, see Configuration Options.

Then, set your environment variables like this:

export FUGUE_AWS_PROFILE=mygovprofile

Installing the Conductor

Now that you’ve configured your settings, it’s time to install the Conductor. The install command installs the Fugue Platform 2.0 beta Conductor in your AWS and Azure accounts and boots up Fugue:

fugue2 install

The CLI will prompt you to confirm your AWS credentials:

[ fugue install ] Installing Fugue Platform

Checking for AWS access ...
{
    "UserId": "AIDALEBVXDKV3NEXAMPLE",
    "Account": "123456789012",
    "Arn": "arn:aws-us-gov:iam::123456789012:user/docs-team"
}
Are these AWS credentials correct for us-gov-west-1? [y/N]

Then, the CLI prompts you to confirm your Azure credentials:

Checking for Azure access ...
{
  "environmentName": "AzureUSGovernment",
  "id": "bf980d0c-5671-4b82-b969-000000000000",
  "isDefault": true,
  "name": "Ludwig van Beethoven",
  "state": "Enabled",
  "tenantId": "2fcac661-7c30-47c5-9161-000000000000",
  "user": {
    "name": "username@email.com",
    "type": "user"
  }
}
Do these Azure credentials look correct? [y/N] y

Once you’ve confirmed your credentials, the CLI deploys the Conductor’s infrastructure into your AWS and Azure accounts. This part takes just a few minutes for the resources to spin up.

Finally, the CLI creates the root Fugue user credentials in the fugue2-credentials.yaml file, located in ~/.fugue on macOS and Linux or %USERPROFILE%\.fugue or %HOMEDRIVE%\%HOMEPATH%\.fugue on Windows.

When the installation has successfully completed, the CLI outputs a success message:

Generating credentials ...
[ fugue install ] Fugue Platform install complete

That’s it! Platform 2.0 beta is ready for you to use.

What’s Next?

Once you’ve completed your installation, take a look at the CLI Guide to learn more about the commands. You can also check out Configuration or Best Practices & Troubleshooting if you have questions about other configuration details. Otherwise you can always reach out to support@fugue.co for questions about any information you don’t see included in the documentation.