Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
- name: Setup Go
uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5.6.0
with:
go-version: "1.26"
go-version: "1.27"
if: ${{ matrix.language == 'go' }}

# Initializes the CodeQL tools for scanning.
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/coverage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
- name: Setup Go
uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5.6.0
with:
go-version: "1.26"
go-version: "1.27"

- name: Checkout base branch
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
- name: Setup Go
uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5.6.0
with:
go-version: "1.26"
go-version: "1.27"
- name: Checkout code
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
- name: Generate docs and fail if there are differences
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/govulncheck.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
- name: Setup Go
uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5.6.0
with:
go-version: "1.26"
go-version: "1.27"
check-latest: true
- name: Checkout code
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
- name: Setup Go
uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5.6.0
with:
go-version: "1.26"
go-version: "1.27"
- name: Checkout code
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
- name: lint
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
- name: Setup Go
uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5.6.0
with:
go-version: "1.26"
go-version: "1.27"

- name: Verify Builds
run: |
Expand Down Expand Up @@ -68,7 +68,7 @@ jobs:
- name: Setup Go
uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5.6.0
with:
go-version: "1.26"
go-version: "1.27"
- id: auth
name: Authenticate to Google Cloud
uses: google-github-actions/auth@c200f3691d83b41bf9bbd8638997a462592937ed # v2.1.13
Expand Down Expand Up @@ -183,7 +183,7 @@ jobs:
- name: Setup Go
uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5.6.0
with:
go-version: "1.26"
go-version: "1.27"
- name: Checkout code
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
- name: Run tests
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ RUN CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} \
go build -ldflags "-X github.com/GoogleCloudPlatform/cloud-sql-proxy/v2/cmd.metadataString=container"

# Final Stage
FROM gcr.io/distroless/static:nonroot@sha256:d62067879de890a1def9da0e7766b7d20810a5e5555cef8506b752437d7a3e88
FROM gcr.io/distroless/static:nonroot@sha256:25ac8f0c3b2334a9eb05452266bd4697864a8c8ef0ef71e5e6480d7f92868329

LABEL org.opencontainers.image.source="https://github.com/GoogleCloudPlatform/cloud-sql-proxy"

Expand Down
2 changes: 1 addition & 1 deletion Dockerfile.alpine
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ RUN CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} \
go build -ldflags "-X github.com/GoogleCloudPlatform/cloud-sql-proxy/v2/cmd.metadataString=container.alpine"

# Final stage
FROM alpine:3@sha256:71e9b7bae160ba167fa17414401b94cbcdaf3c32feeab9298bd794a2a0614c35
FROM alpine:3@sha256:f59abe656b692d901e184be3445e084786602108599d2a51d229c0f5a48c71bf

LABEL org.opencontainers.image.source="https://github.com/GoogleCloudPlatform/cloud-sql-proxy"

Expand Down
44 changes: 22 additions & 22 deletions docs/cmd/cloud-sql-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,39 +234,39 @@ cloud-sql-proxy INSTANCE_CONNECTION_NAME... [flags]
--admin-port string Port for localhost-only admin server (default "9091")
--application-name string Set the application_name label of the built-in client metrics to identify the
application across its instances (e.g., "checkout-api").
-i, --auto-iam-authn (*) Enables Automatic IAM Authentication for all instances
--auto-ip Supports legacy behavior of v1 and will try to connect to first IP
-i, --auto-iam-authn[=true|false] (*) Enables Automatic IAM Authentication for all instances
--auto-ip[=true|false] Supports legacy behavior of v1 and will try to connect to first IP
address returned by the SQL Admin API. In most cases, this flag should not be used.
Prefer default of public IP or use --private-ip instead.
--compute-platform string Override the auto-detected compute_platform label of the built-in client
metrics. One of: gce, gke, cloud_run, app_engine, cloud_functions, ai_studio.
--config-file string Path to a TOML file containing configuration options.
-c, --credentials-file string Use service account key file as a source of IAM credentials.
--debug Enable pprof on the localhost admin server
--debug-logs Enable debug logging
--disable-metrics Disable Cloud Monitoring integration (used with --telemetry-project)
--disable-traces Disable Cloud Trace integration (used with --telemetry-project)
--enable-builtin-metrics Export the built-in client metrics (cloudsql.googleapis.com/client/connector/*)
--debug[=true|false] Enable pprof on the localhost admin server
--debug-logs[=true|false] Enable debug logging
--disable-metrics[=true|false] Disable Cloud Monitoring integration (used with --telemetry-project)
--disable-traces[=true|false] Disable Cloud Trace integration (used with --telemetry-project)
--enable-builtin-metrics[=true|false] Export the built-in client metrics (cloudsql.googleapis.com/client/connector/*)
to Cloud Monitoring in the Cloud SQL instance's project. The Proxy's identity
needs roles/monitoring.metricWriter on that project for the export to succeed;
without it, the Proxy logs one warning and keeps serving. Pass
--enable-builtin-metrics=false to turn the export off. (default true)
--exit-zero-on-sigterm Exit with 0 exit code when Sigterm received (default is 143)
--exit-zero-on-sigterm[=true|false] Exit with 0 exit code when Sigterm received (default is 143)
--fuse string Mount a directory at the path using FUSE to access Cloud SQL instances.
--fuse-tmp-dir string Temp dir for Unix sockets created with FUSE (default "/tmp/csql-tmp")
-g, --gcloud-auth Use gclouds user credentials as a source of IAM credentials.
-g, --gcloud-auth[=true|false] Use gclouds user credentials as a source of IAM credentials.
NOTE: this flag is a legacy feature and generally should not be used.
Instead prefer Application Default Credentials
(enabled with: gcloud auth application-default login) which
the Proxy will then pick-up automatically.
--health-check Enables health check endpoints /startup, /liveness, and /readiness on localhost.
-h, --help Display help information for cloud-sql-proxy
--health-check[=true|false] Enables health check endpoints /startup, /liveness, and /readiness on localhost.
-h, --help[=true|false] Display help information for cloud-sql-proxy
--http-address string Address for Prometheus and health check server (default "localhost")
--http-port string Port for Prometheus and health check server (default "9090")
--impersonate-service-account string Comma separated list of service accounts to impersonate. Last value
is the target account.
-j, --json-credentials string Use service account key JSON as a source of IAM credentials.
--lazy-refresh Configure a lazy refresh where connection info is retrieved only if
--lazy-refresh[=true|false] Configure a lazy refresh where connection info is retrieved only if
the cached copy has expired. Use this setting in environments where the
CPU may be throttled and a background refresh cannot run reliably
(e.g., Cloud Run)
Expand All @@ -275,34 +275,34 @@ cloud-sql-proxy INSTANCE_CONNECTION_NAME... [flags]
--max-sigterm-delay duration Maximum number of seconds to wait for connections to close after receiving a TERM signal.
--min-sigterm-delay duration The number of seconds to accept new connections after receiving a TERM signal.
-p, --port int (*) Initial port for listeners. Subsequent listeners increment from this value.
--private-ip (*) Connect to the private ip address for all instances
--prometheus Enable Prometheus HTTP endpoint /metrics on localhost
--private-ip[=true|false] (*) Connect to the private ip address for all instances
--prometheus[=true|false] Enable Prometheus HTTP endpoint /metrics on localhost
--prometheus-namespace string Use the provided Prometheus namespace for metrics
--psc (*) Connect to the PSC endpoint for all instances
--quiet Log error messages only
--quitquitquit Enable quitquitquit endpoint on the localhost admin server
--psc[=true|false] (*) Connect to the PSC endpoint for all instances
--quiet[=true|false] Log error messages only
--quitquitquit[=true|false] Enable quitquitquit endpoint on the localhost admin server
--quota-project string Specifies the project to use for Cloud SQL Admin API quota tracking.
The IAM principal must have the "serviceusage.services.use" permission
for the given project. See https://cloud.google.com/service-usage/docs/overview and
https://cloud.google.com/storage/docs/requester-pays
--resource-exhausted-cooldown-delay duration Cooldown period after a ResourceExhausted error.
--run-connection-test Runs a connection test
--run-connection-test[=true|false] Runs a connection test
against all specified instances. If an instance is unreachable, the Proxy exits with a failure
status code.
--skip-failed-instance-config If set, the Proxy will skip any instances that are invalid/unreachable (
--skip-failed-instance-config[=true|false] If set, the Proxy will skip any instances that are invalid/unreachable (
only applicable to Unix sockets)
--sql-data Enable SQL Data to tunnel through the Cloud SQL Admin API without needing network access to your public or private IP
--sql-data[=true|false] Enable SQL Data to tunnel through the Cloud SQL Admin API without needing network access to your public or private IP
--sqladmin-api-endpoint string API endpoint for all Cloud SQL Admin API requests. (default: https://sqladmin.googleapis.com)
--sqldata-api-endpoint string Override the SQL Data API endpoint
-l, --structured-logs Enable structured logging with LogEntry format
-l, --structured-logs[=true|false] Enable structured logging with LogEntry format
--telemetry-prefix string Prefix for Cloud Monitoring metrics.
--telemetry-project string Enable Cloud Monitoring and Cloud Trace with the provided project ID.
--telemetry-sample-rate int Set the Cloud Trace sample rate. A smaller number means more traces. (default 10000)
-t, --token string Use bearer token as a source of IAM credentials.
--universe-domain string Universe Domain for non-GDU environments. (default: googleapis.com)
-u, --unix-socket string (*) Enables Unix sockets for all listeners with the provided directory.
--user-agent string Space separated list of additional user agents, e.g. cloud-sql-proxy-operator/0.0.1
-v, --version Print the cloud-sql-proxy version
-v, --version[=true|false] Print the cloud-sql-proxy version
```

### SEE ALSO
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/cloud-sql-proxy_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ See each sub-command's help for details on how to use the generated script.
### Options

```
-h, --help help for completion
-h, --help[=true|false] help for completion
```

### Options inherited from parent commands
Expand Down
4 changes: 2 additions & 2 deletions docs/cmd/cloud-sql-proxy_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ cloud-sql-proxy completion bash
### Options

```
-h, --help help for bash
--no-descriptions disable completion descriptions
-h, --help[=true|false] help for bash
--no-descriptions[=true|false] disable completion descriptions
```

### Options inherited from parent commands
Expand Down
4 changes: 2 additions & 2 deletions docs/cmd/cloud-sql-proxy_completion_fish.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ cloud-sql-proxy completion fish [flags]
### Options

```
-h, --help help for fish
--no-descriptions disable completion descriptions
-h, --help[=true|false] help for fish
--no-descriptions[=true|false] disable completion descriptions
```

### Options inherited from parent commands
Expand Down
4 changes: 2 additions & 2 deletions docs/cmd/cloud-sql-proxy_completion_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ cloud-sql-proxy completion powershell [flags]
### Options

```
-h, --help help for powershell
--no-descriptions disable completion descriptions
-h, --help[=true|false] help for powershell
--no-descriptions[=true|false] disable completion descriptions
```

### Options inherited from parent commands
Expand Down
4 changes: 2 additions & 2 deletions docs/cmd/cloud-sql-proxy_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ cloud-sql-proxy completion zsh [flags]
### Options

```
-h, --help help for zsh
--no-descriptions disable completion descriptions
-h, --help[=true|false] help for zsh
--no-descriptions[=true|false] disable completion descriptions
```

### Options inherited from parent commands
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/cloud-sql-proxy_shutdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ cloud-sql-proxy shutdown [flags]

```
--admin-port string port for the admin server (default "9091")
-h, --help help for shutdown
-h, --help[=true|false] help for shutdown
```

### Options inherited from parent commands
Expand Down
4 changes: 2 additions & 2 deletions docs/cmd/cloud-sql-proxy_wait.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ cloud-sql-proxy wait [flags]
### Options

```
-h, --help help for wait
-m, --max duration maximum amount of time to wait for startup (default 30s)
-h, --help[=true|false] help for wait
-m, --max duration maximum amount of time to wait for startup (default 30s)
```

### Options inherited from parent commands
Expand Down
Loading
Loading