API Reference
cloudflare-operator API Reference
Packages
cloudflare-operator.io/v1
Package v1 contains API schema definitions for the cloudflare-operator.io v1 API group.
Resource Types
Account
Account is the Schema for the accounts API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
cloudflare-operator.io/v1 |
||
kind string |
Account |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec AccountSpec |
|||
status AccountStatus |
AccountRef
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name of the Account object. |
AccountSpec
AccountSpec defines the desired state of Account
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiToken AccountSpecApiToken |
Cloudflare API token | ||
interval Duration |
Interval to check account status | 5m | |
managedZones string array |
List of zone names that should be managed by cloudflare-operator Deprecated and will be removed in a future release |
AccountSpecApiToken
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
secretRef SecretReference |
Secret containing the API token (key must be named “apiToken”) |
AccountStatus
AccountStatus defines the observed state of Account
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array |
Conditions contains the different condition statuses for the Account object. |
DNSRecord
DNSRecord is the Schema for the dnsrecords API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
cloudflare-operator.io/v1 |
||
kind string |
DNSRecord |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec DNSRecordSpec |
|||
status DNSRecordStatus |
DNSRecordSpec
DNSRecordSpec defines the desired state of DNSRecord
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
DNS record name (e.g. example.com) | MaxLength: 255 |
|
accountRef AccountRef |
Reference to the Account used for this DNS record. When omitted, the operator falls back to the owning Zone account, then to the only Account in the cluster. |
||
content string |
DNS record content (e.g. 127.0.0.1) | ||
ipRef DNSRecordSpecIPRef |
Reference to an IP object | ||
type string |
DNS record type | A | |
proxied boolean |
Whether the record is receiving the performance and security benefits of Cloudflare | true | |
ttl integer |
Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for “automatic” (e.g. 3600) | 1 | Maximum: 86400 Minimum: 1 |
data JSON |
Data holds arbitrary key-value pairs used to further configure the DNS record | ||
priority integer |
Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred. | Maximum: 65535 Minimum: 0 |
|
comment string |
Comments or notes about the DNS record. This field has no effect on DNS responses. | MaxLength: 100 |
|
interval Duration |
Interval to check DNSRecord | 5m |
DNSRecordSpecIPRef
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name of the IP object |
DNSRecordStatus
DNSRecordStatus defines the observed state of DNSRecord
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array |
Conditions contains the different condition statuses for the DNSRecord object. | ||
recordID string |
Cloudflare DNS record ID |
IP
IP is the Schema for the ips API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
cloudflare-operator.io/v1 |
||
kind string |
IP |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec IPSpec |
|||
status IPStatus |
IPSpec
IPSpec defines the desired state of IP
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
address string |
IP address (omit if type is dynamic) | ||
type string |
IP address type (static or dynamic) | static | Enum: [static dynamic] |
interval Duration |
Interval at which a dynamic IP should be checked | ||
ipSources IPSpecIPSources array |
IPSources can be configured to get an IP from an external source (e.g. an API or public IP echo service) |
IPSpecIPSources
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
url string |
URL of the IP source (e.g. https://checkip.amazonaws.com) | ||
requestBody string |
RequestBody to be sent to the URL | ||
requestHeaders JSON |
RequestHeaders to be sent to the URL | ||
requestHeadersSecretRef SecretReference |
RequestHeadersSecretRef is a secret reference to the headers to be sent to the URL (e.g. for authentication) where the key is the header name and the value is the header value |
||
requestMethod string |
RequestMethod defines the HTTP method to be used | Enum: [GET POST PUT DELETE] |
|
responseJQFilter string |
ResponseJQFilter applies a JQ filter to the response to extract the IP | ||
postProcessingRegex string |
PostProcessingRegex defines the regular expression to be used to extract the IP from the response or a JQ filter result | ||
insecureSkipVerify boolean |
InsecureSkipVerify defines whether to skip TLS certificate verification |
IPStatus
IPStatus defines the observed state of IP
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
address string |
Address contains the resolved IP address currently used by the operator. For static IPs this mirrors spec.address after validation, for dynamic IPs it is the last successfully discovered address. |
||
conditions Condition array |
Conditions contains the different condition statuses for the IP object. |
Zone
Zone is the Schema for the zones API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
cloudflare-operator.io/v1 |
||
kind string |
Zone |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec ZoneSpec |
|||
status ZoneStatus |
ZoneSpec
ZoneSpec defines the desired state of Zone
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name of the zone | ||
accountRef AccountRef |
Reference to the Account used for this zone. When omitted, the operator falls back to the only Account in the cluster. |
||
prune boolean |
Prune determines whether DNS records in the zone that are not managed by cloudflare-operator should be automatically removed | false | |
interval Duration |
Interval to check zone status | 5m | |
ignoredRecords object (keys:string, values:string array) |
IgnoredRecords are DNS records that should be ignored by the operator when prune is enabled It has no effect when prune is disabled Each key represents a record type, and the value is a list of record names Lines starting with a ‘^’ are treated as regex, otherwise they are treated as prefixes |
{ TXT:[_acme-challenge cf2024-1._domainkey] } |
ZoneStatus
ZoneStatus defines the observed state of Zone
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string |
ID of the zone | ||
conditions Condition array |
Conditions contains the different condition statuses for the Zone object. |
This page is generated from the operator API types with crd-ref-docs.