From 5087f86a938a3382f71f26a2e0a489aab58123b3 Mon Sep 17 00:00:00 2001 From: Broc Seib Date: Sat, 8 Mar 2025 16:49:47 -0500 Subject: [PATCH 1/2] Add note about the new executable name It is a subtle difference to notice in all the examples that the executable name has changed from using underscores to hyphens. It is helpful to the reader to have this explicitly pointed out, the same way that the other changes have been spelled out. --- migration-guide.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/migration-guide.md b/migration-guide.md index 928b58cae..ae82541d7 100644 --- a/migration-guide.md +++ b/migration-guide.md @@ -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: + +``` +# v1 +./cloud_sql_proxy +``` + +vs + +``` +# v2 +./cloud-sql-proxy +``` + ## Sample Invocations ### Listen on TCP socket From 2c2d9349d4bb246984c38b41d316fe1ea0feaf36 Mon Sep 17 00:00:00 2001 From: Broc Seib Date: Mon, 10 Mar 2025 09:24:16 -0400 Subject: [PATCH 2/2] Use `shell` fence info string on code blocks --- migration-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/migration-guide.md b/migration-guide.md index ae82541d7..a830b2797 100644 --- a/migration-guide.md +++ b/migration-guide.md @@ -42,14 +42,14 @@ but recognize in some legacy environments `--auto-ip` may be necessary. 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 ```