Getting Started

June 8, 2025 ยท View on GitHub

Installation

Prerequisites

To install this operator, you need the following:

  • kubectl
  • kustomize (Optional)
  • A kubernetes cluster with a recent enough version to support Custom Resource Definitions. The operator was initially built on v1.22.5+k3s1 and being developed on v1.25.4+k3s1.

Installation methods

  1. Find the latest tag for cloudflare-operator.

  2. Create a kustomization.yaml in your repository that looks like

    apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
namespace: cloudflare-operator-system
resources:
  # ensure you update the ref in this line to the latest version
  - https://github.com/adyanth/cloudflare-operator.git/config/default?ref=v0.13.1

  3. deploy the application from the directory you placed the kustomization.yaml in

    # either approach will work
kubectl apply -k .
kustomize build . | kubectl apply -f -

If you need to customize the operator in some way, you can do so with kustomize

Imperative installation

For a one-off installation, you can use any of the following methods

Install a specific tag

In general, one should pick a specific tag. You can find the latest tag here

kubectl apply -k 'https://github.com/adyanth/cloudflare-operator.git//config/default?ref=v0.13.1'

Install the latest version

To install the latest version without checking tags, you can use either of the following. This will deploy a point in time version of the operator.

kubectl apply -k 'https://github.com/adyanth/cloudflare-operator.git/config/default?ref=main'
kubectl apply -k 'https://github.com/adyanth/cloudflare-operator/config/default'

Where do I go from here?

Now that the operator is installed, we can make it useful.

  1. Deploy a secret with your API token
  2. Create a Tunnel/ClusterTunnel resource
  3. Configure routing for your tunnel by following one of:

Additional Info

  • Look into the documentation in docs/configuration to understand various configurable parameters of this operator.
  • Look at migration documentation in docs/migrations for upgrades.