provider-upjet-cloudflare

Provider Cloudflare

provider-cloudflare is a Crossplane provider built using Upjet that exposes XRM-conformant managed resources for the Cloudflare API.

Getting Started

This provider uses the family distribution model: install only the sub-providers you need. The first sub-provider you install automatically pulls in provider-family-cloudflare, which manages the shared ProviderConfig.

For provider families background, see Scalable Provider Families and the Upbound Provider Families docs.

Install

Install only the Cloudflare services you need:

apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
  name: provider-cloudflare-dns
spec:
  package: xpkg.upbound.io/wildbitca/provider-cloudflare-dns:v0.2.0

Need more services? Add more sub-providers:

apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
  name: provider-cloudflare-zone
spec:
  package: xpkg.upbound.io/wildbitca/provider-cloudflare-zone:v0.2.0
---
apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
  name: provider-cloudflare-workers
spec:
  package: xpkg.upbound.io/wildbitca/provider-cloudflare-workers:v0.2.0

Available sub-providers

ProviderConfig

Create a Secret with Cloudflare credentials (API token recommended):

apiVersion: v1
kind: Secret
metadata:
  name: cloudflare-creds
  namespace: crossplane-system
type: Opaque
stringData:
  credentials: |
    {
      "api_token": "YOUR_CLOUDFLARE_API_TOKEN"
    }

Create a ProviderConfig:

apiVersion: upjet-cloudflare.upbound.io/v1beta1
kind: ProviderConfig
metadata:
  name: default
spec:
  credentials:
    source: Secret
    secretRef:
      name: cloudflare-creds
      namespace: crossplane-system
      key: credentials

Supported credential keys: api_token, api_key, email, api_user_service_key, account_id, api_hostname, api_base_path, api_client_logging.

Rate limiting

Cloudflare's API allows about 1,200 requests per five minutes. For large deployments, use a DeploymentRuntimeConfig to throttle:

apiVersion: pkg.crossplane.io/v1beta1
kind: DeploymentRuntimeConfig
metadata:
  name: cloudflare-throttled
spec:
  deploymentTemplate:
    spec:
      selector: {}
      template:
        spec:
          containers:
            - name: package-runtime
              args:
                - --poll=30m
                - --max-reconcile-rate=1
                - --sync=4h

Developing

make submodules
go install golang.org/x/tools/cmd/goimports@latest
export PATH="$(go env GOPATH)/bin:$PATH"
make generate

Run against a Kubernetes cluster:

make run

Build family sub-providers:

make build.family
make build.family FAMILY_SUBPACKAGES="config dns zone"

Supported resources

This provider exposes 198 managed resources from the Cloudflare Terraform Provider v5.18.0.

API reference: doc.crds.dev

Report a Bug

Open an issue.