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
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,7 @@ _Appears in:_
58
58
|`maxSigtermDelay`_integer_| MaxSigtermDelay is the maximum number of seconds to wait for connections to<br />close after receiving a TERM signal. This sets the proxy container's<br />CLI argument `--max-sigterm-delay` and<br />configures `terminationGracePeriodSeconds` on the workload's PodSpec. || Minimum: 0 <br />Optional: \{\} <br /> |
59
59
|`minSigtermDelay`_integer_| MinSigtermDelay is the minimum number of seconds to wait for connections to<br />close after receiving a TERM signal. This sets the proxy container's<br />CLI argument `--min-sigterm-delay`|| Minimum: 0 <br />Optional: \{\} <br /> |
60
60
|`sqlAdminAPIEndpoint`_string_| SQLAdminAPIEndpoint is a debugging parameter that when specified will<br />change the Google Cloud api endpoint used by the proxy. || Optional: \{\} <br /> |
61
-
|`image`_string_| Image is the URL to the proxy image. Optional, by default the operator<br />will use the latest Cloud SQL Auth Proxy version as of the release of the<br />operator.<br />The operator ensures that all workloads configured with the default proxy<br />image are upgraded automatically to use to the latest released proxy image.<br />When the customer upgrades the operator, the operator upgrades all<br />workloads using the default proxy image to the latest proxy image. The<br />change to the proxy container image is applied in accordance with<br />the RolloutStrategy. || Optional: \{\} <br /> |
61
+
|`image`_string_| Image is the URL to the proxy image. Optional, by default the operator<br />will use the latest Cloud SQL Auth Proxy version as of the release of the<br />operator.<br /><br />The operator ensures that all workloads configured with the default proxy<br />image are upgraded automatically to use to the latest released proxy image.<br /><br />When the customer upgrades the operator, the operator upgrades all<br />workloads using the default proxy image to the latest proxy image. The<br />change to the proxy container image is applied in accordance with<br />the RolloutStrategy. || Optional: \{\} <br /> |
62
62
|`rolloutStrategy`_string_| RolloutStrategy indicates the strategy to use when rolling out changes to<br />the workloads affected by the results. When this is set to<br />`Workload`, changes to this resource will be automatically applied<br />to a running Deployment, StatefulSet, DaemonSet, or ReplicaSet in<br />accordance with the Strategy set on that workload. When this is set to<br />`None`, the operator will take no action to roll out changes to affected<br />workloads. `Workload` will be used by default if no value is set.<br />See: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy| Workload | Enum: [Workload None] <br />Optional: \{\} <br /> |
63
63
|`refreshStrategy`_string_| RefreshStrategy indicates which refresh strategy the proxy should use.<br />When this is set to `lazy`, the proxy will use a lazy refresh strategy,<br />and will be configured to run with the --lazy-refresh flag. When this<br />omitted or set to `background`, the proxy will use the default background<br />refresh strategy.<br />See: https://github.com/GoogleCloudPlatform/cloud-sql-proxy/?tab=readme-ov-file#configuring-a-lazy-refresh| background | Enum: [lazy background] <br />Optional: \{\} <br /> |
64
64
|`quiet`_boolean_| Quiet configures the proxy's --quiet flag to limit the amount of<br />logging generated by the proxy container. |||
@@ -130,21 +130,25 @@ _Appears in:_
130
130
InstanceSpec describes the configuration for how the proxy should expose
131
131
a Cloud SQL database instance to a workload.
132
132
133
+
133
134
In the minimum recommended configuration, the operator will choose
134
135
a non-conflicting TCP port and set environment
135
136
variables MY_DB_SERVER_PORT MY_DB_SERVER_HOST with the value of the TCP port
136
137
and hostname. The application can read these values to connect to the database
0 commit comments