Proxy Settings

Prior to platform version TDP 2.22.0, proxy configuration for Data Hub was manual. There were two steps (listed below) for releases before TDP 2.22.0.

Starting from release TDP 2.22.0, the first step (configure environment variables) can be manual (because usually network administrators prepare environment variables for proxy as part of machine setup), or can be done through installation script. The second step starting from release TDP 2.22.0 (configure Amazon SSM client proxy settings) is done only through installation script. Manual changes are needed only when debugging or resolving possible proxy issues.

Before TDP 2.22.0

When data hub machine is behind proxy, we have to perform additional configuration in order to make both installation working properly and later data hub itself. Proxy settings are done in two steps.:

  1. One step is to configure environment variables for root account so that installation of a data hub can be performed successfully. This must be done before Data Hub installation.
  2. The other step is to configure proxy for Amazon SSM client in order to have it working properly. This step is performed after Data Hub installation, but before activation of a Data Hub through TDP UI.

I Configure Environment Variables

Amazon SSM client that drives TDP data hub uses root account on dedicated Linux machine. Therefore we need to configure shell environment variables that are persistent between sessions. That means that environment variables are available all the time - when data hub server is restarted, when new root session is created, etc. So, we cannot configure environment variables temporary, whenever we create new session. Instead, it must be configured in root's user profile. File that need to be changed depends on the Linux distribution used for data hub. For Ubuntu, we have to edit file /root/.bashrc. For RedHat based Linux distributions, we need to edit file /root/.bash_profile.

The following lines must be added to the previously mentioned files:

export http_proxy=http://hostname:port
export https_proxy=http://hostname:port
export no_proxy=

After this step, we must ensure that setting are applied. We can either restart connection, or restart data hub server or invoke command source /root/.bashrc (Ubuntu) or source /root/.bash_profile (Red Hat).
We can check if proxy settings environment variables are configured by invoking shell command env.

Once we have verified proxy settings, we can proceed with execution of data hub installation script.

Note: Data Hub installer script produces log file. If installation doesn't succeed, installer will provide short error and path to log file for more detailed messages. Please check provided log file and verify that proxy settings are properly done.

II Configure Amazon SSM Client Proxy Settings

After Data Hub installation script is executed properly, and before we activate Data Hub using TDP UI, we must enable proxy settings for Amazon SSM client.
Steps for Amazon SSM client proxy configuration are given in AWS official documentation:

When proxy is configured for Amazon SSM client, we can finally proceed with Data Hub activation.

Note: If activation fails, we need to go back to Data Hub machine and check the log of Amazon SSM client. Log is stored at following location: /var/log/amazon/ssm/amazon-ssm-agent.log. We can executed command like tail /var/log/amazon/ssm/amazon-ssm-agent.log and verify that there are no message like unable to resolve address https://*, or unable to connect to https://* If there are messages like that, please check Amazon SSM client proxy settings again.