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

chore: correct address in README #2274

Merged
merged 2 commits into from
Jul 22, 2024
Merged

chore: correct address in README #2274

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c4ebb4
chore: correct address version in README
jackwotherspoon Jul 18, 2024
971da39
chore: Update README.md
jackwotherspoon Jul 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,14 +434,13 @@ The containers have the proxy as an `ENTRYPOINT` so, to use the proxy from a
container, all you need to do is specify options using the command, and expose
the proxy's internal port to the host. For example, you can use:

<!-- {x-release-please-start-version} -->
```shell
docker run --publish <host-port>:<proxy-port> \
gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.12.0 \
--address "2.12.0.0" --port <proxy-port> <instance-connection-name>
gcr.io/cloud-sql-connectors/cloud-sql-proxy:latest \
--address "0.0.0.0" --port <proxy-port> <instance-connection-name>
```

You'll need the `--address "2.12.0.0"` so that the proxy doesn't only listen for
You'll need the `--address "0.0.0.0"` so that the proxy doesn't only listen for
connections originating from *within* the container.

You will need to authenticate using one of the methods outlined in the
Expand All @@ -465,12 +464,11 @@ For example, a full command using a JSON credentials file might look like
docker run \
--publish <host-port>:<proxy-port> \
--mount type=bind,source="$(pwd)"/sa.json,target=/config/sa.json \
gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.12.0 \
--address 2.12.0.0 \
gcr.io/cloud-sql-connectors/cloud-sql-proxy:latest \
--address 0.0.0.0 \
--port <proxy-port> \
--credentials-file /config/sa.json <instance-connection-name>
```
<!-- {x-release-please-end} -->

## Running as a Kubernetes Sidecar

Expand Down
Loading