22
33Cloud SQL Proxy Operator is an open-source Kubernetes operator that automates
44most of the intricate steps needed to connect a workload in a kubernetes cluster
5- to Cloud SQL databases.
5+ to Cloud SQL databases.
66
7- The operator introduces a custom resource AuthProxyWorkload,
7+ The operator introduces a custom resource AuthProxyWorkload,
88which specifies the Cloud SQL Auth Proxy configuration for a workload. The operator
99reads this resource and adds a properly configured Cloud SQL Auth Proxy container
10- to the matching workload pods.
10+ to the matching workload pods.
1111
1212## Installation
1313
1414Check for the latest version on the [ releases page] [ latest-release ] and use the
15- following instructions.
15+ following instructions.
1616
1717[ latest-release ] : https://github.com/GoogleCloudPlatform/cloud-sql-proxy-operator/releases/latest
1818
@@ -22,8 +22,8 @@ Confirm that kubectl can connect to your kubernetes cluster.
2222kubectl cluster-info
2323```
2424
25- Install cert-manager using helm. Note that you need to use this particular
26- version with these specific cli arguments to make cert-manager work on
25+ Install cert-manager using helm. Note that you need to use this particular
26+ version with these specific cli arguments to make cert-manager work on
2727your GKE cluster.
2828
2929``` shell
@@ -42,9 +42,11 @@ Run the following command to install the cloud sql proxy operator into
4242your kubernetes cluster:
4343
4444<!-- {x-release-please-start-version} -->
45+
4546``` shell
4647kubectl apply -f https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy-operator/v1.7.0/cloud-sql-proxy-operator.yaml
4748```
49+
4850<!-- {x-release-please-end} -->
4951
5052Confirm that the operator is installed and running by listing its pods:
@@ -63,14 +65,27 @@ Additional usage may be found in the [Examples](docs/examples/).
6365### Why would I use the Cloud SQL Auth Proxy Operator?
6466
6567The Cloud SQL Auth Proxy Operator gives you an easy way to add a proxy container
66- to your kubernetes workloads, configured correctly for production use.
68+ to your kubernetes workloads, configured correctly for production use. The operator
69+ adds the auth proxy sidecar to the workloads you specify in a consistent, stable and secure way.
70+
71+ When you upgrade the operator, it will also upgrade the proxy image and container
72+ configuration on those workloads.
6773
68- Writing the kubernetes configuration for a proxy to the production level requires
69- a great deal of deep kubernetes and proxy knowledge. The Cloud SQL Proxy team has
70- worked to encapsulate that knowledge in this operator. This saves you from having
71- to know all the details to configure your proxy.
74+ The operator encodes the best practices for configuring
75+ [ Cloud SQL Proxy sidecar] ( https://github.com/GoogleCloudPlatform/cloud-sql-proxy/tree/main/examples/k8s-sidecar )
76+ containers, and allows you to apply those best practices across the workloads in your kubernetes
77+ cluster. This is especially helpful when managing a Kubernetes cluster that runs lots of
78+ applications, each configured by a different team.
79+
80+ However, if you are deploying only a few applications in your kubernetes cluster, it may be
81+ more straightforward to follow the Proxy K8s Sidecar Example and add the sidecar container
82+ directly in your configuration.
83+
84+ The operator does not help set up roles and permissions. This also requires intricate configuration,
85+ especially for workload identity federation. This is now a feature request, see #706
7286
7387## Reference Documentation
88+
7489- [ Quick Start Guide] ( docs/quick-start.md )
7590- [ API Documentation] ( docs/api.md )
7691- [ Cloud SQL Proxy] ( https://github.com/GoogleCloudPlatform/cloud-sql-proxy )
@@ -102,6 +117,6 @@ Contributions are welcome. Please, see the [Contributing](docs/contributing.md)
102117for details.
103118
104119Please note that this project is released with a Contributor Code of Conduct.
105- By participating in this project you agree to abide by its terms. See
120+ By participating in this project you agree to abide by its terms. See
106121[ Contributor Code of Conduct] ( docs/code-of-conduct.md ) for more information.
107122
0 commit comments