Skip to content

Commit 17298c5

Browse files
author
Saketram Durbha
committed
fix Cloud SQL MySQL & PostgreSQL READMEs to remove unneecessary instructions
1 parent 9fa6f6e commit 17298c5

File tree

2 files changed

+12
-22
lines changed

2 files changed

+12
-22
lines changed

cloud-sql/mysql/sqlalchemy/README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,6 @@ name.
1717
[instructions](https://cloud.google.com/sql/docs/mysql/connect-external-app#4_if_required_by_your_authentication_method_create_a_service_account).
1818
Download a JSON key to use to authenticate your connection.
1919

20-
1. Use the information noted in the previous steps:
21-
```bash
22-
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account/key.json
23-
export CLOUD_SQL_CONNECTION_NAME='<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>'
24-
export DB_USER='my-db-user'
25-
export DB_PASS='my-db-pass'
26-
export DB_NAME='my_db'
27-
```
28-
Note: Saving credentials in environment variables is convenient, but not secure - consider a more
29-
secure solution such as [Cloud KMS](https://cloud.google.com/kms/) to help keep secrets safe.
30-
3120
## Running locally
3221

3322
To run this application locally, download and install the `cloud_sql_proxy` by
@@ -52,6 +41,8 @@ export DB_USER='<DB_USER_NAME>'
5241
export DB_PASS='<DB_PASSWORD>'
5342
export DB_NAME='<DB_NAME>'
5443
```
44+
Note: Saving credentials in environment variables is convenient, but not secure - consider a more
45+
secure solution such as [Cloud KMS](https://cloud.google.com/kms/) to help keep secrets safe.
5546

5647
Then use this command to launch the proxy in the background:
5748
```bash
@@ -67,6 +58,8 @@ $env:DB_USER="<DB_USER_NAME>"
6758
$env:DB_PASS="<DB_PASSWORD>"
6859
$env:DB_NAME="<DB_NAME>"
6960
```
61+
Note: Saving credentials in environment variables is convenient, but not secure - consider a more
62+
secure solution such as [Cloud KMS](https://cloud.google.com/kms/) to help keep secrets safe.
7063

7164
Then use this command to launch the proxy in a separate PowerShell session:
7265
```powershell
@@ -98,6 +91,8 @@ export DB_USER='<DB_USER_NAME>'
9891
export DB_PASS='<DB_PASSWORD>'
9992
export DB_NAME='<DB_NAME>'
10093
```
94+
Note: Saving credentials in environment variables is convenient, but not secure - consider a more
95+
secure solution such as [Cloud KMS](https://cloud.google.com/kms/) to help keep secrets safe.
10196

10297
Then use this command to launch the proxy in the background:
10398
```bash

cloud-sql/postgres/sqlalchemy/README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,6 @@ name.
1717
[instructions](https://cloud.google.com/sql/docs/postgres/connect-external-app#4_if_required_by_your_authentication_method_create_a_service_account).
1818
Download a JSON key to use to authenticate your connection.
1919

20-
1. Use the information noted in the previous steps:
21-
```bash
22-
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account/key.json
23-
export CLOUD_SQL_CONNECTION_NAME='<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>'
24-
export DB_USER='my-db-user'
25-
export DB_PASS='my-db-pass'
26-
export DB_NAME='my_db'
27-
```
28-
Note: Saving credentials in environment variables is convenient, but not secure - consider a more
29-
secure solution such as [Cloud KMS](https://cloud.google.com/kms/) to help keep secrets safe.
30-
3120
## Running locally
3221

3322
To run this application locally, download and install the `cloud_sql_proxy` by
@@ -51,6 +40,8 @@ export DB_USER='<DB_USER_NAME>'
5140
export DB_PASS='<DB_PASSWORD>'
5241
export DB_NAME='<DB_NAME>'
5342
```
43+
Note: Saving credentials in environment variables is convenient, but not secure - consider a more
44+
secure solution such as [Cloud KMS](https://cloud.google.com/kms/) to help keep secrets safe.
5445

5546
Then use this command to launch the proxy in the background:
5647
```bash
@@ -66,6 +57,8 @@ $env:DB_USER="<DB_USER_NAME>"
6657
$env:DB_PASS="<DB_PASSWORD>"
6758
$env:DB_NAME="<DB_NAME>"
6859
```
60+
Note: Saving credentials in environment variables is convenient, but not secure - consider a more
61+
secure solution such as [Cloud KMS](https://cloud.google.com/kms/) to help keep secrets safe.
6962

7063
Then use this command to launch the proxy in a separate PowerShell session:
7164
```powershell
@@ -96,6 +89,8 @@ export DB_USER='<DB_USER_NAME>'
9689
export DB_PASS='<DB_PASSWORD>'
9790
export DB_NAME='<DB_NAME>'
9891
```
92+
Note: Saving credentials in environment variables is convenient, but not secure - consider a more
93+
secure solution such as [Cloud KMS](https://cloud.google.com/kms/) to help keep secrets safe.
9994
10095
Then use this command to launch the proxy in the background:
10196
```bash

0 commit comments

Comments
 (0)