Signals Connector Installation
To install the Tetra Signals Connector, you must do the following:
- Create a Docker volume
- Download the Docker image
- Create the Docker container
- Start the container
System Requirements
For the Connector to function properly, the host machine must meet the following requirements:
- Linux OS
- Docker installed
- Outbound network access to the Tetra Data Platform (TDP) and to Signals
- Allows sufficient inbound network access for Signals users to be able to open the Connector in their web browser
Host Connector on a Tetra Hub or Data Hub
Many of the requirements above are automatically fulfilled by hosting the connector on an existing Tetra Hub or Tetra Data Hub. If you already have a Tetra Hub or Data Hub, you can install the Tetra Signals Connector there. However, it is not required to use a Hub or Data Hub with the Tetra Signals Connector.
Use Privileged Shell for CLI Commands
All of the commands in this procedure should be run in a privileged shell.
macOS: If you are using an Administrator account, no additional action is required.
Linux: Run
sudo su -
to get a root login shell in which to run the commands.
Step 1: Create a Docker Volume
Although optional, we recommend using a Docker volume to store the SQLite databases so that configuration is automatically preserved during Connector upgrades.
If Upgrading instead of Fresh Install
If you are upgrading the Connector, or for some reason your intended Docker volume already exists, skip to Step 2: Download the Docker Image.
To create a volume, run the following shell command:
docker volume create --driver local signals_connector_config
When you create the Docker volume, keep in mind the following:
- This action creates a Docker volume called
signals_connector_config
, which is typically located at/var/lib/docker/volumes/signals_connector_config
in a standard Docker installation on Linux. - When you create the container, make sure that you map this volume to
/app/config
within the container. - The Connector uses this folder to store configuration, state, and logs in SQLite database files.
Step 2: Download the Docker Image
To download the Tetra Signals Connector Docker image, do the following:
- Request a download link from your customer success manager (CSM).
- Open the download link that you receive from your CSM. Then, download the tarfile that contains the Docker image to the host server.
- Extract the Docker image from the tarfile in the local command line terminal by running the following shell command:
NOTE
The following command example uses the filename
ts-connector-signals-v1.0.0.tar
and the image namets-connector-signals:v1.0.0
. If you're using a different version, make sure that you substitute the correct values appropriately.
docker load --input ts-connector-signals-v1.0.0.tar
- The download and image creation was successful if Docker can present the Signals Connector in its list of images. To verify, run the following shell command in the local terminal:
docker image ls -a
Step 3: Create the Docker Container
Create the Docker container by running the following shell command:
docker create -p 3003:8080 --name=signals_connector -v signals_connector_config:/app/config ts-connector-signals:v1.0.0
NOTE
The shell command to create the Docker container uses the following arguments:
-p 3003:8080
: Forward traffic incoming on port3003
on the host to port8080
in the container--name=signals_connector
: Give the container the specific namesignals_connector
-v signals_connector_config:/app/config
: Map/app/config
in the container to use the Docker volumesignals_connector_config
that was set up in a previous step.ts-connector-signals:v1.0.0
: This is the image to base the container on (your version number may differ)
Step 4: Start the Container
Start the Docker container you created by doing the following:
- To start the container, run the following shell command:
docker start signals_connector
NOTE
The Connector may take up to 15 seconds to become available once the container is started.
- (For new installations only) In a web browser, go to
http://<hostname>:3003/
(or, if you previously configured the Connector to use SSL, thenhttps://<hostname>:3003/
). Then, set up the initial configuration.<hostname>
islocalhost
for local development or local access from the server.
Updated 5 months ago