Skip to content

Conversation

@sjeandeaux
Copy link
Contributor

Without --health-check or --prometheus, the server http does not start

@sjeandeaux sjeandeaux requested a review from a team as a code owner March 6, 2025 20:30
@jackwotherspoon
Copy link
Collaborator

@sjeandeaux Thanks for the PR! 😄

All the docs in our docs/ folder are auto-generated from our help messages.

So instead of updating the docs you will want to update the help message directly...

cloud-sql-proxy/cmd/root.go

Lines 331 to 340 in bfb63f5

Configuration
By default, the Proxy will wait up to the maximum time for the startup
endpoint to respond. The wait command requires that the Proxy be started in
another process with the HTTP health check enabled. If an alternate health
check port or address is used, as in:
./cloud-sql-proxy <INSTANCE_CONNECTION_NAME> \
--http-address 0.0.0.0 \
--http-port 9191

Without --health-check or --prometheus, the server http does not start

Signed-off-by: Stephane Jeandeaux <stephane.jeandeaux@gmail.com>
@sjeandeaux sjeandeaux changed the title Update cloud-sql-proxy_wait.md fix(doc): wait documentation Mar 7, 2025
Copy link
Collaborator

@jackwotherspoon jackwotherspoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small nit, otherwise LGTM 👍

Co-authored-by: Jack Wotherspoon <jackwoth@google.com>
@jackwotherspoon jackwotherspoon changed the title fix(doc): wait documentation docs: update wait command help message Mar 7, 2025
@jackwotherspoon jackwotherspoon merged commit 110a105 into GoogleCloudPlatform:main Mar 7, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants