cloudflare-operator on contineroo.ch

Core Concepts

Mon, 01 Jan 0001 00:00:00 +0000

Architecture

cloudflare-operator is designed to serve as the single source of truth for Cloudflare DNS records.
It relies on the Kubernetes API to store the desired state of DNS records using Custom Resource Definitions (CRDs).

DNS records

Cloudflare DNS records are specified using a CRD (dnsrecords.cloudflare-operator.io).
These records can be created manually, through a GitOps workflow, or automatically generated from Kubernetes Ingress resources and supported Gateway API routes when the feature flag is enabled.

Get Started

Mon, 01 Jan 0001 00:00:00 +0000

This tutorial shows you how to get started with using cloudflare-operator and create a sample DNS record.

Before you begin

The following prerequisites are required to complete this tutorial:

A Kubernetes cluster with cloudflare-operator installed (follow the installation guide)
A Cloudflare account

Create Cloudflare API token

The token can be created by following this guide.

The following permissions are required:

Zone:Zone:Read
Zone:DNS:Edit

Configure the following Zone resources:

Include:All zones

or, if you want to limit the zones to which the token has access:

Installation

Mon, 01 Jan 0001 00:00:00 +0000

This guide walks you through installing cloudflare-operator.

Prerequisites

Install Helm 3
Kubernetes cluster

Install cloudflare-operator

Helm repository

Add the cloudflare-operator Helm chart repository:

helm repo add containeroo https://charts.containeroo.ch

Update the Helm chart repository:

helm repo update

Custom Resource Definitions

As per the Helm best practices, cloudflare-operator Helm chart doesn’t ship with CRDs.

To install the latest CRDs, run the following command:

kubectl apply -f https://github.com/containeroo/cloudflare-operator/releases/latest/download/crds.yaml

If you want to install a specific version of CRDs, run the following command:

API Reference

Mon, 01 Jan 0001 00:00:00 +0000

Packages:

cloudflare-operator.io/v1

cloudflare-operator.io/v1

Package v1 contains API Schema definitions for the source v1 API group

Resource Types:

Account

Account is the Schema for the accounts API

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
AccountSpec

`apiToken` AccountSpecApiToken	Cloudflare API token
`interval` Kubernetes meta/v1.Duration	(Optional) Interval to check account status
`managedZones` []string	(Optional) List of zone names that should be managed by cloudflare-operator Deprecated and will be removed in a future release