Connect to Cloud SQL for PostgreSQL from Cloud Run
Learn how to deploy a sample app on Cloud Run connected to a PostgreSQL instance by using the Google Cloud console and a client application.
Assuming that you complete all the steps in a timely manner, the resources created in this quickstart typically cost less than one dollar (USD).
To follow step-by-step guidance for this task directly in the Google Cloud console, click Guide me:
Before you begin
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud APIs necessary to run a Cloud SQL sample app on Cloud Run.
Click Enable APIs to enable the APIs required for this quickstart.
This enables the following APIs:
- Compute Engine API
- Cloud SQL Admin API
- Cloud Run API
- Container Registry API
- Cloud Build API
- Service Networking API
Click the following button to open Cloud Shell, which provides command-line access to your Google Cloud resources directly from the browser. Cloud Shell can be used to run the
gcloud
commands presented throughout this quickstart.Run the following
gcloud
command using Cloud Shell:gcloud services enable compute.googleapis.com sqladmin.googleapis.com run.googleapis.com \ containerregistry.googleapis.com cloudbuild.googleapis.com servicenetworking.googleapis.com
This command enables the following APIs:
- Compute Engine API
- Cloud SQL Admin API
- Cloud Run API
- Container Registry API
- Cloud Build API
- Service Networking API
Set up Cloud SQL
Create a Cloud SQL instance
Public IP
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- Click Create instance.
- Click Choose PostgreSQL.
- Make sure that Enterprise Plus is selected as the Cloud SQL edition for your instance.
- In the Instance ID field, enter
quickstart-instance
. - In the Password field, enter a password for the postgres user. Save this password for future use.
- In the Choose region and zonal availability section, select Single zone.
- Click the Show configuration options menu.
- Expand the Machine configuration node.
- From the Machine shapes region, select the 4 vCPU, 32 GB shape.
- Click Create instance and then wait until the instance initializes and starts.
Before running the command as follows, replace DB_ROOT_PASSWORD with the password of your database user.
Optionally, modify the values for the following parameters:
- --database-version: The database engine type and version. If left unspecified, the API default is used. See the gcloud database versions documentation to see the current available versions.
- --cpu: The number of cores desired in the machine.
- --memory: Whole number value indicating how much memory is desired in the machine. A size unit should be provided (for example, 3072MB or 9GB). If no units are specified, GB is assumed.
- --region: Regional location of the instance
(for example asia-east1, us-east1). If left unspecified, the default
us-central
is used.
Run the gcloud
sql instances create
command to create a Cloud SQL instance.
gcloud sql instances createquickstart-instance \ --database-version=POSTGRES_14 \ --cpu=1 \ --memory=4GB \ --region=us-central \ --root-password=DB_ROOT_PASSWORD
Private IP
Allocate an IP address range and create a private connection to configure private services access for Cloud SQL
-
In the Google Cloud console, go to the VPC networks page.
- Select the
default
VPC network. - Select the Private service connection tab.
- Select the Allocated IP ranges for services tab.
- Click Allocate IP range.
- For the Name of the allocated range, specify
google-managed-services-default
. - Select the Automatic option for IP range and specify the prefix length as
16
. - Click Allocate to create the allocated range.
- Select the Private connections to services tab for the
default
VPC network. - Click Create connection to create a private connection between your network and a service producer.
- For the Assigned allocation, select
google-managed-services-default
. - Click Connect to create the connection.
Create an instance with private IP address and SSL enabled
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- Click Create instance.
- Click Choose PostgreSQL.
- Make sure that Enterprise Plus is selected as the Cloud SQL edition for your instance.
- In the Instance ID field, enter
quickstart-instance
. - In the Password field, enter a password for the postgres user. Save this password for future use.
- In the Choose region and zonal availability section, select Single zone.
- Click the Show configuration options menu.
- Expand the Machine configuration node.
- From the Machine shapes region, select the 4 vCPU, 32 GB shape.
- Expand the Connections node.
- Clear the Public IP checkbox to create an instance only with a private IP address.
- Select the Private IP checkbox.
- From the Network menu, select default.
- Click Create instance and then wait for the instance to initialize and start.
- Click Connections.
- In the Security section, select Allow only SSL connections to enable SSL connections.
- In the Allow only SSL connections dialog, click Save and then wait for the instance to restart.
Allocate an IP address range and create a private connection to configure private services access for Cloud SQL
-
Run the
gcloud compute addresses create
command to allocate an IP address range.gcloud compute addresses create
google-managed-services-default \ --global --purpose=VPC_PEERING --prefix-length=16 \ --description="peering range for Google" --network=default -
Run the
gcloud services vpc-peerings connect
command to create a private connection to the allocated IP address range. Replace YOUR_PROJECT_ID with your project's project ID.gcloud services vpc-peerings connect --service=servicenetworking.googleapis.com \ --ranges=
google-managed-services-default --network=default \ --project=YOUR_PROJECT_ID
Create an instance with private IP address and SSL enabled
-
Before running the command as follows, replace DB_ROOT_PASSWORD with the password of your database user.
- --database-version: The database engine type and version. If left unspecified, the API default is used. See the gcloud database versions documentation to see the current available versions.
- --cpu: The number of cores in the machine.
- --memory: A whole number value indicating how much memory to include in the machine. A size unit can be provided (for example, 3072MB or 9GB). If no units are specified, GB is assumed.
- --region: The regional location of the instance
(for example asia-east1, us-east1). If left unspecified, the default
us-central1
is used. See the full list of regions. Run the
gcloud sql instances patch
command to enable only allow SSL connections for the instance.
Optionally, modify the values for the following parameters:
Run the gcloud
sql instances create
command to create a Cloud SQL instance with a Private IP address.
gcloud sql instances createquickstart-instance \ --database-version=POSTGRES_14 \ --cpu=1 \ --memory=4GB \ --region=us-central \ --root-password=DB_ROOT_PASSWORD \ --no-assign-ip \ --network=default
gcloud sql instances patchquickstart-instance --require-ssl
Create a database
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- Select
quickstart-instance
. - From the SQL navigation menu, select Databases.
- Click Create database.
- In the Database name field of the New database dialog
box, enter
quickstart-db
. - Click Create.
Run the gcloud
sql databases create
command to create a database.
gcloud sql databases createquickstart-db --instance=quickstart-instance
Create a user
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- To open the Overview page of an instance, click the instance name.
- Select Users from the SQL navigation menu.
- Click Add user account.
- On the Add a user account to instance instance_name page,
add the following information:
- In the Username field, enter
quickstart-user
- In the Password field, specify a password for your database user. Make a note of this for use in a later step of this quickstart.
- In the Username field, enter
- Click Add.
Before running the following command, make the following replacements:
- PASSWORD with a password for your database user. Make a note of this for use in a later step of this quickstart.
Run the gcloud sql users create
command to create the user.
gcloud sql users createquickstart-user \ --instance=quickstart-instance \ --password=PASSWORD
User name length limits are the same for Cloud SQL as for on-premises PostgreSQL.
Deploy sample app to Cloud Run
Configure a Cloud Run service account
-
In the Google Cloud console, go to the IAM page.
- For the service account named Compute Engine default service account, click the pencil icon.
- Click ADD ANOTHER ROLE.
- Add the Role named Cloud SQL Client.
- Click Save.
-
Run the following
gcloud
command to get a list of your project's service accounts:gcloud iam service-accounts list
- Copy the EMAIL of the Compute Engine service account.
- Run the following command to add the Cloud SQL Client
role to Compute Engine service account:
gcloud projects add-iam-policy-binding
YOUR_PROJECT_ID \ --member="serviceAccount:SERVICE_ACCOUNT_EMAIL " \ --role="roles/cloudsql.client"
Configure a Cloud SQL sample app
With a Cloud SQL instance, database, and service account with client permissions, you can now configure a sample application to connect to your Cloud SQL instance.
Public IP
For public IP paths, Cloud Run provides encryption and connects using the Cloud SQL Auth Proxy through Unix sockets.- In Cloud Shell Editor, open the sample app's source code.
- In the Open in Cloud Shell dialog box, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
-
Run the following command in Cloud Shell to build a Docker container and publish it to Container Registry.
Replace YOUR_PROJECT_ID with your project's project id.
gcloud builds submit --tag gcr.io/
YOUR_PROJECT_ID /run-sql
- In Cloud Shell Editor, open the sample app's source code.
- In the Open in Cloud Shell dialog box, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
-
Run the following command in Cloud Shell to build a Docker container and publish it to Container Registry.
Replace YOUR_PROJECT_ID with your project's project id.
mvn clean package com.google.cloud.tools:jib-maven-plugin:2.8.0:build \ -Dimage=gcr.io/
YOUR_PROJECT_ID /run-sql -DskipTests
- In Cloud Shell Editor, open the sample app's source code.
- In the Open in Cloud Shell dialog box, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
-
Run the following command in Cloud Shell to build a Docker container and publish it to Container Registry.
Replace YOUR_PROJECT_ID with your project's project id.
gcloud builds submit --tag gcr.io/
YOUR_PROJECT_ID /run-sql
- In Cloud Shell Editor, open the sample app's source code.
- In the Open in Cloud Shell dialog box, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
-
Run the following command in Cloud Shell to build a Docker container and publish it to Container Registry.
Replace YOUR_PROJECT_ID with your project's project id.
gcloud builds submit --tag gcr.io/
YOUR_PROJECT_ID /run-sql
Private IP
For private IP paths, your application connects directly to your instance through Serverless VPC Access. This method uses a TCP socket to connect directly to the Cloud SQL instance without using the Cloud SQL Auth Proxy.Create and download SSL server and client certificates
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- Click the
quickstart-instance
to see its Overview page - Click the Connections tab.
- Under the Security section, click Create client certificate.
- In the Create a client certificate dialog,
enter
quickstart-key
as the name and click Create. In the New SSL certificate created dialog, click each download link to download the certificates. Then, click Close.
Create a Serverless VPC Connection for connections to the instance via Private IP
-
In the Google Cloud console, go to the Serverless VPC access - Create connector page.
- Enter
quickstart-connector
for the Name. - Select default from the Network drop-down menu
- Select Custom IP range from the Subnet drop-down menu
- Enter
10.8.0.0
in the IP range input box - Click Create to create the connector.
Build sample app with SSL certificates
-
In Cloud Shell Editor, open the sample app's source code.
Open Cloud Shell Editor - In the Open in Cloud Shell dialog, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
-
Upload SSL certs files to certs folder.
- Right-click certs folder in Cloud Shell Editor and select Upload Files
- Select following files on your local machine:
client-key.pem
client-cert.pem
server-ca.pem
- With the three SSL certificate files selected, click Open to complete the process of uploading the files to Cloud Shell Editor.
-
Run the following command in Cloud Shell to build a Docker container and publish it to Container Registry.
Replace YOUR_PROJECT_ID with your project's project id.
gcloud builds submit --tag gcr.io/
YOUR_PROJECT_ID /run-sql
Create and download SSL server and client certificates
For Java users, the connector already provides a secure connection so that creating and downloading SSL server and client certificates is unnecessary.
Create a Serverless VPC Connection for connections to the instance via Private IP
-
In the Google Cloud console, go to the Serverless VPC access - Create connector page.
- Enter
quickstart-connector
for the Name. - Select default from the Network drop-down menu
- Select Custom IP range from the Subnet drop-down menu
- Enter
10.8.0.0
in the IP range input box - Click Create to create the connector.
Build Sample App
-
In Cloud Shell Editor, open the sample app's source code.
Open Cloud Shell Editor - In the Open in Cloud Shell dialog, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
-
Run the following command in Cloud Shell to build a Docker container and publish it to Container Registry.
Replace YOUR_PROJECT_ID with your project's project id.
mvn clean package com.google.cloud.tools:jib-maven-plugin:2.8.0:build \ -Dimage=gcr.io/
YOUR_PROJECT_ID /run-sql -DskipTests
Create and download SSL server and client certificates
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- Click the
quickstart-instance
to see its Overview page - Click the Connections tab.
- Under the Security section, click Create client certificate.
- In the Create a client certificate dialog,
enter
quickstart-key
as the name and click Create. In the New SSL certificate created dialog, click each download link to download the certificates. Then, click Close.
Create a Serverless VPC Connection for connections to the instance via Private IP
-
In the Google Cloud console, go to the Serverless VPC access - Create connector page.
- Enter
quickstart-connector
for the Name. - Select default from the Network drop-down menu
- Select Custom IP range from the Subnet drop-down menu
- Enter
10.8.0.0
in the IP range input box - Click Create to create the connector.
Build sample app with SSL certificates
-
In Cloud Shell Editor, open the sample app's source code.
Open Cloud Shell Editor - In the Open in Cloud Shell dialog, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
-
Upload SSL certs files to certs folder.
- Right-click certs folder in Cloud Shell Editor and select Upload Files
- Select following files on your local machine:
client-key.pem
client-cert.pem
server-ca.pem
- With the three SSL certificate files selected, click Open to complete the process of uploading the files to Cloud Shell Editor.
-
Run the following command in Cloud Shell to build a Docker container and publish it to Container Registry.
Replace YOUR_PROJECT_ID with your project's project id.
gcloud builds submit --tag gcr.io/
YOUR_PROJECT_ID /run-sql
Create and download SSL server and client certificates
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- Click the
quickstart-instance
to see its Overview page - Click the Connections tab.
- Under the Security section, click Create client certificate.
- In the Create a client certificate dialog,
enter
quickstart-key
as the name and click Create. In the New SSL certificate created dialog, click each download link to download the certificates. Then, click Close.
Create a Serverless VPC Connection for connections to the instance via Private IP
-
In the Google Cloud console, go to the Serverless VPC access - Create connector page.
- Enter
quickstart-connector
for the Name. - Select default from the Network drop-down menu
- Select Custom IP range from the Subnet drop-down menu
- Enter
10.8.0.0
in the IP range input box - Click Create to create the connector.
Build sample app with SSL certificates
-
In Cloud Shell Editor, open the sample app's source code.
Open Cloud Shell Editor - In the Open in Cloud Shell dialog, click Confirm to download the sample app code and open the sample app directory in Cloud Shell Editor.
-
Upload SSL certs files to certs folder.
- Right-click certs folder in Cloud Shell Editor and select Upload Files
- Select following files on your local machine:
client-key.pem
client-cert.pem
server-ca.pem
- With the three SSL certificate files selected, click Open to complete the process of uploading the files to Cloud Shell Editor.
-
Run the following command in Cloud Shell to build a Docker container and publish it to Container Registry.
Replace YOUR_PROJECT_ID with your project's project id.
gcloud builds submit --tag gcr.io/
YOUR_PROJECT_ID /run-sql
Deploy the sample app
The steps to deploy the sample to Cloud Run depend on the type of IP address you assigned to your Cloud SQL instance.
Public IP
-
In the Google Cloud console, go to the Cloud Run page.
-
Click Create container and select Service to display the Create service form.
- Click the Select button in the Container image URL input field.
- Select the
gcr.io/YOUR_PROJECT_ID/run-sql
container image you created in the previous step. - In the Service name field, enter
quickstart-service
. - In the Authentication section, select
the
Allow unauthenticated invocations
option. If you don't have permissions (Cloud Run Admin role) to select this, the service will deploy and require authentication. - Expand the Container, Variables & Secrets, Connections, Security section.
- Create the following
Environment variables
by clicking Add Variable under Environment variables. Set the values for the environment variables, as follows: - INSTANCE_UNIX_SOCKET: Set to
/cloudsql/YOUR_PROJECT_ID:us-central1:quickstart-instance
. - INSTANCE_CONNECTION_NAME: Set to your instance's Connection name that appears on the Cloud SQL instances page in the Google Cloud console.
- DB_NAME: Set to
quickstart-db
- DB_USER: Set to
quickstart-user
- DB_PASS: Set to the password of the
quickstart-user
that you created in the previous Create a user quickstart step. -
Enable connecting to Cloud SQL:
- Click the Connections tab.
- Click the Add Connection button under the Cloud SQL connections section.
- Select the
quickstart-instance
you previously created from the drop-down menu.
-
Click Create to create the Cloud Run service.
- After the Cloud Run service is deployed, the
Service details page displays the
URL of the running service at the top of the page.
Click the URL link to see the deployed sample app on Cloud Run connected to
Cloud SQL.
Before running the following command, make the following replacements:
- YOUR_PROJECT_ID with your project ID.
-
INSTANCE_CONNECTION_NAME with your instance's Connection name that appears on the Cloud SQL instances page in the Google Cloud console.
-
DB_PASS with the password of the
quickstart-user
that you created in the previous Create a user quickstart step. -
When you see a confirmation message that the Cloud Run service has been deployed, click the
Service URL link in the message to see the sample app on Cloud Run that is connected to Cloud SQL.
Run the gcloud run deploy
command as follows to create the Cloud Run service:
gcloud run deploy run-sql --image gcr.io/YOUR_PROJECT_ID /run-sql \ --add-cloudsql-instancesINSTANCE-CONNECTION-NAME \ --set-env-vars INSTANCE_UNIX_SOCKET="/cloudsql/INSTANCE_CONNECTION_NAME " \ --set-env-vars INSTANCE_CONNECTION_NAME="INSTANCE_CONNECTION_NAME " \ --set-env-vars DB_NAME="quickstart-db " \ --set-env-vars DB_USER="quickstart-user " \ --set-env-vars DB_PASS="DB_PASS "
Enter the numeric choice provided for us-central1
when prompted to specify a region.
Private IP
-
In the Google Cloud console, go to the Cloud Run page.
-
Click Create container and select Service to display the Create service form.
- Retain the option to deploy from an existing container image and click Select to specify the
gcr.io/YOUR_PROJECT_ID/run-sql
container image you created in the previous step. - Enter
quickstart-service
for the Service name. - In the Authentication section, select
the
Allow unauthenticated invocations
option. If you don't have permissions (Cloud Run Admin role) to select this, the service will deploy and require authentication. - Expand the Container, Variables & Secrets, Connections, Security section.
- Create the following environment variables by clicking Add variable under Environment variables. Set the values for the environment variables, as follows:
DB_NAME
: Set toquickstart-db
.DB_USER
: Set toquickstart-user
.DB_PASS
: Set to the password of thequickstart-user
that you specified in the previous Create a user quickstart step.INSTANCE_CONNECTION_NAME
: Set to your instance's Connection name that appears on the Cloud SQL instances page in the Google Cloud console.DB_PORT
: Set to5432
.INSTANCE_HOST
: Set to the private IP address of your instance as mentioned in the Cloud SQL instance Overview page.DB_ROOT_CERT
: Set tocerts/server-ca.pem
.DB_CERT
: Set tocerts/client-cert.pem
.DB_KEY
: Set tocerts/client-key.pem
.PRIVATE_IP
: Set toTRUE
.-
Enable connecting to Cloud SQL:
- Click Connections.
- Click Add Connection in the Cloud SQL connections section.
- Select the
quickstart-instance
Cloud SQL instance that you previously created. - Select
default: Serverless VPC Access Connector "quickstart-connector"
from the VPC Network drop-down menu. - Select the option Route all traffic through the VPC connector.
-
Click Create to create the Cloud Run service.
- After the Cloud Run service is deployed, the
Service details page displays the
URL of the running service at the top of the page.
Click the URL link to see the deployed sample app on Cloud Run connected to
Cloud SQL.
Before running the following command, make the following replacements:
- YOUR_PROJECT_ID with your project ID.
-
INSTANCE_CONNECTION_NAME with your instance's Connection name that appears on the Cloud SQL instances page in the Google Cloud console.
-
DB_PASS with the password of the
quickstart-user
that you created in the previous Create a user quickstart step. - INSTANCE_HOST with the private IP address of your instance. Go to the Cloud SQL instance Overview page where the instance private IP address appears.
-
When you see a confirmation message that the Cloud Run service has been deployed, click the
Service URL link in the message to see the sample app on Cloud Run that is connected to Cloud SQL.
Run the gcloud run deploy
command as follows to create the Cloud Run service:
gcloud run deploy run-sql --image gcr.io/YOUR_PROJECT_ID /run-sql \ --add-cloudsql-instancesINSTANCE_CONNECTION_NAME \ --vpc-connector="quickstart-connector " --vpc-egress=all-traffic \ --set-env-vars DB_NAME="quickstart-db " \ --set-env-vars DB_USER="quickstart-user " \ --set-env-vars DB_PASS="DB_PASS " \ --set-env-vars INSTANCE_CONNECTION_NAME="INSTANCE_CONNECTION_NAME " \ --set-env-vars DB_PORT="5432" \ --set-env-vars INSTANCE_HOST="INSTANCE_HOST " \ --set-env-vars DB_ROOT_CERT="certs/server-ca.pem" \ --set-env-vars DB_CERT="certs/client-cert.pem" \ --set-env-vars DB_KEY="certs/client-key.pem" \ --set-env-vars PRIVATE_IP="TRUE"
Java users should run the gcloud run deploy
command without
the INSTANCE_HOST, DB_ROOT_CERT, DB_CERT, DB_KEY, and PRIVATE_IP --set-env-vars flags, as follows, to create the Cloud Run service
because the Java connector already provides a secure connection:
gcloud run deploy run-sql --image gcr.io/YOUR_PROJECT_ID /run-sql \ --add-cloudsql-instancesINSTANCE_CONNECTION_NAME \ --vpc-connector="quickstart-connector " --vpc-egress=all-traffic \ --set-env-vars DB_NAME="quickstart-db " \ --set-env-vars DB_USER="quickstart-user " \ --set-env-vars DB_PASS="DB_PASS " \ --set-env-vars INSTANCE_CONNECTION_NAME="INSTANCE_CONNECTION_NAME " \ --set-env-vars DB_PORT="5432"
Enter the numeric choice provided for us-central1
when prompted to specify a region.
Clean up
To avoid incurring charges to your Google Cloud account for the resources used on this page, follow these steps.
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- Select the
quickstart-instance
instance to open the Instance details page. - In the icon bar at the top of the page, click Delete.
- In the Delete instance dialog box, type
quickstart-instance
, and then click Delete to delete the instance. -
In the Google Cloud console, go to the Cloud Run page.
- Select the checkbox next to the
quickstart-service
service name. - Click Delete at the top of the Cloud Run page.
Optional cleanup steps
If you're not using the Cloud SQL client role that you assigned to the Compute Engine service account, you can remove it.
-
In the Google Cloud console, go to the IAM page.
- Click the edit icon (which looks like a pencil) for the IAM account named Compute Engine default service account.
- Delete the Cloud SQL client role.
- Click Save.
If you're not using the APIs that were enabled as part of this quickstart, you can disable them.
- APIs that were enabled within this quickstart:
- Compute Engine API
- Cloud SQL Admin API
- Cloud Run API
- Container Registry API
- Cloud Build API
In the Google Cloud console, go to the APIs page.
Select any API that you would like to disable and then click the Disable API button.
What's next
Based on your needs, you can learn more about creating Cloud SQL instances.You also can learn about creating PostgreSQL users and databases for your Cloud SQL instance.
For more information about pricing, see Cloud SQL for PostgreSQL pricing.
Learn more about:
- Configuring your Cloud SQL instance with a public IP address.
- Configuring your Cloud SQL instance with a private IP address.
Additionally, you can learn about connecting to a Cloud SQL instance from other Google Cloud applications: