TetraScience

Tetra Data Platform Documentation

Welcome to TetraScience Tetra Data Platform (TDP) documentation site. Here, you'll find Product Documentation, API Documentation, and Release Notes for TDP components.

Release Notes    API Documentation

Installation

How to install TetraScience DataHub

Requirements

  1. You should have a TetraScience account, and you are the organization owner or administrator
  2. You should have a dedicated computer for DataHub because the DataHub should always be running and you should have admin access to it. The system requirement of the DataHub machine is in System Requirements

DataHub Creation and Installation

  • Click "menu" button
  • Click "Data Hub"
  • Click "SETUP A DATAHUB"
  • Give the new DataHub a name and click "CREATE DATAHUB"
  • Download the installation script
  • Copy the installation script to your DataHub environment
  • Open the "Terminal" app and go to the installation script directory. Make the installation script executable by running sudo chmod +x datahub-installer.sh

Before TDP 2.22.0

  • If DataHub machine is behind the proxy, we need to configure the first part of proxy settings - proxy environment variables for root account. Please refer to: https://developers.tetrascience.com/docs/proxy-settings#configure-environment-variables
  • Run the installation script as root by typing sudo ./datahub-installer.sh. The last step of the script will register DataHub with AWS, the activation will expire after 24 hours after the DataHub is created. You then need to create a new DataHub and run the new installation script. The activation code can only be used once and within the 24 hours after DataHub creation in TDP UI.
  • If DataHub machine is behind the proxy, after successful installation and before activation step, we have to configure proxy settings for Amazon SSM client. Details on how to configure proxy for Amazon SSM client are given at https://developers.tetrascience.com/docs/proxy-settings#configure-amazon-ssm-client-proxy-settings
  • After the installation is complete, go back to the platform, and click activate DataHub.

TDP 2.22.0 and after

  • If DataHub is behind proxy, environment variables for proxy can be added manually like before. For that, please refer to: https://developers.tetrascience.com/docs/proxy-settings#configure-environment-variables. This is usually the case when network administrators prepare clean machine for DataHub as part of their setup. However, this can be done automatically now through installation.

  • Run the installation script as root by typing sudo ./datahub-installer.sh.

DataHub installer will perform various checks and will prompt user several times for input/confirmation.

  • Installer will check if machine has enough RAM memory:
    • if there are less than 4GB of RAM, installer will be aborted
    • if there are more than 4GB and less than 8 GB of RAM, installer will warn user and will prompt whether to continue
    • if there are more than 8GB of RAM, installer will continue without any warning
  • Installer will check if machine has enough allocated disk space:
    • if there are less than 20 GB of disk space, installer will be aborted
    • if there are more than 20 GB but less than 50 GB of disk space, installer will warn user and will prompt whether to continue
    • if there are more than 50 GB of disk space, installer will continue without any warning
  • Installer will try to detect environment proxy variables. If those are set, installer will present them and will check if those are correct values
  • If there are no detected environment proxy variables, installer will ask if machine is behind the proxy and if user answer with 'yes', they will need to provide proxy settings
  • If there were detected proxy settings or manually entered proxy settings in previous step, installer will ask for permission to update AWS SSM client settings with proxy details once that installation is done. If that is rejected, installer will be aborted. Otherwise, if there were no detected proxy settings and we did not provide proxy settings in previous step, installer will continue normally.
  • Installer will check if all required software is installed and if not, it will install them
  • The last step of the installation will register DataHub with AWS, the activation will expire after 24 hours after the DataHub is created in TDP UI. You then need to create a new DataHub and run the new installation script if 24 hours has expired. The activation code can only be used once and within the 24 hours after DataHub creation in TDP UI.
  • After the installation is complete, go back to the platform, and click activate DataHub.
  • The new DataHub should then appear to be activated and online.
  • The new DataHub is now set up. You can add connectors to this DataHub now.

Note: Common issues during the installation:

  1. Installation script fails due to no network access. Actions to perform:
  1. Installation script fails because some of required software components cannot be installed automatically. Most of the times this happens with Docker installation. If that happens, manually install Docker and then run installation script again

  2. DataHub activation fails - please check log at /var/log/amazon/ssm/amazon-ssm-agent.log and identify that there are no network related issues. If there are network issues, check network and proxy settings for DataHub machine

Updated 4 months ago


Installation


How to install TetraScience DataHub

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.