You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api.md
+6-3Lines changed: 6 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,9 @@ _Appears in:_
49
49
|`maxConnections`_integer_| MaxConnections limits the number of connections. Default value is no limit. This sets the proxy container's CLI argument `--max-connections`|
50
50
|`maxSigtermDelay`_integer_| MaxSigtermDelay is the maximum number of seconds to wait for connections to close after receiving a TERM signal. This sets the proxy container's CLI argument `--max-sigterm-delay` and configures `terminationGracePeriodSeconds` on the workload's PodSpec. |
51
51
|`sqlAdminAPIEndpoint`_string_| SQLAdminAPIEndpoint is a debugging parameter that when specified will change the Google Cloud api endpoint used by the proxy. |
52
-
|`image`_string_| Image is the URL to the proxy image. Optional, by default the operator will use the latest Cloud SQL Auth Proxy version as of the release of the operator. <br /><br /> The operator ensures that all workloads configured with the default proxy image are upgraded automatically to use to the latest released proxy image. <br /><br /> When the customer upgrades the operator, the operator upgrades all workloads using the default proxy image to the latest proxy image. The change to the proxy container image is applied in accordance with the RolloutStrategy. |
52
+
| `image`_string_ | Image is the URL to the proxy image. Optional, by default the operator will use the latest Cloud SQL Auth Proxy version as of the release of the operator.
53
+
The operator ensures that all workloads configured with the default proxy image are upgraded automatically to use to the latest released proxy image.
54
+
When the customer upgrades the operator, the operator upgrades all workloads using the default proxy image to the latest proxy image. The change to the proxy container image is applied in accordance with the RolloutStrategy. |
53
55
|`rolloutStrategy`_string_| RolloutStrategy indicates the strategy to use when rolling out changes to the workloads affected by the results. When this is set to `Workload`, changes to this resource will be automatically applied to a running Deployment, StatefulSet, DaemonSet, or ReplicaSet in accordance with the Strategy set on that workload. When this is set to `None`, the operator will take no action to roll out changes to affected workloads. `Workload` will be used by default if no value is set. See: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy|
54
56
|`quiet`_boolean_| Quiet configures the proxy's --quiet flag to limit the amount of logging generated by the proxy container. |
55
57
@@ -142,7 +144,7 @@ _Appears in:_
142
144
|`prometheusNamespace`_string_| PrometheusNamespace is used the provided Prometheus namespace for metrics This sets the proxy container's CLI argument `--prometheus-namespace`|
143
145
|`telemetryProject`_string_| TelemetryProject enables Cloud Monitoring and Cloud Trace with the provided project ID. This sets the proxy container's CLI argument `--telemetry-project`|
144
146
|`telemetryPrefix`_string_| TelemetryPrefix is the prefix for Cloud Monitoring metrics. This sets the proxy container's CLI argument `--telemetry-prefix`|
145
-
|`telemetrySampleRate`_[int](#int)_| TelemetrySampleRate is the Cloud Trace sample rate. A smaller number means more traces. This sets the proxy container's CLI argument `--telemetry-sample-rate`|
147
+
|`telemetrySampleRate`_integer_| TelemetrySampleRate is the Cloud Trace sample rate. A smaller number means more traces. This sets the proxy container's CLI argument `--telemetry-sample-rate`|
146
148
|`httpPort`_integer_| HTTPPort the port for Prometheus and health check server. This sets the proxy container's CLI argument `--http-port`|
147
149
|`disableTraces`_boolean_| DisableTraces disables Cloud Trace testintegration (used with telemetryProject) This sets the proxy container's CLI argument `--disable-traces`|
148
150
|`disableMetrics`_boolean_| DisableMetrics disables Cloud Monitoring testintegration (used with telemetryProject) This sets the proxy container's CLI argument `--disable-metrics`|
@@ -179,6 +181,7 @@ _Appears in:_
179
181
|`version`_string_||
180
182
|`namespace`_string_||
181
183
|`name`_string_||
182
-
|`conditions`_[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#condition-v1-meta) array_| Conditions show the status of the AuthProxyWorkload resource on this matching workload. <br /><br /> The "UpToDate" condition indicates that the proxy was successfully applied to all matching workloads. See ConditionUpToDate. |
184
+
| `conditions`_[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#condition-v1-meta) array_ | Conditions show the status of the AuthProxyWorkload resource on this matching workload.
185
+
The "UpToDate" condition indicates that the proxy was successfully applied to all matching workloads. See ConditionUpToDate. |
0 commit comments