tableaumkt/pantheon-mysql-proxy repository overview

⁠Pantheon Switchboard

This repository contains a Dockerfile of MySQL proxy⁠ that will dynamically proxy MySQL queries made against it to a pre-configured Pantheon⁠ site and environment at runtime.

This allows you to configure and deploy a static endpoint with your choice of credentials that always points to your Pantheon site's database, despite periodic connection detail changes⁠ that occur as a result of server upgrades, endpoint migrations, etc.

⁠Installation

1. Install Docker⁠.
2. Download the automated build⁠ from the Docker Hub Registry⁠: docker pull tableaumkt/pantheon-mysql-proxy
3. Alternatively, you can build an image from the Dockerfile: docker build -t="tableaumkt/pantheon-mysql-proxy" github.com/tableau-mkt/pantheon-mysql-proxy

⁠Usage

You should be able to deploy this image directly; everything you need to change is made configurable via environment variables or arguments, outlined below.

⁠Example run command:

docker run \
  -e "PROXY_DB_UN=pantheon_proxy" \
  -e "PROXY_DB_PW=batteryhorsestaple" \
  -e "PROXY_DB_PORT=3306" \
  -e "PANTHEON_SITE=www-my-company" \
  -e "PANTHEON_ENV=test" \
  -e "PANTHEON_TOKEN=3x4mp130-1337-m4ch-1n30-t0k3n0000000" \
  -p 3306:3306/tcp \
  -d --restart=always tableaumkt/pantheon-mysql-proxy --prefer-replica

These may also be configured/stored differently depending on your Docker deploy strategy.

Once deployed, you can connect to your proxy as if it were a MySQL instance itself: mysql --host=your.proxy.io --port=3306 --user=pantheon_proxy -p

⁠Configurable variables

• PROXY_DB_UN
  • The username that you will give to your end-users to authenticate with the MySQL proxy.
• PROXY_DB_PW
  • The password you will give to your end-users to authenticate with the MySQL proxy.
• PROXY_DB_PORT
  • The port you will give to your end-users to connect with the MySQL proxy. Available so you can pack multiple instances of this image on a single host.
• PANTHEON_SITE
  • The slug of the site whose database you wish to proxy.
• PANTHEON_ENV
  • The Pantheon environment you wish to proxy (e.g. dev, test, or live).
• PANTHEON_TOKEN
  • A Pantheon machine token⁠ with access to the site specified above.

⁠Arguments

There are also some run-time arguments that you can provide to alter the way the connection is made back to Pantheon.

• --prefer-replica
  • When provided, the container will attempt to use the replica/slave database set up for the site/environment on Pantheon. If none is available, it will transparently fallback to the primary DB.
• --require-replica
  • When provided, the container will attempt to use the replica/slave database set up for the site/environment on Pantheon. If none is available, the process will immediately exit with code 1.

⁠Queries no longer forwarding to the right database?

Simply restart or re-deploy the docker image; Pantheon MySQL connection info and credentials are pulled and cached on start-up.

⁠Base docker image

• pataquets/mysql-proxy⁠