feat: add support for wait command #2041
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
enocom
force-pushed
the
wait-stop-cmd
branch
from
eac44ac
to
2bdc963
Compare
To help ensure the Proxy is up and ready, this commit adds a wait command with an optional `--max` flag to set the maximum time to wait. By default when invoking this command: ./cloud-sql-proxy wait The Proxy will wait up to the maximum time for the /startup endpoint to respond. This 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 Then the wait command must also be told to use the same custom values: ./cloud-sql-proxy wait --http-address 0.0.0.0 \ --http-port 9191 By default the wait command will wait 30 seconds. To alter this value, use: ./cloud-sql-proxy wait --max 10s Fixes #1117
enocom
force-pushed
the
wait-stop-cmd
branch
from
2bdc963
to
73c556a
Compare
jackwotherspoon
requested changes
Nov 22, 2023
cmd/root.go
Outdated
|
|
||
| Sometimes it is necessary to wait for the Proxy to start. | ||
|
|
||
| To help ensure the Proxy is up and ready, the Proxy includes adds a wait |
There was a problem hiding this comment.
Suggested change
| To help ensure the Proxy is up and ready, the Proxy includes adds a wait | |
| To help ensure the Proxy is up and ready, the Proxy includes a wait |
cmd/root.go
Outdated
| To help ensure the Proxy is up and ready, the Proxy includes adds a wait | ||
| subcommand with an optional --max flag to set the maximum time to wait. | ||
|
|
||
| By default when invoking this command: |
There was a problem hiding this comment.
This line is slightly confusing ... reads a little funny
This was referenced Nov 27, 2023
|
Hi @enocom , is this feature also added in cloud-sql-proxy v1? |
@vvxxvvxx The wait command is not supported in the v1 version of the Cloud SQL Proxy. We highly recommend upgrading to v2 to take advantage of new features as v1 is mostly in maintenance mode (bug fixes and dep updates only). You can check out the migration guide for more detailed steps to do so. If there is anything holding you back from migrating, please let us know 😄 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To help ensure the Proxy is up and ready, this commit adds a wait command with an optional
--maxflag to set the maximum time to wait.By default when invoking this command:
The Proxy will wait up to the maximum time for the /startup endpoint to respond. This 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:
Then the wait command must also be told to use the same custom values:
By default the wait command will wait 30 seconds. To alter this value, use:
Fixes #1117