Infoworks 5.5.2
Getting Started

Installing Infoworks on AWS

Prerequisites

  • Ensure that you have signed up for an AWS account.
  • Use Amazon Linux 2 AMI to launch a new Virtual Machine. The AMI depends on what is available in your region, and what your corporate policy allows. If you are configuring Infoworks with Databricks then the region must match with the Databricks workspace you plan to use.
  • The recommended minimum hardware requirements are 64 GB RAM, 8 vCPUs, and 200 GB disk space.
  • Infoworks can be installed in the same VPC as that of the Databricks workspace, to allow access between Infoworks and Databricks clusters. This is the recommended setup. Ensure to create an inbound security group rule to allow all ingress traffic within the VPC network. For more details on configuring Infoworks with AWS Databricks, refer to the below section.

NOTE To configure SSL, Infoworks user must be a sudo user.

Prerequisites for Configuring Infoworks with AWS Databricks

  • Ensure that you have signed up for a Databricks subscription. For signing up to Databricks, click here.
  • Establish the connection between Databricks and your AWS account. For more details, see here.
  • Ensure that the Databricks token is created for your workspace.
  • Ensure that the Databricks workspace, Virtual Private Cloud (VPC), and the Infoworks VM are configured in the same region.

Prerequisites for Configuring Infoworks with AWS EMR

There are no separate pre-installation prerequisites for configuring Infoworks to run with AWS EMR. Proceed with installing Infoworks on AWS as documented below.

Installation Procedure

Step 1: Create an inbound security group rule to allow access to port 3000 for your whitelisted IPs. For more details, see here.

Step 2: Log in to the launched instance using SSH.

Step 3: Ensure that the hostname alias set for the Infoworks edge node instance has less than 63 characters. Postgres database has a character limit on hostnames. Run the following command to verify the same on the edge node:

Command
Copy

Step 4: Switch to root user using the following command, before you perform the following steps:

Command
Copy

Step 5: Switch the current working directory to /opt using the following command:

Command
Copy

Step 6: To proceed with your Infoworks installation, create a user named infoworks and change to that user, using Step 7.

Step 7: Execute the following command:

Command
Copy

Step 8: Download the installation package by executing the following command:

NOTE Switch to root user before you perform the following steps.

  • To use Amazon Linux 2, execute the following command:
Command
Copy

NOTE Contact support@infoworks.io, if you encounter any issues in accessing the URL.

Step 9: Untar the package by executing the following commands:

  • For Amazon Linux 2, execute the following command:
Command
Copy

Step 10: Open configure.sh file in the directory.

NOTE Ignore the following fields in configure.sh: KEYVAULT_GLOBAL_ENABLED, KEYVAULT_ENABLED, AZURE_KEYVAULT_URI, FLAG_AZURE_KEYVAULT_AUTH_SP, AZURE_SERVICE_PRINCIPAL_OBJECT_ID, AZURE_SERVICE_PRINCIPAL_SUBSCRIPTION_ID, AZURE_SERVICE_PRINCIPAL_CLIENT_ID, KEYVAULT_FLAG_METADB_HOST, KEYVAULT_FLAG_METADB_USER, KEYVAULT_FLAG_POSTGRESDB_HOST, and KEYVAULT_FLAG_POSTGRESDB_USER.

Step 11: Configure the following parameters as described in the table, and then save the file:

FieldDescriptionDetails
IW_USERThe Infoworks user name. The value is infoworks.This field will be auto-filled.
IW_PLATFORMName of the Infoworks platform. The value to be entered in this field is saas.This field will be auto-filled.
IW_HOMELocation where Infoworks will be installed. The value is /opt/infoworks.This field will be auto-filled.
IW_CLOUD_PROVIDERName of the cloud provider.Enter aws.
IW_EDGENODE_IPThe IP address where Infoworks needs to be launched.Provide the private IP of the virtual machine created.
METADB_MANAGEDThis flag indicates whether the Mongo Installation is managed by Infoworks

If managed by Infoworks, enter Y (default). If managed by an external mongo, enter N.

NOTE This field is applicable only for MongoDB Atlas.

METADB_USE_SRVThis flag indicated whether the MONGO_HOST corresponds to a DNS SRV record

Enter N (default) for No (prefix “mongodb://”), or Y for Yes (prefix “mongodb+srv://”)

NOTE This field is applicable only for MongoDB Atlas.

Step 12: Configure the following parameters as described in the table, and then save the file:

NOTE The following fields apply only to MongoDB Atlas. If you are not using MongoDB Atlas, skip to Step 13.

FieldDescriptionDetails
METADB_FORCE_DROPThis flag indicates whether the Installer should overwrite any existing DatabasesEnter N (default) for No(the provided databases must be empty), or Y to allow dropping of databases.
MONGO_HOSTThe Mongo Host URL to connect to.Enter the Mongo Server or Seed DNS hostname (without prefix)
MONGO_USERThe Mongo User to authenticate as.Enter a user that has at least read/write permissions over the databases mentioned.(defaults to Infoworks)
MONGO_PASSThe Password of the aforementioned MONGO_USEREnter the Password of the MONGO_USER (defaults to Infoworks Mongo Password)
MONGO_DBThe Database Name that will store Infoworks MetaDataEnter a valid database name.
MONGO_QUARTZDBThe Database Name that will store Quartzio MetaDataEnter a valid database name.

Step 13: Ensure that configure.sh and bootstrap.sh files have executable permissions. If the files do not have the permissions, run the following command:

Command
Copy

Step 14: Using command prompt execute the following commands as root user:

Command
Copy

This installs Infoworks in the required environment.

For details on how to navigate through Infoworks, see Navigating Infoworks.

NOTE

Step 1: To access Infoworks user interface, go to http://IP-address:3000.

Step 2: The default credentials to access Infoworks are:

Username: admin@infoworks.io

Password: admin

  Last updated by Monika Momaya