API DocumentationProduct Documentation

Proxy Settings

Suggest Edits

For TDP versions >= 2.22.0

For Tetra Data Platform (TDP) versions >= 2.22.0, the proxy setting configuration process is:

  • Step 1 - Configure environment variables can be manual (because usually network administrators prepare environment variables for proxy as part of machine setup), or can be configured through an installation script.
  • Step 2 - Configure Amazon SSM client proxy settings can only be configured through an installation script. Manual changes are necessary only when debugging or resolving possible proxy issues.

For TDP versions < 2.22.0

For TDP versions < 2.22.0, proxy configuration for Data Hub was manual.

When the Data Hub machine is behind a proxy, TetraScience must perform additional configuration to ensure that both installations, and the Data Hub, are working properly.

To set the proxy settings:

  1. Configure environment variables for the root account so that you can install the Data Hub successfully. You must do this before you install the Data Hub.
  2. Configure the proxy settings for the Amazon SSM client to work properly. You must perform this step after you install the Data Hub, but before you activate the Data Hub through the TDP UI.

Configure Environment Variables Manually

The Amazon SSM client that drives the TDP Data Hub uses the root account on a dedicated Linux machine. Therefore, TetraScience configures the shell environment variables to be persistent between sessions. This means that the environment variables are available all the time, such as when the Data Hub server is restarted, or when a new root session is created. As a result, TetraScience cannot configure environment variables temporarily whenever we create new session. Instead, we must configure it in the root's user profile. The file that needs to change depends on the Linux distribution used for the Data Hub.

  • For Ubuntu, TetraScience edits the /root/.bashrc file.
  • For RedHat based Linux distributions, TetraScience edits the /root/.bash_profile file.

These lines are added to the previously mentioned files:

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

After this step, TetraScience ensures that the settings are applied. We either:

  • Restart the connection
  • Restart the Data Hub server
  • (Ubuntu) Invoke command source /root/.bashrc (Ubuntu)
  • (Red Hat)Invoke source /root/.bash_profile (Red Hat)

TetraScience verifies if the proxy settings environment variables are configured by invoking the shell command env.
After we have verified proxy settings, we execute the Data Hub installation script.

📘

Log File

The Data Hub installer script generates a log file. If the installation was not successful, then the installer provides a short error and path to the log file to review more detailed messages. Please review the log file and verify that the proxy settings were configured properly.

Configure Amazon SSM Client Proxy Settings

After the Data Hub installation script executes properly, and before we activate the Data Hub using the TDP UI, TetraScience must enable the proxy settings for Amazon SSM client.

To review the Amazon SSM client proxy configuration procedure, see their AWS documentation.

After the proxy is configured for Amazon SSM client, TetraScience can activate the Data Hub.

📘

Failed Activation

If the activation fails, then TetraScience returns to the Data Hub machine and reviews the Amazon SSM client log. The log is stored at: /var/log/amazon/ssm/amazon-ssm-agent.log. TetraScience can execute a command such as tail /var/log/amazon/ssm/amazon-ssm-agent.log and verify that no messages display, such as unable to resolve address https://*.amazonservices.com, or unable to connect to https://*.amazonservices.com. However, if these messages do display, then please check the Amazon SSM client proxy settings once more

Updated almost 2 years ago