API Reference
Packages:
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 | ||||||
|---|---|---|---|---|---|---|---|
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||
specAccountSpec |
|
||||||
statusAccountStatus |
AccountSpec
(Appears on: Account)
AccountSpec defines the desired state of Account
| Field | Description |
|---|---|
apiTokenAccountSpecApiToken |
Cloudflare API token |
intervalKubernetes 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 |
AccountSpecApiToken
(Appears on: AccountSpec)
| Field | Description |
|---|---|
secretRefKubernetes core/v1.SecretReference |
Secret containing the API token (key must be named “apiToken”) |
AccountStatus
(Appears on: Account)
AccountStatus defines the observed state of Account
| Field | Description |
|---|---|
conditions[]Kubernetes meta/v1.Condition |
(Optional)
Conditions contains the different condition statuses for the Account object. |
DNSRecord
DNSRecord is the Schema for the dnsrecords API
| Field | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||
specDNSRecordSpec |
|
||||||||||||||||||||
statusDNSRecordStatus |
DNSRecordSpec
(Appears on: DNSRecord)
DNSRecordSpec defines the desired state of DNSRecord
| Field | Description |
|---|---|
namestring |
DNS record name (e.g. example.com) |
contentstring |
(Optional)
DNS record content (e.g. 127.0.0.1) |
ipRefDNSRecordSpecIPRef |
(Optional)
Reference to an IP object |
typestring |
(Optional)
DNS record type |
proxiedbool |
(Optional)
Whether the record is receiving the performance and security benefits of Cloudflare |
ttlint |
(Optional)
Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for “automatic” (e.g. 3600) |
dataKubernetes pkg/apis/apiextensions/v1.JSON |
(Optional)
Data holds arbitrary key-value pairs used to further configure the DNS record |
priorityuint16 |
(Optional)
Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred. |
commentstring |
(Optional)
Comments or notes about the DNS record. This field has no effect on DNS responses. |
intervalKubernetes meta/v1.Duration |
(Optional)
Interval to check DNSRecord |
DNSRecordSpecIPRef
(Appears on: DNSRecordSpec)
| Field | Description |
|---|---|
namestring |
(Optional)
Name of the IP object |
DNSRecordStatus
(Appears on: DNSRecord)
DNSRecordStatus defines the observed state of DNSRecord
| Field | Description |
|---|---|
conditions[]Kubernetes meta/v1.Condition |
(Optional)
Conditions contains the different condition statuses for the DNSRecord object. |
recordIDstring |
(Optional)
Cloudflare DNS record ID |
IP
IP is the Schema for the ips API
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
specIPSpec |
|
||||||||
statusIPStatus |
IPSpec
(Appears on: IP)
IPSpec defines the desired state of IP
| Field | Description |
|---|---|
addressstring |
(Optional)
IP address (omit if type is dynamic) |
typestring |
(Optional)
IP address type (static or dynamic) |
intervalKubernetes meta/v1.Duration |
(Optional)
Interval at which a dynamic IP should be checked |
ipSources[]IPSpecIPSources |
(Optional)
IPSources can be configured to get an IP from an external source (e.g. an API or public IP echo service) |
IPSpecIPSources
(Appears on: IPSpec)
| Field | Description |
|---|---|
urlstring |
URL of the IP source (e.g. https://checkip.amazonaws.com) |
requestBodystring |
(Optional)
RequestBody to be sent to the URL |
requestHeadersKubernetes pkg/apis/apiextensions/v1.JSON |
(Optional)
RequestHeaders to be sent to the URL |
requestHeadersSecretRefKubernetes core/v1.SecretReference |
(Optional)
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 |
requestMethodstring |
(Optional)
RequestMethod defines the HTTP method to be used |
responseJQFilterstring |
(Optional)
ResponseJQFilter applies a JQ filter to the response to extract the IP |
postProcessingRegexstring |
(Optional)
PostProcessingRegex defines the regular expression to be used to extract the IP from the response or a JQ filter result |
insecureSkipVerifybool |
(Optional)
InsecureSkipVerify defines whether to skip TLS certificate verification |
IPStatus
(Appears on: IP)
IPStatus defines the observed state of IP
| Field | Description |
|---|---|
conditions[]Kubernetes meta/v1.Condition |
(Optional)
Conditions contains the different condition statuses for the IP object. |
Zone
Zone is the Schema for the zones API
| Field | Description | ||||||
|---|---|---|---|---|---|---|---|
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||
specZoneSpec |
|
||||||
statusZoneStatus |
ZoneSpec
(Appears on: Zone)
ZoneSpec defines the desired state of Zone
| Field | Description |
|---|---|
namestring |
Name of the zone |
prunebool |
(Optional)
Prune determines whether DNS records in the zone that are not managed by cloudflare-operator should be automatically removed |
intervalKubernetes meta/v1.Duration |
(Optional)
Interval to check zone status |
ZoneStatus
(Appears on: Zone)
ZoneStatus defines the observed state of Zone
| Field | Description |
|---|---|
idstring |
(Optional)
ID of the zone |
conditions[]Kubernetes meta/v1.Condition |
(Optional)
Conditions contains the different condition statuses for the Zone object. |
This page was automatically generated with
gen-crd-api-reference-docs