Fugue Setup through AWS Marketplace¶
If you’re an AWS Marketplace user the Fugue setup process is managed in two parts.
First, you will complete a series of steps through the AWS Marketplace. These are provided in an overview below. Next, you’ll walk through a series of steps provided by Fugue to complete your installation and setup.
If you’re not an AWS Marketplace user and need instructions on completing a Fugue install from scratch, jump over to the Fugue Quick Setup page.
AWS Marketplace Installation Steps¶
The AWS Marketplace portion of the Fugue installation creates a Fugue Conductor on an EC2 instance
1. Visit the AWS Marketplace page for Fugue.
2. Accept the license.
3. Review the details under Launch Options that are required for the CloudFormation install.
Note: Be sure to remember the region you specify when you install CloudFormation. You will need this information later to initialize your project.
4. Important - Under the “Specify Details” section update the
stack name to
fugue (this is case sensitive).
You must specify fugue as the stackname during the AWS Marketplace installation process. If you do not populate this field correctly it will result in a failed installation that still incurs AWS costs. If you require assistance reach out to us at firstname.lastname@example.org.
5. Complete the Options, review your settings (Template, Details, Options) on the final page, and click “Create”.
Note: This completes the AWS Marketplace website portion of the installation.
Fugue Installation Steps¶
- macOS El Capitan (10.11.*), macOS Sierra (10.12.*), macOS High Sierra (10.13.*)
- Ubuntu (14.04 LTS, 16.04 LTS)
- Amazon Linux (2016.03.3)
- RHEL 6 & 7.2 (Yum/RPM)
- Microsoft Windows (Windows 7, 10) Note: For Windows users we
recommend using PowerShell 5 and
$env:varsyntax. To determine your version of PowerShell you can use
echo $PSVersionTable.PSVersion. If you have additional questions reach out to email@example.com.
Install Client Tools¶
After selecting the client package for the platform you’re working on, installation should be easy to follow. Instructions based on package type are included here. This installation step provides the CLI for Fugue.
These instructions use a wildcard filename for the package names. This works fine as long as you only have one matching file in the present directory. In addition, we recommend verifying that your version of Fugue meets the needs of your business, or reach out to firstname.lastname@example.org for details on a potential upgrade. The latest version of Fugue is available through our Download Portal.
Note: Client packages, with the exception of RHEL 6, now include Fugue Composer. Refer to the Composer docs for additional details.
For Linux RPM (without Composer):
$ sudo rpm -ivh fugue-client*.rpm
For Linux RPM (including Composer):
$ sudo rpm -Uvh https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm $ sudo yum localinstall fugue-client-desktop-*.rpm
For Linux DEB (without Composer):
$ sudo dpkg -i fugue-client-*.deb
For Linux DEB (including Composer):
$ sudo dpkg -i fugue-client_*.deb $ sudo apt-get install -f
For macOS PKG:
Double-click on the PKG file and follow the installation wizard.
For Windows MSI:
Double-click on the .MSI file and follow the installation wizard.
Configure AWS Credentials¶
This guide assumes you are running the Fugue CLI on a local machine. You can also easily run the Fugue CLI on an EC2 instance. If you choose to run the instance with a sufficiently privileged IAM role, you can skip this step.
Before you begin working with Fugue, you’ll need to set up AWS credentials on the client machine. This step ensures that Fugue is using the right credentials when interacting with AWS. The best way to do this is simply to use the AWS CLI’s
aws configure command. Here’s a quick guide on getting set up with the AWS CLI, and then how to use it to configure AWS credentials for your machine.
The Fugue CLI does not support the use of AWS root account credentials. For details, see the explanation here.
Fugue generates IAM policies and roles for you during the
install process. For more information, see AWS Permissions and the Fugue CLI.
The credentials should be associated with the AWS account you installed the Conductor in.
Initialize a Project¶
Fugue work is done in project directories. This makes Fugue projects
easy to work on in version control systems. The project settings are
saved in a
fugue.yaml file that includes the AMI ID of the
Conductor, the Conductor installation region, and the name of the AWS
credentials profile to use for commands, if the
default profile is
not used. You may optionally customize your
fugue.yaml with many
more technical and advanced settings. All of this is set up using the
fugue init command, and you can read more about
init in the Fugue CLI Reference.
Note: Your AWS credentials are not checked in to version control.
Once you’ve made a directory for your Fugue project and made it your present working directory, you’re ready to initialize. Just make sure you select the same region you specified during the AWS Marketplace installation process.
Fugue is currently supported in:
$ fugue init <region>
Optionally, you can specify an AWS credential profile to use. This is
only necessary if you used the
--profile flag when you ran
aws configure. If you didn’t, you set credentials for the
default profile, and that is the profile Fugue commands will use. If
you did set a certain profile name,
fugue init conveniently uses the
same flag to define the profile for Fugue commands:
$ fugue init --profile [PROFILE] <region>
Make sure the credential profile is associated with the AWS account the Conductor is installed in.
If you run
ls, you should now see a file called
fugue.yaml file maintains the settings for the Fugue initialization
process and guides the Fugue CLI through its various operations.
Note that one field in
ami field in the
conductor block, will not match the AMI of the Conductor currently
installed in your AWS account. This is expected. If you have any
questions, reach out to email@example.com for assistance.
See Project Setup
Options for more
information about the fields in
fugue.yaml and how to customize
Reset your User Secret¶
In order to connect the infrastructure you created via the AWS
Marketplace you will need to reset the
user-secret associated with
the account. This will be the
root user that was created
during the AWS Marketplace installation.
Without arguments, the command resets the user secret for the
fugue support reset-secret
You’ll see output like this:
If you wish to use root as the profile name: ==================== User Credential Details: [root] user = root secret = YooDwGZa1WKx93feRxDnQHiEW2OGREEXAMPLEEXAMPLE [ HELP ] You can copy/paste these values into your credentials file /Users/main-user/projects/credentials ==================== If you wish to use the default profile name: ==================== User Credential Details: [default-xxxxxxxxxxxx-us-east-1] user = root secret = YooDwGZa1WKx93feRxDnQHiEW2OGREEXAMPLEEXAMPLE [ HELP ] You can copy/paste these values into your credentials file /Users/main-user/projects/credentials ==================== [ DONE ] Secret successfully reset.
For convenience, the CLI displays text you can copy and paste into your
credentials file. The first set of Fugue
credentials is for a profile named
root and the second set is for a
default-<account-id>-<region> (the default profile).
default-<account-id>-<region> is your default profile, so
use that one unless you’ve specifically created a Fugue credentials
root (or intend to create it).
You must then execute the user set command to associate the specified user with the new credentials:
fugue user set root YooDwGZa1WKx93feRxDnQHiEW2OGREEXAMPLEEXAMPLE
If you encountered trouble while attempting to install Fugue reach out to us at firstname.lastname@example.org.
You’re Done with the Fugue Installation and Setup¶
Congratulations! You’ve completed the AWS Marketplace installation. You’ve successfully installed the Fugue Client Tools, configured your AWS credentials, initialized a project, and updated your credentials.