Skip to content
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.

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

docs: Describe environment variable configuration in the README. #2264

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

hessjcg
Copy link
Collaborator

@hessjcg hessjcg commented Jul 10, 2024

Fixes #2263

@hessjcg hessjcg requested a review from a team as a code owner July 10, 2024 15:32
Comment on lines +380 to +383
the uppercase version of the flag using underscores as word delimiters. For
example, the `--auto-iam-authn` flag may be set with the environment variable
`CSQL_PROXY_AUTO_IAM_AUTHN`. An invocation of the Proxy using environment
variables would look like the following:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
the uppercase version of the flag using underscores as word delimiters. For
example, the `--auto-iam-authn` flag may be set with the environment variable
`CSQL_PROXY_AUTO_IAM_AUTHN`. An invocation of the Proxy using environment
variables would look like the following:
the uppercase version of the flag using underscores as word delimiters.
For example, the `--auto-iam-authn` flag may be set with the environment variable
`CSQL_PROXY_AUTO_IAM_AUTHN`.
An invocation of the Proxy using environment variables would look like the following:


```shell
CSQL_PROXY_AUTO_IAM_AUTHN=true \
./cloud-sql-proxy my-project:us-central1:my-db-server
Copy link
Collaborator

Choose a reason for hiding this comment

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

let's use either INSTANCE_CONNECTION_NAME or myproject:my-region:myinstance for consistency

Suggested change
./cloud-sql-proxy my-project:us-central1:my-db-server
./cloud-sql-proxy <INSTANCE_CONNECTION_NAME>

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.

Environment variable names for configuration
2 participants