{"id":13643492,"url":"https://github.com/adyanth/cloudflare-operator","last_synced_at":"2025-04-09T05:10:27.543Z","repository":{"id":39622654,"uuid":"443854340","full_name":"adyanth/cloudflare-operator","owner":"adyanth","description":"A Kubernetes Operator to create and manage Cloudflare Tunnels and DNS records  for (HTTP/TCP/UDP*) Service Resources ","archived":false,"fork":false,"pushed_at":"2024-09-12T01:27:36.000Z","size":763,"stargazers_count":357,"open_issues_count":31,"forks_count":37,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-11-24T17:43:10.381Z","etag":null,"topics":["cloudflare","cloudflare-tunnel","cloudflared","kubernetes","kubernetes-operator","operator","operator-sdk"],"latest_commit_sha":null,"homepage":"https://adyanth.site/posts/migration-compose-k8s/cloudflare-tunnel-operator-architecture/","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/adyanth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["adyanth"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2022-01-02T19:38:54.000Z","updated_at":"2024-11-23T18:31:16.000Z","dependencies_parsed_at":"2023-12-15T20:08:01.157Z","dependency_job_id":"4c391b45-b7c3-4f69-8489-d060059e2180","html_url":"https://github.com/adyanth/cloudflare-operator","commit_stats":{"total_commits":179,"total_committers":8,"mean_commits":22.375,"dds":0.04469273743016755,"last_synced_commit":"d6135dd4919787cadff60b59e7a63b8b7db49265"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adyanth%2Fcloudflare-operator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adyanth%2Fcloudflare-operator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adyanth%2Fcloudflare-operator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adyanth%2Fcloudflare-operator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adyanth","download_url":"https://codeload.github.com/adyanth/cloudflare-operator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247980837,"owners_count":21027808,"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":["cloudflare","cloudflare-tunnel","cloudflared","kubernetes","kubernetes-operator","operator","operator-sdk"],"created_at":"2024-08-02T01:01:48.349Z","updated_at":"2025-04-09T05:10:27.516Z","avatar_url":"https://github.com/adyanth.png","language":"Go","readme":"\u003ch1 align=center\u003eCloudflare Operator\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/adyanth/cloudflare-operator\"\u003e\n    \u003cimg src=\"images/CloudflareOperatorLogo.png\" alt=\"Logo\" height=\"250\"\u003e\n  \u003c/a\u003e\n  \u003cbr /\u003e\n\n  \u003cp align=\"center\"\u003e\n    A Kubernetes Operator to create and manage Cloudflare Tunnels and DNS records \u003cbr /\u003e for (HTTP/TCP/UDP*) Service Resources\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"docs/getting-started.md\"\u003e\u003cstrong\u003eGetting Started Guide »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/adyanth/cloudflare-operator/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/adyanth/cloudflare-operator/issues\"\u003eRequest Feature\u003c/a\u003e\n    \u003cbr /\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n[![GitHub license](https://img.shields.io/github/license/adyanth/cloudflare-operator?color=brightgreen)](https://github.com/adyanth/cloudflare-operator/blob/main/LICENSE)\n[![GitHub forks](https://img.shields.io/github/forks/adyanth/cloudflare-operator)](https://github.com/adyanth/cloudflare-operator/network)\n[![GitHub stars](https://img.shields.io/github/stars/adyanth/cloudflare-operator)](https://github.com/adyanth/cloudflare-operator/stargazers)\n[![GitHub issues](https://img.shields.io/github/issues/adyanth/cloudflare-operator)](https://github.com/adyanth/cloudflare-operator/issues)\n[![Go Report Card](https://goreportcard.com/badge/github.com/adyanth/cloudflare-operator)](https://goreportcard.com/report/github.com/adyanth/cloudflare-operator)\n\n\u003e **_NOTE_**: This project is currently in Alpha\n\n\u003e UDP*: UDP support for Cloudflare Tunnels is in [Early Access](https://blog.cloudflare.com/extending-cloudflares-zero-trust-platform-to-support-udp-and-internal-dns/)\n\n## Motivation\n\nThe [Cloudflare Tunnels guide](https://developers.cloudflare.com/cloudflare-one/tutorials/many-cfd-one-tunnel) for deployment on Kubernetes provides a [manifest](https://github.com/cloudflare/argo-tunnel-examples/tree/master/named-tunnel-k8s) which is very bare bones and does not hook into Kubernetes in any meaningful way. The operator started out as a hobby project of mine to deploy applications in my home lab and expose them to the internet via Cloudflare Tunnels without doing a lot of manual work every time a new application is deployed.\n\n## Overview\n\nThe Cloudflare Operator aims to provide a new way of dynamically deploying the [cloudflared](https://github.com/cloudflare/cloudflared) daemon on Kubernetes. Scaffolded and built using `operator-sdk`. Once deployed, this operator provides the following:\n\n* Ability to create new and use existing Tunnels for [Cloudflare for Teams](https://developers.cloudflare.com/cloudflare-one/) using Custom Resources (CR/CRD) which will:\n  * Accept a Secret for Cloudflare API Tokens and Keys\n  * Run a scaled (configurable) Deployment of `cloudflared`\n  * Manage a ConfigMap for the above Deployment\n  * Have Cluster and Namespace scoped Tunnels\n* A TunnelBinding controller which does the following:\n  * Update the `cloudflared` ConfigMap to include the new Services to be served under a given Tunnel\n  * Restart the `cloudflared` Deployment to make the configuration change take effect\n  * Add a DNS entry in Cloudflare for the specified domain to be a [proxied CNAME to the referenced tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/routing-to-tunnel/dns)\n  * Reverse the above when the TunnelBinding is deleted using Finalizers\n\n## Bird's eye view\n\nHere is how the operator and the Tunnel Resource fit into your deployment.\n\n![Operator Architecture](images/OperatorArchitecture.png#center)\n\nThere is more detailed information on this architecture and the thought process behind it in my [blog post](https://adyanth.site/posts/migration-compose-k8s/cloudflare-tunnel-operator-architecture/).\n\n## Getting Started\n\nGo through the dedicated documentation on [Getting Started](docs/getting-started.md) to learn how to deploy this operator and a sample tunnel along with a service to expose.\n\nLook into the [Configuration](docs/configuration.md) documentation to understand various configurable parameters of this operator.\n\n\u003e **_NOTE_**: This is **NOT** an official operator provided/backed by Cloudflare Inc. It utilizes their [v4 API](https://api.cloudflare.com/) and their [`cloudflared`](https://github.com/cloudflare/cloudflared) to automate setting up of tunnels on Kubernetes.\n","funding_links":["https://github.com/sponsors/adyanth"],"categories":["kubernetes","Go"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadyanth%2Fcloudflare-operator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadyanth%2Fcloudflare-operator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadyanth%2Fcloudflare-operator/lists"}