Skip to content

README.md

Latest commit

 

History

History
43 lines (32 loc) · 1.83 KB

README.md

File metadata and controls

43 lines (32 loc) · 1.83 KB

Logo

@GrowthSpace/gce-cloudsql-proxy-action

Github action which will start a Google Cloud SQL Proxy as Docker container.

Getting Started

Prerequisites

Set up the following resources manually in the Cloud Console or use a tool like Terraform.

  • Running Cloud SQL instance with a public IP address
  • Create Service Account with Role Cloud SQL Client and export a new JSON key.

Github Action Inputs

Variable Description
creds Required Service Account JSON Key (not base64 encoded)
instances Required Cloud SQL connection names. Expects a comma-separated list of CloudSQL instance names
port Expects a comma-separated list of ports corresponding to each CloudSQL instance. If not provided, it defaults to port 5432.
proxy_version Cloud SQL Proxy version, default 1.21.0

Example Usage

uses: growthspace-engineering/gce-cloudsql-proxy-action@v2.0.2
with:
  creds: ${{ secrets.GOOGLE_APPLICATION_CREDENTIALS }}
  instances: my-project:us-central1:instance-1,my-project:us-central1:instance-2
  ports: 5432,5433