Skip to content
cfgatePublic

About

Gateway API-native Kubernetes operator for Cloudflare Tunnel, DNS, and Access

Topics

Resources

Contributing

Stars

26 stars

Watchers

1 watching

Forks

Repository files navigation

cfgate

Latest Release Image Helm Chart Artifact Hub

Build Status Coverage golangci-lint Go Reference

cfgate manages Cloudflare Tunnels, DNS records, and Access configuration from Kubernetes resources. It uses Gateway API HTTPRoutes to configure a separate cloudflared connector, which carries traffic from Cloudflare to your Services. The manager handles configuration; it is not an application proxy.

Getting started

Follow the getting-started guide to install the controller, create credentials, deploy a sample service, publish a hostname, and verify a request. It includes optional Access protection and scoped cleanup.

For an existing installation, read compatibility and upgrades before changing the controller, chart, or CRDs. This documentation describes v0.2.0-alpha.11; Helm chart 1.10.0 installs that release. Use versioned release artifacts rather than assuming GitHub's latest endpoint selects an alpha.

How it works

How cfgate works

A CloudflareTunnel manages a remote tunnel and its connector Deployment. A Gateway selects that tunnel, and HTTPRoutes attach supported hostname/path matches to Services. CloudflareDNS publishes hostnames separately. Access policies define who may connect; Access applications attach those policies to host/path targets. Creating a policy alone does not protect a route.

The connector establishes outbound connections, so this path does not require a public cluster IP or an inbound LoadBalancer. Other cluster services can still have their own exposure. The Gateway API resource model is shared with other implementations; cfgate supports a defined HTTPRoute subset, not every feature implemented by other controllers.

Resource reference

Resource Responsibility
CloudflareTunnel Remote tunnel, connector workload, and origin defaults
CloudflareDNS Route-derived or explicit DNS records and ownership tracking
CloudflareAccessPolicy Reusable Access policy and managed service tokens
CloudflareAccessApplication Policy attachment to Gateway or HTTPRoute targets
Annotations Route transport, discovery, lifecycle, and adoption settings

Documentation

The documentation index groups installation, configuration, operations, and contributor guides. Start with:

Examples

Examples require a running controller and edited credentials, account IDs, and hostnames. Their READMEs describe the required permissions and cleanup order.

Example Purpose
Basic One public service through a tunnel
Multiple services Shared tunnel with public and path-protected routes
External target DNS records without a tunnel
Rancher Integration considerations for a separate Gateway API application

Development

CONTRIBUTING.md covers setup and repository conventions. Testing separates unit, schema, live API, and packaged-deployment checks. Release notes are generated from Git history; see CHANGELOG.md.

Related repositories: Helm chart, website, and cloudflared h2c fork.

License

Apache-2.0.

About

Gateway API-native Kubernetes operator for Cloudflare Tunnel, DNS, and Access

Topics

Resources

Contributing

Stars

26 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages