Skip to content

docs: add note about new executable name in migration guide #2403

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

Merged
jackwotherspoon merged 2 commits into from
Mar 10, 2025
Merged

docs: add note about new executable name in migration guide #2403

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5087f86
Add note about the new executable name
bseib Mar 8, 2025
2c2d934
Use `shell` fence info string on code blocks
bseib Mar 10, 2025
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
18 changes: 17 additions & 1 deletion migration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,26 @@ and then attempt to use a private IP. In v2, the Proxy now defaults to public
IP without trying private IP. If you want to use private IP, you must pass
either the `--private-ip` flag or the query parameter. See the README for details.

In some cases, the v1 behavior may be preferrable. Use the `--auto-ip` flag to
In some cases, the v1 behavior may be preferable. Use the `--auto-ip` flag to
mimic v1 behavior. We generally recommend using deterministic IP address selection,
but recognize in some legacy environments `--auto-ip` may be necessary.

## Executable Name Change

Note that the name of the executable has changed, using hyphens rather than underscores:

```shell
# v1
./cloud_sql_proxy
```

vs

```shell
# v2
./cloud-sql-proxy
```

## Sample Invocations

### Listen on TCP socket
Expand Down
Loading