Skip to content

Commit 110a105

Browse files
docs: update wait command help message (#2401)
Signed-off-by: Stephane Jeandeaux <stephane.jeandeaux@gmail.com> Co-authored-by: Jack Wotherspoon <jackwoth@google.com>
1 parent bfb63f5 commit 110a105

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

cmd/root.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -332,12 +332,13 @@ Configuration
332332
333333
By default, the Proxy will wait up to the maximum time for the startup
334334
endpoint to respond. The wait command requires that the Proxy be started in
335-
another process with the HTTP health check enabled. If an alternate health
336-
check port or address is used, as in:
335+
another process with the HTTP health check or Prometheus enabled. If an
336+
alternate health check port or address is used, as in:
337337
338338
./cloud-sql-proxy <INSTANCE_CONNECTION_NAME> \
339339
--http-address 0.0.0.0 \
340-
--http-port 9191
340+
--http-port 9191 \
341+
--health-check
341342
342343
Then the wait command must also be told to use the same custom values:
343344

docs/cmd/cloud-sql-proxy_wait.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,13 @@ Configuration
2323

2424
By default, the Proxy will wait up to the maximum time for the startup
2525
endpoint to respond. The wait command requires that the Proxy be started in
26-
another process with the HTTP health check enabled. If an alternate health
27-
check port or address is used, as in:
26+
another process with the HTTP health check or Prometheus enabled. If an
27+
alternate health check port or address is used, as in:
2828

2929
./cloud-sql-proxy <INSTANCE_CONNECTION_NAME> \
3030
--http-address 0.0.0.0 \
31-
--http-port 9191
31+
--http-port 9191 \
32+
--health-check
3233

3334
Then the wait command must also be told to use the same custom values:
3435

0 commit comments

Comments
 (0)