Connect to Cloud SQL for SQL Server from Google Kubernetes Engine

Connect to Cloud SQL for SQL Server from Google Kubernetes Engine

MySQL   |  PostgreSQL   |  SQL Server

This page shows you how to deploy a sample app on Google Kubernetes Engine (GKE) connected to a SQL Server instance using the Google Cloud console and a client application. The resources created in this quickstart typically cost less than one dollar (USD), assuming you complete the steps, including the clean up, in a timely manner.

Before you begin

Note: The name you use for your project must be between 4 and 30 characters. When you type the name, the form suggests a project ID, which you can edit. The project ID must be between 6 and 30 characters, with a lowercase letter as the first character. You can use a dash, lowercase letter, or digit for the remaining characters, but the last character cannot be a dash.

1. 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.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

5. Make sure that billing is enabled for your Google Cloud project.

6. Enable the Google Cloud APIs necessary to run a Cloud SQL sample app on GKE.

   Console

   Click Enable APIs to enable the APIs required for this quickstart.

   Enable APIs

   This enables the following APIs:

   • Compute Engine API
   • Cloud SQL Admin API
   • Google Kubernetes Engine API
   • Artifact Registry API
   • Cloud Build API

   gcloud

   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.

   Open Cloud Shell

   Run the gcloud services enable command as follows using Cloud Shell to enable the APIs required for this quickstart.:

   gcloud services enable compute.googleapis.com sqladmin.googleapis.com \
        container.googleapis.com artifactregistry.googleapis.com cloudbuild.googleapis.com

   This command enables the following APIs:

   • Compute Engine API
   • Cloud SQL Admin API
   • GKE API
   • Artifact Registry API
   • Cloud Build API

Set up Cloud SQL

Create a Cloud SQL instance

Public IP

Console

Create an instance with a public IP address

1. In the Google Cloud console, go to the Cloud SQL Instances page.

   Go to Cloud SQL Instances

2. Click Create Instance.
3. Click SQL Server.
4. Enter quickstart-instance for Instance ID.
5. Enter a password for the sqlserver user. Save this password for future use.
6. Click the Single zone option for Choose region and zonal availability.
7. Click and expand the Show Configurations section.
8. In the Machine Type drop-down menu, select Lightweight.

9. Click Create Instance and wait until the instance initializes and starts.

gcloud

Create an instance with a public IP address

Before running the gcloud sql instances create 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 currently 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. See the full list of regions.

Run the gcloud sql instances create command to create a Cloud SQL instance.

gcloud sql instances create quickstart-instance \
--database-version=SQLSERVER_2019_STANDARD \
--cpu=1 \
--memory=4GB \
--region=us-central \
--root-password=DB_ROOT_PASSWORD

Private IP

Console

Create an instance with a private IP address and SSL enabled

1. In the Google Cloud console, go to the Cloud SQL Instances page.

   Go to Cloud SQL Instances

2. Click Create instance.
3. Click SQL Server.
4. Enter quickstart-instance for Instance ID.
5. Enter a password for the sqlserver user. Save this password for future use.
6. Click the Single zone option for Choose region and zonal availability.
7. Click and expand Show configuration options.
8. For Machine Type, select Lightweight.
9. In Connections, select Private IP.
10. Select default in the Network drop-down menu.
11. If you see a dialog stating Private services access connection required, click the Set Up Connection button.
• In the Enable Service Networking API dialog, click the Enable API button.
• In the Allocate an IP range dialog, select Use an automatically allocated IP range and click Continue.
• In the Create a connection dialog, click Create Connection.
12. Clear the Public IP checkbox to create an instance only with a private IP.
13. Click Create instance and then wait for the instance to initialize and start.
14. Click Connections.
15. In the Security section, select Allow only SSL connections to enable SSL connections.
16. In the Allow only SSL connections dialog, click Save and restart and then wait for the instance to restart.

gcloud

Create an instance with a private IP address and SSL enabled

Creating an instance with a private IP address only requires configuring private services access to enable connections from other Google Cloud services, such as GKE.

1. Run the gcloud compute addresses create command to allocate an IP range for a private services access connection:

gcloud compute addresses create google-managed-services-default \
--global \
--purpose=VPC_PEERING \
--prefix-length=16 \
--description="peering range for Google" \
--network=default

2. Run the gcloud services vpc-peerings connect command to create the private services access connection:

gcloud services vpc-peerings connect \
--service=servicenetworking.googleapis.com \
--ranges=google-managed-services-default \
--network=default

3. Before running the gcloud sql instances create command to create an instance 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 gcloud database versions for a list of currently available versions.
• --cpu: The number of cores in the machine.
• --memory: A whole number 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 create command to create a Cloud SQL instance with a private IP address.

gcloud beta sql instances create quickstart-instance \
--database-version=SQLSERVER_2017_STANDARD \
 --cpu=1 \
 --memory=4GB \
 --region=us-central \
 --root-password=DB_ROOT_PASSWORD \
 --no-assign-ip \
--network=default

4. Run the gcloud sql instances patch command to allow only SSL connections for the instance.

gcloud sql instances patch quickstart-instance --require-ssl

Create a database

Console

1. In the Google Cloud console, go to the Cloud SQL Instances page.

   Go to Cloud SQL Instances

2. Select quickstart-instance.
3. From the SQL navigation menu, select Databases.
4. Click Create database.
1. In the Database name field of the New database dialog box, enter quickstart-db.
2. Click Create.

gcloud

Run the gcloud sql databases create command to create a database.

gcloud sql databases create quickstart-db --instance=quickstart-instance

Create a GKE cluster

Console

1. In the Google Cloud console, go to the Google Kubernetes Engine page.

   Go to Google Kubernetes Engine

2. Click Create.
3. Click Configure for GKE Autopilot.
4. For Name, specify the cluster name as gke-cloud-sql-quickstart.
5. Click Create.

gcloud

Run the gcloud container clusters create-auto command to create the cluster.

gcloud container clusters create-auto gke-cloud-sql-quickstart \
    --region us-central1

Clone a Cloud SQL sample app into Cloud Shell Editor

With a Cloud SQL instance, a database, and a GKE cluster, you can now clone and configure a sample application to connect to your Cloud SQL instance. The remaining steps in this quickstart require using the gcloud and kubectl command-line tools. Both tools are pre-installed in Cloud Shell.

Go

1. In Cloud Shell Editor, open the sample app's source code.
   Open Cloud Shell Editor
2. 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.

Java

1. In Cloud Shell Editor, open the sample app's source code.
   Open Cloud Shell Editor
2. 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.

Node.js

1. In Cloud Shell Editor, open the sample app's source code.
   Open Cloud Shell Editor
2. 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.

Python

1. In Cloud Shell Editor, open the sample app's source code.
   Open Cloud Shell Editor
2. 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.

Enable the GKE cluster

Enable the GKE cluster you just created as the default cluster to be used for the remaining commands in this quickstart.

Run the gcloud container clusters get-credentials command as follows to enable the GKE cluster.

gcloud container clusters get-credentials gke-cloud-sql-quickstart \
  --region us-central1

Set up a service account

Create and configure a Google Cloud service account to be used by GKE so that it has the Cloud SQL Client role with permissions to connect to Cloud SQL.

1. Run the gcloud iam service-accounts create command as follows to create a new service account:

   gcloud iam service-accounts create gke-quickstart-service-account \
     --display-name="GKE Quickstart Service Account"

2. Run the gcloud projects add-iam-policy-binding command as follows to add the Cloud SQL Client role to the Google Cloud service account you just created. Replace YOUR_PROJECT_ID with the project ID.

   gcloud projects add-iam-policy-binding YOUR_PROJECT_ID \
     --member="serviceAccount:gke-quickstart-service-account@YOUR_PROJECT_ID.iam.gserviceaccount.com" \
     --role="roles/cloudsql.client"

3. The sample app uses logging, so run the gcloud projects add-iam-policy-binding command as follows to add the Log Writer role to the Google Cloud service account you just created. Replace YOUR_PROJECT_ID with the project ID.

   gcloud projects add-iam-policy-binding YOUR_PROJECT_ID \
     --member="serviceAccount:gke-quickstart-service-account@YOUR_PROJECT_ID.iam.gserviceaccount.com" \
     --role="roles/logging.logWriter"

4. The service account must be able to pull images from the artifactory repository, so run the
   gcloud projects add-iam-policy-binding command as follows to add the Artifact Registry Reader role to the service account. Replace YOUR_PROJECT_ID with the project ID.

   gcloud projects add-iam-policy-binding YOUR_PROJECT_ID \
     --member="serviceAccount:gke-quickstart-service-account@YOUR_PROJECT_ID.iam.gserviceaccount.com" \
     --role="roles/artifactregistry.reader"

Create a Kubernetes service account configured to have access to Cloud SQL by binding it to the Google Cloud service account using Workload Identity Federation for GKE.

1. Create a Kubernetes Service Account.
   1. Update the service-account.yaml file in Cloud Shell Editor. Replace <YOUR-KSA-NAME> with ksa-cloud-sql.
   2. Run the kubectl apply command as follows in Cloud Shell:

      kubectl apply -f service-account.yaml

2. Run the gcloud iam service-accounts add-iam-policy-binding command as follows to enable IAM binding of the Google Cloud Service Account and the Kubernetes Service Account. Make the following replacements:
   • YOUR_PROJECT_ID with the project ID.
   • YOUR_K8S_NAMESPACE with default, which is the default namespace for clusters created in GKE.
   • YOUR_KSA_NAME with ksa-cloud-sql.

   gcloud iam service-accounts add-iam-policy-binding \
     --role="roles/iam.workloadIdentityUser" \
     --member="serviceAccount:YOUR_PROJECT_ID.svc.id.goog[YOUR_K8S_NAMESPACE/YOUR_KSA_NAME]" \
     gke-quickstart-service-account@YOUR_PROJECT_ID.iam.gserviceaccount.com

3. Run the kubectl annotate command as follows to annotate the Kubernetes Service Account with IAM binding. Make the following replacements:
   • YOUR_KSA_NAME with ksa-cloud-sql.
   • YOUR_PROJECT_ID with the project ID.

   kubectl annotate serviceaccount \
     YOUR_KSA_NAME  \
     iam.gke.io/gcp-service-account=gke-quickstart-service-account@YOUR_PROJECT_ID.iam.gserviceaccount.com

Configure secrets

Run the kubectl create secret generic command as follows to create Kubernetes secrets for the database, user, and user password to be used by the sample app. The values of each secret are based on the values specified in the previous steps of this quickstart. Replace DB_PASS with the password of the sqlserver root user that was created in the Create a Cloud SQL instance step.

kubectl create secret generic gke-cloud-sql-secrets \
  --from-literal=database=quickstart-db \
  --from-literal=username=sqlserver \
  --from-literal=password=DB_PASS

Build the sample app

Go

1. Run the following gcloud artifacts repositories create command in Cloud Shell to create a repository in the Artifact Registry named gke-cloud-sql-repo in the same region as your cluster. Replace YOUR_PROJECT_ID with the project ID.

   gcloud artifacts repositories create gke-cloud-sql-repo \
     --project=YOUR_PROJECT_ID \
     --repository-format=docker \
     --location=us-central1 \
     --description="GKE Quickstart sample app"

2. Run the gcloud builds submit command as follows in Cloud Shell to build a Docker container and publish it to Artifact Registry. Replace YOUR_PROJECT_ID with the project ID.

   gcloud builds submit \
     --tag us-central1-docker.pkg.dev/YOUR_PROJECT_ID/gke-cloud-sql-repo/gke-sql .

Java

1. Run the following gcloud artifacts repositories create command in Cloud Shell to create a repository in the Artifact Registry named gke-cloud-sql-repo in the same region as your cluster. Replace YOUR_PROJECT_ID with the project ID.

   gcloud artifacts repositories create gke-cloud-sql-repo \
     --project=YOUR_PROJECT_ID \
     --repository-format=docker \
     --location=us-central1 \
     --description="GKE Quickstart sample app"

2. Run the mvn command as follows in Cloud Shell to build a Docker container and publish it to Artifact Registry. Replace YOUR_PROJECT_ID with the project ID.

   mvn clean package com.google.cloud.tools:jib-maven-plugin:2.8.0:build \
     -Dimage=us-central1-docker.pkg.dev/YOUR_PROJECT_ID/gke-cloud-sql-repo/gke-sql \
     -DskipTests -Djib.to.credHelper=gcloud

Node.js

1. Run the following gcloud artifacts repositories create command in Cloud Shell to create a repository in the Artifact Registry named gke-cloud-sql-repo in the same region as your cluster. Replace YOUR_PROJECT_ID with the project ID.

   gcloud artifacts repositories create gke-cloud-sql-repo \
     --project=YOUR_PROJECT_ID \
     --repository-format=docker \
     --location=us-central1 \
     --description="GKE Quickstart sample app"

2. Run the gcloud builds submit command as follows in Cloud Shell to build a Docker container and publish it to Artifact Registry. Replace YOUR_PROJECT_ID with the project ID.

   gcloud builds submit \
     --tag us-central1-docker.pkg.dev/YOUR_PROJECT_ID/gke-cloud-sql-repo/gke-sql .

Python

1. Run the following gcloud artifacts repositories create command in Cloud Shell to create a repository in the Artifact Registry named gke-cloud-sql-repo in the same region as your cluster. Replace YOUR_PROJECT_ID with the project ID.

   gcloud artifacts repositories create gke-cloud-sql-repo \
     --project=YOUR_PROJECT_ID \
     --repository-format=docker \
     --location=us-central1 \
     --description="GKE Quickstart sample app"

2. Run the gcloud builds submit command as follows in Cloud Shell to build a Docker container and publish it to Artifact Registry. Replace YOUR_PROJECT_ID with the project ID.

   gcloud builds submit \
     --tag us-central1-docker.pkg.dev/YOUR_PROJECT_ID/gke-cloud-sql-repo/gke-sql .

Deploy the sample app

Public IP

With the sample app configuration in place, you can now deploy the sample app.

Go

The deployed sample app connects to your Cloud SQL instance using the Cloud SQL proxy running in a Kubernetes sidecar pattern. The sidecar pattern is accomplished by deploying a workload with an additional container that shares the same Kubernetes pod as the sample app's container.

1. Get the Cloud SQL instance connection name by running the gcloud sql instances describe command:

   gcloud sql instances describe quickstart-instance --format='value(connectionName)'

2. Update the deployment.yaml file in Cloud Shell Editor. Make the following replacements:
   • <YOUR_KSA_NAME> with ksa-cloud-sql.
   • <LOCATION> with us-central1.
   • <YOUR_PROJECT_ID> with the project ID.
   • <YOUR-DB-SECRET> with gke-cloud-sql-secrets.
   • <INSTANCE_CONNECTION_NAME> with the Cloud SQL instance connection name retrieved from the gcloud command on the previous step. The format is project_id:region:instance_name. The instance connection name is also visible in the Cloud SQL instance Overview page.
   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: gke-cloud-sql-quickstart
   spec:
     selector:
       matchLabels:
         app: gke-cloud-sql-app
     template:
       metadata:
         labels:
           app: gke-cloud-sql-app
       spec:
         serviceAccountName: <YOUR-KSA-NAME>
         containers:
         - name: gke-cloud-sql-app
           # Replace <LOCATION> with your Artifact Registry location (e.g., us-central1).
           # Replace <YOUR_PROJECT_ID> with your project ID.
           image: <LOCATION>-docker.pkg.dev/<YOUR_PROJECT_ID>/gke-cloud-sql-repo/gke-sql:latest
           # This app listens on port 8080 for web traffic by default.
           ports:
           - containerPort: 8080
           env:
           - name: PORT
             value: "8080"
           - name: INSTANCE_HOST
             value: "127.0.0.1"
           - name: DB_PORT
             value: "1433"
           - name: DB_USER
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: username
           - name: DB_PASS
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: password
           - name: DB_NAME
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: database
         - name: cloud-sql-proxy
           # This uses the latest version of the Cloud SQL Proxy
           # It is recommended to use a specific version for production environments.
           # See: https://github.com/GoogleCloudPlatform/cloudsql-proxy
           image: gcr.io/cloud-sql-connectors/cloud-sql-proxy:latest
           args:
             # If connecting from a VPC-native GKE cluster, you can use the
             # following flag to have the proxy connect over private IP
             # - "--private-ip"
   
             # tcp should be set to the port the proxy should listen on
             # and should match the DB_PORT value set above.
             # Defaults: MySQL: 3306, Postgres: 5432, SQLServer: 1433
             - "--port=1433"
             - "<INSTANCE_CONNECTION_NAME>"
           securityContext:
             # The default Cloud SQL proxy image runs as the
             # "nonroot" user and group (uid: 65532) by default.
             runAsNonRoot: true
   

3. Run the kubectl apply command as follows in Cloud Shell to deploy the sample app:

   kubectl apply -f deployment.yaml

4. Run the kubectl apply command as follows to add a load balancer in front of the deployment, so that you can access it through the internet:

   kubectl apply -f service.yaml

5. Run the kubectl get command as follows to get the service details:

   kubectl get services

6. Copy the External IP address once it becomes available in the service details, which may take a few minutes.
7. View the deployed sample app. Open a browser window and go to the service's External IP address.

   

Java

The deployed sample app connects to your Cloud SQL instance using the Cloud SQL Java connector.

1. Get the Cloud SQL instance connection name by running the gcloud sql instances describe command:

   gcloud sql instances describe quickstart-instance --format='value(connectionName)'

2. Update the deployment.yaml file in Cloud Shell Editor. Make the following replacements:
   • <YOUR_KSA_NAME> with ksa-cloud-sql.
   • <LOCATION> with us-central1.
   • <YOUR_PROJECT_ID> with the project ID.
   • <YOUR-DB-SECRET> with gke-cloud-sql-secrets.
   • <INSTANCE_CONNECTION_NAME> with the Cloud SQL instance connection name retrieved from the gcloud command on the previous step. The format is project_id:region:instance_name. The instance connection name is also visible in the Cloud SQL instance Overview page.
   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: gke-cloud-sql-quickstart
   spec:
     selector:
       matchLabels:
         app: gke-cloud-sql-app
     template:
       metadata:
         labels:
           app: gke-cloud-sql-app
       spec:
         # For more information about using Kubernetes service accounts see: 
         # https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts
         serviceAccountName: <YOUR-KSA-NAME> # TODO(developer): replace this value.
         containers:
         - name: gke-cloud-sql-app
           # Replace <LOCATION> with your Artifact Registry location (e.g., us-central1).
           # Replace <YOUR_PROJECT_ID> with your project ID.
           image: <LOCATION>-docker.pkg.dev/<YOUR_PROJECT_ID>/gke-cloud-sql-repo/gke-sql:latest
           # This app listens on port 8080 for web traffic by default.
           ports:
           - containerPort: 8080
           env:
           - name: PORT
             value: "8080"
           - name: INSTANCE_CONNECTION_NAME
             value: <INSTANCE_CONNECTION_NAME>
           - name: DB_HOST
             value: "127.0.0.1"
           - name: DB_PORT
             value: "1433"  
           - name: DB_USER
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: username
           - name: DB_PASS
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: password
           - name: DB_NAME
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: database
   

3. Run the kubectl apply command as follows in Cloud Shell to deploy the sample app:

   kubectl apply -f deployment.yaml

4. Run the kubectl apply command as follows to add a load balancer in front of the deployment, so that you can access it through the internet:

   kubectl apply -f service.yaml

5. Run the kubectl get command as follows to get the service details:

   kubectl get services

6. Copy the External IP address once it becomes available in the service details, which may take a few minutes.
7. View the deployed sample app. Open a browser window and go to the service's External IP address.

   

Node.js

The deployed sample app connects to your Cloud SQL instance using the Cloud SQL proxy running in a Kubernetes sidecar pattern. The sidecar pattern is accomplished by deploying a workload with an additional container that shares the same Kubernetes pod as the sample app's container.

1. Get the Cloud SQL instance connection name by running the gcloud sql instances describe command:

   gcloud sql instances describe quickstart-instance --format='value(connectionName)'

2. Update the deployment.yaml file in Cloud Shell Editor. Make the following replacements:
   • <YOUR_KSA_NAME> with ksa-cloud-sql.
   • <LOCATION> with us-central1.
   • <YOUR_PROJECT_ID> with the project ID.
   • <YOUR-DB-SECRET> with gke-cloud-sql-secrets.
   • <INSTANCE_CONNECTION_NAME> with the Cloud SQL instance connection name retrieved from the gcloud command on the previous step. The format is project_id:region:instance_name. The instance connection name is also visible in the Cloud SQL instance Overview page.
   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: gke-cloud-sql-quickstart
   spec:
     selector:
       matchLabels:
         app: gke-cloud-sql-app
     template:
       metadata:
         labels:
           app: gke-cloud-sql-app
       spec:
         serviceAccountName: <YOUR-KSA-NAME>
         containers:
         - name: gke-cloud-sql-app
           # Replace <LOCATION> with your Artifact Registry location (e.g., us-central1).
           # Replace <YOUR_PROJECT_ID> with your project ID.
           image: <LOCATION>-docker.pkg.dev/<YOUR_PROJECT_ID>/gke-cloud-sql-repo/gke-sql:latest
           # This app listens on port 8080 for web traffic by default.
           ports:
           - containerPort: 8080
           env:
           - name: PORT
             value: "8080"
           - name: INSTANCE_HOST
             value: "127.0.0.1"
           - name: DB_PORT
             value: "1433"  
           - name: DB_USER
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: username
           - name: DB_PASS
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: password
           - name: DB_NAME
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: database
         - name: cloud-sql-proxy
           # This uses the latest version of the Cloud SQL proxy
           # It is recommended to use a specific version for production environments.
           # See: https://github.com/GoogleCloudPlatform/cloudsql-proxy 
           image: gcr.io/cloud-sql-connectors/cloud-sql-proxy:latest
           args:
             # If connecting from a VPC-native GKE cluster, you can use the
             # following flag to have the proxy connect over private IP
             # - "--private-ip"
   
             # tcp should be set to the port the proxy should listen on
             # and should match the DB_PORT value set above.
             # Defaults: MySQL: 3306, Postgres: 5432, SQLServer: 1433
             - "--port=1433"
             - "<INSTANCE_CONNECTION_NAME>"
           securityContext:
             # The default Cloud SQL proxy image runs as the
             # "nonroot" user and group (uid: 65532) by default.
             runAsNonRoot: true
   

3. Run the kubectl apply command as follows in Cloud Shell to deploy the sample app:

   kubectl apply -f deployment.yaml

4. Run the kubectl apply command as follows to add a load balancer in front of the deployment, so that you can access it through the internet:

   kubectl apply -f service.yaml

5. Run the kubectl get command as follows to get the service details:

   kubectl get services

6. Copy the External IP address once it becomes available in the service details, which may take a few minutes.
7. View the deployed sample app. Open a browser window and go to the service's External IP address.

   

Python

The deployed sample app connects to your Cloud SQL instance using the Cloud SQL proxy running in a Kubernetes sidecar pattern. The sidecar pattern is accomplished by deploying a workload with an additional container that shares the same Kubernetes pod as the sample app's container.

1. Get the Cloud SQL instance connection name by running the gcloud sql instances describe command:

   gcloud sql instances describe quickstart-instance --format='value(connectionName)'

2. Update the deployment.yaml file in Cloud Shell Editor. Make the following replacements:
   • <YOUR_KSA_NAME> with ksa-cloud-sql.
   • <LOCATION> with us-central1.
   • <YOUR_PROJECT_ID> with the project ID.
   • <YOUR-DB-SECRET> with gke-cloud-sql-secrets.
   • <INSTANCE_CONNECTION_NAME> with the Cloud SQL instance connection name retrieved from the gcloud command on the previous step. The format is project_id:region:instance_name. The instance connection name is also visible in the Cloud SQL instance Overview page.
   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: gke-cloud-sql-quickstart
   spec:
     selector:
       matchLabels:
         app: gke-cloud-sql-app
     template:
       metadata:
         labels:
           app: gke-cloud-sql-app
       spec:
         serviceAccountName: <YOUR-KSA-NAME>
         containers:
         - name: gke-cloud-sql-app
           # Replace <LOCATION> with your Artifact Registry location (e.g., us-central1).
           # Replace <YOUR_PROJECT_ID> with your project ID.
           image: <LOCATION>-docker.pkg.dev/<YOUR_PROJECT_ID>/gke-cloud-sql-repo/gke-sql:latest
           # This app listens on port 8080 for web traffic by default.
           ports:
           - containerPort: 8080
           env:
           - name: PORT
             value: "8080"
           # This project uses environment variables to determine
           # how you would like to run your application
           # To use the Python connector (recommended) - use INSTANCE_CONNECTION_NAME (proj:region:instance)
           # To use TCP - Setting INSTANCE_HOST will use TCP (e.g., 127.0.0.1)
           - name: INSTANCE_HOST
             value: "127.0.0.1"
           - name: DB_PORT
             value: "1433"
           # If connecting from a VPC-native GKE cluster, you can use the
           # following environment variable to have the proxy connect over private IP
           # - name: CLOUD_SQL_AUTH_PROXY_IP_ADDRESS_TYPE
           #   value: "PRIVATE"
           - name: DB_USER
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: username
           - name: DB_PASS
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: password
           - name: DB_NAME
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: database
         # If you are using the Python Connector (recommended), you can
         # remove cloud-sql-proxy (everything below this line)
         - name: cloud-sql-proxy
           # This uses the latest version of the Cloud SQL proxy
           # It is recommended to use a specific version for production environments.
           # See: https://github.com/GoogleCloudPlatform/cloudsql-proxy 
           image: gcr.io/cloud-sql-connectors/cloud-sql-proxy:latest
           args:
             # If connecting from a VPC-native GKE cluster, you can use the
             # following flag to have the proxy connect over private IP
             # - "--private-ip"
   
             # tcp should be set to the port the proxy should listen on
             # and should match the DB_PORT value set above.
             # Defaults: MySQL: 3306, Postgres: 5432, SQLServer: 1433
             - "--port=1433"
             - "<INSTANCE_CONNECTION_NAME>"
           securityContext:
             # The default Cloud SQL proxy image runs as the
             # "nonroot" user and group (uid: 65532) by default.
             runAsNonRoot: true
   

3. Run the kubectl apply command as follows in Cloud Shell to deploy the sample app:

   kubectl apply -f deployment.yaml

4. Run the kubectl apply command as follows to add a load balancer in front of the deployment, so that you can access it through the internet:

   kubectl apply -f service.yaml

5. Run the kubectl get command as follows to get the service details:

   kubectl get services

6. Copy the External IP address once it becomes available in the service details, which may take a few minutes.
7. View the deployed sample app. Open a browser window and go to the service's External IP address.

   

Private IP

With the sample app configuration in place, you can now deploy the sample app.

Go

The deployed sample app connects to your Cloud SQL instance using the Cloud SQL proxy running in a Kubernetes sidecar pattern. The sidecar pattern is accomplished by deploying a workload with an additional container that shares the same Kubernetes pod as the sample app's container.

1. Get the Cloud SQL instance connection name by running the gcloud sql instances describe command:

   gcloud sql instances describe quickstart-instance --format='value(connectionName)'

2. Update the deployment.yaml file in Cloud Shell Editor. Make the following replacements and edits:
   • Replace <YOUR_KSA_NAME> with ksa-cloud-sql.
   • Replace <LOCATION> with us-central1.
   • Replace <YOUR_PROJECT_ID> with the project ID.
   • Replace <YOUR-DB-SECRET> with gke-cloud-sql-secrets.
   • Replace <INSTANCE_CONNECTION_NAME> with the Cloud SQL instance connection name retrieved from the gcloud command on the previous step. The format is project_id:region:instance_name. The instance connection name is also visible in the Cloud SQL instance Overview page.
   • Enable the Cloud SQL Auth proxy to connect to your Cloud SQL instance using its private IP address. Uncomment the "-ip_address_types=PRIVATE" flag by removing the # comment symbol and its trailing white space. The uncommented flag should look like this:

     - "-ip_address_types=PRIVATE"

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: gke-cloud-sql-quickstart
   spec:
     selector:
       matchLabels:
         app: gke-cloud-sql-app
     template:
       metadata:
         labels:
           app: gke-cloud-sql-app
       spec:
         serviceAccountName: <YOUR-KSA-NAME>
         containers:
         - name: gke-cloud-sql-app
           # Replace <LOCATION> with your Artifact Registry location (e.g., us-central1).
           # Replace <YOUR_PROJECT_ID> with your project ID.
           image: <LOCATION>-docker.pkg.dev/<YOUR_PROJECT_ID>/gke-cloud-sql-repo/gke-sql:latest
           # This app listens on port 8080 for web traffic by default.
           ports:
           - containerPort: 8080
           env:
           - name: PORT
             value: "8080"
           - name: INSTANCE_HOST
             value: "127.0.0.1"
           - name: DB_PORT
             value: "1433"
           - name: DB_USER
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: username
           - name: DB_PASS
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: password
           - name: DB_NAME
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: database
         - name: cloud-sql-proxy
           # This uses the latest version of the Cloud SQL Proxy
           # It is recommended to use a specific version for production environments.
           # See: https://github.com/GoogleCloudPlatform/cloudsql-proxy
           image: gcr.io/cloud-sql-connectors/cloud-sql-proxy:latest
           args:
             # If connecting from a VPC-native GKE cluster, you can use the
             # following flag to have the proxy connect over private IP
             # - "--private-ip"
   
             # tcp should be set to the port the proxy should listen on
             # and should match the DB_PORT value set above.
             # Defaults: MySQL: 3306, Postgres: 5432, SQLServer: 1433
             - "--port=1433"
             - "<INSTANCE_CONNECTION_NAME>"
           securityContext:
             # The default Cloud SQL proxy image runs as the
             # "nonroot" user and group (uid: 65532) by default.
             runAsNonRoot: true
   

3. Run the kubectl apply command as follows in Cloud Shell to deploy the sample app:

   kubectl apply -f deployment.yaml

4. Run the kubectl apply command as follows to add a load balancer in front of the deployment, so that you can access it through the internet:

   kubectl apply -f service.yaml

5. Run the kubectl get command as follows to get the service details:

   kubectl get services

6. Copy the External IP address once it becomes available in the service details, which may take a few minutes.
7. View the deployed sample app. Open a browser window and go to the service's External IP address.

   

Java

The deployed sample app connects to your Cloud SQL instance using the Cloud SQL Java connector.

1. Get the Cloud SQL instance connection name by running the gcloud sql instances describe command:

   gcloud sql instances describe quickstart-instance --format='value(connectionName)'

2. Update the deployment.yaml file in Cloud Shell Editor. Make the following replacements:
   • <YOUR_KSA_NAME> with ksa-cloud-sql.
   • <LOCATION> with us-central1.
   • <YOUR_PROJECT_ID> with the project ID.
   • <YOUR-DB-SECRET> with gke-cloud-sql-secrets.
   • <INSTANCE_CONNECTION_NAME> with the Cloud SQL instance connection name retrieved from the gcloud command on the previous step. The format is project_id:region:instance_name. The instance connection name is also visible in the Cloud SQL instance Overview page.
   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: gke-cloud-sql-quickstart
   spec:
     selector:
       matchLabels:
         app: gke-cloud-sql-app
     template:
       metadata:
         labels:
           app: gke-cloud-sql-app
       spec:
         # For more information about using Kubernetes service accounts see: 
         # https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts
         serviceAccountName: <YOUR-KSA-NAME> # TODO(developer): replace this value.
         containers:
         - name: gke-cloud-sql-app
           # Replace <LOCATION> with your Artifact Registry location (e.g., us-central1).
           # Replace <YOUR_PROJECT_ID> with your project ID.
           image: <LOCATION>-docker.pkg.dev/<YOUR_PROJECT_ID>/gke-cloud-sql-repo/gke-sql:latest
           # This app listens on port 8080 for web traffic by default.
           ports:
           - containerPort: 8080
           env:
           - name: PORT
             value: "8080"
           - name: INSTANCE_CONNECTION_NAME
             value: <INSTANCE_CONNECTION_NAME>
           - name: DB_HOST
             value: "127.0.0.1"
           - name: DB_PORT
             value: "1433"  
           - name: DB_USER
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: username
           - name: DB_PASS
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: password
           - name: DB_NAME
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: database
   

3. Run the kubectl apply command as follows in Cloud Shell to deploy the sample app:

   kubectl apply -f deployment.yaml

4. Run the kubectl apply command as follows to add a load balancer in front of the deployment, so that you can access it through the internet:

   kubectl apply -f service.yaml

5. Run the kubectl get command as follows to get the service details:

   kubectl get services

6. Copy the External IP address once it becomes available in the service details, which may take a few minutes.
7. View the deployed sample app. Open a browser window and go to the service's External IP address.

   

Node.js

The deployed sample app connects to your Cloud SQL instance using the Cloud SQL proxy running in a Kubernetes sidecar pattern. The sidecar pattern is accomplished by deploying a workload with an additional container that shares the same Kubernetes pod as the sample app's container.

1. Get the Cloud SQL instance connection name by running the gcloud sql instances describe command:

   gcloud sql instances describe quickstart-instance --format='value(connectionName)'

2. Update the deployment.yaml file in Cloud Shell Editor. Make the following replacements and edits:
   • Replace <YOUR_KSA_NAME> with ksa-cloud-sql.
   • Replace <LOCATION> with us-central1.
   • Replace <YOUR_PROJECT_ID> with the project ID.
   • Replace <YOUR-DB-SECRET> with gke-cloud-sql-secrets.
   • Replace <INSTANCE_CONNECTION_NAME> with the Cloud SQL instance connection name retrieved from the gcloud command on the previous step. The format is project_id:region:instance_name. The instance connection name is also visible in the Cloud SQL instance Overview page.
   • Enable the Cloud SQL Auth proxy to connect to your Cloud SQL instance using its private IP address. Uncomment the "-ip_address_types=PRIVATE" flag by removing the # comment symbol and its trailing white space. The uncommented flag should look like this:

     - "-ip_address_types=PRIVATE"

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: gke-cloud-sql-quickstart
   spec:
     selector:
       matchLabels:
         app: gke-cloud-sql-app
     template:
       metadata:
         labels:
           app: gke-cloud-sql-app
       spec:
         serviceAccountName: <YOUR-KSA-NAME>
         containers:
         - name: gke-cloud-sql-app
           # Replace <LOCATION> with your Artifact Registry location (e.g., us-central1).
           # Replace <YOUR_PROJECT_ID> with your project ID.
           image: <LOCATION>-docker.pkg.dev/<YOUR_PROJECT_ID>/gke-cloud-sql-repo/gke-sql:latest
           # This app listens on port 8080 for web traffic by default.
           ports:
           - containerPort: 8080
           env:
           - name: PORT
             value: "8080"
           - name: INSTANCE_HOST
             value: "127.0.0.1"
           - name: DB_PORT
             value: "1433"  
           - name: DB_USER
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: username
           - name: DB_PASS
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: password
           - name: DB_NAME
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: database
         - name: cloud-sql-proxy
           # This uses the latest version of the Cloud SQL proxy
           # It is recommended to use a specific version for production environments.
           # See: https://github.com/GoogleCloudPlatform/cloudsql-proxy 
           image: gcr.io/cloud-sql-connectors/cloud-sql-proxy:latest
           args:
             # If connecting from a VPC-native GKE cluster, you can use the
             # following flag to have the proxy connect over private IP
             # - "--private-ip"
   
             # tcp should be set to the port the proxy should listen on
             # and should match the DB_PORT value set above.
             # Defaults: MySQL: 3306, Postgres: 5432, SQLServer: 1433
             - "--port=1433"
             - "<INSTANCE_CONNECTION_NAME>"
           securityContext:
             # The default Cloud SQL proxy image runs as the
             # "nonroot" user and group (uid: 65532) by default.
             runAsNonRoot: true
   

3. Run the kubectl apply command as follows in Cloud Shell to deploy the sample app:

   kubectl apply -f deployment.yaml

4. Run the kubectl apply command as follows to add a load balancer in front of the deployment, so that you can access it through the internet:

   kubectl apply -f service.yaml

5. Run the kubectl get command as follows to get the service details:

   kubectl get services

6. Copy the External IP address once it becomes available in the service details, which may take a few minutes.
7. View the deployed sample app. Open a browser window and go to the service's External IP address.

   

Python

The deployed sample app connects to your Cloud SQL instance using the Cloud SQL proxy running in a Kubernetes sidecar pattern. The sidecar pattern is accomplished by deploying a workload with an additional container that shares the same Kubernetes pod as the sample app's container.

1. Get the Cloud SQL instance connection name by running the gcloud sql instances describe command:

   gcloud sql instances describe quickstart-instance --format='value(connectionName)'

2. Update the deployment.yaml file in Cloud Shell Editor. Make the following replacements and edits:
   • Replace <YOUR_KSA_NAME> with ksa-cloud-sql.
   • Replace <LOCATION> with us-central1.
   • Replace <YOUR_PROJECT_ID> with the project ID.
   • Replace <YOUR-DB-SECRET> with gke-cloud-sql-secrets.
   • Replace <INSTANCE_CONNECTION_NAME> with the Cloud SQL instance connection name retrieved from the gcloud command on the previous step. The format is project_id:region:instance_name. The instance connection name is also visible in the Cloud SQL instance Overview page.
   • Enable the Cloud SQL Auth proxy to connect to your Cloud SQL instance using its private IP address. Uncomment the "-ip_address_types=PRIVATE" flag by removing the # comment symbol and its trailing white space. The uncommented flag should look like this:

     - "-ip_address_types=PRIVATE"

   • Uncomment the - name: CLOUD_SQL_AUTH_PROXY_IP_ADDRESS_TYPE environment variable and its value by removing the # comment symbols and trailing white space. The uncommented environment variable and value should look like this:

      - name: CLOUD_SQL_AUTH_PROXY_IP_ADDRESS_TYPE
        value: "PRIVATE"

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: gke-cloud-sql-quickstart
   spec:
     selector:
       matchLabels:
         app: gke-cloud-sql-app
     template:
       metadata:
         labels:
           app: gke-cloud-sql-app
       spec:
         serviceAccountName: <YOUR-KSA-NAME>
         containers:
         - name: gke-cloud-sql-app
           # Replace <LOCATION> with your Artifact Registry location (e.g., us-central1).
           # Replace <YOUR_PROJECT_ID> with your project ID.
           image: <LOCATION>-docker.pkg.dev/<YOUR_PROJECT_ID>/gke-cloud-sql-repo/gke-sql:latest
           # This app listens on port 8080 for web traffic by default.
           ports:
           - containerPort: 8080
           env:
           - name: PORT
             value: "8080"
           # This project uses environment variables to determine
           # how you would like to run your application
           # To use the Python connector (recommended) - use INSTANCE_CONNECTION_NAME (proj:region:instance)
           # To use TCP - Setting INSTANCE_HOST will use TCP (e.g., 127.0.0.1)
           - name: INSTANCE_HOST
             value: "127.0.0.1"
           - name: DB_PORT
             value: "1433"
           # If connecting from a VPC-native GKE cluster, you can use the
           # following environment variable to have the proxy connect over private IP
           # - name: CLOUD_SQL_AUTH_PROXY_IP_ADDRESS_TYPE
           #   value: "PRIVATE"
           - name: DB_USER
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: username
           - name: DB_PASS
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: password
           - name: DB_NAME
             valueFrom:
               secretKeyRef:
                 name: <YOUR-DB-SECRET>
                 key: database
         # If you are using the Python Connector (recommended), you can
         # remove cloud-sql-proxy (everything below this line)
         - name: cloud-sql-proxy
           # This uses the latest version of the Cloud SQL proxy
           # It is recommended to use a specific version for production environments.
           # See: https://github.com/GoogleCloudPlatform/cloudsql-proxy 
           image: gcr.io/cloud-sql-connectors/cloud-sql-proxy:latest
           args:
             # If connecting from a VPC-native GKE cluster, you can use the
             # following flag to have the proxy connect over private IP
             # - "--private-ip"
   
             # tcp should be set to the port the proxy should listen on
             # and should match the DB_PORT value set above.
             # Defaults: MySQL: 3306, Postgres: 5432, SQLServer: 1433
             - "--port=1433"
             - "<INSTANCE_CONNECTION_NAME>"
           securityContext:
             # The default Cloud SQL proxy image runs as the
             # "nonroot" user and group (uid: 65532) by default.
             runAsNonRoot: true
   

3. Run the kubectl apply command as follows in Cloud Shell to deploy the sample app:

   kubectl apply -f deployment.yaml

4. Run the kubectl apply command as follows to add a load balancer in front of the deployment, so that you can access it through the internet:

   kubectl apply -f service.yaml

5. Run the kubectl get command as follows to get the service details:

   kubectl get services

6. Copy the External IP address once it becomes available in the service details, which may take a few minutes.
7. View the deployed sample app. Open a browser window and go to the service's External IP address.

   

Clean up

To avoid incurring charges to your Google Cloud account for the resources used on this page, follow these steps.

1. In the Google Cloud console, go to the Cloud SQL Instances page.

   Go to Cloud SQL Instances

2. Select the quickstart-instance instance to open the Instance details page.
3. In the icon bar at the top of the page, click Delete.
4. In the Delete instance dialog box, type quickstart-instance, and then click Delete to delete the instance.

5. In the Google Cloud console, go to the Google Kubernetes Engine page.

   Go to Google Kubernetes Engine

6. Click the checkbox next to the gke-cloud-sql-quickstart service name.
7. Click the Delete button at the top of the Google Kubernetes Engine page.

Optional cleanup steps

If you're not using the Google Cloud service account you created for this quickstart, you can remove it.

1. In the Google Cloud console, go to the IAM page.

   Go to IAM

2. Select the checkbox for the IAM account named gke-quickstart-service-account.
3. Click Remove and confirm the removal.

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
  • Google Kubernetes Engine API
  • Artifact Registry API
  • Cloud Build API

1. In the Google Cloud console, go to the APIs page.

   Go to APIs

2. 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 SQL Server users and databases for your Cloud SQL instance.

Also see the Cloud SQL pricing information.

Learn more about:

• All of the connectivity options in Cloud SQL.
• 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:

• From an application running on App Engine standard environment
• From an application running on Compute Engine
• From an application running on GKE
• From Cloud Run functions
• From Cloud Run