Development¶

This section covers development setup, architecture, and contribution guidelines for the Cloudflare Tunnel Gateway Controller.

Overview¶

The controller is built with:

Go - Primary programming language
controller-runtime - Kubernetes controller framework
Helm SDK - For cloudflared deployment management
Cloudflare Go SDK - For tunnel configuration API

Sections¶

Setup

Development environment setup and build commands.

Setup
Architecture

System architecture, components, and data flow.

Architecture
Contributing

Contribution guidelines and code review process.

Contributing
Testing

Testing standards, patterns, and commands.

Testing

Quick Start¶

# Clone repository
git clone https://github.com/lexfrei/cloudflare-tunnel-gateway-controller.git
cd cloudflare-tunnel-gateway-controller

# Build binary
go build -o bin/controller ./cmd/controller

# Run tests
go test -v -race ./...

# Run linter
golangci-lint run --timeout=5m

Project Structure¶

api/v1alpha1/            # GatewayClassConfig CRD types
cmd/controller/          # Entrypoint and CLI
internal/
  config/                # GatewayClassConfig resolver
  controller/            # Kubernetes controllers
  dns/                   # Cluster domain detection
  helm/                  # Helm SDK operations
  ingress/               # Route to ingress conversion
charts/                  # Helm chart
deploy/                  # Raw Kubernetes manifests

Code Quality¶

All changes must pass:

go test -race ./... - Unit tests with race detection
golangci-lint run - Linting (all errors must be fixed)
markdownlint-cli2 '**/*.md' - Markdown linting