Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asapdotid/dcc-cloud-sql-proxy
Docker Compose Google Cloud SQL Proxy
https://github.com/asapdotid/dcc-cloud-sql-proxy
cloud-sql cloud-sql-database cloud-sql-proxy connection-pool database docker docker-compose gcp google-cloud mysql postgresql sql-proxy
Last synced: 29 days ago
JSON representation
Docker Compose Google Cloud SQL Proxy
- Host: GitHub
- URL: https://github.com/asapdotid/dcc-cloud-sql-proxy
- Owner: asapdotid
- License: mit
- Created: 2023-11-27T12:29:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-07T06:50:00.000Z (8 months ago)
- Last Synced: 2024-11-07T08:14:53.792Z (3 months ago)
- Topics: cloud-sql, cloud-sql-database, cloud-sql-proxy, connection-pool, database, docker, docker-compose, gcp, google-cloud, mysql, postgresql, sql-proxy
- Language: Makefile
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker Compose Google Cloud SQL Proxy
The Cloud SQL Auth Proxy is a utility for ensuring secure connections to your Cloud SQL instances. It provides IAM authorization, allowing you to control who can connect to your instance through IAM permissions, and TLS 1.3 encryption, using docker compose.
| Database | Status | Tested |
| :--------- | :----: | :----: |
| MySQL | DONE | ✅ |
| PostgreSQL | DONE | ✅ |
| SQL Server | TODO | - |
## To Do
- [x] Connection to database from code [doc](https://github.com/asapdotid/dcc-cloud-sql-proxy?tab=readme-ov-file#connection-using-tcp)
- [ ] Add connection using SSL CLient Certificate
## Enable APIs and Services
SQL Proxy connection need `Cloud SQL Admin API` so first of all enable the API [document](https://cloud.google.com/sql/docs/introduction)
Please go to Google CLoude console, ex: `https://console.cloud.google.com/apis/dashboard?project=your_project` and change `your_project`
## Credentials
The Cloud SQL Proxy uses a Cloud IAM principal to authorize connections against a Cloud SQL instance. The Proxy sources the credentials using [Application Default Credentials](https://cloud.google.com/docs/authentication/production).
Note: Any IAM principal connecting to a Cloud SQL database will need one of the following IAM roles:
- Cloud SQL Client (preferred)
- Cloud SQL Editor
- Cloud SQL Admin
Or one may manually assign the following IAM permissions:
- cloudsql.instances.connect
- cloudsql.instances.get
> Download credentials json (ex: project-file-4234234.json) file and place on `./src/config` don't forget rename file to `credentials.json`
## Additional custom environment
Check `/src/.env`
| Environment variable | Description | Default |
| :---------------------- | :--------------------------------------------------------------------------------------------- | :-----: |
| `SQL_PROXY_INSTANCE_ID` | Visit the detail page of your Cloud SQL instance in the console (`project:region:instance_db`) | `""` |
| `SQL_PROXY_PORT` | Port connection to SQL database (default port) ex: `mysql 3306`, `postgres 5432` | `""` |
| `SQL_HOST_PORT` | Host connection using `localhost` and port (can change) ex: `mysql 3306`, `postgres 5432` | `""` |
## Run Docker Compose
Running docker compose using Makefile:
### Initial Docker Network
Create docker network `secure`
```bash
docker network create secure
```
### Initial Make
```bash
make init
```
### Set Docker Compose Environment variables
```bash
make set-env
```
Open file on `./src/.env` and edit value of variables.
### Docker Compose Up
```bash
make up
```
### Docker Compose Down
```bash
make down
```
### Make Help
```bash
make help
```
## Connection using TCP
Connection from code to `DATABASE` base of environment variable `SQL_HOST_PORT`:
| Connection | Host | Port |
| :--------- | :------------------------- | :-------------: |
| Code | `localhost` or `127.0.0.1` | `SQL_HOST_PORT` |
| Container | `cloudsql-proxy` | `SQL_HOST_PORT` |
Sample using `nodejs` [read document](https://cloud.google.com/sql/docs/postgres/connect-auth-proxy#expandable-1)
```javascript
const Knex = require("knex");
const fs = require("fs");
// createTcpPool initializes a TCP connection pool for a Cloud SQL
// instance of Postgres.
const createTcpPool = async (config) => {
// Note: Saving credentials in environment variables is convenient, but not
// secure - consider a more secure solution such as
// Cloud Secret Manager (https://cloud.google.com/secret-manager) to help
// keep secrets safe.
const dbConfig = {
client: "pg",
connection: {
host: process.env.INSTANCE_HOST, // e.g. '127.0.0.1'
port: process.env.DB_PORT, // e.g. '5432'
user: process.env.DB_USER, // e.g. 'my-user'
password: process.env.DB_PASS, // e.g. 'my-user-password'
database: process.env.DB_NAME, // e.g. 'my-database'
},
// ... Specify additional properties here.
...config,
};
// Establish a connection to the database.
return Knex(dbConfig);
};
```
## License
MIT / BSD
## Author Information
This Code was created at 2023 by [Asapdotid](https://github.com/asapdotid). 🚀