chore: small fixes to multicontainer sample (#1801)

GoogleCloudPlatform · May 17, 2023 · 11c9ce0 · 11c9ce0
1 parent 46c6e55
commit 11c9ce0
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 12 deletions.
diff --git a/examples/multi-container/ruby/README.md b/examples/multi-container/ruby/README.md
@@ -7,7 +7,7 @@ existing application which connects to a Cloud SQL instance.
 
 1. If you haven't already, [create a project](https://cloud.google.com/resource-manager/docs/creating-managing-projects#creating_a_project).
 
-1. Create a 2nd Gen Cloud SQL Instance by following these
+1. Create a 2nd Gen Cloud SQL Postgres Instance by following these
 [instructions](https://cloud.google.com/sql/docs/postgres/create-instance).
 Note the connection string, database user, and database password that you create.
 
@@ -54,9 +54,9 @@ Next, build the container image for the main application and deploy it:
 gcloud builds submit --tag gcr.io/<YOUR_PROJECT_ID>/run-cloudsql
 ```
 
-Finally, create a revision YAML file (multicontainers.yaml), using the `example.yaml`
-file as a reference for the deployment, listing the Cloud SQL container image as
-a sidecar:
+Finally, update the `multicontainers.yaml` file with the correct values for your
+deployment for `YOUR_PROJECT_ID`, `DB_USER`, `DB_PASS`, `DB_NAME`, and `INSTANCE_CONNECTION_NAME`
+listing the Cloud SQL container image as a sidecar:
 
 ```yaml
 apiVersion: serving.knative.dev/v1
@@ -70,7 +70,6 @@ spec:
     metadata:
       annotations:
         run.googleapis.com/execution-environment: gen1 #or gen2
-        # run.googleapis.com/vpc-access-connector: <CONNECTOR_NAME>
 
     spec:
       containers:
@@ -92,18 +91,16 @@ spec:
       - name: cloud-sql-proxy
         image: gcr.io/cloud-sql-connectors/cloud-sql-proxy:latest
         args:
-             # If connecting from within a VPC network, you can use the
-             # following flag to have the proxy connect over private IP
-             # - "--private-ip"
-
-             # Ensure the port number on the --port argument matches the value of the DB_PORT env var on the my-app container.
+             # Ensure the port number on the --port argument matches the value of
+             # the DB_PORT env var on the my-app container.
              - "--port=5432"
              - "<INSTANCE_CONNECTION_NAME>"
 
 ```
 
 Before deploying, you will need to make sure that the service account associated
-with the Cloud Run deployment (defaults to compute engine service account) has the Cloud SQL Client role.
+with the Cloud Run deployment (defaults to compute engine service account) has the
+Cloud SQL Client role.
 See [this documentation](https://cloud.google.com/sql/docs/postgres/roles-and-permissions)
 for more details.
 

diff --git a/examples/multi-container/ruby/example.yaml → .../multi-container/ruby/multicontainer.yaml b/examples/multi-container/ruby/example.yaml → .../multi-container/ruby/multicontainer.yaml
@@ -23,6 +23,8 @@ spec:
     metadata:
       annotations:
         run.googleapis.com/execution-environment: gen1 #or gen2
+        # Uncomment the following line if connecting to Cloud SQL using Private IP
+        # via a VPC access connector
         # run.googleapis.com/vpc-access-connector: <CONNECTOR_NAME>
     spec:
       containers:
@@ -44,7 +46,7 @@ spec:
       - name: cloud-sql-proxy
         image: gcr.io/cloud-sql-connectors/cloud-sql-proxy:latest
         args:
-             # If connecting from within a VPC network, you can use the
+             # If connecting to a Cloud SQL instance within a VPC network, you can use the
              # following flag to have the proxy connect over private IP
              # - "--private-ip"