On-premises Deployment

Minimum requirements

2 core CPU, 8GB RAM, and 100GB SSD.

Supported operating systems are Amazon Linux 2018, Amazon Linux 2, Ubuntu 18.04, Ubuntu 20.04, CentOS 7.

Installation

The installer provided a tar zip archive that also contains a unique license file.

• Copy etlworks-installer.tar.gz file into /opt/etlworks directory and then unarchive it.

  sudo tar -zxvf etlworks-installer.tar.gz

• Start the installation by executing:
  

  sudo ./etlworks-cli.sh install

• Optional parameters/flags:
  •  --skip-confirm: proceed with installation without confirmation
    • aliases: -s 
  • --user (String) (Default: ec2-user): sudoer user name
    • aliases: -u
  • --no-app: do not install application artifacts, only provision the system
    • aliases: -n
• After the installation process is over, the service should be available on port 8080. The default Super Admin username and password are:
  • user: admin
  • password: admin1
• After you first log in, navigate to Settings
  • Under General, update Home URL to your instance URL.
  • Under Email, provide the email configuration that will be used by the system to send notifications (required for user management).

Upgrade

In order to upgrade service to the latest version:

• Navigate to /opt/etlworks directory.
• Execute upgrade command. 
  

  sudo ./etlworks-cli.sh upgrade

Maintenance

Start service

• Navigate to /opt/etlworks directory.
• Execute start command.
  

  sudo ./etlworks-cli.sh start

Stop service

• Navigate to /opt/etlworks directory.
• Execute stop command. 
  

  sudo ./etlworks-cli.sh stop

View service logs

• Navigate to /opt/etlworks directory.
• Execute log command. 
  

  sudo ./etlworks-cli.sh log

• Optional parameters/flags
  • --engine: show ETL engine log instead of the application log
    • aliases: -e
  • --follow: live log output
    • aliases: -f
  • --lines (Number): number of lines to show
    • aliases: -n <value>

Backup service

• Navigate to /opt/etlworks directory.
• Execute backup command. 
  

  sudo ./etlworks-cli.sh backup

• All backup files will be created under /opt/etlworks/backup directory.