Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Steps in Cloud SQL README are out of date and do not work #3635

Closed
rogerthatdev opened this issue Mar 7, 2024 · 2 comments · Fixed by #3655
Closed

Steps in Cloud SQL README are out of date and do not work #3635

rogerthatdev opened this issue Mar 7, 2024 · 2 comments · Fixed by #3655
Assignees
@enocom
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. samples Issues that are directly related to samples. triage me I really want to be triaged. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@rogerthatdev
Copy link
Contributor

The README for Cloud SQL MySQL samples has several problems:

  • it includes a link to our docs to install cloud-sql-proxy. The steps after this however are out of date, as they use the older cloud_sql_proxy instead of cloud-sql-proxy. ALL COMMANDS USING cloud_sql_proxy FAIL.
  • step 5 sets the environment variable for INSTANCE_CONNECTION_NAME. Subsequence steps still use <project-id>:<region>:<instance-name> instead of the variable
  • the flag --credential_file used in these steps does not exist; it is --credentials-file

Recommendation:

These instructions do not work. They should be updated ASAP as they are linked directly from official Cloud SQL documentation. See Connect from Cloud Run**
@rogerthatdev rogerthatdev added priority: p2 Moderately-important priority. Fix may not be included in next release. triage me I really want to be triaged. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Mar 7, 2024
@product-auto-label product-auto-label bot added the samples Issues that are directly related to samples. label Mar 7, 2024
@iennae
Copy link
Contributor

iennae commented Apr 12, 2024

@mrfaizal do you have any insight on who might be able to assess and triage this ? Thanks

@mrfaizal mrfaizal assigned enocom and unassigned mrfaizal Apr 15, 2024
@enocom
Copy link
Member

enocom commented Apr 15, 2024

This is probably an issue across all engines. I can send a quick PR to address the key v1 vs v2 Cloud SQL Proxy concerns.

Separately, we are planning a general rewrite of these samples. cc @jackwotherspoon

enocom added a commit that referenced this issue Apr 15, 2024
@enocom
chore: use Cloud SQL Proxy v2 in README
dc477f3 
Also, remove all reference to service account keys in favor of
Application Default Credentials.

Fixes #3634
Fixes #3635
@enocom enocom mentioned this issue Apr 15, 2024
Merged
enocom added a commit to GoogleCloudPlatform/golang-samples that referenced this issue Apr 15, 2024
@enocom
chore: use Cloud SQL Proxy v2 in READMEs
7b1928c 
Also remove references to service account keys in favor of application
default credentials.

Related to GoogleCloudPlatform/nodejs-docs-samples#3635
@enocom enocom mentioned this issue Apr 15, 2024
Merged
@enocom enocom closed this as completed in d8159bb Apr 15, 2024
enocom added a commit to GoogleCloudPlatform/golang-samples that referenced this issue Jun 4, 2024
@enocom
chore: use Cloud SQL Proxy v2 in READMEs (#3998)
4dcb0e3 
Also remove references to service account keys in favor of application
default credentials.

Related to GoogleCloudPlatform/nodejs-docs-samples#3635
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@enocom enocom

Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. samples Issues that are directly related to samples. triage me I really want to be triaged. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: use Cloud SQL Proxy v2 in README GoogleCloudPlatform/nodejs-docs-samples
4 participants
@enocom @iennae @mrfaizal @rogerthatdev