heroku-buildpack-cloud-sql-proxy

by efrisch6

GitHub Readme.md

Google Cloud SQL Proxy buildpack

Connect to Google Cloud SQL from an external application without a static (or public) IP address.

The buildpack will install Google's Proxy service to the localhost and configure it with credentials supplied via the environment variables. After starting the proxy service, your application will have access to the Cloud SQL instance by connecting and querying the proxy running on the localhost.

The proxy establishes the actual connection to the Cloud SQL instance and acts as a 'proxy' that communicates requests and responses between your application and the Cloud SQL instance. Learn more: Google Docs

Setup and installation

  • Enable the Cloud SQL Admin API: here

  • Create credential key file: Go to Google Cloud Console -> Menu -> API & Services -> Credentials -> Create "Service account key" -> Follow instructions to generate a json credential file. If required, create a service account.

  • Setup a user that the proxy will use for authorizing with the Cloud SQL instance: Go to Google Cloud console -> Menu -> SQL -> Select instance -> Go to users -> create a user and remember the username + password for later.

  • Encode credential key file into a base64 string: In the terminal run: base64 <key-filename.json>

  • Add envs to server:
    GCLOUD_CREDENTIALS=<base64 string from step before>
    GCLOUD_INSTANCE=<instance-connection-name>=tcp:5432 instance-connection-name is found in the overview on the Cloud SQL instance
    YOUR_DB_CONNECTION_URI=postgres://<username>:<password>@localhost:5432/<database-name> username and password for the user created in the steps before

  • Add buildpack to server and run bin/run_cloud_sql_proxy on startup:
    For heroku run: heroku buildpacks:add https://github.com/DanielZambelli/heroku-buildpack-cloud-sql-proxy -a <name-of-your-application>
    And to run the proxy when starting a Node.js web process add this to the .procfile web: bin/run_cloud_sql_proxy &>null && npm start.