A command-line utility to build, run, and monitor Tableau Bridge Agents in containers.
BridgeCTL will help you build your Tableau Bridge Linux container images including downloading and installing the right database drivers and bridge rpm installer. Then it will help you easily configure and run your bridge containers in Docker or Kubernetes with the correct connection settings. It has a convenient log viewer for bridge container logs in docker, kubernetes. It will also monitor the status and configuration of your running bridge agents and can send you an alert if one of your agents becomes disconnected. BridgeCTL can be installed on Linux, Windows or Mac.
BridgeCTL is easy to install. Just download and run the bridgectl_setup.py script using the following two commands:
curl -OL https://github.com/tab-se/bridgectl/releases/download/setup/bridgectl_setup.py
python bridgectl_setup.py
Requirements
- Python >= 3.10
- Docker Desktop
- BridgeCTL works on Windows, Linux or Mac
Note python 3.10 or greater is required. Please use the appropriate python command on your machine to run the setup script, for example instead of "python" you may need to use "python3" or "python3.11".
The BridgeCTL setup script will create a folder "bridgectl" in the current directory and a python virtual environment named "tabenv". It will then create a shortcut function bridgectl so that you can conveniently use that global command from the terminal.
Detailed Installation Instructions
Optional Requirement: If you would like to run bridge agents containers in Kubernetes you will need access to AWS Elastic Container Registry and a Kubernetes cluster.
- Build Tableau Bridge docker container images. detail
- Download and install the bridge rpm and selected database drivers in the image.
- Follow best practices for building containers.
- Run bridge containers in Docker
- Reports
- Display Jobs Report
- Display Bridge Agent Status
- Analyze bridge logs detail
- Log viewer with ability to filter and sort logs
- Analyze logs from local docker containers, local disk or from kubernetes containers (pods)
- Monitor bridge agent health detail
- BridgeCTL provides a monitoring feature to send a Slack or Pager Duty notifications when any bridge agent becomes disconnected.
- Run bridge containers in Kubernetes
- After importing your kubeconfig file, you can spin up bridge agent containers in a Kubernetes cluster
- Manage bridge containers in Docker or Kubernetes
- View configuration settings of bridge containers or delete bridge containers
- View current bridge agent activity (standard output logs)
- Show snapshot metrics about resource utilization
- Example Dockerfile Scripts detail
- In addition to building your bridge images for you, BridgeCTL can show you how to create and customize your own bridge docker files using best practices and also with different database drivers.
BridgeCTL is Community-Supported as defined here. BridgeCTL has a great deal of helpful documentaion in this wiki. Also, questions can be posted in the Tableau DataDev Slack workspace in the channel #help-bridge, or in the Tableau Community forums.
See official Tableau documentation for creating bridge containers on Linux
