{"id":15221591,"url":"https://github.com/googlecloudplatform/cloud-sql-proxy-operator","last_synced_at":"2026-01-23T20:15:15.418Z","repository":{"id":64746094,"uuid":"526268629","full_name":"GoogleCloudPlatform/cloud-sql-proxy-operator","owner":"GoogleCloudPlatform","description":"A Kubernetes Operator to automatically configure secure connections to Cloud SQL","archived":false,"fork":false,"pushed_at":"2024-12-12T19:09:47.000Z","size":1094,"stargazers_count":100,"open_issues_count":28,"forks_count":11,"subscribers_count":20,"default_branch":"main","last_synced_at":"2024-12-18T08:40:01.974Z","etag":null,"topics":["cloud-sql","cloud-sql-proxy","gke","google-kubernetes-engine","kubernetes","libraries"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GoogleCloudPlatform.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-18T15:29:06.000Z","updated_at":"2024-12-12T19:09:42.000Z","dependencies_parsed_at":"2023-02-16T22:31:35.876Z","dependency_job_id":"977ba1d8-d11e-4687-bf4f-d26afaf37500","html_url":"https://github.com/GoogleCloudPlatform/cloud-sql-proxy-operator","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoogleCloudPlatform%2Fcloud-sql-proxy-operator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoogleCloudPlatform%2Fcloud-sql-proxy-operator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoogleCloudPlatform%2Fcloud-sql-proxy-operator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoogleCloudPlatform%2Fcloud-sql-proxy-operator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GoogleCloudPlatform","download_url":"https://codeload.github.com/GoogleCloudPlatform/cloud-sql-proxy-operator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246230523,"owners_count":20744347,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloud-sql","cloud-sql-proxy","gke","google-kubernetes-engine","kubernetes","libraries"],"created_at":"2024-09-28T15:06:12.919Z","updated_at":"2026-01-23T20:15:15.411Z","avatar_url":"https://github.com/GoogleCloudPlatform.png","language":"Go","readme":"# Cloud SQL Proxy Operator\n\nCloud SQL Proxy Operator is an open-source Kubernetes operator that automates\nmost of the intricate steps needed to connect a workload in a kubernetes cluster\nto Cloud SQL databases.\n\nThe operator introduces a custom resource AuthProxyWorkload,\nwhich specifies the Cloud SQL Auth Proxy configuration for a workload. The operator\nreads this resource and adds a properly configured Cloud SQL Auth Proxy container\nto the matching workload pods.\n\n## Installation\n\nCheck for the latest version on the [releases page][latest-release] and use the\nfollowing instructions.\n\n[latest-release]: https://github.com/GoogleCloudPlatform/cloud-sql-proxy-operator/releases/latest\n\nConfirm that kubectl can connect to your kubernetes cluster.\n\n```shell\nkubectl cluster-info\n```\n\nInstall cert-manager using helm. Note that you need to use this particular\nversion with these specific cli arguments to make cert-manager work on\nyour GKE cluster.\n\n```shell\nhelm repo add jetstack https://charts.jetstack.io\nhelm repo update\nhelm install \\\n  cert-manager jetstack/cert-manager \\\n  --namespace cert-manager \\\n  --version \"v1.9.1\" \\\n  --create-namespace \\\n  --set global.leaderElection.namespace=cert-manager \\\n  --set installCRDs=true\n```\n\nRun the following command to install the cloud sql proxy operator into\nyour kubernetes cluster:\n\n\u003c!-- {x-release-please-start-version} --\u003e\n\n```shell\nkubectl apply -f https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy-operator/v1.7.4/cloud-sql-proxy-operator.yaml\n```\n\n\u003c!-- {x-release-please-end} --\u003e\n\nConfirm that the operator is installed and running by listing its pods:\n\n```shell\nkubectl get pods -n cloud-sql-proxy-operator-system\n```\n\n## Usage\n\nSee the [Quick Start Guide](docs/quick-start.md) for a description of basic usage.\nAdditional usage may be found in the [Examples](docs/examples/).\n\n## Frequently Asked Questions\n\n### Why would I use the Cloud SQL Auth Proxy Operator?\n\nThe Cloud SQL Auth Proxy Operator gives you an easy way to add a proxy container\nto your kubernetes workloads, configured correctly for production use. The operator\nadds the auth proxy sidecar to the workloads you specify in a consistent, stable and secure way.\n\nWhen you upgrade the operator, it will also upgrade the proxy image and container\nconfiguration on those workloads.\n\nThe operator encodes the best practices for configuring\n[Cloud SQL Proxy sidecar](https://github.com/GoogleCloudPlatform/cloud-sql-proxy/tree/main/examples/k8s-sidecar)\ncontainers, and allows you to apply those best practices across the workloads in your kubernetes\ncluster. This is especially helpful when managing a Kubernetes cluster that runs lots of\napplications, each configured by a different team.\n\nHowever, if you are deploying only a few applications in your kubernetes cluster, it may be\nmore straightforward to follow the Proxy K8s Sidecar Example and add the sidecar container\ndirectly in your configuration.\n\nThe operator does not help set up roles and permissions. This also requires intricate configuration,\nespecially for workload identity federation. This is now a feature request, see #706\n\n## Reference Documentation\n\n- [Quick Start Guide](docs/quick-start.md)\n- [API Documentation](docs/api.md)\n- [Cloud SQL Proxy](https://github.com/GoogleCloudPlatform/cloud-sql-proxy)\n- [Developer Getting Started](docs/dev.md)\n- [Developing End-to-End tests](docs/e2e-tests.md)\n- [Contributing](docs/contributing.md)\n- [Code of Conduct](docs/code-of-conduct.md)\n- [Examples](docs/examples/)\n\n## Support policy\n\n### Major version lifecycle\n\nThis project uses [semantic versioning](https://semver.org/), and uses the\nfollowing lifecycle regarding support for a major version:\n\n**Active** - Active versions get all new features and security fixes (that\nwouldn’t otherwise introduce a breaking change). New major versions are\nguaranteed to be \"active\" for a minimum of 1 year.\n**Deprecated** - Deprecated versions continue to receive security and critical\nbug fixes, but do not receive new features. Deprecated versions will be publicly\nsupported for 1 year.\n**Unsupported** - Any major version that has been deprecated for \u003e=1 year is\nconsidered publicly unsupported.\n\n## Contributing\n\nContributions are welcome. Please, see the [Contributing](docs/contributing.md) document\nfor details.\n\nPlease note that this project is released with a Contributor Code of Conduct.\nBy participating in this project you agree to abide by its terms. See\n[Contributor Code of Conduct](docs/code-of-conduct.md) for more information.\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgooglecloudplatform%2Fcloud-sql-proxy-operator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgooglecloudplatform%2Fcloud-sql-proxy-operator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgooglecloudplatform%2Fcloud-sql-proxy-operator/lists"}