{"id":49317458,"url":"https://github.com/warjiang/cloudflaretunnel-operator","last_synced_at":"2026-04-26T16:02:51.222Z","repository":{"id":351128444,"uuid":"994284800","full_name":"warjiang/cloudflaretunnel-operator","owner":"warjiang","description":null,"archived":false,"fork":false,"pushed_at":"2026-04-22T04:02:00.000Z","size":181,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-22T05:42:49.839Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/warjiang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-06-01T16:07:08.000Z","updated_at":"2026-04-22T03:51:32.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/warjiang/cloudflaretunnel-operator","commit_stats":null,"previous_names":["warjiang/cloudflaretunnel-operator"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/warjiang/cloudflaretunnel-operator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/warjiang%2Fcloudflaretunnel-operator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/warjiang%2Fcloudflaretunnel-operator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/warjiang%2Fcloudflaretunnel-operator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/warjiang%2Fcloudflaretunnel-operator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/warjiang","download_url":"https://codeload.github.com/warjiang/cloudflaretunnel-operator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/warjiang%2Fcloudflaretunnel-operator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32303177,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T09:34:17.070Z","status":"ssl_error","status_checked_at":"2026-04-26T09:34:00.993Z","response_time":129,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2026-04-26T16:02:49.618Z","updated_at":"2026-04-26T16:02:51.217Z","avatar_url":"https://github.com/warjiang.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cloudflare Tunnel Operator\n\n[English](README.md) | [中文](README.zh-CN.md)\n\nCloudflare Tunnel Operator manages Cloudflare Tunnels declaratively through the `CloudflareTunnel` CRD.\n\n![Cloudflare Tunnel Operator Advantages](docusaurus/static/img/project-advantages.svg)\n\n## Quick Start\n\nPrerequisites:\n\n- Kubernetes cluster access (`kubectl` configured)\n- A Cloudflare API Token with tunnel permissions\n- Cloudflare Account ID\n\n1. Create a credentials Secret:\n\n```yaml\napiVersion: v1\nkind: Secret\nmetadata:\n  name: cloudflare-credentials\n  namespace: default\ntype: Opaque\nstringData:\n  api-token: \u003cYOUR_CLOUDFLARE_API_TOKEN\u003e\n  account-id: \u003cYOUR_CLOUDFLARE_ACCOUNT_ID\u003e\n```\n\n2. Create a `CloudflareTunnel` resource:\n\n```yaml\napiVersion: cloudflaretunnel.spotty.com.cn/v1alpha1\nkind: CloudflareTunnel\nmetadata:\n  name: my-tunnel\n  namespace: default\nspec:\n  tunnelName: my-first-tunnel\n  credentialsRef:\n    name: cloudflare-credentials\n  ingress:\n    rules:\n      - path: /api\n        service:\n          name: my-backend\n          namespace: my-backend-ns\n          port: 8080\n  connector:\n    image: cloudflare/cloudflared:2026.3.0\n    replicas: 1\n```\n\n3. Apply your manifest:\n\n```bash\nkubectl apply -f demo.yaml\n```\n\n4. Verify tunnel status:\n\n```bash\nkubectl get cloudflaretunnel my-tunnel -n default -o yaml\n```\n\nIf `spec.tokenSecretRef` is omitted, the operator stores token in `${metadata.name}-token` by default and reports the actual Secret name in `status.tokenSecretName`.\n\n## What It Does\n\nThe operator watches `CloudflareTunnel` resources and ensures:\n\n- The target Cloudflare Tunnel exists.\n- A Kubernetes Secret containing the tunnel token is created or updated.\n- A dedicated cloudflared Deployment is created for each CloudflareTunnel.\n- Optional ingress-style path forwarding rules are rendered into cloudflared config.\n- Status (`tunnelID`, `tokenSecretName`, `observedGeneration`, conditions) reflects reconciliation state.\n- Finalizers are used to clean up remote tunnel resources during deletion.\n\n## Credentials Model\n\nCloudflare credentials are read from the Secret referenced by `spec.credentialsRef`.\n\nRequired Secret keys:\n\n- `api-token`\n- `account-id`\n\nCredentials are not accepted directly in CRD spec fields.\n\n## Installation\n\nWith Kustomize:\n\n```bash\nmake docker-build IMG=\u003cimage:tag\u003e\nmake docker-push IMG=\u003cimage:tag\u003e\nmake deploy IMG=\u003cimage:tag\u003e\n```\n\nFor multi-arch image build and push:\n\n```bash\nmake docker-buildx IMG=\u003cimage:tag\u003e\n```\n\nDefault image platforms:\n\n`linux/amd64,linux/arm64,linux/s390x,linux/ppc64le`\n\nOverride with `PLATFORMS=\u003cplatforms\u003e`.\n\nWith Helm (CRDs auto-installed from `crds/`):\n\n```bash\nhelm install cloudflaretunnel-operator \\\n  oci://ghcr.io/warjiang/charts/cloudflaretunnel-operator \\\n  --version \u003cx.y.z\u003e \\\n  --namespace cloudflaretunnel-operator-system \\\n  --create-namespace\n```\n\nUpgrade:\n\n```bash\nhelm upgrade cloudflaretunnel-operator \\\n  oci://ghcr.io/warjiang/charts/cloudflaretunnel-operator \\\n  --version \u003cx.y.z\u003e \\\n  --namespace cloudflaretunnel-operator-system\n```\n\nUninstall:\n\n```bash\nhelm uninstall cloudflaretunnel-operator --namespace cloudflaretunnel-operator-system\n```\n\nNote: CRDs installed from Helm `crds/` are not deleted by `helm uninstall`.\n\n## Development Commands\n\n- Build manager binary: `make build`\n- Build cross-platform binaries: `make build-cross`\n- Run unit/controller tests: `make test`\n- Run e2e tests: `make test-e2e`\n- Run controller locally: `make run`\n- Install envtest assets: `make setup-envtest`\n\nCross-platform binaries are written to `dist/\u003cgoos\u003e-\u003cgoarch\u003e/manager`.\n\nDefault binary platforms:\n\n`linux/amd64,linux/arm64,linux/s390x,linux/ppc64le,darwin/arm64`\n\nOverride with `BINARY_PLATFORMS=\u003cplatforms\u003e`.\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwarjiang%2Fcloudflaretunnel-operator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwarjiang%2Fcloudflaretunnel-operator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwarjiang%2Fcloudflaretunnel-operator/lists"}