README.md

API Reference

This section contains detailed documentation for all Custom Resource Definitions (CRDs).

CRD Categories

Tunnel Management

• Tunnel - Namespace-scoped Cloudflare Tunnel
• ClusterTunnel - Cluster-wide Cloudflare Tunnel
• TunnelBinding - Bind Services to Tunnels

Private Network

• VirtualNetwork - Traffic isolation network
• NetworkRoute - CIDR routing through tunnel
• PrivateService - Private IP service exposure
• WARPConnector - Site-to-site WARP connector

Access Control

• AccessApplication - Zero Trust application
• AccessGroup - Reusable access policy group
• AccessIdentityProvider - Identity provider config
• AccessServiceToken - M2M authentication token
• AccessTunnel - Access-protected tunnel endpoint

Gateway & Security

• GatewayRule - DNS/HTTP/L4 policy rule
• GatewayList - List for gateway rules
• GatewayConfiguration - Global gateway settings

Device Management

• DeviceSettingsPolicy - WARP client configuration
• DevicePostureRule - Device health check rule

DNS & Connectivity

• DNSRecord - DNS record management

Pages & Workers

• PagesProject - Cloudflare Pages project management
• PagesDeployment - Deploy versions to Pages
• PagesDomain - Custom domain for Pages

Kubernetes Integration

• TunnelIngressClassConfig - Ingress integration
• TunnelGatewayClassConfig - Gateway API integration

Common Types

CloudflareSpec

All CRDs that interact with Cloudflare API include a cloudflare spec:

spec:
  cloudflare:
    accountId: "your-account-id"
    domain: example.com
    secret: cloudflare-credentials

Status Conditions

All CRDs report status through standard Kubernetes conditions:

Condition	Description
Ready	Resource is fully reconciled and operational
Progressing	Resource is being created or updated
Degraded	Resource has errors but may be partially functional

API Version

Current API version: networking.cloudflare-operator.io/v1alpha2

Legacy version v1alpha1 is deprecated but still supported for backwards compatibility.